{"id":23722366,"url":"https://github.com/stdlib-js/ndarray-base-min-view-buffer-index","last_synced_at":"2025-09-03T23:31:39.200Z","repository":{"id":41354833,"uuid":"376830811","full_name":"stdlib-js/ndarray-base-min-view-buffer-index","owner":"stdlib-js","description":"Compute the minimum linear index in an underlying data buffer accessible to an array view.","archived":false,"fork":false,"pushed_at":"2024-12-01T03:44:59.000Z","size":347,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-19T16:12:31.021Z","etag":null,"topics":["array","base","idx","index","javascript","linear","min","minimum","multidimensional","ndarray","node","node-js","nodejs","stdlib","strides","types","utilities","utility","utils","view"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-14T13:22:11.000Z","updated_at":"2024-12-01T01:46:42.000Z","dependencies_parsed_at":"2023-02-17T06:30:58.361Z","dependency_job_id":"dc608854-ddc0-4c4e-ba60-af613675d339","html_url":"https://github.com/stdlib-js/ndarray-base-min-view-buffer-index","commit_stats":{"total_commits":62,"total_committers":1,"mean_commits":62.0,"dds":0.0,"last_synced_commit":"7c604ef38ac3fbd70566f30306fb6222f4c92d9b"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-min-view-buffer-index","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-min-view-buffer-index/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-min-view-buffer-index/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-min-view-buffer-index/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-base-min-view-buffer-index/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231874117,"owners_count":18439217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["array","base","idx","index","javascript","linear","min","minimum","multidimensional","ndarray","node","node-js","nodejs","stdlib","strides","types","utilities","utility","utils","view"],"created_at":"2024-12-30T23:35:43.799Z","updated_at":"2025-09-03T23:31:39.167Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# minViewBufferIndex\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Compute the minimum linear index in an underlying data buffer accessible to an array view.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/ndarray-base-min-view-buffer-index\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar minViewBufferIndex = require( '@stdlib/ndarray-base-min-view-buffer-index' );\n```\n\n#### minViewBufferIndex( shape, strides, offset )\n\nComputes the minimum linear index in an underlying data buffer accessible to an array view.\n\n```javascript\n// Array shape:\nvar shape = [ 2, 2 ];\n\n// Stride array:\nvar strides = [ -2, -1 ];\n\n// Index offset which specifies the location of the first indexed value:\nvar offset = 13; // includes a view offset\n\nvar idx = minViewBufferIndex( shape, strides, offset );\n// returns 10\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar discreteUniform = require( '@stdlib/random-base-discrete-uniform' );\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar strides2offset = require( '@stdlib/ndarray-base-strides2offset' );\nvar randu = require( '@stdlib/random-base-randu' );\nvar minViewBufferIndex = require( '@stdlib/ndarray-base-min-view-buffer-index' );\n\nvar strides;\nvar offset;\nvar shape;\nvar idx;\nvar i;\nvar j;\n\nshape = [ 0, 0, 0 ];\n\nfor ( i = 0; i \u003c 100; i++ ) {\n    // Generate a random array shape:\n    shape[ 0 ] = discreteUniform( 1, 10 );\n    shape[ 1 ] = discreteUniform( 1, 10 );\n    shape[ 2 ] = discreteUniform( 1, 10 );\n\n    // Generate strides:\n    if ( randu() \u003c 0.5 ) {\n        strides = shape2strides( shape, 'row-major' );\n    } else {\n        strides = shape2strides( shape, 'column-major' );\n    }\n    j = discreteUniform( 0, shape.length-1 );\n    strides[ j ] *= ( randu() \u003c 0.5 ) ? -1 : 1;\n\n    // Compute the index offset:\n    offset = strides2offset( shape, strides ) + 25; // include view offset\n\n    // Compute the minimum linear index:\n    idx = minViewBufferIndex( shape, strides, offset );\n    console.log( 'Shape: %s. Strides: %s. Offset: %d. Min idx: %d.', shape.join( 'x' ), strides.join( ',' ), offset, idx );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- C interface documentation. --\u003e\n\n* * *\n\n\u003csection class=\"c\"\u003e\n\n## C APIs\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- C usage documentation. --\u003e\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```c\n#include \"stdlib/ndarray/base/min_view_buffer_index.h\"\n```\n\n#### stdlib_ndarray_min_view_buffer_index( ndims, \\*shape, \\*strides, offset )\n\nComputes the minimum linear index (in bytes) in an underlying data buffer accessible to an array view.\n\n```c\n#include \u003cstdint.h\u003e\n\nint64_t ndims = 2;\nint64_t shape[] = { 10, 10 };\nint64_t strides[] = { 10, 1 };\nint64_t offset = 10;\n\nint64_t idx = stdlib_ndarray_min_view_buffer_index( ndims, shape, strides, offset );\n// returns 10\n```\n\nThe function accepts the following arguments:\n\n-   **ndims**: `[in] int64_t` number of dimensions.\n-   **shape**: `[in] int64_t*` array shape (dimensions).\n-   **strides**: `[in] int64_t*` array strides (in bytes).\n-   **offset**: `[in] int64_t` index offset.\n\n```c\nint64_t stdlib_ndarray_min_view_buffer_index( const int64_t ndims, const int64_t *shape, const int64_t *strides, const int64_t offset );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- C API usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```c\n#include \"stdlib/ndarray/base/min_view_buffer_index.h\"\n#include \u003cstdint.h\u003e\n#include \u003cstdio.h\u003e\n#include \u003cinttypes.h\u003e\n\nint main( void ) {\n    // Specify the number of dimensions:\n    const int64_t ndims = 2;\n\n    // Define an array shape:\n    const int64_t shape[] = { 10, 10 };\n\n    // Define array strides:\n    const int64_t strides[] = { -2, 5 };\n\n    // Define an offset:\n    const int64_t offset = 100;\n\n    // Compute the minimum accessible index:\n    int64_t idx = stdlib_ndarray_min_view_buffer_index( ndims, shape, strides, offset );\n\n    // Print the results:\n    printf( \"idx: %\"PRId64\"\\n\", idx );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.c --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-min-view-buffer-index.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-min-view-buffer-index\n\n[test-image]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-min-view-buffer-index/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-min-view-buffer-index?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base-min-view-buffer-index.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base-min-view-buffer-index/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-base-min-view-buffer-index/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-min-view-buffer-index/main/LICENSE\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-min-view-buffer-index","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-base-min-view-buffer-index","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-min-view-buffer-index/lists"}