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
192 changes: 192 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/slogspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,198 @@ console.log( ndarray2array( x ) );

<!-- /.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/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 <stdint.h>
#include <stdbool.h>

// 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[] );
```

</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">

### 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**.

</section>

<!-- /.notes -->

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

<section class="examples">

### 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 <stdint.h>
#include <stdbool.h>
#include <stdlib.h>
#include <stdio.h>

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 );
}
```

</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 pow = require( '@stdlib/math/base/special/pow' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var slogspace = require( './../lib' );
var slogspace = require( './../lib/main.js' );


// VARIABLES //
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/**
* @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 uniform = require( '@stdlib/random/uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
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 slogspace = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( slogspace instanceof Error )
};
var options = {
'dtype': 'float32'
};


// FUNCTIONS //

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

x = uniform( [ len ], 0.0, 100.0, options );
base = scalar2ndarray( 10.0, options );
strt = scalar2ndarray( 0.0, options );
stp = [
scalar2ndarray( 9.0, options ),
scalar2ndarray( 5.0, options )
];
endpoint = scalar2ndarray( true, {
'dtype': 'bool'
});
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 = slogspace( [ x, base, strt, stp[ i%2 ], endpoint ] );
if ( typeof out !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( isnanf( out.get( i%len ) ) ) {
b.fail( 'should not return NaN' );
}
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