Skip to content
Merged
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ import fliplr = require( '@stdlib/ndarray/base/fliplr' );
import flipud = require( '@stdlib/ndarray/base/flipud' );
import forEach = require( '@stdlib/ndarray/base/for-each' );
import scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
import scalar2ndarrayLike = require( '@stdlib/ndarray/base/from-scalar-like' );
import ind = require( '@stdlib/ndarray/base/ind' );
import ind2sub = require( '@stdlib/ndarray/base/ind2sub' );
import iterationOrder = require( '@stdlib/ndarray/base/iteration-order' );
Expand Down Expand Up @@ -1143,6 +1144,33 @@ interface Namespace {
*/
scalar2ndarray: typeof scalar2ndarray;

/**
* Returns a zero-dimensional ndarray containing a provided scalar value and having the same data type as a provided input ndarray.
*
* @param x - input array
* @param value - scalar value
* @returns zero-dimensional ndarray
*
* @example
* var zeros = require( '@stdlib/ndarray/base/zeros' );
*
* var x = zeros( 'float64', [ 2, 2 ], 'row-major' );
* // returns <ndarray>
*
* var y = ns.scalar2ndarrayLike( x, 1.0 );
* // returns <ndarray>
*
* var sh = y.shape;
* // returns []
*
* var dt = y.dtype;
* // returns 'generic'
*
* var v = y.get();
* // returns 1.0
*/
scalar2ndarrayLike: typeof scalar2ndarrayLike;

/**
* Returns an index given an index mode.
*
Expand Down
Loading