Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 159 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/zindex-of/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
<!--

@license Apache-2.0

Copyright (c) 2026 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# zindexOf

> Return the first index of a search element in a one-dimensional double-precision complex floating-point ndarray.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var zindexOf = require( '@stdlib/blas/ext/base/ndarray/zindex-of' );
```

#### zindexOf( arrays )

Returns the first index of a specified search element in a one-dimensional double-precision complex floating-point ndarray.

```javascript
var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

var searchElement = scalar2ndarray( new Complex128( 3.0, 4.0 ), {
'dtype': 'complex128'
});

var fromIndex = scalar2ndarray( 0, {
'dtype': 'generic'
});

var idx = zindexOf( [ x, searchElement, fromIndex ] );
// returns 1
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the search element.
- a zero-dimensional ndarray containing the index from which to begin searching.

If the function is unable to find a search element, the function returns `-1`.

```javascript
var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );

var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );

var searchElement = scalar2ndarray( new Complex128( 10.0, 0.0 ), {
'dtype': 'complex128'
});

var fromIndex = scalar2ndarray( 0, {
'dtype': 'generic'
});

var idx = zindexOf( [ x, searchElement, fromIndex ] );
// returns -1
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If a specified starting search index is negative, the function resolves the starting search index by counting backward from the last element (where `-1` refers to the last element).

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );
var zindexOf = require( '@stdlib/blas/ext/base/ndarray/zindex-of' );

var opts = {
'dtype': 'float64'
};

var x = new Complex128Vector( discreteUniform( 20, -50, 50, opts ) );
console.log( ndarray2array( x ) );

var searchElement = scalar2ndarray( new Complex128( 2.0, 3.0 ), {
'dtype': 'complex128'
});
console.log( 'Search Element:', ndarraylike2scalar( searchElement ) );

var fromIndex = scalar2ndarray( 0, {
'dtype': 'generic'
});
console.log( 'From Index:', ndarraylike2scalar( fromIndex ) );

var idx = zindexOf( [ x, searchElement, fromIndex ] );
console.log( idx );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var pow = require( '@stdlib/math/base/special/pow' );
var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var Complex128 = require( '@stdlib/complex/float64/ctor' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var zindexOf = require( './../lib' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var searchElement;
var fromIndex;
var xbuf;
var x;

xbuf = uniform( len*2, 0.0, 100.0, {
'dtype': 'float64'
});
x = new Complex128Vector( xbuf.buffer );
searchElement = scalar2ndarray( new Complex128( -10.0, -10.0 ), {
'dtype': 'complex128'
});
fromIndex = scalar2ndarray( 0, {
'dtype': 'generic'
});
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var out;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = zindexOf( [ x, searchElement, fromIndex ] );
if ( out !== out ) {
b.fail( 'should return an integer' );
}
}
b.toc();
if ( !isInteger( out ) ) {
b.fail( 'should return an integer' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

{{alias}}( arrays )
Returns the first index of a search element in a one-dimensional double-
precision complex floating-point ndarray.

If a specified starting search index is negative, the function resolves the
starting search index by counting backward from the last element (where `-1`
refers to the last element).

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the search element.
- a zero-dimensional ndarray containing the index from which to begin
searching.

Returns
-------
out: integer
Index.

Examples
--------
> var x = new {{alias:@stdlib/ndarray/vector/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var c = new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 4.0 );
> var v = {{alias:@stdlib/ndarray/from-scalar}}( c, { 'dtype': 'complex128' } );
> var i = {{alias:@stdlib/ndarray/from-scalar}}( 0, { 'dtype': 'generic' } );
> {{alias}}( [ x, v, i ] )
1

See Also
--------
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { complex128ndarray, typedndarray } from '@stdlib/types/ndarray';
import { Complex128 } from '@stdlib/types/complex';

/**
* Returns the first index of a search element in a one-dimensional double-precision complex floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the search element.
* - a zero-dimensional ndarray containing the index from which to begin searching.
*
* @param arrays - array-like object containing ndarrays
* @returns index
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* var searchElement = scalar2ndarray( new Complex128( 3.0, 4.0 ), {
* 'dtype': 'complex128'
* });
*
* var fromIndex = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var v = zindexOf( [ x, searchElement, fromIndex ] );
* // returns 1
*/
declare function zindexOf( arrays: [ complex128ndarray, typedndarray<Complex128>, typedndarray<number> ] ): number;


// EXPORTS //

export = zindexOf;
Loading