scalar2ndarray

Convert a scalar value to a zero-dimensional ndarray.

Usage

var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );

scalar2ndarray( value[, dtype] )

Returns a zero-dimensional ndarray containing a provided scalar value and having a specified data type.

var x = scalar2ndarray( 1.0 );
// returns <ndarray>

var sh = x.shape;
// returns []

var dt = x.dtype;
// returns 'float64'

var v = x.get();
// returns 1.0

If dtype is not provided and value

is a number, the default data type is 'float64'.
is a complex number object, the default data type is 'complex128'.
is any other value type, the default data type is 'generic'.

To explicitly specify the data type of the returned ndarray, provide a dtype argument.

var x = scalar2ndarray( 1.0, 'float32' );
// returns <ndarray>

var sh = x.shape;
// returns []

var dt = x.dtype;
// returns 'float32'

var v = x.get();
// returns 1.0

Notes

If value is a number and dtype is a complex data type, the function returns a zero-dimensional ndarray containing a complex number whose real component equals the provided scalar value and whose imaginary component is zero.

Examples

var dtypes = require( '@stdlib/ndarray/dtypes' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );

// Get a list of data types:
var dt = dtypes();

// Generate zero-dimensional arrays...
var x;
var i;
for ( i = 0; i < dt.length; i++ ) {
    x = scalar2ndarray( i, dt[ i ] );
    console.log( x.get() );
}