Skip to content

Commit ed13e5b

Browse files
chore: adding essential files
1 parent 7c902a3 commit ed13e5b

File tree

11 files changed

+243
-98
lines changed

11 files changed

+243
-98
lines changed

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

Lines changed: 100 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,106 @@ console.log( v );
180180

181181
<!-- /.examples -->
182182

183-
* * *
183+
<!-- C usage documentation. -->
184+
185+
<section class="usage">
186+
187+
### Usage
188+
189+
```c
190+
#include "stdlib/stats/base/dnanmeanpn.h"
191+
```
192+
193+
#### stdlib_strided_dnanmeanpn( N, \*X, strideX )
194+
195+
Calculate the mean value of a double-precision floating-point strided array, ignoring `NaN` values.
196+
197+
```c
198+
const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };
199+
200+
double v = stdlib_strided_dnanmeanpn( 5, x, 2 );
201+
// returns 1.25
202+
```
203+
204+
The function accepts the following arguments:
205+
206+
- **N**: `[in] CBLAS_INT` number of indexed elements.
207+
- **X**: `[in] double*` input array.
208+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
209+
210+
```c
211+
double stdlib_strided_dnanmeanpn( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
212+
```
213+
214+
#### stdlib_strided_dsmeanwd_ndarray( N, \*X, strideX, offsetX )
215+
216+
Computes the mean value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics.
217+
218+
```c
219+
const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };
220+
221+
double v = stdlib_strided_dnanmeanpn( 5, x, 2, 0 );
222+
// returns 1.25
223+
```
224+
225+
The function accepts the following arguments:
226+
227+
- **N**: `[in] CBLAS_INT` number of indexed elements.
228+
- **X**: `[in] double*` input array.
229+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
230+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
231+
232+
```c
233+
double stdlib_strided_dnanmeanpn_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
234+
```
235+
236+
</section>
237+
238+
<!-- /.usage -->
239+
240+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
241+
242+
<section class="notes">
243+
244+
</section>
245+
246+
<!-- /.notes -->
247+
248+
<!-- C API usage examples. -->
249+
250+
<section class="examples">
251+
252+
### Examples
253+
254+
```c
255+
#include "stdlib/stats/base/dnanmeanpn.h"
256+
#include <stdio.h>
257+
258+
int main( void ) {
259+
// Create a strided array:
260+
const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };
261+
262+
// Specify the number of elements:
263+
const int N = 6;
264+
265+
// Specify the stride length:
266+
const int strideX = 2;
267+
268+
// Compute the arithmetic mean:
269+
double v = stdlib_strided_dnanmeanpn( N, x, strideX );
270+
271+
// Print the result:
272+
printf( "mean: %lf\n", v );
273+
}
274+
```
275+
276+
</section>
277+
278+
<!-- /.examples -->
279+
280+
</section>
281+
282+
<!-- /.c -->
184283
185284
<section class="references">
186285

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,29 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/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' );
2829
var pkg = require( './../package.json' ).name;
2930
var dnanmeanpn = require( './../lib/dnanmeanpn.js' );
3031

3132

3233
// FUNCTIONS //
3334

35+
/**
36+
* Returns a random value or `NaN`.
37+
*
38+
* @returns {number} random number or `NaN`
39+
*/
40+
function rand() {
41+
if ( bernoulli( 0.2 ) ) {
42+
return NaN;
43+
}
44+
return uniform( -10.0, 10.0 );
45+
}
46+
3447
/**
3548
* Creates a benchmark function.
3649
*
@@ -39,17 +52,7 @@ var dnanmeanpn = require( './../lib/dnanmeanpn.js' );
3952
* @returns {Function} benchmark function
4053
*/
4154
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float64Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
if ( randu() < 0.2 ) {
48-
x[ i ] = NaN;
49-
} else {
50-
x[ i ] = ( randu()*20.0 ) - 10.0;
51-
}
52-
}
55+
var x = filledarrayBy( len, 'float64', rand );
5356
return benchmark;
5457

5558
function benchmark( b ) {

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +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/base/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' );
2930
var tryRequire = require( '@stdlib/utils/try-require' );
3031
var pkg = require( './../package.json' ).name;
3132

@@ -40,6 +41,18 @@ var opts = {
4041

4142
// FUNCTIONS //
4243

44+
/**
45+
* Returns a random value or `NaN`.
46+
*
47+
* @returns {number} random number or `NaN`
48+
*/
49+
function rand() {
50+
if ( bernoulli( 0.2 ) ) {
51+
return NaN;
52+
}
53+
return uniform( -10.0, 10.0 );
54+
}
55+
4356
/**
4457
* Creates a benchmark function.
4558
*
@@ -48,17 +61,7 @@ var opts = {
4861
* @returns {Function} benchmark function
4962
*/
5063
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float64Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
if ( randu() < 0.2 ) {
57-
x[ i ] = NaN;
58-
} else {
59-
x[ i ] = ( randu()*20.0 ) - 10.0;
60-
}
61-
}
64+
var x = filledarrayBy( len, 'float64', rand );
6265
return benchmark;
6366

6467
function benchmark( b ) {

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,29 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/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' );
2829
var pkg = require( './../package.json' ).name;
2930
var dnanmeanpn = require( './../lib/ndarray.js' );
3031

3132

3233
// FUNCTIONS //
3334

35+
/**
36+
* Returns a random value or `NaN`.
37+
*
38+
* @returns {number} random number or `NaN`
39+
*/
40+
function rand() {
41+
if ( bernoulli( 0.2 ) ) {
42+
return NaN;
43+
}
44+
return uniform( -10.0, 10.0 );
45+
}
46+
3447
/**
3548
* Creates a benchmark function.
3649
*
@@ -39,17 +52,7 @@ var dnanmeanpn = require( './../lib/ndarray.js' );
3952
* @returns {Function} benchmark function
4053
*/
4154
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float64Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
if ( randu() < 0.2 ) {
48-
x[ i ] = NaN;
49-
} else {
50-
x[ i ] = ( randu()*20.0 ) - 10.0;
51-
}
52-
}
55+
var x = filledarrayBy( len, 'float64', rand );
5356
return benchmark;
5457

5558
function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +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/base/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' );
2930
var tryRequire = require( '@stdlib/utils/try-require' );
3031
var pkg = require( './../package.json' ).name;
3132

@@ -40,6 +41,18 @@ var opts = {
4041

4142
// FUNCTIONS //
4243

44+
/**
45+
* Returns a random value or `NaN`.
46+
*
47+
* @returns {number} random number or `NaN`
48+
*/
49+
function rand() {
50+
if ( bernoulli( 0.2 ) ) {
51+
return NaN;
52+
}
53+
return uniform( -10.0, 10.0 );
54+
}
55+
4356
/**
4457
* Creates a benchmark function.
4558
*
@@ -48,17 +61,7 @@ var opts = {
4861
* @returns {Function} benchmark function
4962
*/
5063
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float64Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
if ( randu() < 0.2 ) {
57-
x[ i ] = NaN;
58-
} else {
59-
x[ i ] = ( randu()*20.0 ) - 10.0;
60-
}
61-
}
64+
var x = filledarrayBy( len, 'float64', rand );
6265
return benchmark;
6366

6467
function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ static double rand_double( void ) {
9494
* @param len array length
9595
* @return elapsed time in seconds
9696
*/
97-
static double benchmark( int iterations, int len ) {
97+
static double benchmark1( int iterations, int len ) {
9898
double elapsed;
9999
double x[ len ];
100100
double v;
@@ -107,6 +107,7 @@ static double benchmark( int iterations, int len ) {
107107
v = 0.0;
108108
t = tic();
109109
for ( i = 0; i < iterations; i++ ) {
110+
// cppcheck-suppress uninitvar
110111
v = stdlib_strided_dnanmeanpn( len, x, 1 );
111112
if ( v != v ) {
112113
printf( "should not return NaN\n" );
@@ -120,6 +121,40 @@ static double benchmark( int iterations, int len ) {
120121
return elapsed;
121122
}
122123

124+
/**
125+
* Runs a benchmark.
126+
*
127+
* @param iterations number of iterations
128+
* @param len array length
129+
* @return elapsed time in seconds
130+
*/
131+
static double benchmark2( int iterations, int len ) {
132+
double elapsed;
133+
double x[ len ];
134+
double v;
135+
double t;
136+
int i;
137+
138+
for ( i = 0; i < len; i++ ) {
139+
x[ i ] = ( rand_double() * 20000.0 ) - 10000.0;
140+
}
141+
v = 0.0;
142+
t = tic();
143+
for ( i = 0; i < iterations; i++ ) {
144+
// cppcheck-suppress uninitvar
145+
v = stdlib_strided_dnanmeanpn_ndarray( len, x, 1, 0 );
146+
if ( v != v ) {
147+
printf( "should not return NaN\n" );
148+
break;
149+
}
150+
}
151+
elapsed = tic() - t;
152+
if ( v != v ) {
153+
printf( "should not return NaN\n" );
154+
}
155+
return elapsed;
156+
}
157+
123158
/**
124159
* Main execution sequence.
125160
*/
@@ -142,7 +177,18 @@ int main( void ) {
142177
for ( j = 0; j < REPEATS; j++ ) {
143178
count += 1;
144179
printf( "# c::%s:len=%d\n", NAME, len );
145-
elapsed = benchmark( iter, len );
180+
elapsed = benchmark1( iter, len );
181+
print_results( iter, elapsed );
182+
printf( "ok %d benchmark finished\n", count );
183+
}
184+
}
185+
for ( i = MIN; i <= MAX; i++ ) {
186+
len = pow( 10, i );
187+
iter = ITERATIONS / pow( 10, i-1 );
188+
for ( j = 0; j < REPEATS; j++ ) {
189+
count += 1;
190+
printf( "# c::%s:ndarray:len=%d\n", NAME, len );
191+
elapsed = benchmark2( iter, len );
146192
print_results( iter, elapsed );
147193
printf( "ok %d benchmark finished\n", count );
148194
}

0 commit comments

Comments
 (0)