fill

Fill an input ndarray with a specified value.

Usage

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

fill( x, value )

Fills an input ndarray with a specified value.

var Float64Array = require( '@stdlib/array/float64' );

// Create a data buffer:
var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

// Define the shape of the input array:
var shape = [ 3, 1, 2 ];

// Define the array strides:
var sx = [ 2, 2, 1 ];

// Define the index offset:
var ox = 0;

// Create the input ndarray-like object:
var x = {
    'dtype': 'float64',
    'data': xbuf,
    'shape': shape,
    'strides': sx,
    'offset': ox,
    'order': 'row-major'
};

fill( x, 10.0 );

console.log( x.data );
// => <Float64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]

The function accepts the following arguments:

x: array-like object containing an input ndarray.
value: scalar value.

A provided ndarray should be an object with the following properties:

dtype: data type.
data: data buffer.
shape: dimensions.
strides: stride lengths.
offset: index offset.
order: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).

Notes

If value is a number and x has a complex data type, the function fills an input ndarray with a complex number whose real component equals the provided scalar value and whose imaginary component is zero.
The function mutates the input ndarray.

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
var fill = require( '@stdlib/ndarray/base/fill' );

var x = {
    'dtype': 'generic',
    'data': filledarrayBy( 10, 'generic', discreteUniform( -100, 100 ) ),
    'shape': [ 5, 2 ],
    'strides': [ 2, 1 ],
    'offset': 0,
    'order': 'row-major'
};

fill( x, 10.0 );
console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );