@stdlib/array
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.12 • Public • Published

    Arrays

    NPM version Build Status Coverage Status dependencies

    Arrays.

    Installation

    npm install @stdlib/array

    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:

    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 ]

    The namespace contains functions to create arrays pre-filled with spaced values:

    You can use the following functions to retrieve a list of available 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:

    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.

    Examples

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

    Notice

    This package is part of 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, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/array

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    3,601

    Version

    0.0.12

    License

    Apache-2.0

    Unpacked Size

    1.37 MB

    Total Files

    373

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser