Skip to content

stdlib-js/ndarray-base-full

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

full

NPM version Build Status Coverage Status

Create an ndarray filled with a specified value and having a specified shape and data type.

Installation

npm install @stdlib/ndarray-base-full

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

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

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

full( value, dtype, shape, order )

Returns an ndarray filled with a specified value and having a specified shape and data type.

var getShape = require( '@stdlib/ndarray-shape' );
var getDType = require( '@stdlib/ndarray-dtype' );

var arr = full( 10.0, 'float64', [ 2, 2 ], 'row-major' );
// returns <ndarray>[ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ]

var sh = getShape( arr );
// returns [ 2, 2 ]

var dt = String( getDType( arr ) );
// returns 'float64'

This function accepts the following arguments:

  • value: scalar fill value.
  • dtype: underlying data type.
  • shape: array shape.
  • order: specifies whether an ndarray is 'row-major' (C-style) or 'column-major' (Fortran-style).

Notes

  • If value is a number and dtype is a complex data type, the function casts the number to a complex number whose real component equals the provided scalar value and whose imaginary component is zero.
  • A value must be able to safely cast to the output ndarray data type. Scalar values having floating-point data types (both real and complex) are allowed to downcast to a lower precision data type of the same kind (e.g., a scalar double-precision floating-point number can be used to fill a 'float32' output ndarray).

Examples

var dtypes = require( '@stdlib/ndarray-dtypes' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var full = require( '@stdlib/ndarray-base-full' );

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

// Generate initialized arrays...
var arr;
var i;
for ( i = 0; i < dt.length; i++ ) {
    arr = full( 10, dt[ i ], [ 2, 2 ], 'row-major' );
    console.log( ndarray2array( 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-2026. The Stdlib Authors.

About

Create an ndarray filled with a specified value and having a specified shape and data type.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors