Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/strided-base-max-view-buffer-index
Return the maximum accessible index based on a set of provided strided array parameters.
https://github.com/stdlib-js/strided-base-max-view-buffer-index
array base idx index javascript linear max maximum node node-js nodejs stdlib strided strides view
Last synced: 2 months ago
JSON representation
Return the maximum accessible index based on a set of provided strided array parameters.
- Host: GitHub
- URL: https://github.com/stdlib-js/strided-base-max-view-buffer-index
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-11-19T21:26:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T03:29:04.000Z (3 months ago)
- Last Synced: 2024-10-10T12:38:06.398Z (2 months ago)
- Topics: array, base, idx, index, javascript, linear, max, maximum, node, node-js, nodejs, stdlib, strided, strides, view
- Language: C
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 311 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# maxViewBufferIndex
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the maximum accessible index based on a set of provided strided array parameters.
## Installation
```bash
npm install @stdlib/strided-base-max-view-buffer-index
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] 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
```javascript
var maxViewBufferIndex = require( '@stdlib/strided-base-max-view-buffer-index' );
```
#### maxViewBufferIndex( N, stride, offset )
Returns the maximum accessible index based on a set of provided strided array parameters.
```javascript
var idx = maxViewBufferIndex( 3, 2, 10 );
// returns 14
```
## 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
```javascript
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 );
```
* * *
## C APIs
### Usage
```c
#include "stdlib/strided/base/max_view_buffer_index.h"
```
#### stdlib_strided_max_view_buffer_index( N, stride, offset )
Returns the maximum accessible index based on a set of provided strided array parameters.
```c
#include "stdlib/strided/base/max_view_buffer_index.h"
#include
int64_t offset = stdlib_strided_max_view_buffer_index( 3, 2, 10 );
// returns 14
```
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.
```c
int64_t stdlib_strided_max_view_buffer_index( const int64_t N, const int64_t stride, const int64_t offset );
```
### Examples
```c
#include "stdlib/strided/base/max_view_buffer_index.h"
#include
#include
#include
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 );
}
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/strided-base-max-view-buffer-index.svg
[npm-url]: https://npmjs.org/package/@stdlib/strided-base-max-view-buffer-index
[test-image]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/strided-base-max-view-buffer-index/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/strided-base-max-view-buffer-index?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/tree/deno
[deno-readme]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/tree/umd
[umd-readme]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/tree/esm
[esm-readme]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/strided-base-max-view-buffer-index/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/strided-base-max-view-buffer-index/main/LICENSE