Return the maximum accessible index based on a set of provided strided array parameters.
APACHE-2.0 License
Return the maximum accessible index based on a set of provided strided array parameters.
npm install @stdlib/strided-base-max-view-buffer-index
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).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.
var maxViewBufferIndex = require( '@stdlib/strided-base-max-view-buffer-index' );
Returns the maximum accessible index based on a set of provided strided array parameters.
var idx = maxViewBufferIndex( 3, 2, 10 );
// returns 14
N <= 0
, the function returns the specified offset
; however, do note that, when N
equals zero, no strided array elements should be accessed.var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var maxViewBufferIndex = require( '@stdlib/strided-base-max-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 maximum accessible index:
var idx = maxViewBufferIndex( N, stride, offset );
console.log( 'N: %d, stride: %d, offset: %d => %d', N, stride, offset, idx );
#include "stdlib/strided/base/max_view_buffer_index.h"
Returns the maximum accessible index based on a set of provided strided array parameters.
#include "stdlib/strided/base/max_view_buffer_index.h"
#include <stdint.h>
int64_t offset = stdlib_strided_max_view_buffer_index( 3, 2, 10 );
// returns 14
The function accepts the following arguments:
[in] int64_t
number of indexed elements.[in] int64_t
index increment.[in] int64_t
starting index.int64_t stdlib_strided_max_view_buffer_index( const int64_t N, const int64_t stride, const int64_t offset );
#include "stdlib/strided/base/max_view_buffer_index.h"
#include <stdint.h>
#include <stdio.h>
#include <inttypes.h>
int main( void ) {
// Specify the number of indexed elements:
int64_t N = 6;
// Define a stride:
int64_t stride = 2;
// Define an offset:
int64_t offset = 100;
// Compute the maximum accessible index:
int64_t idx = stdlib_strided_max_view_buffer_index( N, stride, offset );
// Print the results:
printf( "N: %"PRId64", stride: %"PRId64", offset: %"PRId64" => idx: %"PRId64"\n", N, stride, offset, idx );
}
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-2024. The Stdlib Authors.