-
-
Notifications
You must be signed in to change notification settings - Fork 869
feat: add C ndarray
and refactor for stats/base/dmeanpn
#4726
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
Closed
DhruvArvindSingh
wants to merge
19
commits into
stdlib-js:develop
from
DhruvArvindSingh:feat/ndarray_dmeanpn
Closed
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
2887967
feat: add C ndarray implementation for stats/base/dmeanpn
DhruvArvindSingh ffa1357
Merge branch 'stdlib-js:develop' into feat/ndarray_dmeanpn
DhruvArvindSingh ee78bc0
feat: add C ndarray implementation for stats/base/dmeanpn
DhruvArvindSingh 6d3d7df
fix: fixed minor error
DhruvArvindSingh 3db0802
fix: fixed test files
DhruvArvindSingh b6126f7
chore: minor issues
DhruvArvindSingh 4b33018
Merge branch 'stdlib-js:develop' into feat/ndarray_dmeanpn
DhruvArvindSingh 0f02bdd
refactor: refactored benchmark
DhruvArvindSingh e0aeac3
fix: src/main.c
DhruvArvindSingh b0b0a0c
Merge branch 'stdlib-js:develop' into feat/ndarray_dmeanpn
DhruvArvindSingh 1bfe09a
fix: tests of stats/base/dmeanpn
DhruvArvindSingh 49653e8
Update lib/node_modules/@stdlib/stats/base/dmeanpn/lib/ndarray.js
DhruvArvindSingh 3899530
fix: fixing mistakes
DhruvArvindSingh 33c4d14
fix: Update README.md
DhruvArvindSingh 0c32ffc
fix: Update README.md
DhruvArvindSingh 0a7b50f
fix: Update example.c
DhruvArvindSingh 1e95b9b
fix: update example.c
DhruvArvindSingh 03fd64d
Update lib/node_modules/@stdlib/stats/base/dmeanpn/README.md
DhruvArvindSingh d579d76
Update lib/node_modules/@stdlib/stats/base/dmeanpn/README.md
DhruvArvindSingh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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,107 @@ 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, -7.0, -2.0, 3.0, 4.0, 2.0 }; | ||||||||||||||
|
||||||||||||||
double v = stdlib_strided_dmeanpn( x.length, x, 2 ); | ||||||||||||||
// 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`. | ||||||||||||||
|
||||||||||||||
```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 }; | ||||||||||||||
|
||||||||||||||
// Specify the number of elements: | ||||||||||||||
const int N = 4; | ||||||||||||||
|
||||||||||||||
// Specify the stride length: | ||||||||||||||
Comment on lines
+251
to
+253
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
|
||||||||||||||
const int strideX = 2; | ||||||||||||||
|
||||||||||||||
// Compute the arithmetic mean: | ||||||||||||||
DhruvArvindSingh marked this conversation as resolved.
Show resolved
Hide resolved
Comment on lines
+254
to
+256
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
|
||||||||||||||
double v = stdlib_strided_dmeanpn( N, x, strideX ); | ||||||||||||||
|
||||||||||||||
// Print the result: | ||||||||||||||
printf( "mean: %lf\n", v ); | ||||||||||||||
} | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
</section> | ||||||||||||||
|
||||||||||||||
<!-- /.examples --> | ||||||||||||||
|
||||||||||||||
</section> | ||||||||||||||
|
||||||||||||||
<!-- /.c --> | ||||||||||||||
|
||||||||||||||
* * * | ||||||||||||||
|
||||||||||||||
<section class="references"> | ||||||||||||||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.