-
-
Notifications
You must be signed in to change notification settings - Fork 587
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add C ndarray
and refactor for stats/base/dmeanpn
#4726
base: develop
Are you sure you want to change the base?
Changes from all commits
2887967
ffa1357
ee78bc0
6d3d7df
3db0802
b6126f7
4b33018
0f02bdd
e0aeac3
b0b0a0c
1bfe09a
49653e8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -51,7 +51,7 @@ The [arithmetic mean][arithmetic-mean] is defined as | |||||||||||
var dmeanpn = require( '@stdlib/stats/base/dmeanpn' ); | ||||||||||||
``` | ||||||||||||
|
||||||||||||
#### dmeanpn( N, x, stride ) | ||||||||||||
#### dmeanpn( N, x, strideX ) | ||||||||||||
|
||||||||||||
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x` using a two-pass error correction algorithm. | ||||||||||||
|
||||||||||||
|
@@ -69,18 +69,16 @@ The function has the following parameters: | |||||||||||
|
||||||||||||
- **N**: number of indexed elements. | ||||||||||||
- **x**: input [`Float64Array`][@stdlib/array/float64]. | ||||||||||||
- **stride**: index increment for `x`. | ||||||||||||
- **strideX**: stride increment for `x`. | ||||||||||||
|
||||||||||||
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, | ||||||||||||
The `N` and `strideX` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`, | ||||||||||||
|
||||||||||||
```javascript | ||||||||||||
var Float64Array = require( '@stdlib/array/float64' ); | ||||||||||||
var floor = require( '@stdlib/math/base/special/floor' ); | ||||||||||||
|
||||||||||||
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); | ||||||||||||
var N = floor( x.length / 2 ); | ||||||||||||
|
||||||||||||
var v = dmeanpn( N, x, 2 ); | ||||||||||||
var v = dmeanpn( 4, x, 2 ); | ||||||||||||
// returns 1.25 | ||||||||||||
``` | ||||||||||||
|
||||||||||||
|
@@ -90,18 +88,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [ | |||||||||||
|
||||||||||||
```javascript | ||||||||||||
var Float64Array = require( '@stdlib/array/float64' ); | ||||||||||||
var floor = require( '@stdlib/math/base/special/floor' ); | ||||||||||||
|
||||||||||||
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); | ||||||||||||
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||||||||||||
|
||||||||||||
var N = floor( x0.length / 2 ); | ||||||||||||
|
||||||||||||
var v = dmeanpn( N, x1, 2 ); | ||||||||||||
var v = dmeanpn( 4, x1, 2 ); | ||||||||||||
// returns 1.25 | ||||||||||||
``` | ||||||||||||
|
||||||||||||
#### dmeanpn.ndarray( N, x, stride, offset ) | ||||||||||||
#### dmeanpn.ndarray( N, x, strideX, offsetX ) | ||||||||||||
|
||||||||||||
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array using a two-pass error correction algorithm and alternative indexing semantics. | ||||||||||||
|
||||||||||||
|
@@ -117,18 +112,16 @@ var v = dmeanpn.ndarray( N, x, 1, 0 ); | |||||||||||
|
||||||||||||
The function has the following additional parameters: | ||||||||||||
|
||||||||||||
- **offset**: starting index for `x`. | ||||||||||||
- **offsetX**: starting index for `x`. | ||||||||||||
|
||||||||||||
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 [arithmetic mean][arithmetic-mean] for every other value in `x` starting from the second value | ||||||||||||
|
||||||||||||
```javascript | ||||||||||||
var Float64Array = require( '@stdlib/array/float64' ); | ||||||||||||
var floor = require( '@stdlib/math/base/special/floor' ); | ||||||||||||
|
||||||||||||
var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); | ||||||||||||
var N = floor( x.length / 2 ); | ||||||||||||
|
||||||||||||
var v = dmeanpn.ndarray( N, x, 2, 1 ); | ||||||||||||
var v = dmeanpn.ndarray( 4, x, 2, 1 ); | ||||||||||||
// returns 1.25 | ||||||||||||
``` | ||||||||||||
|
||||||||||||
|
@@ -175,6 +168,101 @@ console.log( v ); | |||||||||||
|
||||||||||||
<!-- /.examples --> | ||||||||||||
|
||||||||||||
<!-- C usage documentation. --> | ||||||||||||
|
||||||||||||
<section class="usage"> | ||||||||||||
|
||||||||||||
### Usage | ||||||||||||
|
||||||||||||
```c | ||||||||||||
#include "stdlib/stats/base/dmeanpn.h" | ||||||||||||
``` | ||||||||||||
|
||||||||||||
#### stdlib_strided_dmeanpn( N, \*X, strideX ) | ||||||||||||
|
||||||||||||
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array using aa two-pass error correction algorithm. | ||||||||||||
|
||||||||||||
```c | ||||||||||||
const double x[] = { 1.0, -2.0, 2.0 }; | ||||||||||||
|
||||||||||||
double v = stdlib_strided_dmeanpn( x.length, x, 1 ); | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
// returns ~0.3333 | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
``` | ||||||||||||
|
||||||||||||
The function accepts the following arguments: | ||||||||||||
|
||||||||||||
- **N**: `[in] CBLAS_INT` number of indexed elements. | ||||||||||||
- **X**: `[in] double*` input array. | ||||||||||||
- **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||||||||||||
|
||||||||||||
```c | ||||||||||||
double stdlib_strided_dmeanpn( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); | ||||||||||||
``` | ||||||||||||
|
||||||||||||
#### stdlib_strided_dmeanpn_ndarray( N, \*X, strideX, offsetX ) | ||||||||||||
|
||||||||||||
Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array using a two-pass error correction algorithm and alternative indexing semantics. | ||||||||||||
|
||||||||||||
```c | ||||||||||||
const double x[] = { 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 }; | ||||||||||||
|
||||||||||||
double v = stdlib_strided_dmeanpn_ndarray( 4, x, 2, 1 ); | ||||||||||||
// returns 1.25 | ||||||||||||
``` | ||||||||||||
|
||||||||||||
The function accepts the following arguments: | ||||||||||||
|
||||||||||||
- **N**: `[in] CBLAS_INT` number of indexed elements. | ||||||||||||
- **X**: `[in] double*` input array. | ||||||||||||
- **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||||||||||||
- **offsetX**: `[in] CBLAS_INT` starting index for `X`. | ||||||||||||
|
||||||||||||
```c | ||||||||||||
double stdlib_strided_dmeanpn_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); | ||||||||||||
``` | ||||||||||||
|
||||||||||||
</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"> | ||||||||||||
|
||||||||||||
</section> | ||||||||||||
|
||||||||||||
<!-- /.notes --> | ||||||||||||
|
||||||||||||
<!-- C API usage examples. --> | ||||||||||||
|
||||||||||||
<section class="examples"> | ||||||||||||
|
||||||||||||
### Examples | ||||||||||||
|
||||||||||||
```c | ||||||||||||
#include "stdlib/stats/base/dmeanpn.h" | ||||||||||||
#include <stdio.h> | ||||||||||||
|
||||||||||||
int main( void ) { | ||||||||||||
// Create a strided array: | ||||||||||||
const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; | ||||||||||||
|
||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
// Compute the arithmetic mean: | ||||||||||||
double v = stdlib_strided_dmeanpn( 4, x, 2 ); | ||||||||||||
|
||||||||||||
// Print the result: | ||||||||||||
printf( "mean: %lf\n", v ); | ||||||||||||
} | ||||||||||||
``` | ||||||||||||
|
||||||||||||
</section> | ||||||||||||
|
||||||||||||
<!-- /.examples --> | ||||||||||||
|
||||||||||||
</section> | ||||||||||||
|
||||||||||||
<!-- /.c --> | ||||||||||||
|
||||||||||||
* * * | ||||||||||||
|
||||||||||||
<section class="references"> | ||||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,14 +21,20 @@ | |
// MODULES // | ||
|
||
var bench = require( '@stdlib/bench' ); | ||
var randu = require( '@stdlib/random/base/randu' ); | ||
var uniform = require( '@stdlib/random/array/uniform' ); | ||
var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
var pow = require( '@stdlib/math/base/special/pow' ); | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
var pkg = require( './../package.json' ).name; | ||
var dmeanpn = require( './../lib/dmeanpn.js' ); | ||
|
||
|
||
// VARIABLES // | ||
|
||
var options = { | ||
'dtype': 'float64' | ||
}; | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. for Ex:- /**
* Returns a random value or `NaN`.
*
* @private
* @returns {number} random number or `NaN`
**/
function rand() {
if ( bernoulli( 0.2 ) ) {
return NaN;
}
return uniform( -10.0, 10.0 );
} There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same goes for the rest of the |
||
/** | ||
|
@@ -39,13 +45,7 @@ var dmeanpn = require( './../lib/dmeanpn.js' ); | |
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( len ) { | ||
var x; | ||
var i; | ||
|
||
x = new Float64Array( len ); | ||
for ( i = 0; i < x.length; i++ ) { | ||
x[ i ] = ( randu()*20.0 ) - 10.0; | ||
} | ||
var x = uniform( len, -10.0, 10.0, options ); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need to use |
||
return benchmark; | ||
|
||
function benchmark( b ) { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.