diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts index d3374d58a5ff..e1e9f50c04b6 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts @@ -45,7 +45,15 @@ interface Namespace { /** * Multiplies a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional single-precision complex floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * - a zero-dimensional ndarray containing a scalar constant. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -71,7 +79,14 @@ interface Namespace { /** * Copies values from a one-dimensional single-precision complex floating-point ndarray `x` into a one-dimensional single-precision complex floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray and an output ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -91,7 +106,13 @@ interface Namespace { /** * Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray. * - * @param arrays - array-like object containing a one-dimensional input ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns sum * * @example @@ -107,7 +128,15 @@ interface Namespace { /** * Multiplies a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * - a zero-dimensional ndarray containing a scalar constant. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -132,7 +161,14 @@ interface Namespace { /** * Copies values from a one-dimensional double-precision floating-point ndarray `x` into a one-dimensional double-precision floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray and an output ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -152,7 +188,14 @@ interface Namespace { /** * Computes the dot product of two one-dimensional double-precision floating-point ndarrays. * - * @param arrays - array-like object containing two one-dimensional input ndarrays + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a first one-dimensional input ndarray. + * - a second one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns dot product * * @example @@ -169,7 +212,14 @@ interface Namespace { /** * Interchanges two one-dimensional double-precision floating-point ndarrays. * - * @param arrays - array-like object containing two input ndarrays + * ## Notes + * + * - The function expects the following ndarrays: + * + * - first one-dimensional input ndarray. + * - second one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns second input ndarray * * @example @@ -190,7 +240,13 @@ interface Namespace { /** * Computes the sum of absolute values for all elements in a one-dimensional ndarray. * - * @param arrays - array-like object containing a one-dimensional input ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns sum * * @example @@ -206,7 +262,15 @@ interface Namespace { /** * Multiplies a one-dimensional ndarray `x` by a constant `alpha` and adds the result to a one-dimensional ndarray `y`. * - * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * - a zero-dimensional ndarray containing a scalar constant. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -231,7 +295,14 @@ interface Namespace { /** * Copies values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`. * - * @param arrays - array-like object containing an input ndarray and an output ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -251,7 +322,14 @@ interface Namespace { /** * Computes the dot product of two one-dimensional ndarrays. * - * @param arrays - array-like object containing two one-dimensional input ndarrays + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a first one-dimensional input ndarray. + * - a second one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns dot product * * @example @@ -268,7 +346,13 @@ interface Namespace { /** * Computes the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray. * - * @param arrays - array-like object containing a one-dimensional input ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns sum * * @example @@ -284,7 +368,15 @@ interface Namespace { /** * Multiplies a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional single-precision floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * - a zero-dimensional ndarray containing a scalar constant. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -309,7 +401,14 @@ interface Namespace { /** * Copies values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray and an output ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -329,7 +428,14 @@ interface Namespace { /** * Computes the dot product of two one-dimensional single-precision floating-point ndarrays. * - * @param arrays - array-like object containing two one-dimensional input ndarrays + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a first one-dimensional input ndarray. + * - a second one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns dot product * * @example @@ -346,7 +452,15 @@ interface Namespace { /** * Multiplies a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision complex floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * - a zero-dimensional ndarray containing a scalar constant. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example @@ -372,7 +486,14 @@ interface Namespace { /** * Copies values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. * - * @param arrays - array-like object containing an input ndarray and an output ndarray + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example