@stdlib/array-filled

Filled Array

Create a filled array.

Installation

npm install @stdlib/array-filled

Usage

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

filledarray( [dtype] )

Creates a filled array having a specified data type dtype.

var arr = filledarray();
// 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 = filledarray( 'int32' );
// returns <Int32Array>

filledarray( value, length[, dtype] )

Returns a filled array having a specified length.

var arr1 = filledarray( 1.0, 5 );
// returns <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]

var arr2 = filledarray( 1, 5, 'uint8' );
// returns <Uint8Array>[ 1, 1, 1, 1, 1 ]

filledarray( value, array[, dtype] )

Creates a filled array from another array (or array-like object).

var arr0 = {
    '0': 0.5,
    '1': 0.5,
    '2': 0.5,
    'length': 3
};

var arr1 = filledarray( 1.0, arr0 );
// returns <Float64Array>[ 1.0, 1.0, 1.0 ]

var arr2 = filledarray( 2.0, arr1 );
// returns <Float64Array>[ 2.0, 2.0, 2.0 ]

var arr3 = filledarray( 3, arr1, 'int32' );
// returns <Int32Array>[ 3, 3, 3 ]

filledarray( value, iterable[, dtype] )

Creates a filled array from an iterable.

var iterConstant = require( '@stdlib/iter-constant' );

var it = iterConstant( 3.0, {
    'iter': 3
});
var arr1 = filledarray( 1.0, it );
// returns <Float64Array>[ 1.0, 1.0, 1.0 ]

var arr2 = filledarray( 1.0, it, 'float32' );
// returns <Float32Array>[ 1.0, 1.0, 1.0 ]

filledarray( value, buffer[, byteOffset[, length]][, dtype] )

Returns a filled typed array view of an ArrayBuffer.

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

var buf = new ArrayBuffer( 32 );
var arr = filledarray( 1.0, buf );
// returns <Float64Array>[ 1.0, 1.0, 1.0, 1.0 ]

buf = new ArrayBuffer( 32 );
arr = filledarray( 1.0, buf, 'float32' );
// returns <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ]

buf = new ArrayBuffer( 32 );
arr = filledarray( 1.0, buf, 16 );
// returns <Float64Array>[ 1.0, 1.0 ]

buf = new ArrayBuffer( 32 );
arr = filledarray( 1.0, buf, 16, 'float32' );
// returns <Float32Array>[ 1.0, 1.0, 1.0, 1.0 ]

buf = new ArrayBuffer( 32 );
arr = filledarray( 1.0, buf, 16, 1 );
// returns <Float64Array>[ 1.0 ]

buf = new ArrayBuffer( 32 );
arr = filledarray( 1, buf, 10, 4, 'int16' );
// returns <Int16Array>[ 1, 1, 1, 1 ]

Notes

• Creating a generic array from an ArrayBuffer is not supported.

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var dtypes = require( '@stdlib/array-typed-real-dtypes' );
var filledarray = require( '@stdlib/array-filled' );

// Generate a random number:
var r = discreteUniform( 0, 100 );

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

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

See Also

• @stdlib/array/typed: create a typed array.

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

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.