Skip to content

feat!: update ndarray TypeScript declarations #9508

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
Jan 3, 2026
Merged

feat!: update ndarray TypeScript declarations #9508

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
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,11 +489,10 @@ interface Namespace {
* Concatenates a list of ndarrays along a specified ndarray dimension.
*
* @param arrays - array-like object containing input ndarrays
* @param dim - dimension along which to concatenate input ndarrays
* @param options - function options
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
Expand All @@ -503,14 +502,12 @@ interface Namespace {
* var ybuf = new Float64Array( [ -5.0, 6.0, -7.0, 8.0, -9.0, 10.0 ] );
* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
*
* var out = ns.concat( [ x, y ], -1 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
* var out = ns.concat( [ x, y ], {
* 'dim': -1
* });
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
Expand All @@ -522,13 +519,13 @@ interface Namespace {
*
* var z = new ndarray( 'float64', new Float64Array( 10 ), [ 2, 5 ], [ 5, 1 ], 0, 'row-major' );
*
* var out = ns.concat.assign( [ x, y ], z, -1 );
* var out = ns.concat.assign( [ x, y ], z, {
* 'dim': -1
* });
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
concat: typeof concat;

Expand Down
Loading