diff --git a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts index b2f7c44b4a44..8f46962a7fa0 100644 --- a/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts @@ -451,10 +451,7 @@ interface Namespace { * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); * * var z = dot.apply( x, y ); - * // returns - * - * var v = z.get(); - * // returns -5.0 + * // returns [ -5.0 ] */ binaryReduceStrided1dDispatch: typeof binaryReduceStrided1dDispatch; @@ -491,10 +488,7 @@ interface Namespace { * var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); * * var z = dot( x, y ); - * // returns - * - * var v = z.get(); - * // returns -5.0 + * // returns [ -5.0 ] */ binaryReduceStrided1dDispatchFactory: typeof binaryReduceStrided1dDispatchFactory; @@ -739,7 +733,7 @@ interface Namespace { * var sh = getShape( x ); * // returns [ 2, 2 ] * - * var dt = getDType( x ); + * var dt = String( getDType( x ) ); * // returns 'generic' * * var v = x.get( 0, 1 ); @@ -1587,31 +1581,20 @@ interface Namespace { * @returns output array * * @example + * var getShape = require( '@stdlib/ndarray/shape' ); * var array = require( '@stdlib/ndarray/array' ); * * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - * // returns + * // returns [ [ 1, 2 ], [ 3, 4 ] ] * - * var shx = x.shape; + * var shx = getShape( x ); * // returns [ 2, 2 ] * * var y = ns.expandDimensions( x, 1 ); - * // returns + * // returns [ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ] * - * var shy = y.shape; + * var shy = getShape( y ); * // returns [ 2, 1, 2 ] - * - * var v = y.get( 0, 0, 0 ); - * // returns 1 - * - * v = y.get( 0, 0, 1 ); - * // returns 2 - * - * v = y.get( 1, 0, 0 ); - * // returns 3 - * - * v = y.get( 1, 0, 1 ); - * // returns 4 */ expandDimensions: typeof expandDimensions; @@ -1624,6 +1607,7 @@ interface Namespace { * * @param x - input ndarray * @param value - scalar value + * @returns input ndarray * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -1650,10 +1634,13 @@ interface Namespace { * 'order': 'row-major' * }; * - * ns.fill( x, 10.0 ); + * var out = ns.fill( x, 10.0 ); * * console.log( x.data ); * // => [ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ] + * + * var bool = ( out === x ); + * // returns true */ fill: typeof fill; @@ -1841,6 +1828,7 @@ interface Namespace { * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); + * var getShape = require( '@stdlib/ndarray/shape' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1, 2, 3, 4, 5, 6 ]; @@ -1851,7 +1839,7 @@ interface Namespace { * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); * // returns * - * var sh = x.shape; + * var sh = getShape( x ); * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); @@ -1860,7 +1848,7 @@ interface Namespace { * var y = ns.fliplr( x, false ); * // returns * - * sh = y.shape; + * sh = getShape( y ); * // returns [ 3, 2 ] * * arr = ndarray2array( y ); @@ -2285,6 +2273,7 @@ interface Namespace { * * @example * var Float64Array = require( '@stdlib/array/float64' ); + * var getData = require( '@stdlib/ndarray/data-buffer' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * function scale( x ) { @@ -2313,7 +2302,7 @@ interface Namespace { * // Apply function: * ns.map( [ x, y ], scale ); * - * console.log( y.data ); + * console.log( getData( y ) ); * // => [ 20.0, 30.0, 60.0, 70.0, 100.0, 110.0 ] */ map: typeof map;