@stdlib/ndarray-base-from-scalar NPM

scalar2ndarray

Convert a scalar value to a zero-dimensional ndarray.

Installation

npm install @stdlib/ndarray-base-from-scalar

Usage

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

scalar2ndarray( value, dtype, order )

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

var x = scalar2ndarray( 1.0, 'float64', 'row-major' );
// returns <ndarray>

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

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

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-base-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 ], 'row-major' );
    console.log( x.get() );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.