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
64 changes: 64 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 @@ -24,6 +24,7 @@ import any = require( '@stdlib/ndarray/base/any' );
import anyBy = require( '@stdlib/ndarray/base/any-by' );
import assert = require( '@stdlib/ndarray/base/assert' );
import assign = require( '@stdlib/ndarray/base/assign' );
import assignScalar = require( '@stdlib/ndarray/base/assign-scalar' );
import atleastnd = require( '@stdlib/ndarray/base/atleastnd' );
import binary = require( '@stdlib/ndarray/base/binary' );
import binaryInputCastingDataType = require( '@stdlib/ndarray/base/binary-input-casting-dtype' );
Expand Down Expand Up @@ -87,6 +88,7 @@ import forEach = require( '@stdlib/ndarray/base/for-each' );
import array2ndarray = require( '@stdlib/ndarray/base/from-array' );
import scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
import scalar2ndarrayLike = require( '@stdlib/ndarray/base/from-scalar-like' );
import full = require( '@stdlib/ndarray/base/full' );
import includes = require( '@stdlib/ndarray/base/includes' );
import ind = require( '@stdlib/ndarray/base/ind' );
import ind2sub = require( '@stdlib/ndarray/base/ind2sub' );
Expand Down Expand Up @@ -305,6 +307,44 @@ interface Namespace {
*/
assign: typeof assign;

/**
* Assigns a scalar value to every element of an output ndarray.
*
* @param arrays - array-like object containing a zero-dimensional input ndarray containing the scalar value and one output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a zero-dimensional ndarray containing the scalar value:
* var x = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* // Create a data buffer:
* var ybuf = new Float64Array( 4 );
*
* // Define the shape of the output array:
* var shape = [ 2, 2 ];
*
* // Define the array strides:
* var sy = [ 2, 1 ];
*
* // Define the index offset:
* var oy = 0;
*
* // Create the output ndarray:
* var y = ndarray( 'float64', ybuf, shape, sy, oy, 'row-major' );
*
* // Assign the scalar value:
* ns.assignScalar( [ x, y ] );
*
* console.log( y.data );
* // => <Float64Array>[ 5.0, 5.0, 5.0, 5.0 ]
*/
assignScalar: typeof assignScalar;

/**
* Converts a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.
*
Expand Down Expand Up @@ -2041,6 +2081,30 @@ interface Namespace {
*/
scalar2ndarrayLike: typeof scalar2ndarrayLike;

/**
* Returns an ndarray filled with a specified value and having a specified shape and data type.
*
* @param value - fill value
* @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 output array
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = ns.full( 10.0, 'float32', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ]
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float32'
*/
full: typeof full;

/**
* Tests whether an ndarray contains a specified value.
*
Expand Down
Loading