{"id":27125093,"url":"https://github.com/stdlib-js/ndarray-base-includes","last_synced_at":"2025-04-09T23:08:57.009Z","repository":{"id":286365163,"uuid":"960781765","full_name":"stdlib-js/ndarray-base-includes","owner":"stdlib-js","description":"Test whether an ndarray contains a specified value.","archived":false,"fork":false,"pushed_at":"2025-04-06T00:50:50.000Z","size":586,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T01:25:39.537Z","etag":null,"topics":["array","base","find","includes","javascript","ndarray","node","node-js","nodejs","search","stdlib","strided","utility","utils"],"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":"2025-04-05T03:57:32.000Z","updated_at":"2025-04-06T00:47:32.000Z","dependencies_parsed_at":"2025-04-06T01:25:55.559Z","dependency_job_id":"49e44359-e522-403c-b499-2e1116cad2ba","html_url":"https://github.com/stdlib-js/ndarray-base-includes","commit_stats":null,"previous_names":["stdlib-js/ndarray-base-includes"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-includes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-includes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-includes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-includes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-base-includes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247669148,"owners_count":20976336,"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","find","includes","javascript","ndarray","node","node-js","nodejs","search","stdlib","strided","utility","utils"],"created_at":"2025-04-07T14:29:13.269Z","updated_at":"2025-04-07T14:29:14.210Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2025 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# includes\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 Test whether an ndarray contains a specified value.\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/ndarray-base-includes\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 includes = require( '@stdlib/ndarray-base-includes' );\n```\n\n#### includes( arrays )\n\nTests whether an ndarray contains a specified value.\n\n\u003c!-- eslint-disable max-len --\u003e\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\n\n// Create a data buffer:\nvar xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );\n\n// Define the shape of the input array:\nvar shape = [ 3, 1, 2 ];\n\n// Define the array strides:\nvar sx = [ 4, 4, 1 ];\n\n// Define the index offset:\nvar ox = 0;\n\n// Create the input ndarray-like object:\nvar x = {\n    'dtype': 'float64',\n    'data': xbuf,\n    'shape': shape,\n    'strides': sx,\n    'offset': ox,\n    'order': 'row-major'\n};\n\n// Create the search element ndarray-like object:\nvar searchElement = {\n    'dtype': 'float64',\n    'data': new Float64Array( [ 6.0 ] ),\n    'shape': [],\n    'strides': [ 0 ],\n    'offset': 0,\n    'order': 'row-major'\n};\n\n// Perform reduction:\nvar out = includes( [ x, searchElement ] );\n// returns true\n```\n\nThe function accepts the following arguments:\n\n-   **arrays**: array-like object containing an input ndarray and a zero-dimensional search element ndarray.\n\nEach provided ndarray should be an object with the following properties:\n\n-   **dtype**: data type.\n-   **data**: data buffer.\n-   **shape**: dimensions.\n-   **strides**: stride lengths.\n-   **offset**: index offset.\n-   **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing the operation in order to achieve better performance.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\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-array-discrete-uniform' );\nvar ndarray2array = require( '@stdlib/ndarray-base-to-array' );\nvar includes = require( '@stdlib/ndarray-base-includes' );\n\nvar x = {\n    'dtype': 'generic',\n    'data': discreteUniform( 10, 0, 10, {\n        'dtype': 'generic'\n    }),\n    'shape': [ 5, 2 ],\n    'strides': [ 2, 1 ],\n    'offset': 0,\n    'order': 'row-major'\n};\nconsole.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );\n\nvar v = {\n    'dtype': x.dtype,\n    'data': [ 1 ],\n    'shape': [],\n    'strides': [ 0 ],\n    'offset': 0,\n    'order': x.order\n};\nconsole.log( 'Search element: %d', v.data[ 0 ] );\n\nvar out = includes( [ x, v ] );\nconsole.log( out );\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\nCharacter codes for data types:\n\n\u003c!-- The following is auto-generated. Do not manually edit. See scripts/loops.js. --\u003e\n\n\u003c!-- charcodes --\u003e\n\n-   **x**: `bool` (boolean).\n-   **z**: `complex128` (double-precision floating-point complex number).\n-   **c**: `complex64` (single-precision floating-point complex number).\n-   **f**: `float32` (single-precision floating-point number).\n-   **d**: `float64` (double-precision floating-point number).\n-   **k**: `int16` (signed 16-bit integer).\n-   **i**: `int32` (signed 32-bit integer).\n-   **s**: `int8` (signed 8-bit integer).\n-   **t**: `uint16` (unsigned 16-bit integer).\n-   **u**: `uint32` (unsigned 32-bit integer).\n-   **b**: `uint8` (unsigned 8-bit integer).\n\n\u003c!-- ./charcodes --\u003e\n\nFunction name suffix naming convention:\n\n```text\nstdlib_ndarray_includes_\u003cinput_data_type\u003e\u003csearch_element_data_type\u003e_\u003coutput_data_type\u003e[_as_\u003cinput_cast_data_type\u003e\u003csearch_element_cast_data_type\u003e_\u003coutput_data_type\u003e]\n```\n\nFor example,\n\n\u003c!-- run-disable --\u003e\n\n```c\nvoid stdlib_ndarray_includes_dd_x(...) {...}\n```\n\nis a function which accepts one double-precision floating-point input ndarray, a double-precision floating-point search element ndarray, and one boolean output ndarray.\n\nTODO: document casting convention\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/includes.h\"\n```\n\n\u003c!-- The following is auto-generated. Do not manually edit. See scripts/*loops.js. --\u003e\n\n\u003c!-- loops --\u003e\n\n\u003c!-- ./loops --\u003e\n\n\u003c!-- macros --\u003e\n\n\u003c!-- TODO: consider documenting macros --\u003e\n\n\u003c!-- ./macros --\u003e\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* * *\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```c\n// TODO\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 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\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-includes.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-includes\n\n[test-image]: https://github.com/stdlib-js/ndarray-base-includes/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-base-includes/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-includes/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-includes?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base-includes.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base-includes/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-includes/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-base-includes/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-base-includes/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-base-includes/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-base-includes/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-base-includes/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-base-includes/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-includes/main/LICENSE\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n\u003c!-- \u003c/related-links\u003e --\u003e\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-includes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-base-includes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-includes/lists"}