Skip to content

feat: update ndarray/base TypeScript declarations #11166

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
Mar 27, 2026
Merged

feat: update ndarray/base TypeScript declarations #11166

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
40 changes: 40 additions & 0 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 @@ -104,6 +104,7 @@ import minSignedIntegerDataType = require( '@stdlib/ndarray/base/min-signed-inte
import minUnsignedIntegerDataType = require( '@stdlib/ndarray/base/min-unsigned-integer-dtype' );
import minViewBufferIndex = require( '@stdlib/ndarray/base/min-view-buffer-index' );
import minmaxViewBufferIndex = require( '@stdlib/ndarray/base/minmax-view-buffer-index' );
import nans = require( '@stdlib/ndarray/base/nans' );
import ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' );
import ndarraylike2object = require( '@stdlib/ndarray/base/ndarraylike2object' );
import ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
Expand All @@ -117,6 +118,7 @@ import nullaryLoopOrder = require( '@stdlib/ndarray/base/nullary-loop-interchang
import nullaryStrided1dDispatch = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch' );
import nullaryStrided1dDispatchFactory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
import nullaryBlockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
import nulls = require( '@stdlib/ndarray/base/nulls' );
import numel = require( '@stdlib/ndarray/base/numel' );
import numelDimension = require( '@stdlib/ndarray/base/numel-dimension' );
import offset = require( '@stdlib/ndarray/base/offset' );
Expand Down Expand Up @@ -2761,6 +2763,25 @@ interface Namespace {
*/
minmaxViewBufferIndex: typeof minmaxViewBufferIndex;

/**
* Creates a NaN-filled array having a specified shape and data type.
*
* @param dtype - underlying data type
* @param shape - array shape
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
* @returns NaN-filled array
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = ns.nans( 'float64', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ NaN, NaN ], [ NaN, NaN ] ]
*
* var dt = String( getDType( arr ) );
* // returns 'float64'
*/
nans: typeof nans;

/**
* Converts an ndarray-like object to an ndarray.
*
Expand Down Expand Up @@ -3120,6 +3141,25 @@ interface Namespace {
*/
nullaryBlockSize: typeof nullaryBlockSize;

/**
* Creates a null-filled array having a specified shape and data type.
*
* @param dtype - underlying data type
* @param shape - array shape
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
* @returns null-filled array
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = ns.nulls( 'generic', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ null, null ], [ null, null ] ]
*
* var dt = String( getDType( arr ) );
* // returns 'generic'
*/
nulls: typeof nulls;

/**
* Returns the number of elements in an array.
*
Expand Down