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!
Convert a scalar value to a zero-dimensional ndarray.
npm install @stdlib/ndarray-from-scalar
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch (see README). - If you are using Deno, visit the
deno
branch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umd
branch (see README).
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
Returns a zero-dimensional ndarray
containing a provided scalar value
.
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
The function accepts the following options
:
- dtype: output array data type.
- order: array order (i.e., memory layout), which is either
row-major
(C-style) orcolumn-major
(Fortran-style). Default:'row-major'
. - readonly:
boolean
indicating whether an array should be read-only. Default:false
.
If a dtype
option is not provided and value
- is a number, the default data type is the default real-valued floating-point data type.
- is a boolean, the default data type is the default boolean 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 ndarray
, provide a dtype
option.
var x = scalar2ndarray( 1.0, {
'dtype': 'float32'
});
// returns <ndarray>
var sh = x.shape;
// returns []
var dt = x.dtype;
// returns 'float32'
var v = x.get();
// returns 1.0
- If
value
is a number andoptions.dtype
is a complex data type, the function returns a zero-dimensionalndarray
containing a complex number whose real component equals the provided scalarvalue
and whose imaginary component is zero. - The function does not guard against precision loss when
value
is a number and thedtype
argument is an integer data type.
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, {
'dtype': dt[ i ]
});
console.log( x.get() );
}
@stdlib/ndarray-array
: multidimensional arrays.@stdlib/ndarray-ctor
: multidimensional array constructor.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.