0.2.1 • Published 2 months ago

@stdlib/array-empty v0.2.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

empty

NPM version Build Status Coverage Status

Create an uninitialized array having a specified length.

Installation

npm install @stdlib/array-empty

Usage

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

empty( length[, dtype] )

Creates an uninitialized array having a specified length.

var arr = empty( 2 );
// 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)
  • 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 float64 (i.e., a typed array). To specify an alternative data type, provide a dtype argument.

var arr = empty( 2, 'int32' );
// returns <Int32Array>

Notes

  • In browser environments, the function always returns zero-filled arrays.
  • If dtype is 'generic', the function always returns a zero-filled array.
  • In Node.js versions >=3.0.0, the underlying memory of returned typed arrays is not initialized. Memory contents are unknown and may contain sensitive data.

Examples

var dtypes = require( '@stdlib/array-dtypes' );
var empty = require( '@stdlib/array-empty' );

// Get a list of array data types:
var dt = dtypes();

// Generate empty arrays...
var arr;
var i;
for ( i = 0; i < dt.length; i++ ) {
    arr = empty( 4, dt[ i ] );
    console.log( arr );
}

See Also


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