Skip to content

Commit 8f4e7a9

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 f5f16d3 commit 8f4e7a9

File tree

22 files changed

+478
-389
lines changed

22 files changed

+478
-389
lines changed

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

Lines changed: 123 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,22 +55,20 @@ The function has the following parameters:
5555

5656
- **N**: number of indexed elements.
5757
- **x**: input [`Float64Array`][@stdlib/array/float64].
58-
- **strideX**: index increment for `x`.
58+
- **strideX**: stride length for `x`.
5959
- **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.
60-
- **strideMask**: index increment for `mask`.
60+
- **strideMask**: stride length for `mask`.
6161

6262
The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
6363

6464
```javascript
6565
var Float64Array = require( '@stdlib/array/float64' );
6666
var Uint8Array = require( '@stdlib/array/uint8' );
67-
var floor = require( '@stdlib/math/base/special/floor' );
6867

6968
var x = new Float64Array( [ 1.0, 2.0, 7.0, -2.0, -4.0, 3.0, -5.0, -6.0 ] );
7069
var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
71-
var N = floor( x.length / 2 );
7270

73-
var v = dmskmin( N, x, 2, mask, 2 );
71+
var v = dmskmin( 4, x, 2, mask, 2 );
7472
// returns -4.0
7573
```
7674

@@ -81,17 +79,14 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t
8179
```javascript
8280
var Float64Array = require( '@stdlib/array/float64' );
8381
var Uint8Array = require( '@stdlib/array/uint8' );
84-
var floor = require( '@stdlib/math/base/special/floor' );
8582

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

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

92-
var N = floor( x0.length / 2 );
93-
94-
var v = dmskmin( N, x1, 2, mask1, 2 );
89+
var v = dmskmin( 4, x1, 2, mask1, 2 );
9590
// returns -2.0
9691
```
9792

@@ -115,18 +110,16 @@ The function has the following additional parameters:
115110
- **offsetX**: starting index for `x`.
116111
- **offsetMask**: starting index for `mask`.
117112

118-
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 minimum value for every other value in `x` starting from the second value
113+
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 minimum value for every other element in `x` starting from the second element
119114

120115
```javascript
121116
var Float64Array = require( '@stdlib/array/float64' );
122117
var Uint8Array = require( '@stdlib/array/uint8' );
123-
var floor = require( '@stdlib/math/base/special/floor' );
124118

125119
var x = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0 ] );
126120
var mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
127-
var N = floor( x.length / 2 );
128121

129-
var v = dmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
122+
var v = dmskmin.ndarray( 4, x, 2, 1, mask, 2, 1 );
130123
// returns -2.0
131124
```
132125

@@ -182,6 +175,123 @@ console.log( v );
182175

183176
<!-- /.examples -->
184177

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

lib/node_modules/@stdlib/stats/base/dmskmin/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 isnan = require( '@stdlib/math/base/assert/is-nan' );
2628
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
28-
var Uint8Array = require( '@stdlib/array/uint8' );
2929
var pkg = require( './../package.json' ).name;
3030
var dmskmin = require( './../lib/dmskmin.js' );
3131

3232

33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'float64'
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 dmskmin = require( './../lib/dmskmin.js' );
4060
* @returns {Function} benchmark function
4161
*/
4262
function createBenchmark( len ) {
43-
var mask;
44-
var x;
45-
var i;
46-
47-
x = new Float64Array( 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/dmskmin/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 isnan = require( '@stdlib/math/base/assert/is-nan' );
2729
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
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 dmskmin = tryRequire( resolve( __dirname, './../lib/dmskmin.native.js' ) );
3737
var opts = {
3838
'skip': ( dmskmin instanceof Error )
3939
};
40+
var options = {
41+
'dtype': 'float64'
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 Float64Array( 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/dmskmin/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 isnan = require( '@stdlib/math/base/assert/is-nan' );
2628
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
28-
var Uint8Array = require( '@stdlib/array/uint8' );
2929
var pkg = require( './../package.json' ).name;
3030
var dmskmin = require( './../lib/ndarray.js' );
3131

3232

33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'float64'
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 dmskmin = 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 Float64Array( 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)