diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/cindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/cindex-of/README.md index 2beea1084555..f489723778e3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/cindex-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/cindex-of/README.md @@ -52,7 +52,7 @@ var searchElement = scalar2ndarray( new Complex64( 3.0, 4.0 ), { }); var fromIndex = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); var idx = cindexOf( [ x, searchElement, fromIndex ] ); @@ -81,7 +81,7 @@ var searchElement = scalar2ndarray( new Complex64( 10.0, 0.0 ), { }); var fromIndex = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); var idx = cindexOf( [ x, searchElement, fromIndex ] ); @@ -130,7 +130,7 @@ var searchElement = scalar2ndarray( new Complex64( 2.0, 3.0 ), { console.log( 'Search Element:', ndarraylike2scalar( searchElement ) ); var fromIndex = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); console.log( 'From Index:', ndarraylike2scalar( fromIndex ) ); @@ -142,6 +142,196 @@ console.log( idx ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/ndarray/cindex_of.h" +``` + +#### stdlib_blas_ext_cindex_of( arrays ) + +Returns the first index of a search element in a one-dimensional single-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 + +// Create an input ndarray: +const float data[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f }; +int64_t shape[] = { 3 }; +int64_t strides[] = { STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT }; +int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + +struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)data, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Create zero-dimensional ndarrays containing the search element and the index from which to begin searching: +const float sdata[] = { 3.0f, 4.0f }; +const int32_t fdata[] = { 0 }; +int64_t sstrides[] = { 0 }; + +struct ndarray *searchElement = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)sdata, 0, NULL, sstrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +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, searchElement, fromIndex }; +CBLAS_INT idx = stdlib_blas_ext_cindex_of( arrays ); +// returns 1 + +// Free allocated memory: +stdlib_ndarray_free( x ); +stdlib_ndarray_free( searchElement ); +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 search element. + - a zero-dimensional ndarray containing the index from which to begin searching. + +```c +CBLAS_INT stdlib_blas_ext_cindex_of( const struct ndarray *arrays[] ); +``` + +
+ + + + + +
+ +- The zero-dimensional ndarray containing the index from which to begin searching must have an `int32` data type. + +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/ndarray/cindex_of.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 +#include +#include + +int main( void ) { + // Create a data buffer: + const float data[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; + + // 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_COMPLEX64_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_COMPLEX64, (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 search element: + const float sdata[] = { 5.0f, -6.0f }; + + // Create a zero-dimensional ndarray containing the search element: + struct ndarray *searchElement = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)sdata, 0, NULL, sstrides, 0, order, imode, nsubmodes, submodes ); + if ( searchElement == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // 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, searchElement, fromIndex }; + + // Resolve the index: + CBLAS_INT idx = stdlib_blas_ext_cindex_of( arrays ); + + // Print the result: + printf( "index: %i\n", (int)idx ); + + // Free allocated memory: + stdlib_ndarray_free( x ); + stdlib_ndarray_free( searchElement ); + stdlib_ndarray_free( fromIndex ); +} +``` + +
+ + + +
+ + +