@stdlib/array-from-scalar

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

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 [ {} ]

---

See Also

• @stdlib/array-from-iterator: create (or fill) an array from an iterator.

---

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.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.