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!
Fill a one-dimensional ndarray with linearly spaced values over a specified interval.
npm install @stdlib/blas-ext-base-ndarray-glinspaceAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (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.
var glinspace = require( '@stdlib/blas-ext-base-ndarray-glinspace' );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:
- a one-dimensional input ndarray.
- a zero-dimensional ndarray specifying the start of the interval.
- a zero-dimensional ndarray specifying the end of the interval.
- a zero-dimensional ndarray specifying whether to include the end of the interval when writing values to the input ndarray.
-
Let
Mbe 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.
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 ) );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.
See LICENSE.
Copyright © 2016-2025. The Stdlib Authors.
