Skip to content

Commit baef022

Browse files
authored
feat: update ndarray/base TypeScript declarations
PR-URL: #11131 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 434a969 commit baef022

File tree

1 file changed

+38
-9
lines changed
  • lib/node_modules/@stdlib/ndarray/base/docs/types

1 file changed

+38
-9
lines changed

lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ import nullaryBlockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-si
120120
import numel = require( '@stdlib/ndarray/base/numel' );
121121
import numelDimension = require( '@stdlib/ndarray/base/numel-dimension' );
122122
import offset = require( '@stdlib/ndarray/base/offset' );
123+
import ones = require( '@stdlib/ndarray/base/ones' );
123124
import order = require( '@stdlib/ndarray/base/order' );
124125
import outputDataType = require( '@stdlib/ndarray/base/output-dtype' );
125126
import outputPolicyEnum2Str = require( '@stdlib/ndarray/base/output-policy-enum2str' );
@@ -3159,6 +3160,29 @@ interface Namespace {
31593160
*/
31603161
offset: typeof offset;
31613162

3163+
/**
3164+
* Creates a ones-filled array having a specified shape and data type.
3165+
*
3166+
* @param dtype - underlying data type
3167+
* @param shape - array shape
3168+
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
3169+
* @returns ones-filled array
3170+
*
3171+
* @example
3172+
* var getShape = require( '@stdlib/ndarray/shape' );
3173+
* var getDType = require( '@stdlib/ndarray/dtype' );
3174+
*
3175+
* var arr = ns.ones( 'float64', [ 2, 2 ], 'row-major' );
3176+
* // returns <ndarray>[ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ]
3177+
*
3178+
* var sh = getShape( arr );
3179+
* // returns [ 2, 2 ]
3180+
*
3181+
* var dt = String( getDType( arr ) );
3182+
* // returns 'float64'
3183+
*/
3184+
ones: typeof ones;
3185+
31623186
/**
31633187
* Returns the layout order of a provided ndarray.
31643188
*
@@ -5386,13 +5410,16 @@ interface Namespace {
53865410
* @returns zero-filled array
53875411
*
53885412
* @example
5413+
* var getShape = require( '@stdlib/ndarray/shape' );
5414+
* var getDType = require( '@stdlib/ndarray/dtype' );
5415+
*
53895416
* var arr = ns.zeros( 'float64', [ 2, 2 ], 'row-major' );
5390-
* // returns <ndarray>
5417+
* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
53915418
*
5392-
* var sh = arr.shape;
5419+
* var sh = getShape( arr );
53935420
* // returns [ 2, 2 ]
53945421
*
5395-
* var dt = arr.dtype;
5422+
* var dt = String( getDType( arr ) );
53965423
* // returns 'float64'
53975424
*/
53985425
zeros: typeof zeros;
@@ -5404,24 +5431,26 @@ interface Namespace {
54045431
* @returns zero-filled array
54055432
*
54065433
* @example
5434+
* var getShape = require( '@stdlib/ndarray/shape' );
5435+
* var getDType = require( '@stdlib/ndarray/dtype' );
54075436
* var zeros = require( '@stdlib/ndarray/base/zeros' );
54085437
*
54095438
* var x = zeros( 'generic', [ 2, 2 ], 'row-major' );
5410-
* // returns <ndarray>
5439+
* // returns <ndarray>[ [ 0, 0 ], [ 0, 0 ] ]
54115440
*
5412-
* var sh = x.shape;
5441+
* var sh = getShape( x );
54135442
* // returns [ 2, 2 ]
54145443
*
5415-
* var dt = x.dtype;
5444+
* var dt = String( getDType( x ) );
54165445
* // returns 'generic'
54175446
*
54185447
* var y = ns.zerosLike( x );
5419-
* // returns <ndarray>
5448+
* // returns <ndarray>[ [ 0, 0 ], [ 0, 0 ] ]
54205449
*
5421-
* sh = y.shape;
5450+
* sh = getShape( y );
54225451
* // returns [ 2, 2 ]
54235452
*
5424-
* dt = y.dtype;
5453+
* dt = String( getDType( y ) );
54255454
* // returns 'generic'
54265455
*/
54275456
zerosLike: typeof zerosLike;

0 commit comments

Comments
 (0)