Skip to content

docs: update ndarray/base TypeScript declarations #10021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Feb 2, 2026
+22 −30
Merged

docs: update ndarray/base TypeScript declarations #10021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 22 additions & 30 deletions lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1859,30 +1859,23 @@ interface Namespace {
* 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 ];
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
* var shape = [ 3, 2 ];
* var strides = [ 2, 1 ];
* var offset = 0;
*
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* var sh = getShape( x );
* // returns [ 3, 2 ]
*
* var arr = ndarray2array( x );
* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
*
* var y = ns.fliplr( x, false );
* // returns <ndarray>
* // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
*
* sh = getShape( y );
* // returns [ 3, 2 ]
*
* arr = ndarray2array( y );
* // returns [ [ 2, 1 ], [ 4, 3 ], [ 6, 5 ] ]
*/
fliplr: typeof fliplr;

Expand All @@ -1896,37 +1889,31 @@ interface Namespace {
* @example
* var typedarray = require( '@stdlib/array/typed' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var getShape = require( '@stdlib/ndarray/shape' );
*
* var buffer = [ 1, 2, 3, 4, 5, 6 ];
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
* var shape = [ 3, 2 ];
* var strides = [ 2, 1 ];
* var offset = 0;
*
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* var sh = x.shape;
* var sh = getShape( x );
* // returns [ 3, 2 ]
*
* var arr = ndarray2array( x );
* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
*
* var y = ns.flipud( x, false );
* // returns <ndarray>
* // returns <ndarray>[ [ 5.0, 6.0 ], [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
*
* sh = y.shape;
* sh = getShape( y );
* // returns [ 3, 2 ]
*
* arr = ndarray2array( y );
* // returns [ [ 5, 6 ], [ 3, 4 ], [ 1, 2 ] ]
*/
flipud: typeof flipud;

/**
* Invokes a callback function once for each ndarray element.
* Invokes a callback function once for each element in an ndarray.
*
* @param arrays - array-like object containing an output ndarray
* @param arrays - array-like object containing an input ndarray
* @param fcn - callback function
* @param thisArg - callback function execution context
*
Expand All @@ -1948,7 +1935,7 @@ interface Namespace {
* // Define the index offset:
* var ox = 1;
*
* // Create the output ndarray:
* // Create the input ndarray:
* var x = ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' );
*
* // Apply the callback function:
Expand All @@ -1964,12 +1951,14 @@ interface Namespace {
* @returns one-dimensional ndarray
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = [ 1, 2, 3, 4 ];
*
* var x = ns.array2ndarray( arr, 'row-major' );
* // returns <ndarray>
*
* var dt = x.dtype;
* var dt = String( getDType( x ) );
* // returns 'generic'
*/
array2ndarray: typeof array2ndarray;
Expand All @@ -1983,13 +1972,16 @@ interface Namespace {
* @returns zero-dimensional ndarray
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var x = ns.scalar2ndarray( 1.0, 'generic', 'row-major' );
* // returns <ndarray>
*
* var sh = x.shape;
* var sh = getShape( x );
* // returns []
*
* var dt = x.dtype;
* var dt = String( getDType( x ) );
* // returns 'generic'
*
* var v = x.get();
Expand Down