diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts index de73cb6a6ddf..8eca4b50b0cc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts @@ -47,6 +47,7 @@ import dcusumors = require( '@stdlib/blas/ext/base/ndarray/dcusumors' ); import dcusumpw = require( '@stdlib/blas/ext/base/ndarray/dcusumpw' ); import ddiff = require( '@stdlib/blas/ext/base/ndarray/ddiff' ); import dfillEqual = require( '@stdlib/blas/ext/base/ndarray/dfill-equal' ); +import dfillNaN = require( '@stdlib/blas/ext/base/ndarray/dfill-nan' ); import dfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/dfill-not-equal' ); import dfirstIndexGreaterThan = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than' ); import dfirstIndexLessThan = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-less-than' ); @@ -92,6 +93,7 @@ import gcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn2' ); import gcusumors = require( '@stdlib/blas/ext/base/ndarray/gcusumors' ); import gcusumpw = require( '@stdlib/blas/ext/base/ndarray/gcusumpw' ); import gfillEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-equal' ); +import gfillNaN = require( '@stdlib/blas/ext/base/ndarray/gfill-nan' ); import gfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-not-equal' ); import gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' ); import gfindLastIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-last-index' ); @@ -138,6 +140,7 @@ import scusum = require( '@stdlib/blas/ext/base/ndarray/scusum' ); import scusumkbn = require( '@stdlib/blas/ext/base/ndarray/scusumkbn' ); import scusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/scusumkbn2' ); import scusumors = require( '@stdlib/blas/ext/base/ndarray/scusumors' ); +import sfillNaN = require( '@stdlib/blas/ext/base/ndarray/sfill-nan' ); import sfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/sfill-not-equal' ); import sfirstIndexLessThan = require( '@stdlib/blas/ext/base/ndarray/sfirst-index-less-than' ); import sindexOf = require( '@stdlib/blas/ext/base/ndarray/sindex-of' ); @@ -402,7 +405,7 @@ interface Namespace { * var B = new Complex64Matrix( [ [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] ); * * var k = scalar2ndarray( 0, { - * 'dtype': 'generic' + * 'dtype': 'generic' * }); * * var out = ns.ctriu( [ A, B, k ] ); @@ -992,6 +995,34 @@ interface Namespace { */ dfillEqual: typeof dfillEqual; + /** + * Replaces elements in a one-dimensional double-precision floating-point ndarray equal to `NaN` with a specified scalar constant. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the scalar constant. + * + * @param arrays - array-like object containing ndarrays + * @returns input ndarray + * + * @example + * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Float64Vector( [ NaN, -2.0, 3.0, NaN, 4.0, -6.0 ] ); + * + * var alpha = scalar2ndarray( 0.0, { + * 'dtype': 'float64' + * }); + * + * var out = ns.dfillNaN( [ x, alpha ] ); + * // returns [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] + */ + dfillNaN: typeof dfillNaN; + /** * Replaces elements in a one-dimensional double-precision floating-point ndarray not equal to a provided search element with a specified scalar constant. * @@ -2234,6 +2265,34 @@ interface Namespace { */ gfillEqual: typeof gfillEqual; + /** + * Replaces elements in a one-dimensional ndarray equal to `NaN` with a specified scalar constant. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the scalar constant. + * + * @param arrays - array-like object containing ndarrays + * @returns input ndarray + * + * @example + * var vector = require( '@stdlib/ndarray/vector/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = vector( [ NaN, -2.0, 3.0, NaN, 4.0, -6.0 ], 'generic' ); + * + * var alpha = scalar2ndarray( 0.0, { + * 'dtype': 'generic' + * }); + * + * var out = ns.gfillNaN( [ x, alpha ] ); + * // returns [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] + */ + gfillNaN: typeof gfillNaN; + /** * Replaces elements in a one-dimensional ndarray not equal to a provided search element with a specified scalar constant. * @@ -2966,7 +3025,7 @@ interface Namespace { * var B = matrix( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ], 'generic' ); * * var k = scalar2ndarray( 0, { - * 'dtype': 'generic' + * 'dtype': 'generic' * }); * * var out = ns.gtriu( [ A, B, k ] ); @@ -3504,6 +3563,34 @@ interface Namespace { */ scusumors: typeof scusumors; + /** + * Replaces elements in a one-dimensional single-precision floating-point ndarray equal to `NaN` with a specified scalar constant. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the scalar constant. + * + * @param arrays - array-like object containing ndarrays + * @returns input ndarray + * + * @example + * var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Float32Vector( [ NaN, -2.0, 3.0, NaN, 4.0, -6.0 ] ); + * + * var alpha = scalar2ndarray( 0.0, { + * 'dtype': 'float32' + * }); + * + * var out = ns.sfillNaN( [ x, alpha ] ); + * // returns [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] + */ + sfillNaN: typeof sfillNaN; + /** * Replaces elements in a one-dimensional single-precision floating-point ndarray not equal to a provided search element with a specified scalar constant. * @@ -4047,7 +4134,7 @@ interface Namespace { * var B = new Float32Matrix( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ); * * var k = scalar2ndarray( 0, { - * 'dtype': 'generic' + * 'dtype': 'generic' * }); * * var out = ns.striu( [ A, B, k ] ); @@ -4472,7 +4559,7 @@ interface Namespace { * var B = new Complex128Matrix( [ [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] ); * * var k = scalar2ndarray( 0, { - * 'dtype': 'generic' + * 'dtype': 'generic' * }); * * var out = ns.ztriu( [ A, B, k ] );