@stdlib/array-from-scalar NPM

scalar2array

Create a single-element array containing a provided scalar value.

Installation

npm install @stdlib/array-from-scalar

Usage

var scalar2array = require( '@stdlib/array-from-scalar' );

scalar2array( value[, dtype] )

Returns a single-element array containing a provided scalar value.

var x = scalar2array( 3.0 );
// returns <Float64Array>[ 3.0 ]

If not provided a dtype argument and value

is a number, the default data type is the default real-valued floating-point data type.
is a complex number object of a known data type, the data type is the same as the provided value.
is a complex number object of an unknown data type, the default data type is the default complex-valued floating-point data type.
is any other value type, the default data type is 'generic'.

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

var x = scalar2array( 3.0, 'float32' );
// returns <Float32Array>[ 3.0 ]

Notes

If value is a number and the dtype argument is a complex data type, the function returns a complex number array containing a complex number whose real component equals the provided scalar value and whose imaginary component is zero.
The function does not guard against precision loss when value is a number and the dtype argument is an integer data type.

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var array2scalar = require( '@stdlib/array-from-scalar' );

var x = array2scalar( 3.0 );
// returns <Float64Array>[ 3.0 ]

x = array2scalar( 3, 'int32' );
// returns <Int32Array>[ 3 ]

x = array2scalar( new Complex128( 3.0, 4.0 ) );
// returns <Complex128Array>

x = array2scalar( {} );
// returns [ {} ]

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.