Skip to content

Latest commit

 

History

History
309 lines (192 loc) · 10.6 KB

File metadata and controls

309 lines (192 loc) · 10.6 KB
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!

slinspace

NPM version Build Status Coverage Status

Fill a single-precision floating-point strided array with linearly spaced values over a specified interval.

Usage

To use in Observable,

slinspace = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-slinspace@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var slinspace = require( 'path/to/vendor/umd/blas-ext-base-slinspace/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-slinspace@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.slinspace;
})();
</script>

slinspace( N, start, stop, endpoint, x, strideX )

Fills a single-precision floating-point strided array with linearly spaced values over a specified interval.

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

slinspace( x.length, 0.0, 7.0, true, x, 1 );
// x => <Float32Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]

The function has the following parameters:

  • N: number of indexed elements.
  • start: start of interval.
  • stop: end of interval.
  • endpoint: boolean indicating whether to include the stop value when writing values to the input array. If true, the input array is filled with evenly spaced values over the closed interval [start, stop]. If false, the input array is filled with evenly spaced values over the half-open interval [start, stop).
  • x: input Float32Array.
  • strideX: stride length.

The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element:

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

slinspace( 4, 1.0, 5.0, false, x, 2 );
// x => <Float32Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float32Array = require( '@stdlib/array-float32' );

// Initial array...
var x0 = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

// Create an offset view...
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

// Fill every other element...
slinspace( 3, 1.0, 3.0, true, x1, 2 );
// x0 => <Float32Array>[ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0 ]

slinspace.ndarray( N, start, stop, endpoint, x, strideX, offsetX )

Fills a single-precision floating-point strided array with linearly spaced values over a specified interval using alternative indexing semantics.

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

slinspace.ndarray( x.length, 0.0, 7.0, true, x, 1, 0 );
// x => <Float32Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]

The function has the following additional parameters:

  • offsetX: starting index.

While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements:

var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

slinspace.ndarray( 3, 1.0, 3.0, true, x, 1, x.length-3 );
// x => <Float32Array>[ 0.0, 0.0, 0.0, 1.0, 2.0, 3.0 ]

Notes

  • Let M be the number of generated values (which is either N or N+1 depending on whether endpoint is true or false, respectively). The spacing between values is thus given by

    Δ = (stop-start)/(M-1)
    
  • When the number of generated values is greater than 1 and endpoint is true, the set of values written to a provided input 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 Float32Array = require( '@stdlib/array-float32' );
    
    var x = new Float32Array( [ 0.0, 0.0, 0.0 ] );
    
    slinspace( 3, 0.0, 1.0, true, x, 1 );
    // x => <Float32Array>[ 0.0, ~0.5, 1.0 ]

    where x[1] is only guaranteed to be approximately equal to 0.5.

  • When N = 1 and endpoint is false, only the start value is written to a provided input array. When N = 1 and endpoint is true, only the stop value is written to a provided input array.

  • If start < stop, values are written to a provided input array in ascending order; otherwise, values are written in descending order.

  • If N <= 0, both functions return x unchanged.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-slinspace@umd/browser.js"></script>
<script type="text/javascript">
(function () {

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'float32'
});
console.log( x );

slinspace( x.length, 0.0, 10.0, true, x, 1 );
console.log( x );

})();
</script>
</body>
</html>

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.