Default ndarray settings.
npm install @stdlib/ndarray-defaultsWe 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]
> Default ndarray settings.
``bash`
npm install @stdlib/ndarray-defaults
`javascript`
var defaults = require( '@stdlib/ndarray-defaults' );
#### defaults()
Returns default ndarray settings.
`javascript`
var out = defaults();
// returns {...}
The returned object has the following properties:
- dtypes: default data types.
- default: default data type.
- numeric: default numeric data type.
- real: default real-valued data type.
- floating_point: default floating-point data type.
- real_floating_point: default real-valued floating-point data type.
- complex_floating_point: default complex-valued floating-point data type.
- integer: default integer data type.
- signed_integer: default signed integer data type.
- unsigned_integer: default unsigned integer data type.
- boolean: default boolean data type.
- index: default index data type.
- integer_index: default integer index data type.
- boolean_index: default boolean index data type.
- mask_index: default mask index data type.
- order: default memory layout.
- casting: default casting mode.
- index_mode: default index mode.
#### defaults.get( name )
Returns the setting value for a provided setting name.
`javascript
var v = defaults.get( 'order' );
// returns
v = defaults.get( 'dtypes.floating_point' );
// returns
`
The setting name corresponds to a flattened object path. For example, the setting name 'dtypes.default' maps to the nested path o.dtypes.default as found in the object returned by defaults().
`javascript
var array = require( '@stdlib/ndarray-array' );
var defaults = require( '@stdlib/ndarray-defaults' );
var o = defaults();
var buf = [ [ 1, 2 ], [ 3, 4 ] ];
var opts = {
'order': o.order,
'casting': 'unsafe',
'mode': o.index_mode
};
opts.dtype = o.dtypes.default;
var x = array( buf, opts );
console.log( x.dtype );
opts.dtype = o.dtypes.floating_point;
x = array( buf, opts );
console.log( x.dtype );
opts.dtype = o.dtypes.real_floating_point;
x = array( buf, opts );
console.log( x.dtype );
opts.dtype = o.dtypes.integer;
x = array( buf, opts );
console.log( x.dtype );
opts.dtype = o.dtypes.signed_integer;
x = array( buf, opts );
console.log( x.dtype );
opts.dtype = o.dtypes.unsigned_integer;
x = array( buf, opts );
console.log( x.dtype );
opts.dtype = o.dtypes.boolean;
x = array( buf, opts );
console.log( x.dtype );
`
*
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-defaults.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-defaults
[test-image]: https://github.com/stdlib-js/ndarray-defaults/actions/workflows/test.yml/badge.svg?branch=v0.4.1
[test-url]: https://github.com/stdlib-js/ndarray-defaults/actions/workflows/test.yml?query=branch:v0.4.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-defaults/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-defaults?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-defaults/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-defaults/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-defaults/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-defaults/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-defaults/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-defaults/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-defaults/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-defaults/main/LICENSE