/strided-base-min-view-buffer-index

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

Primary LanguageCApache License 2.0Apache-2.0

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!

minViewBufferIndex

NPM version Build Status Coverage Status

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

Installation

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

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 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 );

C APIs

Usage

#include "stdlib/strided/base/min_view_buffer_index.h"

stdlib_strided_min_view_buffer_index( N, stride, offset )

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

#include "stdlib/strided/base/min_view_buffer_index.h"
#include <stdint.h>

int64_t offset = stdlib_strided_min_view_buffer_index( 3, -2, 10 );
// returns 6

The function accepts the following arguments:

  • N: [in] int64_t number of indexed elements.
  • stride: [in] int64_t index increment.
  • offset: [in] int64_t starting index.
int64_t stdlib_strided_min_view_buffer_index( const int64_t N, const int64_t stride, const int64_t offset );

Examples

#include "stdlib/strided/base/min_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 minimum accessible index:
    int64_t idx = stdlib_strided_min_view_buffer_index( N, stride, offset );

    // Print the results:
    printf( "N: %"PRId64", stride: %"PRId64", offset: %"PRId64" => idx: %"PRId64"\n", 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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.