defaults

Default ndarray settings.

Usage

var defaults = require( '@stdlib/ndarray/defaults' );

defaults()

Returns default ndarray settings.

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.
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.

var v = defaults.get( 'order' );
// returns <string>

v = defaults.get( 'dtypes.floating_point' );
// returns <string>

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().

Examples

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 );