glinspace

Fill a one-dimensional ndarray with linearly spaced values over a specified interval.

Installation

npm install @stdlib/blas-ext-base-ndarray-glinspace

Usage

var glinspace = require( '@stdlib/blas-ext-base-ndarray-glinspace' );

glinspace( arrays )

Fills a one-dimensional ndarray with linearly spaced values over a specified interval.

var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );

var xbuf = [ 0.0, 0.0, 0.0, 0.0 ];
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );

var start = scalar2ndarray( 0.0, {
    'dtype': 'generic'
});

var end = scalar2ndarray( 3.0, {
    'dtype': 'generic'
});

var endpoint = scalar2ndarray( true, {
    'dtype': 'bool'
});

var out = glinspace( [ x, start, end, endpoint ] );
// returns <ndarray>

var arr = ndarray2array( out );
// returns [ 0.0, 1.0, 2.0, 3.0 ]

The function has the following parameters:

• arrays: array-like object containing the following ndarrays in order:

  1. a one-dimensional input ndarray.
  2. a zero-dimensional ndarray specifying the start of the interval.
  3. a zero-dimensional ndarray specifying the end of the interval.
  4. a zero-dimensional ndarray specifying whether to include the end of the interval when writing values to the input ndarray.

Notes

• Let M be the number of generated values. The spacing between values is thus given by

  Δ = (end-start)/(M-1)

• If an input ndarray has a single element and the function is supposed to include the end of the interval, the set of values written to an input ndarray only includes the end of the interval, but not the start of the interval.

• Otherwise, when an input ndarray has a single element and the function is not supposed to include the end of the interval, the set of values written to an input ndarray only includes the start of the interval, but not the end of the interval.

• If the start of the interval is less than end of the interval, the set of values written to an input ndarray will be written in ascending order, and, if the start of the interval is greater than the end of the interval, the set of written values will be in descending order.

• When an input ndarray contains at least two values and the function is supposed to include the end of the interval, the set of values written to an input ndarray is guaranteed to include the start and end interval values. Beware, however, that values between the interval bounds are subject to floating-point rounding errors.

• The input ndarray is mutated.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var ndarraylike2scalar = require( '@stdlib/ndarray-base-ndarraylike2scalar' );
var glinspace = require( '@stdlib/blas-ext-base-ndarray-glinspace' );

var xbuf = discreteUniform( 10, -100, 100, {
    'dtype': 'generic'
});
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

var start = scalar2ndarray( 0.0, {
    'dtype': 'generic'
});
console.log( 'Start: %d', ndarraylike2scalar( start ) );

var end = scalar2ndarray( 100.0, {
    'dtype': 'generic'
});
console.log( 'Stop: %d', ndarraylike2scalar( end ) );

var endpoint = scalar2ndarray( true, {
    'dtype': 'bool'
});
console.log( 'Endpoint: %s', ndarraylike2scalar( endpoint ) );

glinspace( [ x, start, end, endpoint ] );
console.log( ndarray2array( x ) );

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