https://github.com/stdlib-js/blas-ext-base-dindex-of
Return the first index of a specified search element in a double-precision floating-point strided array.
https://github.com/stdlib-js/blas-ext-base-dindex-of
array blas double element find float float64 float64array index javascript ndarray node node-js nodejs search stdlib strided
Last synced: 5 months ago
JSON representation
Return the first index of a specified search element in a double-precision floating-point strided array.
- Host: GitHub
- URL: https://github.com/stdlib-js/blas-ext-base-dindex-of
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-06-25T11:28:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-07-09T07:45:26.000Z (9 months ago)
- Last Synced: 2025-09-05T06:25:45.052Z (7 months ago)
- Topics: array, blas, double, element, find, float, float64, float64array, index, javascript, ndarray, node, node-js, nodejs, search, stdlib, strided
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 223 KB
- Stars: 0
- Watchers: 0
- 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!
# dindexOf
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the first index of a specified search element in a double-precision floating-point strided array.
## Installation
```bash
npm install @stdlib/blas-ext-base-dindex-of
```
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 dindexOf = require( '@stdlib/blas-ext-base-dindex-of' );
```
#### dindexOf( N, searchElement, x, strideX )
Returns the first index of a specified search element in a double-precision floating-point strided array.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
var idx = dindexOf( x.length, 3.0, x, 1 );
// returns 2
```
The function has the following parameters:
- **N**: number of indexed elements.
- **searchElement**: search element.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **strideX**: stride length.
If the function is unable to find a search element, the function returns `-1`.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
var idx = dindexOf( x.length, 8.0, x, 1 );
// returns -1
```
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to search every other element:
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
var idx = dindexOf( 4, -1.0, x, 2 );
// returns 3
```
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
// Initial array...
var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
// Create an offset view...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
// Find index...
var idx = dindexOf( 3, -6.0, x1, 2 );
// returns 2
```
#### dindexOf.ndarray( N, searchElement, x, strideX, offsetX )
Returns the first index of a specified search element in a double-precision floating-point strided array using alternative indexing semantics.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
var idx = dindexOf.ndarray( x.length, 3.0, x, 1, 0 );
// returns 2
```
The function has the following additional parameters:
- **offsetX**: starting index.
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the strided array
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
var idx = dindexOf.ndarray( 3, 3.0, x, 1, x.length-3 );
// returns 2
```
## Notes
- When searching for a search element, the function checks for equality using the strict equality operator `===`. As a consequence, `NaN` values are considered distinct, and `-0` and `+0` are considered the same.
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var dindexOf = require( '@stdlib/blas-ext-base-dindex-of' );
var x = discreteUniform( 10, -100, 100, {
'dtype': 'float64'
});
console.log( x );
var idx = dindexOf( x.length, 80.0, x, 1 );
console.log( idx );
```
* * *
## C APIs
### Usage
```c
#include "stdlib/blas/ext/base/dindex_of.h"
```
#### stdlib_strided_dindex_of( N, searchElement, \*X, strideX )
Returns the first index of a specified search element in a double-precision floating-point strided array.
```c
double x[] = { 1.0, 2.0, 3.0, 4.0 };
int idx = stdlib_strided_dindex_of( 4, 3.0, x, 1 );
// returns 2
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **searchElement**: `[in] double` search element.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.
```c
CBLAS_INT N stdlib_strided_dindex_of( const CBLAS_INT N, const double searchElement, const double *X, const CBLAS_INT strideX );
```
#### stdlib_strided_dindex_of_ndarray( N, searchElement, \*X, strideX, offsetX )
Returns the first index of a specified search element in a double-precision floating-point strided array using alternative indexing semantics.
```c
double x[] = { 1.0, 2.0, 3.0, 4.0 };
int idx = stdlib_strided_dindex_of( 4, 3.0, x, 1, 0 );
// returns 2
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **searchElement**: `[in] double` search element.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.
- **offsetX**: `[in] CBLAS_INT` starting index.
```c
CBLAS_INT stdlib_strided_dindex_of_ndarray( const CBLAS_INT N, const double searchElement, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
```
### Examples
```c
#include "stdlib/blas/ext/base/dindex_of.h"
#include
int main( void ) {
// Create a strided array:
double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
// Specify the number of indexed elements:
const int N = 8;
// Specify a stride:
const int strideX = 1;
// Perform a search:
int idx = stdlib_strided_dindex_of( N, 5.0, x, strideX );
// Print the result:
printf( "index value: %d\n", 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-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-ext-base-dindex-of.svg
[npm-url]: https://npmjs.org/package/@stdlib/blas-ext-base-dindex-of
[test-image]: https://github.com/stdlib-js/blas-ext-base-dindex-of/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/blas-ext-base-dindex-of/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-ext-base-dindex-of/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/blas-ext-base-dindex-of?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/blas-ext-base-dindex-of/tree/deno
[deno-readme]: https://github.com/stdlib-js/blas-ext-base-dindex-of/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/blas-ext-base-dindex-of/tree/umd
[umd-readme]: https://github.com/stdlib-js/blas-ext-base-dindex-of/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/blas-ext-base-dindex-of/tree/esm
[esm-readme]: https://github.com/stdlib-js/blas-ext-base-dindex-of/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/blas-ext-base-dindex-of/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-ext-base-dindex-of/main/LICENSE
[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray