Skip to content

Create a filled array having a specified length.

License

Notifications You must be signed in to change notification settings

stdlib-js/array-full

Repository files navigation

full

NPM version Build Status Coverage Status

Create a filled array having a specified length.

Installation

npm install @stdlib/array-full

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

Usage

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

full( length, value[, dtype] )

Creates a filled array having a specified length.

var arr = full( 2, 1.0 );
// returns <Float64Array>[ 1.0, 1.0 ]

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 = full( 2, 1, 'int32' );
// returns <Int32Array>[ 1, 1 ]

Examples

var dtypes = require( '@stdlib/array-typed-real-dtypes' );
var full = require( '@stdlib/array-full' );

// 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 = full( 5, i+1, dt[ i ] );
    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-2022. The Stdlib Authors.