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!

linspace2d

Generate a linearly spaced two-dimensional nested numeric array.

Installation

npm install @stdlib/array-base-linspace2d

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 linspace2d = require( '@stdlib/array-base-linspace2d' );

linspace2d( start, stop, shape, colexicographic )

Generates a linearly spaced two-dimensional nested numeric array.

var x = linspace2d( 0, 100, [ 2, 3 ], false );
// returns [ [ 0, 20, 40 ], [ 60, 80, 100 ] ]

x = linspace2d( 0, 100, [ 2, 3 ], true );
// returns [ [ 0, 40, 80 ], [ 20, 60, 100 ] ]

The function accepts the following arguments:

start: first array value.
stop: last array value.
shape: array shape.
colexicographic: specifies whether generated array values should be stored in colexicographic order.

Notes

The output array is guaranteed to include the start and stop values. Beware, however, that values between start and stop are subject to floating-point rounding errors. Hence,

var arr = linspace2d( 0, 1, [ 1, 3 ], false );
// returns [ [ 0, ~0.5, 1 ] ]

where arr[0][1] is only guaranteed to be approximately equal to 0.5. If you desire more control over element precision, consider using roundn:

var roundn = require( '@stdlib/math-base-special-roundn' );
var map2d = require( '@stdlib/array-base-map2d' );

var arr = linspace2d( 0, 1, [ 1, 3 ], false );
// returns [ [ 0, ~0.5, 1 ] ]

// Round each value to the nearest tenth:
var out = map2d( arr, [ 1, 3 ], clbk );
// returns [ [ 0, 0.5, 1 ] ]

function clbk( v ) {
    return roundn( v, -1 );
}

Examples

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

var out = linspace2d( 0, 10, [ 2, 5 ], false );
console.log( out );

out = linspace2d( 0, 10, [ 2, 3 ], true );
console.log( out );

out = linspace2d( 0, 10, [ 4, 2 ], true );
console.log( out );

// Create an array of arrays with decremented values:
out = linspace2d( 10, 0, [ 2, 5 ], false );
console.log( out );

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

Uh oh!

License

stdlib-js/array-base-linspace2d

About

Topics

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Languages

Packages