Neoanthropic Preternatural Murmurings

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

    0.0.1 • Public • Published

    zerosLike

    NPM version Build Status Coverage Status

    Create a zero-filled array having the same length and data type as a provided array.

    Installation

    npm install @stdlib/array-zeros-like

    Usage

    var zerosLike = require( '@stdlib/array-zeros-like' );

    zerosLike( x[, dtype] )

    Creates a zero-filled array having the same length and data type as a provided array x.

    var x = [ 1, 2, 3, 4, 5 ];
    
    var arr = zerosLike( x );
    // returns [ 0, 0, 0, 0, 0 ]

    The function supports the following data types:

    • float64: double-precision floating-point numbers (IEEE 754)
    • float32: single-precision floating-point numbers (IEEE 754)
    • complex128: double-precision complex floating-point numbers
    • complex64: single-precision complex floating-point numbers
    • 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
    • generic: generic JavaScript values

    By default, the output array data type is inferred from the provided array x. To return an array having a different data type, provide a dtype argument.

    var x = [ 0, 0 ];
    
    var arr = zerosLike( x, 'int32' );
    // returns <Int32Array>[ 0, 0 ]

    Examples

    var dtypes = require( '@stdlib/array-dtypes' );
    var zeros = require( '@stdlib/array-zeros' );
    var zerosLike = require( '@stdlib/array-zeros-like' );
    
    // Create a zero-filled array:
    var x = zeros( 4, 'complex128' );
    
    // Get a list of array data types:
    var dt = dtypes();
    
    // Generate additional zero-filled arrays...
    var y;
    var i;
    for ( i = 0; i < dt.length; i++ ) {
        y = zerosLike( x, dt[ i ] );
        console.log( y );
    }

    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-2022. The Stdlib Authors.

    Install

    npm i @stdlib/array-zeros-like

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    36

    Version

    0.0.1

    License

    Apache-2.0

    Unpacked Size

    64.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser