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

    0.0.4 • Public • Published

    Typed Arrays

    NPM version Build Status Coverage Status dependencies

    Create a typed array.

    Installation

    npm install @stdlib/array-typed

    Usage

    var typedarray = require( '@stdlib/array-typed' );

    typedarray( [dtype] )

    Creates a typed array having a specified data type dtype.

    var arr = typedarray();
    // returns <Float64Array>

    The function recognizes the following data types:

    • float64: double-precision floating-point numbers (IEEE 754)
    • float32: single-precision floating-point numbers (IEEE 754)
    • int32: 32-bit two's complement signed integers
    • uint32: 32-bit unsigned integers
    • int16: 16-bit two's complement signed integers
    • uint16: 16-bit unsigned integers
    • int8: 8-bit two's complement signed integers
    • uint8: 8-bit unsigned integers
    • uint8c: 8-bit unsigned integers clamped to 0-255

    By default, the output typed array data type is float64. To specify an alternative data type, provide a dtype argument.

    var arr = typedarray( 'int32' );
    // returns <Int32Array>

    typedarray( length[, dtype] )

    Returns a typed array having a specified length.

    var arr1 = typedarray( 5 );
    // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]
    
    var arr2 = typedarray( 5, 'uint8' );
    // returns <Uint8Array>[ 0, 0, 0, 0, 0 ]

    typedarray( typedarray[, dtype] )

    Creates a typed array from another typed array.

    var arr1 = typedarray( [ 5.0, -3.0, 2.0 ] );
    // returns <Float64Array>[ 5.0, -3.0, 2.0 ]
    
    var arr2 = typedarray( arr1 );
    // returns <Float64Array>[ 5.0, -3.0, 2.0 ]
    
    var arr3 = typedarray( arr1, 'int32' );
    // returns <Int32Array>[ 5, -3, 2 ]

    typedarray( obj[, dtype] )

    Creates a typed array from an array-like object or iterable.

    var arr1 = typedarray( [ 0.5, 0.5, 0.5 ] );
    // returns <Float64Array>[ 0.5, 0.5, 0.5 ]
    
    var arr2 = typedarray( [ 0.5, 0.5, 0.5 ], 'float32' );
    // returns <Float32Array>[ 0.5, 0.5, 0.5 ]

    typedarray( buffer[, byteOffset[, length]][, dtype] )

    Returns a typed array view of an ArrayBuffer.

    var ArrayBuffer = require( '@stdlib/array-buffer' );
    var buf = new ArrayBuffer( 32 );
    
    var arr1 = typedarray( buf );
    // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0 ]
    
    var arr2 = typedarray( buf, 'float32' );
    // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
    
    var arr3 = typedarray( buf, 16 );
    // returns <Float64Array>[ 0.0, 0.0 ]
    
    var arr4 = typedarray( buf, 16, 'float32' );
    // returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
    
    var arr5 = typedarray( buf, 16, 1 );
    // returns <Float64Array>[ 0.0 ]
    
    var arr6 = typedarray( buf, 10, 4, 'int16' );
    // returns <Int16Array>[ 0, 0, 0, 0 ]

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var typedarray = require( '@stdlib/array-typed' );
    
    var arr;
    var i;
    
    arr = typedarray( 100, 'float64' );
    for ( i = 0; i < arr.length; i++ ) {
        arr[ i ] = randu() * 100.0;
    }
    console.log( arr );

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

    DownloadsWeekly Downloads

    8

    Version

    0.0.4

    License

    Apache-2.0

    Unpacked Size

    51 kB

    Total Files

    10

    Homepage

    stdlib.io

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar