Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var x = new Complex128Vector( [ 0.0, 0.0, 1.0, 2.0, 4.0, 5.0 ] );

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

var idx = zindexOfTruthy( [ x, fromIndex ] );
Expand All @@ -70,7 +70,7 @@ var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var x = new Complex128Vector( [ 0.0, 0.0, 0.0, 0.0 ] );

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

var idx = zindexOfTruthy( [ x, fromIndex ] );
Expand Down Expand Up @@ -113,7 +113,7 @@ var x = new Complex128Vector( buf.buffer );
console.log( ndarray2array( x ) );

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

var idx = zindexOfTruthy( [ x, fromIndex ] );
Expand All @@ -124,6 +124,181 @@ console.log( idx );

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/blas/ext/base/ndarray/zindex_of_truthy.h"
```

#### stdlib_blas_ext_zindex_of_truthy( arrays )

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

```c
#include "stdlib/ndarray/ctor.h"
#include "stdlib/ndarray/dtypes.h"
#include "stdlib/ndarray/index_modes.h"
#include "stdlib/ndarray/orders.h"
#include "stdlib/ndarray/base/bytes_per_element.h"
#include "stdlib/blas/base/shared.h"
#include <stdint.h>

// Create an input ndarray:
const double data[] = { 0.0, 0.0, 1.0, 2.0, 4.0, 5.0 };
int64_t shape[] = { 3 };
int64_t strides[] = { STDLIB_NDARRAY_COMPLEX128_BYTES_PER_ELEMENT };
int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };

struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX128, (uint8_t *)data, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );

// Create a zero-dimensional ndarray containing the index from which to begin searching:
const int32_t fdata[] = { 0 };
int64_t sstrides[] = { 0 };

struct ndarray *fromIndex = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)fdata, 0, NULL, sstrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );

// Resolve the index:
const struct ndarray *arrays[] = { x, fromIndex };
CBLAS_INT idx = stdlib_blas_ext_zindex_of_truthy( arrays );
// returns 1

// Free allocated memory:
stdlib_ndarray_free( x );
stdlib_ndarray_free( fromIndex );
```

The function accepts the following arguments:

- **arrays**: `[in] struct ndarray**` list containing the following ndarrays:

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

```c
CBLAS_INT stdlib_blas_ext_zindex_of_truthy( const struct ndarray *arrays[] );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

- The zero-dimensional ndarray containing the index from which to begin searching must have an `int32` data type.

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/blas/ext/base/ndarray/zindex_of_truthy.h"
#include "stdlib/ndarray/ctor.h"
#include "stdlib/ndarray/dtypes.h"
#include "stdlib/ndarray/index_modes.h"
#include "stdlib/ndarray/orders.h"
#include "stdlib/ndarray/base/bytes_per_element.h"
#include "stdlib/blas/base/shared.h"
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
// Create a data buffer:
const double data[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };

// Specify the number of array dimensions:
const int64_t ndims = 1;

// Specify the array shape:
int64_t shape[] = { 4 };

// Specify the array strides:
int64_t strides[] = { STDLIB_NDARRAY_COMPLEX128_BYTES_PER_ELEMENT };

// Specify the byte offset:
const int64_t offset = 0;

// Specify the array order:
const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR;

// Specify the index mode:
const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR;

// Specify the subscript index modes:
int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };
const int64_t nsubmodes = 1;

// Create an input ndarray:
struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX128, (uint8_t *)data, ndims, shape, strides, offset, order, imode, nsubmodes, submodes );
if ( x == NULL ) {
fprintf( stderr, "Error allocating memory.\n" );
exit( 1 );
}

// Specify the array strides for zero-dimensional ndarrays:
int64_t sstrides[] = { 0 };

// Create a data buffer for an ndarray containing the index from which to begin searching:
const int32_t fdata[] = { 0 };

// Create a zero-dimensional ndarray containing the index from which to begin searching:
struct ndarray *fromIndex = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)fdata, 0, NULL, sstrides, 0, order, imode, nsubmodes, submodes );
if ( fromIndex == NULL ) {
fprintf( stderr, "Error allocating memory.\n" );
exit( 1 );
}

// Define a list of ndarrays:
const struct ndarray *arrays[] = { x, fromIndex };

// Resolve the index:
CBLAS_INT idx = stdlib_blas_ext_zindex_of_truthy( arrays );

// Print the result:
printf( "index: %i\n", (int)idx );

// Free allocated memory:
stdlib_ndarray_free( x );
stdlib_ndarray_free( fromIndex );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

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

<section class="related">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var zeros = require( '@stdlib/ndarray/zeros' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var zindexOfTruthy = require( './../lib' );
var zindexOfTruthy = require( './../lib/main.js' );


// VARIABLES //
Expand All @@ -52,7 +52,7 @@ function createBenchmark( len ) {

x = zeros( [ len ], options );
fromIndex = scalar2ndarray( 0, {
'dtype': 'generic'
'dtype': 'int32'
});
return benchmark;

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/**
* @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 resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var pow = require( '@stdlib/math/base/special/pow' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var zeros = require( '@stdlib/ndarray/zeros' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var format = require( '@stdlib/string/format' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var zindexOfTruthy = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( zindexOfTruthy instanceof Error )
};
var options = {
'dtype': 'complex128'
};


// FUNCTIONS //

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

x = zeros( [ len ], options );
fromIndex = scalar2ndarray( 0, {
'dtype': 'int32'
});
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 = zindexOfTruthy( [ x, 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::native:len=%d', pkg, len ), opts, f );
}
}

main();
Loading
Loading