{"id":17716382,"url":"https://github.com/stdlib-js/ndarray-base-ind","last_synced_at":"2025-04-01T16:30:32.293Z","repository":{"id":41354533,"uuid":"376830959","full_name":"stdlib-js/ndarray-base-ind","owner":"stdlib-js","description":"Return an index given an index mode.","archived":false,"fork":false,"pushed_at":"2024-12-30T01:45:40.000Z","size":1079,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-21T20:47:40.447Z","etag":null,"topics":["array","base","clamp","idx","ind","index","javascript","multidimensional","ndarray","node","node-js","nodejs","stdlib","subscript","types","util","utilities","utility","utils","wrap"],"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:37.000Z","updated_at":"2024-12-30T01:34:40.000Z","dependencies_parsed_at":"2023-02-17T08:31:13.035Z","dependency_job_id":"21a165d5-4dd6-4b89-bf4e-995d80c8497a","html_url":"https://github.com/stdlib-js/ndarray-base-ind","commit_stats":{"total_commits":61,"total_committers":1,"mean_commits":61.0,"dds":0.0,"last_synced_commit":"bb5d348135499f603f158ffd903ed9493d79503a"},"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-ind","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-ind/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-ind/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-ind/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-base-ind/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246620222,"owners_count":20806722,"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","clamp","idx","ind","index","javascript","multidimensional","ndarray","node","node-js","nodejs","stdlib","subscript","types","util","utilities","utility","utils","wrap"],"created_at":"2024-10-25T13:12:28.623Z","updated_at":"2025-04-01T16:30:32.286Z","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# ind\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 Return an index given an index mode.\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-ind\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 ind = require( '@stdlib/ndarray-base-ind' );\n```\n\n#### ind( idx, max, mode )\n\nReturns an index given an index `mode`.\n\n\u003c!-- run throws: true --\u003e\n\n```javascript\nvar idx = ind( 2, 9, 'throw' );\n// returns 2\n\nidx = ind( -1, 9, 'throw' );\n// throws \u003cRangeError\u003e\n\nidx = ind( 10, 9, 'throw' );\n// throws \u003cRangeError\u003e\n\n// Wrapping indices around using modulo arithmetic:\nidx = ind( 2, 9, 'wrap' );\n// returns 2\n\nidx = ind( 10, 9, 'wrap' );\n// returns 0\n\nidx = ind( -1, 9, 'wrap' );\n// returns 9\n\n// Clamping indices to first and last indices:\nidx = ind( 2, 9, 'clamp' );\n// returns 2\n\nidx = ind( 10, 9, 'clamp' );\n// returns 9\n\nidx = ind( -1, 9, 'clamp' );\n// returns 0\n\n// Normalizing negative indices:\nidx = ind( 2, 9, 'normalize' );\n// returns 2\n\nidx = ind( -4, 9, 'normalize' );\n// returns 6\n```\n\n#### ind.factory( mode )\n\nReturns a function for returning an index according to a provided index `mode`.\n\n```javascript\nvar fcn = ind.factory( 'clamp' );\n\nvar idx = fcn( 2, 9 );\n// returns 2\n\nidx = fcn( 10, 9 );\n// returns 9\n\nidx = fcn( -1, 9 );\n// returns 0\n```\n\nThe function returns a function accepts the following arguments:\n\n-   **index**: input index.\n-   **max**: maximum index value.\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## Notes\n\n-   Both functions support the following modes:\n\n    -   **throw**: specifies that the function should throw an error when an index is outside the interval `[0, max]`.\n    -   **normalize**: specifies that the function should normalize negative indices and throw an error when an index is outside the interval `[-max-1, max]`.\n    -   **wrap**: specifies that the function should wrap around an index using modulo arithmetic.\n    -   **clamp**: specifies that the function should set an index less than `0` to `0` (minimum index) and set an index greater than `max` to `max`.\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 ind = require( '@stdlib/ndarray-base-ind' );\n\nvar modes;\nvar mode;\nvar idx;\nvar out;\nvar i;\n\nmodes = [ 'clamp', 'wrap' ];\n\nfor ( i = 0; i \u003c 100; i++ ) {\n    idx = discreteUniform( -20, 20 );\n    mode = modes[ discreteUniform( 0, modes.length-1 ) ];\n    out = ind( idx, 9, mode );\n    console.log( '%d =\u003e %s(%d,%d) =\u003e %d', idx, mode, 0, 9, out );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\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-ind.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-ind\n\n[test-image]: https://github.com/stdlib-js/ndarray-base-ind/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-base-ind/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-ind/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-ind?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base-ind.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base-ind/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-ind/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-base-ind/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-base-ind/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-base-ind/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-base-ind/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-base-ind/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-base-ind/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-ind/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-ind","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-base-ind","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-ind/lists"}