@stdlib/strided-base-min-view-buffer-index v0.2.1

minViewBufferIndex

Return the minimum accessible index based on a set of provided strided array parameters.

Installation

npm install @stdlib/strided-base-min-view-buffer-index

Usage

var minViewBufferIndex = require( '@stdlib/strided-base-min-view-buffer-index' );

minViewBufferIndex( N, stride, offset )

Returns the minimum accessible index based on a set of provided strided array parameters.

var idx = minViewBufferIndex( 3, -2, 10 );
// returns 6

Notes

• If N <= 0, the function returns the specified offset; however, do note that, when N equals zero, no strided array elements should be accessed.

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var minViewBufferIndex = require( '@stdlib/strided-base-min-view-buffer-index' );

// Generate a random number of indexed elements:
var N = discreteUniform( 10, 20 );

// Generate a random stride length:
var stride = discreteUniform( -10, 10 );

// Generate a random offset:
var offset = discreteUniform( 0, 100 ) + ( ( stride < 0 ) ? (1-N)*stride : 0 );

// Compute the minimum accessible index:
var idx = minViewBufferIndex( N, stride, offset );

console.log( 'N: %d, stride: %d, offset: %d => %d', N, stride, offset, idx );

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