diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/slogspace/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/slogspace/README.md index fbb79ef16898..a327bf61fd79 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/slogspace/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/slogspace/README.md @@ -179,6 +179,198 @@ console.log( ndarray2array( x ) ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/ndarray/slogspace.h" +``` + +#### stdlib_blas_ext_slogspace( arrays ) + +Fills a one-dimensional single-precision floating-point ndarray with logarithmically spaced values over a specified interval. + +```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 ndarrays: +float dataX[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; +float baseData[] = { 10.0f }; +float startData[] = { 0.0f }; +float stopData[] = { 5.0f }; +bool endpointData[] = { true }; +int64_t shape[] = { 6 }; +int64_t strides[] = { STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT }; +int64_t scalarStrides[] = { 0 }; +int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + +struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)dataX, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *base = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)baseData, 0, NULL, scalarStrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *start = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)startData, 0, NULL, scalarStrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *stop = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)stopData, 0, NULL, scalarStrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); +struct ndarray *endpoint = stdlib_ndarray_allocate( STDLIB_NDARRAY_BOOL, (uint8_t *)endpointData, 0, NULL, scalarStrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Perform computation: +const struct ndarray *arrays[] = { x, base, start, stop, endpoint }; +stdlib_blas_ext_slogspace( arrays ); + +// Free allocated memory: +stdlib_ndarray_free( x ); +stdlib_ndarray_free( base ); +stdlib_ndarray_free( start ); +stdlib_ndarray_free( stop ); +stdlib_ndarray_free( endpoint ); +``` + +The function accepts the following arguments: + +- **arrays**: `[in] struct ndarray**` list containing the following ndarrays: + + - `[out] struct ndarray*` a one-dimensional ndarray to fill with logarithmically spaced values. + - `[in] struct ndarray*` a zero-dimensional ndarray specifying the base of the logarithmic scale. + - `[in] struct ndarray*` a zero-dimensional ndarray specifying the exponent of the starting value, where the starting value is `base^start`. + - `[in] struct ndarray*` a zero-dimensional ndarray specifying the exponent of the final value, where the final value is `base^stop`. + - `[in] struct ndarray*` a zero-dimensional boolean ndarray specifying whether to include `base^stop`. When `true`, the interval is closed; otherwise, it is half-open. + +```c +void stdlib_blas_ext_slogspace( const struct ndarray *arrays[] ); +``` + +
+ + + + + +
+ +### Notes + +- When the input ndarray contains one element, that element is `base^stop` if `endpoint` is true and `base^start` otherwise. +- The input ndarray is **mutated**. + +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/ndarray/slogspace.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: + float dataX[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; + float baseData[] = { 10.0f }; + float startData[] = { 0.0f }; + float stopData[] = { 5.0f }; + bool endpointData[] = { true }; + + // Specify the number of array dimensions: + const int64_t ndims = 1; + const int64_t scalarNdims = 0; + + // Specify the array shape: + int64_t shape[] = { 6 }; + + // Specify the array strides: + int64_t strides[] = { STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT }; + int64_t scalarStrides[] = { 0 }; + + // 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 *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)dataX, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + + struct ndarray *base = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)baseData, scalarNdims, NULL, scalarStrides, offset, order, imode, nsubmodes, submodes ); + + struct ndarray *start = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)startData, scalarNdims, NULL, scalarStrides, offset, order, imode, nsubmodes, submodes ); + + struct ndarray *stop = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)stopData, scalarNdims, NULL, scalarStrides, offset, order, imode, nsubmodes, submodes ); + + struct ndarray *endpoint = stdlib_ndarray_allocate( STDLIB_NDARRAY_BOOL, (uint8_t *)endpointData, scalarNdims, NULL, scalarStrides, offset, order, imode, nsubmodes, submodes ); + if ( x == NULL || base == NULL || start == NULL || stop == NULL || endpoint == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { x, base, start, stop, endpoint }; + + // Perform computation: + stdlib_blas_ext_slogspace( arrays ); + + // Print the result: + for ( int i = 0; i < 6; i++ ) { + printf( "x[ %i ] = %f\n", i, dataX[ i ] ); + } + + // Free allocated memory: + stdlib_ndarray_free( x ); + stdlib_ndarray_free( base ); + stdlib_ndarray_free( start ); + stdlib_ndarray_free( stop ); + stdlib_ndarray_free( endpoint ); +} +``` + +
+ + + +
+ + +