diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwhere/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwhere/README.md index 96ed983e7c71..31854e3c7bc6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwhere/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwhere/README.md @@ -111,6 +111,182 @@ console.log( ndarray2array( out ) ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/ndarray/dwhere.h" +``` + +#### stdlib_blas_ext_dwhere( arrays ) + +Takes elements from one of two one-dimensional double-precision floating-point ndarrays depending on a condition. + +```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 +#include + +// Create data buffers: +const uint8_t dataC[] = { 1, 0, 1, 0 }; +const double dataX[] = { 1.0, 2.0, 3.0, 4.0 }; +const double dataY[] = { 5.0, 6.0, 7.0, 8.0 }; +double dataOut[] = { 0.0, 0.0, 0.0, 0.0 }; + +int64_t shape[] = { 4 }; +int64_t stridesC[] = { STDLIB_NDARRAY_BOOL_BYTES_PER_ELEMENT }; +int64_t strides[] = { STDLIB_NDARRAY_FLOAT64_BYTES_PER_ELEMENT }; +int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + +struct ndarray *c = stdlib_ndarray_allocate( STDLIB_NDARRAY_BOOL, (uint8_t *)dataC, 1, shape, stridesC, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataX, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *y = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataY, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *out = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataOut, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Perform computation: +const struct ndarray *arrays[] = { c, x, y, out }; +stdlib_blas_ext_dwhere( arrays ); + +// Free allocated memory: +stdlib_ndarray_free( c ); +stdlib_ndarray_free( x ); +stdlib_ndarray_free( y ); +stdlib_ndarray_free( out ); +``` + +The function accepts the following arguments: + +- **arrays**: `[in] struct ndarray**` list containing the following ndarrays: + + - `[in] struct ndarray*` a one-dimensional condition ndarray. + - `[in] struct ndarray*` first one-dimensional input ndarray. + - `[in] struct ndarray*` second one-dimensional input ndarray. + - `[out] struct ndarray*` a one-dimensional output ndarray. + +```c +void stdlib_blas_ext_dwhere( const struct ndarray *arrays[] ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/ndarray/dwhere.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 +#include +#include +#include + +int main( void ) { + // Create data buffers: + const uint8_t dataC[] = { 1, 0, 1, 0 }; + const double dataX[] = { 1.0, 2.0, 3.0, 4.0 }; + const double dataY[] = { 5.0, 6.0, 7.0, 8.0 }; + double dataOut[] = { 0.0, 0.0, 0.0, 0.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 stridesC[] = { STDLIB_NDARRAY_BOOL_BYTES_PER_ELEMENT }; + int64_t strides[] = { STDLIB_NDARRAY_FLOAT64_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 ndarrays: + struct ndarray *c = stdlib_ndarray_allocate( STDLIB_NDARRAY_BOOL, (uint8_t *)dataC, ndims, shape, stridesC, offset, order, imode, nsubmodes, submodes ); + struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataX, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + struct ndarray *y = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataY, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + struct ndarray *out = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataOut, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + if ( c == NULL || x == NULL || y == NULL || out == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { c, x, y, out }; + + // Perform computation: + stdlib_blas_ext_dwhere( arrays ); + + // Print the result: + for ( int i = 0; i < 4; i++ ) { + printf( "out[ %i ] = %lf\n", i, dataOut[ i ] ); + } + + // Free allocated memory: + stdlib_ndarray_free( c ); + stdlib_ndarray_free( x ); + stdlib_ndarray_free( y ); + stdlib_ndarray_free( out ); +} +``` + +
+ + + +
+ + +