Skip to content

Commit 501212e

Browse files
committed
Auto-generated commit
1 parent 28c8d06 commit 501212e

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
### Features
1212

13+
- [`28d3e7d`](https://github.com/stdlib-js/stdlib/commit/28d3e7d6b05b312ebf14896cb0d8593902e443cb) - update `ndarray/base` TypeScript declarations [(#11166)](https://github.com/stdlib-js/stdlib/pull/11166)
1314
- [`364e294`](https://github.com/stdlib-js/stdlib/commit/364e294fbd4ebd149d86b8f7996da4b00b6c6b3b) - add `nulls` to namespace
1415
- [`f1ab973`](https://github.com/stdlib-js/stdlib/commit/f1ab9738a81b32e0bcd49a2661b0023bbc4ca84f) - add `nans` to namespace
1516
- [`751b29f`](https://github.com/stdlib-js/stdlib/commit/751b29f4675e211127d6b24211d9bf655bcbac2c) - add `ndarray/base/nans` [(#11144)](https://github.com/stdlib-js/stdlib/pull/11144)
@@ -816,6 +817,7 @@ A total of 45 issues were closed in this release:
816817

817818
<details>
818819

820+
- [`28d3e7d`](https://github.com/stdlib-js/stdlib/commit/28d3e7d6b05b312ebf14896cb0d8593902e443cb) - **feat:** update `ndarray/base` TypeScript declarations [(#11166)](https://github.com/stdlib-js/stdlib/pull/11166) _(by stdlib-bot)_
819821
- [`762f410`](https://github.com/stdlib-js/stdlib/commit/762f410098b29afa3823ab1191553101db0dcead) - **fix:** correct grammar in ndarray type test comments [(#11154)](https://github.com/stdlib-js/stdlib/pull/11154) _(by Matt Van Horn)_
820822
- [`364e294`](https://github.com/stdlib-js/stdlib/commit/364e294fbd4ebd149d86b8f7996da4b00b6c6b3b) - **feat:** add `nulls` to namespace _(by Athan Reines)_
821823
- [`f1ab973`](https://github.com/stdlib-js/stdlib/commit/f1ab9738a81b32e0bcd49a2661b0023bbc4ca84f) - **feat:** add `nans` to namespace _(by Athan Reines)_

base/docs/types/index.d.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ import minSignedIntegerDataType = require( './../../../base/min-signed-integer-d
104104
import minUnsignedIntegerDataType = require( './../../../base/min-unsigned-integer-dtype' );
105105
import minViewBufferIndex = require( './../../../base/min-view-buffer-index' );
106106
import minmaxViewBufferIndex = require( './../../../base/minmax-view-buffer-index' );
107+
import nans = require( './../../../base/nans' );
107108
import ndarraylike2ndarray = require( './../../../base/ndarraylike2ndarray' );
108109
import ndarraylike2object = require( './../../../base/ndarraylike2object' );
109110
import ndarraylike2scalar = require( './../../../base/ndarraylike2scalar' );
@@ -117,6 +118,7 @@ import nullaryLoopOrder = require( './../../../base/nullary-loop-interchange-ord
117118
import nullaryStrided1dDispatch = require( './../../../base/nullary-strided1d-dispatch' );
118119
import nullaryStrided1dDispatchFactory = require( './../../../base/nullary-strided1d-dispatch-factory' );
119120
import nullaryBlockSize = require( './../../../base/nullary-tiling-block-size' );
121+
import nulls = require( './../../../base/nulls' );
120122
import numel = require( './../../../base/numel' );
121123
import numelDimension = require( './../../../base/numel-dimension' );
122124
import offset = require( './../../../base/offset' );
@@ -2761,6 +2763,25 @@ interface Namespace {
27612763
*/
27622764
minmaxViewBufferIndex: typeof minmaxViewBufferIndex;
27632765

2766+
/**
2767+
* Creates a NaN-filled array having a specified shape and data type.
2768+
*
2769+
* @param dtype - underlying data type
2770+
* @param shape - array shape
2771+
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
2772+
* @returns NaN-filled array
2773+
*
2774+
* @example
2775+
* var getDType = require( './../../../dtype' );
2776+
*
2777+
* var arr = ns.nans( 'float64', [ 2, 2 ], 'row-major' );
2778+
* // returns <ndarray>[ [ NaN, NaN ], [ NaN, NaN ] ]
2779+
*
2780+
* var dt = String( getDType( arr ) );
2781+
* // returns 'float64'
2782+
*/
2783+
nans: typeof nans;
2784+
27642785
/**
27652786
* Converts an ndarray-like object to an ndarray.
27662787
*
@@ -3120,6 +3141,25 @@ interface Namespace {
31203141
*/
31213142
nullaryBlockSize: typeof nullaryBlockSize;
31223143

3144+
/**
3145+
* Creates a null-filled array having a specified shape and data type.
3146+
*
3147+
* @param dtype - underlying data type
3148+
* @param shape - array shape
3149+
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
3150+
* @returns null-filled array
3151+
*
3152+
* @example
3153+
* var getDType = require( './../../../dtype' );
3154+
*
3155+
* var arr = ns.nulls( 'generic', [ 2, 2 ], 'row-major' );
3156+
* // returns <ndarray>[ [ null, null ], [ null, null ] ]
3157+
*
3158+
* var dt = String( getDType( arr ) );
3159+
* // returns 'generic'
3160+
*/
3161+
nulls: typeof nulls;
3162+
31233163
/**
31243164
* Returns the number of elements in an array.
31253165
*

0 commit comments

Comments
 (0)