Arrays

Arrays.

Usage

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

ns

Arrays.

var o = ns;
// returns {...}

The namespace exports the following array constructors:

• ArrayBuffer( size ): constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.
• Float32Array(): typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order.
• Float64Array(): typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in the platform byte order.
• Int16Array(): typed array constructor which returns a typed array representing an array of twos-complement 16-bit signed integers in the platform byte order.
• Int32Array(): typed array constructor which returns a typed array representing an array of twos-complement 32-bit signed integers in the platform byte order.
• Int8Array(): typed array constructor which returns a typed array representing an array of twos-complement 8-bit signed integers in the platform byte order.
• SharedArrayBuffer( size ): constructor returning an object used to represent a generic, fixed-length raw binary data buffer which can be used to create views of shared memory.
• Uint16Array(): typed array constructor which returns a typed array representing an array of 16-bit unsigned integers in the platform byte order.
• Uint32Array(): typed array constructor which returns a typed array representing an array of 32-bit unsigned integers in the platform byte order.
• Uint8Array(): typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order.
• Uint8ClampedArray(): typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order clamped to 0-255.

var arr = new ns.Int32Array( 5 );
// returns <Int32Array>[ 0, 0, 0, 0, 0 ]

Alternatively, use the typedarray function to create a typed array of a given data type:

• typedarray(): create a typed array.

var arr1 = ns.typedarray( 5 );
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]

var arr2 = ns.typedarray( 5, 'uint8' );
// returns <Uint8Array>[ 0, 0, 0, 0, 0 ]

You can use the following functions to retrieve a list of available data types:

• arrayDataTypes(): list of array data types.
• typedarrayComplexDataTypes(): list of complex typed array data types.
• typedarrayDataTypes(): list of typed array data types.

var DTYPES = ns.arrayDataTypes();
// returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ]

Furthermore, the namespace contains utility functions to retrieve a given constructor:

• arrayCtors( dtype ): array constructors.
• typedarrayComplexCtors( dtype ): complex typed array constructors.
• typedarrayCtors( dtype ): typed array constructors.

var ctor = ns.typedarrayCtors( 'float64' );
// returns <Function>

ctor = ns.typedarrayCtors( 'int' );
// returns null

Lastly, the namespace contains various other functions for dealing with arrays, including functions to convert arrays from one data type to another or to serialize them as JSON and vice versa.

• convertArray( arr, dtype ): convert an array to an array of a different data type.
• convertArraySame( x, y ): convert an array to the same data type as a second input array.
• arrayDataType( array ): return the data type of an array.
• reviveTypedArray( key, value ): revive a JSON-serialized typed array.
• typedarray2json( typedarray ): return a JSON representation of a typed array.

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/array' );

console.log( objectKeys( ns ) );