defaults

Default array settings.

Usage

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

defaults()

Returns default array 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.
    • boolean: default boolean data type.
    • integer: default integer data type.
    • signed_integer: default signed integer data type.
    • unsigned_integer: default unsigned integer data type.

defaults.get( name )

Returns the setting value for a provided setting name.

var 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 empty = require( '@stdlib/array/empty' );
var dtype = require( '@stdlib/array/dtype' );
var defaults = require( '@stdlib/array/defaults' );

var o = defaults();

var x = empty( 10, o.dtypes.default );
console.log( dtype( x ) );

x = empty( 10, o.dtypes.floating_point );
console.log( dtype( x ) );

x = empty( 10, o.dtypes.real_floating_point );
console.log( dtype( x ) );

x = empty( 10, o.dtypes.integer );
console.log( dtype( x ) );

x = empty( 10, o.dtypes.signed_integer );
console.log( dtype( x ) );

x = empty( 10, o.dtypes.unsigned_integer );
console.log( dtype( x ) );
Did you find this page helpful?