Convert a scalar value to a zero-dimensional ndarray.
npm install @stdlib/ndarray-from-scalarWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert a scalar value to a zero-dimensional [ndarray][@stdlib/ndarray/ctor].
``bash`
npm install @stdlib/ndarray-from-scalar
`javascript`
var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
#### scalar2ndarray( value\[, options] )
Returns a zero-dimensional [ndarray][@stdlib/ndarray/ctor] containing a provided scalar value.
`javascript
var x = scalar2ndarray( 1.0 );
// returns
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][@stdlib/ndarray/dtypes].
- order: array order (i.e., memory layout), which is either row-major (C-style) or column-major (Fortran-style). Default: 'row-major'.boolean
- readonly: 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][@stdlib/ndarray/dtypes] is the [default][@stdlib/ndarray/defaults] real-valued floating-point data type.
- is a boolean, the default [data type][@stdlib/ndarray/dtypes] is the [default][@stdlib/ndarray/defaults] 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][@stdlib/ndarray/dtypes] is the [default][@stdlib/ndarray/defaults] complex-valued floating-point data type.
- is any other value type, the default [data type][@stdlib/ndarray/dtypes] is 'generic'.
To explicitly specify the [data type][@stdlib/ndarray/dtypes] of the returned [ndarray][@stdlib/ndarray/ctor], provide a dtype option.
`javascript
var x = scalar2ndarray( 1.0, {
'dtype': 'float32'
});
// returns
var sh = x.shape;
// returns []
var dt = x.dtype;
// returns 'float32'
var v = x.get();
// returns 1.0
`
- If value is a number and options.dtype is a complex [data type][@stdlib/ndarray/dtypes], the function returns a zero-dimensional [ndarray][@stdlib/ndarray/ctor] containing a complex number whose real component equals the provided scalar value and whose imaginary component is zero.value
- The function does not guard against precision loss when is a number and the dtype argument is an integer [data type][@stdlib/ndarray/dtypes].
`javascript
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][@stdlib/ndarray/array]: multidimensional arrays.
- [@stdlib/ndarray-ctor][@stdlib/ndarray/ctor]: multidimensional array constructor.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-from-scalar.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-from-scalar
[test-image]: https://github.com/stdlib-js/ndarray-from-scalar/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/ndarray-from-scalar/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-from-scalar/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-from-scalar?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/ndarray-from-scalar/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-from-scalar/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-from-scalar/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-from-scalar/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-from-scalar/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-from-scalar/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-from-scalar/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-from-scalar/main/LICENSE
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
[@stdlib/ndarray/defaults]: https://www.npmjs.com/package/@stdlib/ndarray-defaults
[@stdlib/ndarray/array]: https://www.npmjs.com/package/@stdlib/ndarray-array