Skip to content

Commit 6f6753c

Browse files
committed
feat: add C ndarray interface and refactor implementation
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 4301694 commit 6f6753c

File tree

22 files changed

+475
-393
lines changed

22 files changed

+475
-393
lines changed

lib/node_modules/@stdlib/stats/base/smskrange/README.md

Lines changed: 124 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,20 @@ The function has the following parameters:
5757

5858
- **N**: number of indexed elements.
5959
- **x**: input [`Float32Array`][@stdlib/array/float32].
60-
- **strideX**: index increment for `x`.
60+
- **strideX**: stride length for `x`.
6161
- **mask**: mask [`Uint8Array`][@stdlib/array/uint8]. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from computation.
62-
- **strideMask**: index increment for `mask`.
62+
- **strideMask**: stride length for `mask`.
6363

64-
The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
64+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the [range][range] of every other element in `x`,
6565

6666
```javascript
6767
var Float32Array = require( '@stdlib/array/float32' );
6868
var Uint8Array = require( '@stdlib/array/uint8' );
69-
var floor = require( '@stdlib/math/base/special/floor' );
7069

7170
var x = new Float32Array( [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0 ] );
7271
var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
73-
var N = floor( x.length / 2 );
7472

75-
var v = smskrange( N, x, 2, mask, 2 );
73+
var v = smskrange( 4, x, 2, mask, 2 );
7674
// returns 11.0
7775
```
7876

@@ -83,17 +81,14 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t
8381
```javascript
8482
var Float32Array = require( '@stdlib/array/float32' );
8583
var Uint8Array = require( '@stdlib/array/uint8' );
86-
var floor = require( '@stdlib/math/base/special/floor' );
8784

8885
var x0 = new Float32Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
8986
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
9087

9188
var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
9289
var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
9390

94-
var N = floor( x0.length / 2 );
95-
96-
var v = smskrange( N, x1, 2, mask1, 2 );
91+
var v = smskrange( 4, x1, 2, mask1, 2 );
9792
// returns 6.0
9893
```
9994

@@ -117,18 +112,16 @@ The function has the following additional parameters:
117112
- **offsetX**: starting index for `x`.
118113
- **offsetMask**: starting index for `mask`.
119114

120-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the [range][range] for every other value in `x` starting from the second value
115+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on a starting index. For example, to calculate the [range][range] for every other value in `x` starting from the second value
121116

122117
```javascript
123118
var Float32Array = require( '@stdlib/array/float32' );
124119
var Uint8Array = require( '@stdlib/array/uint8' );
125-
var floor = require( '@stdlib/math/base/special/floor' );
126120

127121
var x = new Float32Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
128122
var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
129-
var N = floor( x.length / 2 );
130123

131-
var v = smskrange.ndarray( N, x, 2, 1, mask, 2, 1 );
124+
var v = smskrange.ndarray( 4, x, 2, 1, mask, 2, 1 );
132125
// returns 6.0
133126
```
134127

@@ -184,6 +177,123 @@ console.log( v );
184177

185178
<!-- /.examples -->
186179

180+
<!-- C usage documentation. -->
181+
182+
<section class="usage">
183+
184+
### Usage
185+
186+
```c
187+
#include "stdlib/stats/base/smskrange.h"
188+
```
189+
190+
#### stdlib_strided_smskrange( N, \*X, strideX, Mask, strideMask )
191+
192+
Computes the [range][range] of a single-precision floating-point strided array `x` according to a `mask`.
193+
194+
```c
195+
#include <stdint.h>
196+
197+
const float x[] = { 1.0f, -2.0f, 2.0f };
198+
const uint_8 mask = { 0, 1, 0 };
199+
200+
float v = stdlib_strided_smskrange( 3, x, 1, mask, 1 );
201+
// returns 1.0f
202+
```
203+
204+
The function accepts the following arguments:
205+
206+
- **N**: `[in] CBLAS_INT` number of indexed elements.
207+
- **X**: `[in] float*` input array.
208+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
209+
- **Mask**: `[in] uint_8*`. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and included in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and excluded from computation.
210+
- **strideMask**: `[in] CBLAS_INT` stride length for `Mask`.
211+
212+
```c
213+
float stdlib_strided_smskrange( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const uint8_t *Mask, const CBLAS_INT strideMask );
214+
```
215+
216+
#### stdlib_strided_smskrange_ndarray( N, \*X, strideX, offsetX )
217+
218+
Computes the [range][range] of a single-precision floating-point strided array according to a `mask` and using alternative indexing semantics.
219+
220+
```c
221+
#include <stdint.h>
222+
223+
const float x[] = { 1.0f, -2.0f, 2.0f };
224+
const uint_8 mask = { 0, 1, 0 };
225+
226+
float v = stdlib_strided_smskrange( 3, x, 1, 0, mask, 1, 0 );
227+
// returns 1.0f
228+
```
229+
230+
The function accepts the following arguments:
231+
232+
- **N**: `[in] CBLAS_INT` number of indexed elements.
233+
- **X**: `[in] float*` input array.
234+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
235+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
236+
- **Mask**: `[in] uint_8*`. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and included in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and excluded from computation.
237+
- **strideMask**: `[in] CBLAS_INT` stride length for `Mask`.
238+
- **offsetMask**: `[in] CBLAS_INT` starting index for `Mask`.
239+
240+
```c
241+
float stdlib_strided_smskrange_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const uint8_t *Mask, const CBLAS_INT strideMask , const CBLAS_INT offsetMask );
242+
```
243+
244+
</section>
245+
246+
<!-- /.usage -->
247+
248+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
249+
250+
<section class="notes">
251+
252+
</section>
253+
254+
<!-- /.notes -->
255+
256+
<!-- C API usage examples. -->
257+
258+
<section class="examples">
259+
260+
### Examples
261+
262+
```c
263+
#include "stdlib/stats/base/smskrange.h"
264+
#include <stdint.h>
265+
#include <stdio.h>
266+
267+
int main( void ) {
268+
// Create a strided array:
269+
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f, 10.0f };
270+
271+
// Create a mask array:
272+
uint8_t mask[] = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 };
273+
274+
// Specify the number of elements:
275+
const int N = 5;
276+
277+
// Specify the stride lengths:
278+
const int strideX = 2;
279+
const int strideMask = 2;
280+
281+
// Compute the minimum value:
282+
float v = stdlib_strided_smskrange( N, x, strideX, mask, strideMask );
283+
284+
// Print the result:
285+
printf( "min: %f\n", v );
286+
}
287+
```
288+
289+
</section>
290+
291+
<!-- /.examples -->
292+
293+
</section>
294+
295+
<!-- /.c -->
296+
187297
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
188298
189299
<section class="related">

lib/node_modules/@stdlib/stats/base/smskrange/benchmark/benchmark.js

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,37 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2527
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2628
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float32Array = require( '@stdlib/array/float32' );
28-
var Uint8Array = require( '@stdlib/array/uint8' );
2929
var pkg = require( './../package.json' ).name;
3030
var smskrange = require( './../lib/smskrange.js' );
3131

3232

33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'float32'
37+
};
38+
39+
3340
// FUNCTIONS //
3441

42+
/**
43+
* Returns either one or zero.
44+
*
45+
* @private
46+
* @returns {number} one or zero
47+
*/
48+
function rand() {
49+
if ( bernoulli( 0.2 ) ) {
50+
return 1;
51+
}
52+
return 0;
53+
}
54+
3555
/**
3656
* Creates a benchmark function.
3757
*
@@ -40,20 +60,8 @@ var smskrange = require( './../lib/smskrange.js' );
4060
* @returns {Function} benchmark function
4161
*/
4262
function createBenchmark( len ) {
43-
var mask;
44-
var x;
45-
var i;
46-
47-
x = new Float32Array( len );
48-
mask = new Uint8Array( len );
49-
for ( i = 0; i < x.length; i++ ) {
50-
if ( randu() < 0.2 ) {
51-
mask[ i ] = 1;
52-
} else {
53-
mask[ i ] = 0;
54-
}
55-
x[ i ] = ( randu()*20.0 ) - 10.0;
56-
}
63+
var mask = filledarrayBy( len, 'uint8', rand );
64+
var x = uniform( len, -10.0, 10.0, options );
5765
return benchmark;
5866

5967
function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/smskrange/benchmark/benchmark.native.js

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/array/uniform' );
26+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
27+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2628
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2729
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float32Array = require( '@stdlib/array/float32' );
29-
var Uint8Array = require( '@stdlib/array/uint8' );
3030
var tryRequire = require( '@stdlib/utils/try-require' );
3131
var pkg = require( './../package.json' ).name;
3232

@@ -37,10 +37,26 @@ var smskrange = tryRequire( resolve( __dirname, './../lib/smskrange.native.js' )
3737
var opts = {
3838
'skip': ( smskrange instanceof Error )
3939
};
40+
var options = {
41+
'dtype': 'float32'
42+
};
4043

4144

4245
// FUNCTIONS //
4346

47+
/**
48+
* Returns either one or zero.
49+
*
50+
* @private
51+
* @returns {number} one or zero
52+
*/
53+
function rand() {
54+
if ( bernoulli( 0.2 ) ) {
55+
return 1;
56+
}
57+
return 0;
58+
}
59+
4460
/**
4561
* Creates a benchmark function.
4662
*
@@ -49,20 +65,8 @@ var opts = {
4965
* @returns {Function} benchmark function
5066
*/
5167
function createBenchmark( len ) {
52-
var mask;
53-
var x;
54-
var i;
55-
56-
x = new Float32Array( len );
57-
mask = new Uint8Array( len );
58-
for ( i = 0; i < x.length; i++ ) {
59-
if ( randu() < 0.2 ) {
60-
mask[ i ] = 1;
61-
} else {
62-
mask[ i ] = 0;
63-
}
64-
x[ i ] = ( randu()*20.0 ) - 10.0;
65-
}
68+
var mask = filledarrayBy( len, 'uint8', rand );
69+
var x = uniform( len, -10.0, 10.0, options );
6670
return benchmark;
6771

6872
function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/smskrange/benchmark/benchmark.ndarray.js

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,37 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2527
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
2628
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float32Array = require( '@stdlib/array/float32' );
28-
var Uint8Array = require( '@stdlib/array/uint8' );
2929
var pkg = require( './../package.json' ).name;
3030
var smskrange = require( './../lib/ndarray.js' );
3131

3232

33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'float32'
37+
};
38+
39+
3340
// FUNCTIONS //
3441

42+
/**
43+
* Returns either one or zero.
44+
*
45+
* @private
46+
* @returns {number} one or zero
47+
*/
48+
function rand() {
49+
if ( bernoulli( 0.2 ) ) {
50+
return 1;
51+
}
52+
return 0;
53+
}
54+
3555
/**
3656
* Creates a benchmark function.
3757
*
@@ -40,20 +60,8 @@ var smskrange = require( './../lib/ndarray.js' );
4060
* @returns {Function} benchmark function
4161
*/
4262
function createBenchmark( len ) {
43-
var mask;
44-
var x;
45-
var i;
46-
47-
x = new Float32Array( len );
48-
mask = new Uint8Array( len );
49-
for ( i = 0; i < x.length; i++ ) {
50-
if ( randu() < 0.2 ) {
51-
mask[ i ] = 1;
52-
} else {
53-
mask[ i ] = 0;
54-
}
55-
x[ i ] = ( randu()*20.0 ) - 10.0;
56-
}
63+
var mask = filledarrayBy( len, 'uint8', rand );
64+
var x = uniform( len, -10.0, 10.0, options );
5765
return benchmark;
5866

5967
function benchmark( b ) {

0 commit comments

Comments
 (0)