Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 18 additions & 29 deletions lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ndarray>
*
* var v = z.get();
* // returns -5.0
* // returns <ndarray>[ -5.0 ]
*/
binaryReduceStrided1dDispatch: typeof binaryReduceStrided1dDispatch;

Expand Down Expand Up @@ -491,10 +488,7 @@ interface Namespace {
* var y = new ndarray( 'generic', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
*
* var z = dot( x, y );
* // returns <ndarray>
*
* var v = z.get();
* // returns -5.0
* // returns <ndarray>[ -5.0 ]
*/
binaryReduceStrided1dDispatchFactory: typeof binaryReduceStrided1dDispatchFactory;

Expand Down Expand Up @@ -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 );
Expand Down Expand Up @@ -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 <ndarray>
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
*
* var shx = x.shape;
* var shx = getShape( x );
* // returns [ 2, 2 ]
*
* var y = ns.expandDimensions( x, 1 );
* // returns <ndarray>
* // returns <ndarray>[ [ [ 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;

Expand All @@ -1624,6 +1607,7 @@ interface Namespace {
*
* @param x - input ndarray
* @param value - scalar value
* @returns input ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
Expand All @@ -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 );
* // => <Float64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
*
* var bool = ( out === x );
* // returns true
*/
fill: typeof fill;

Expand Down Expand Up @@ -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 ];
Expand All @@ -1851,7 +1839,7 @@ interface Namespace {
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>
*
* var sh = x.shape;
* var sh = getShape( x );
* // returns [ 3, 2 ]
*
* var arr = ndarray2array( x );
Expand All @@ -1860,7 +1848,7 @@ interface Namespace {
* var y = ns.fliplr( x, false );
* // returns <ndarray>
*
* sh = y.shape;
* sh = getShape( y );
* // returns [ 3, 2 ]
*
* arr = ndarray2array( y );
Expand Down Expand Up @@ -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 ) {
Expand Down Expand Up @@ -2313,7 +2302,7 @@ interface Namespace {
* // Apply function:
* ns.map( [ x, y ], scale );
*
* console.log( y.data );
* console.log( getData( y ) );
* // => <Float64Array>[ 20.0, 30.0, 60.0, 70.0, 100.0, 110.0 ]
*/
map: typeof map;
Expand Down
Loading