From ca8296567e42b4de91a0e891f3eca0b32abbee52 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 26 Mar 2025 21:21:46 +0530 Subject: [PATCH 1/4] feat: add `stats/strided/dnanmeanpn` Ref: https://github.com/stdlib-js/stdlib/issues/4797 --- 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: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../stats/strided/dnanmeanpn/README.md | 351 ++++++++++++++++++ .../strided/dnanmeanpn/benchmark/benchmark.js | 104 ++++++ .../dnanmeanpn/benchmark/benchmark.native.js | 113 ++++++ .../dnanmeanpn/benchmark/benchmark.ndarray.js | 104 ++++++ .../benchmark/benchmark.ndarray.native.js | 113 ++++++ .../strided/dnanmeanpn/benchmark/c/Makefile | 146 ++++++++ .../dnanmeanpn/benchmark/c/benchmark.length.c | 205 ++++++++++ .../stats/strided/dnanmeanpn/binding.gyp | 170 +++++++++ .../docs/img/equation_arithmetic_mean.svg | 42 +++ .../stats/strided/dnanmeanpn/docs/repl.txt | 94 +++++ .../strided/dnanmeanpn/docs/types/index.d.ts | 92 +++++ .../strided/dnanmeanpn/docs/types/test.ts | 157 ++++++++ .../strided/dnanmeanpn/examples/c/Makefile | 146 ++++++++ .../strided/dnanmeanpn/examples/c/example.c | 37 ++ .../strided/dnanmeanpn/examples/index.js | 40 ++ .../stats/strided/dnanmeanpn/include.gypi | 53 +++ .../include/stdlib/stats/strided/dnanmeanpn.h | 45 +++ .../strided/dnanmeanpn/lib/dnanmeanpn.js | 61 +++ .../dnanmeanpn/lib/dnanmeanpn.native.js | 51 +++ .../stats/strided/dnanmeanpn/lib/index.js | 68 ++++ .../stats/strided/dnanmeanpn/lib/main.js | 35 ++ .../stats/strided/dnanmeanpn/lib/native.js | 35 ++ .../stats/strided/dnanmeanpn/lib/ndarray.js | 97 +++++ .../strided/dnanmeanpn/lib/ndarray.native.js | 52 +++ .../stats/strided/dnanmeanpn/manifest.json | 99 +++++ .../stats/strided/dnanmeanpn/package.json | 76 ++++ .../stats/strided/dnanmeanpn/src/Makefile | 70 ++++ .../stats/strided/dnanmeanpn/src/addon.c | 62 ++++ .../stats/strided/dnanmeanpn/src/main.c | 99 +++++ .../dnanmeanpn/test/test.dnanmeanpn.js | 171 +++++++++ .../dnanmeanpn/test/test.dnanmeanpn.native.js | 262 +++++++++++++ .../stats/strided/dnanmeanpn/test/test.js | 82 ++++ .../strided/dnanmeanpn/test/test.ndarray.js | 168 +++++++++ .../dnanmeanpn/test/test.ndarray.native.js | 177 +++++++++ 34 files changed, 3677 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/README.md create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/img/equation_arithmetic_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/include/stdlib/stats/strided/dnanmeanpn.h create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/dnanmeanpn.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/dnanmeanpn.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/package.json create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/README.md new file mode 100644 index 000000000000..1ef646e2edef --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/README.md @@ -0,0 +1,351 @@ + + +# dnanmeanpn + +> Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. + +
+ +The [arithmetic mean][arithmetic-mean] is defined as + + + +```math +\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var dnanmeanpn = require( '@stdlib/stats/strided/dnanmeanpn' ); +``` + +#### dnanmeanpn( N, x, strideX ) + +Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values and using a two-pass error correction algorithm. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); + +var v = dnanmeanpn( x.length, x, 1 ); +// returns ~0.3333 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: stride length for `x`. + +The `N` and stride parameters determine which elements in the strided array 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 x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ] ); + +var v = dnanmeanpn( 5, x, 2 ); +// returns 1.25 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var v = dnanmeanpn( 5, x1, 2 ); +// returns 1.25 +``` + +#### dnanmeanpn.ndarray( N, x, strideX, offsetX ) + +Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); + +var v = dnanmeanpn.ndarray( x.length, x, 1, 0 ); +// returns ~0.33333 +``` + +The function has the following additional parameters: + +- **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 element in `x` starting from the second element + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); + +var v = dnanmeanpn.ndarray( 5, x, 2, 1 ); +// returns 1.25 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `NaN`. +- If every indexed element is `NaN`, both functions return `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dnanmeanpn = require( '@stdlib/stats/strided/dnanmeanpn' ); + +var x; +var i; + +x = new Float64Array( 10 ); +for ( i = 0; i < x.length; i++ ) { + if ( randu() < 0.2 ) { + x[ i ] = NaN; + } else { + x[ i ] = round( randu() * 10.0 ); + } +} +console.log( x ); + +var v = dnanmeanpn( x.length, x, 1 ); +console.log( v ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/strided/dnanmeanpn.h" +``` + +#### stdlib_strided_dnanmeanpn( N, \*X, strideX ) + +Computes arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. + +```c +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 }; + +double v = stdlib_strided_dnanmeanpn( 6, x, 2 ); +// returns ~4.6667 +``` + +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_dnanmeanpn( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnanmeanpn_ndarray( N, \*X, strideX, offsetX ) + +Computes the aithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. + +```c +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 }; + +double v = stdlib_strided_dnanmeanpn( 6, x, 2, 0 ); +// returns ~4.6667 +``` + +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_dnanmeanpn_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/strided/dnanmeanpn.h" +#include + +int main( void ) { + // Create a strided array: + 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 }; + + // Specify the number of elements: + const int N = 6; + + // Specify the stride length: + const int strideX = 2; + + // Compute the arithmetic mean: + double v = stdlib_strided_dnanmeanpn( N, x, strideX ); + + // Print the result: + printf( "mean: %lf\n", v ); +} +``` + +
+ + + +
+ + + +
+ +## References + +- Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958][@neely:1966a]. +- Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036][@schubert:2018a]. + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/stats/base/dmeanpn`][@stdlib/stats/base/dmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array using a two-pass error correction algorithm. +- [`@stdlib/stats/strided/dnanmean`][@stdlib/stats/strided/dnanmean]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values. +- [`@stdlib/stats/base/nanmeanpn`][@stdlib/stats/base/nanmeanpn]: calculate the arithmetic mean of a strided array, ignoring NaN values and using a two-pass error correction algorithm. +- [`@stdlib/stats/base/snanmeanpn`][@stdlib/stats/base/snanmeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. + +
+ + + + + +
+ +[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean + +[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +[@neely:1966a]: https://doi.org/10.1145/365719.365958 + +[@schubert:2018a]: https://doi.org/10.1145/3221269.3223036 + + + +[@stdlib/stats/base/dmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmeanpn + +[@stdlib/stats/strided/dnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmean + +[@stdlib/stats/base/nanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmeanpn + +[@stdlib/stats/base/snanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanmeanpn + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.js new file mode 100644 index 000000000000..781fe434d618 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var dnanmeanpn = require( './../lib/dnanmeanpn.js' ); + + +// FUNCTIONS // + +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = filledarrayBy( len, 'float64', rand ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = dnanmeanpn( x.length, x, 1 ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.native.js new file mode 100644 index 000000000000..d93fa5baf9d4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.native.js @@ -0,0 +1,113 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/dnanmeanpn.native.js' ) ); +var opts = { + 'skip': ( dnanmeanpn instanceof Error ) +}; + + +// FUNCTIONS // + +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = filledarrayBy( len, 'float64', rand ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = dnanmeanpn( x.length, x, 1 ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+'::native:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..30b12f97d2bd --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var dnanmeanpn = require( './../lib/ndarray.js' ); + + +// FUNCTIONS // + +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = filledarrayBy( len, 'float64', rand ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = dnanmeanpn( x.length, x, 1, 0 ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':ndarray:len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..56a18a6be70b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,113 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dnanmeanpn instanceof Error ) +}; + + +// FUNCTIONS // + +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = filledarrayBy( len, 'float64', rand ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = dnanmeanpn( x.length, x, 1, 0 ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+'::native:ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/Makefile new file mode 100644 index 000000000000..7280962b4c4d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2020 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..ce81ec85d19f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/benchmark/c/benchmark.length.c @@ -0,0 +1,205 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/dnanmeanpn.h" +#include +#include +#include +#include +#include + +#define NAME "dnanmeanpn" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + double x[ len ]; + double v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + if ( rand_double() < 0.2 ) { + x[ i ] = 0.0 / 0.0; // NaN + } else { + x[ i ] = ( rand_double()*20000.0 ) - 10000.0; + } + } + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_dnanmeanpn( len, x, 1 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double x[ len ]; + double v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + if ( rand_double() < 0.2 ) { + x[ i ] = 0.0 / 0.0; // NaN + } else { + x[ i ] = ( rand_double()*20000.0 ) - 10000.0; + } + } + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_dnanmeanpn_ndarray( len, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/binding.gyp b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/binding.gyp new file mode 100644 index 000000000000..7d0005b2e390 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2020 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/img/equation_arithmetic_mean.svg b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/img/equation_arithmetic_mean.svg new file mode 100644 index 000000000000..c31439606fb6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/img/equation_arithmetic_mean.svg @@ -0,0 +1,42 @@ + +mu equals StartFraction 1 Over n EndFraction sigma-summation Underscript i equals 0 Overscript n minus 1 Endscripts x Subscript i + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/repl.txt new file mode 100644 index 000000000000..6e4a3963dccb --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/repl.txt @@ -0,0 +1,94 @@ + +{{alias}}( N, x, strideX ) + Computes the arithmetic mean of a double-precision floating-point strided + array, ignoring `NaN` values and using a two-pass error correction + algorithm. + + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use a typed + array view. + + If `N <= 0`, the function returns `NaN`. + + If every indexed element is `NaN`, the function returns `NaN`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Stride length. + + Returns + ------- + out: number + The arithmetic mean. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, NaN, 2.0 ] ); + > {{alias}}( x.length, x, 1 ) + ~0.3333 + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] ); + > {{alias}}( 4, x, 2 ) + ~0.3333 + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > {{alias}}( 4, x1, 2 ) + ~-0.3333 + + +{{alias}}.ndarray( N, x, strideX, offsetX ) + Computes the arithmetic mean of a double-precision floating-point strided + array, ignoring `NaN` values and using a two-pass error correction algorithm + and alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameter supports indexing semantics based on a + starting index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Stride length. + + offsetX: integer + Starting index. + + Returns + ------- + out: number + The arithmetic mean. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, NaN, 2.0 ] ); + > {{alias}}.ndarray( x.length, x, 1, 0 ) + ~0.3333 + + // Using offset parameter: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); + > {{alias}}.ndarray( 4, x, 2, 1 ) + ~-0.3333 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/index.d.ts new file mode 100644 index 000000000000..4ceb7650acc4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/index.d.ts @@ -0,0 +1,92 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Interface describing `dnanmeanpn`. +*/ +interface Routine { + /** + * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @returns arithmetic mean + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); + * + * var v = dnanmeanpn( x.length, x, 1 ); + * // returns ~0.3333 + */ + ( N: number, x: Float64Array, strideX: number ): number; + + /** + * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @param offsetX - starting index + * @returns arithmetic mean + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); + * + * var v = dnanmeanpn.ndarray( x.length, x, 1, 0 ); + * // returns ~0.3333 + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number; +} + +/** +* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - stride length +* @returns arithmetic mean +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); +* +* var v = dnanmeanpn( x.length, x, 1 ); +* // returns ~0.3333 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); +* +* var v = dnanmeanpn.ndarray( x.length, x, 1, 0 ); +* // returns ~0.3333 +*/ +declare var dnanmeanpn: Routine; + + +// EXPORTS // + +export = dnanmeanpn; diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/test.ts new file mode 100644 index 000000000000..33651f5220c3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/docs/types/test.ts @@ -0,0 +1,157 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import dnanmeanpn = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn( x.length, x, 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn( '10', x, 1 ); // $ExpectError + dnanmeanpn( true, x, 1 ); // $ExpectError + dnanmeanpn( false, x, 1 ); // $ExpectError + dnanmeanpn( null, x, 1 ); // $ExpectError + dnanmeanpn( undefined, x, 1 ); // $ExpectError + dnanmeanpn( [], x, 1 ); // $ExpectError + dnanmeanpn( {}, x, 1 ); // $ExpectError + dnanmeanpn( ( x: number ): number => x, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn( x.length, 10, 1 ); // $ExpectError + dnanmeanpn( x.length, '10', 1 ); // $ExpectError + dnanmeanpn( x.length, true, 1 ); // $ExpectError + dnanmeanpn( x.length, false, 1 ); // $ExpectError + dnanmeanpn( x.length, null, 1 ); // $ExpectError + dnanmeanpn( x.length, undefined, 1 ); // $ExpectError + dnanmeanpn( x.length, [], 1 ); // $ExpectError + dnanmeanpn( x.length, {}, 1 ); // $ExpectError + dnanmeanpn( x.length, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn( x.length, x, '10' ); // $ExpectError + dnanmeanpn( x.length, x, true ); // $ExpectError + dnanmeanpn( x.length, x, false ); // $ExpectError + dnanmeanpn( x.length, x, null ); // $ExpectError + dnanmeanpn( x.length, x, undefined ); // $ExpectError + dnanmeanpn( x.length, x, [] ); // $ExpectError + dnanmeanpn( x.length, x, {} ); // $ExpectError + dnanmeanpn( x.length, x, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn(); // $ExpectError + dnanmeanpn( x.length ); // $ExpectError + dnanmeanpn( x.length, x ); // $ExpectError + dnanmeanpn( x.length, x, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn.ndarray( x.length, x, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn.ndarray( '10', x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( true, x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( false, x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( null, x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( undefined, x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( [], x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( {}, x, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( ( x: number ): number => x, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn.ndarray( x.length, 10, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, '10', 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, true, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, false, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, null, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, undefined, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, [], 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, {}, 1, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn.ndarray( x.length, x, '10', 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, true, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, false, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, null, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, undefined, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, [], 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, {}, 0 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn.ndarray( x.length, x, 1, '10' ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, true ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, false ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, null ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, undefined ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, [] ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, {} ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + + dnanmeanpn.ndarray(); // $ExpectError + dnanmeanpn.ndarray( x.length ); // $ExpectError + dnanmeanpn.ndarray( x.length, x ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1 ); // $ExpectError + dnanmeanpn.ndarray( x.length, x, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/Makefile new file mode 100644 index 000000000000..ff5293d3059f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2020 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/example.c new file mode 100644 index 000000000000..def80770b6e9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/c/example.c @@ -0,0 +1,37 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/dnanmeanpn.h" +#include + +int main( void ) { + // Create a strided array: + 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 }; + + // Specify the number of elements: + const int N = 6; + + // Specify the stride length: + const int strideX = 2; + + // Compute the arithmetic mean: + double v = stdlib_strided_dnanmeanpn( N, x, strideX ); + + // Print the result: + printf( "mean: %lf\n", v ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/index.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/index.js new file mode 100644 index 000000000000..f491ab5a9318 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/examples/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var randu = require( '@stdlib/random/base/randu' ); +var round = require( '@stdlib/math/base/special/round' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dnanmeanpn = require( './../lib' ); + +var x; +var i; + +x = new Float64Array( 10 ); +for ( i = 0; i < x.length; i++ ) { + if ( randu() < 0.2 ) { + x[ i ] = NaN; + } else { + x[ i ] = round( randu() * 10.0 ); + } +} +console.log( x ); + +var v = dnanmeanpn( x.length, x, 1 ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/include.gypi b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/include.gypi new file mode 100644 index 000000000000..26476a8c2655 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2020 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + '=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "average", + "avg", + "mean", + "arithmetic mean", + "central tendency", + "strided", + "strided array", + "typed", + "array", + "float64", + "double", + "float64array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/Makefile b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/Makefile new file mode 100644 index 000000000000..dd720a3de8f2 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2020 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/addon.c new file mode 100644 index 000000000000..ae655c555789 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/addon.c @@ -0,0 +1,62 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/dnanmeanpn.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_float64array.h" +#include "stdlib/napi/create_double.h" +#include "stdlib/blas/base/shared.h" +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmeanpn)( N, X, strideX ), v ); + return v; +} + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, offsetX ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) + diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/main.c b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/main.c new file mode 100644 index 000000000000..94dff02840b8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/src/main.c @@ -0,0 +1,99 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/dnanmeanpn.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. +* +* ## Method +* +* - This implementation uses a two-pass approach, as suggested by Neely (1966). +* +* ## References +* +* - Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958). +* - Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036). +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dnanmeanpn)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, ox ); +} + +/** +* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param offsetX starting index for X +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; + CBLAS_INT n; + double dn; + double s; + double t; + double v; + + if ( N <= 0 ) { + return 0.0 / 0.0; // NaN + } + if ( N == 1 || strideX == 0 ) { + return X[ offsetX ]; + } + ix = offsetX; + + // Compute an estimate for the mean... + s = 0.0; + n = 0; + for ( i = 0; i < N; i++ ) { + v = X[ ix ]; + if ( v == v ) { + n += 1; + s += v; + } + ix += strideX; + } + if ( n == 0 ) { + return 0.0 / 0.0; // NaN + } + dn = (double)n; + s /= dn; + + // Compute an error term... + ix = offsetX; + t = 0.0; + for ( i = 0; i < N; i++ ) { + v = X[ ix ]; + if ( v == v ) { + t += v - s; + } + ix += strideX; + } + return s + (t/dn); +} diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.js new file mode 100644 index 000000000000..b5493e3a60bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.js @@ -0,0 +1,171 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dnanmeanpn = require( './../lib/dnanmeanpn.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 3', function test( t ) { + t.strictEqual( dnanmeanpn.length, 3, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 1 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float64Array( [ -4.0, NaN ] ); + + v = dnanmeanpn( x.length, x, 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = new Float64Array( [ NaN, NaN ] ); + + v = dnanmeanpn( x.length, x, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 0, x, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = dnanmeanpn( -1, x, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 1, x, 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports a `stride` parameter', function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0, + NaN // 4 + ]); + + v = dnanmeanpn( 5, x, 2 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN // 0 + ]); + + v = dnanmeanpn( 5, x, -2 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var x0; + var x1; + var v; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0, + NaN // 4 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = dnanmeanpn( 5, x1, 2 ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.native.js new file mode 100644 index 000000000000..9f37ef260ca1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.dnanmeanpn.native.js @@ -0,0 +1,262 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/dnanmeanpn.native.js' ) ); +var opts = { + 'skip': ( dnanmeanpn instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 3', opts, function test( t ) { + t.strictEqual( dnanmeanpn.length, 3, 'has expected arity' ); + t.end(); +}); + +tape( 'the functions throws an error if provided a first argument which is not a number', opts, function test( t ) { + var values; + var i; + + values = [ + '5', + true, + false, + null, + void 0, + [], + {}, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dnanmeanpn( value, new Float64Array( 10 ), 1 ); + }; + } +}); + +tape( 'the functions throws an error if provided a second argument which is not a Float64Array', opts, function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + true, + false, + null, + void 0, + [], + {}, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dnanmeanpn( 10, value, 1 ); + }; + } +}); + +tape( 'the functions throws an error if provided a third argument which is not a number', opts, function test( t ) { + var values; + var i; + + values = [ + '5', + true, + false, + null, + void 0, + [], + {}, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dnanmeanpn( 10, new Float64Array( 10 ), value ); + }; + } +}); + +tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 1 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float64Array( [ -4.0, NaN ] ); + + v = dnanmeanpn( x.length, x, 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = new Float64Array( [ NaN, NaN ] ); + + v = dnanmeanpn( x.length, x, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 0, x, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = dnanmeanpn( -1, x, 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 1, x, 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports a `stride` parameter', opts, function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0, + NaN // 4 + ]); + + v = dnanmeanpn( 5, x, 2 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN // 0 + ]); + + v = dnanmeanpn( 5, x, -2 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var x0; + var x1; + var v; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0, + NaN // 4 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = dnanmeanpn( 5, x1, 2 ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.js new file mode 100644 index 000000000000..84b1718f83d7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); +var dnanmeanpn = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof dnanmeanpn.ndarray, 'function', 'method is a function' ); + t.end(); +}); + +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var dnanmeanpn = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dnanmeanpn, mock, 'returns expected value' ); + t.end(); + + function tryRequire() { + return mock; + } + + function mock() { + // Mock... + } +}); + +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var dnanmeanpn; + var main; + + main = require( './../lib/dnanmeanpn.js' ); + + dnanmeanpn = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dnanmeanpn, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.js new file mode 100644 index 000000000000..a0c68d707448 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.js @@ -0,0 +1,168 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dnanmeanpn = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', function test( t ) { + t.strictEqual( dnanmeanpn.length, 4, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 1, 0 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float64Array( [ -4.0, NaN ] ); + + v = dnanmeanpn( x.length, x, 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = new Float64Array( [ NaN, NaN ] ); + + v = dnanmeanpn( x.length, x, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 0, x, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = dnanmeanpn( -1, x, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 1, x, 1, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports a `stride` parameter', function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0, + NaN // 4 + ]); + + v = dnanmeanpn( 5, x, 2, 0 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN // 0 + ]); + + v = dnanmeanpn( 5, x, -2, 8 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 0, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offset` parameter', function test( t ) { + var x; + var v; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + NaN, + NaN // 4 + ]); + + v = dnanmeanpn( 5, x, 2, 1 ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.native.js new file mode 100644 index 000000000000..36b5d91bc985 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dnanmeanpn/test/test.ndarray.native.js @@ -0,0 +1,177 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dnanmeanpn instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', opts, function test( t ) { + t.strictEqual( dnanmeanpn.length, 4, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 1, 0 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float64Array( [ -4.0, NaN ] ); + + v = dnanmeanpn( x.length, x, 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = new Float64Array( [ NaN, NaN ] ); + + v = dnanmeanpn( x.length, x, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 0, x, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = dnanmeanpn( -1, x, 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( 1, x, 1, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports a `stride` parameter', opts, function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0, + NaN // 4 + ]); + + v = dnanmeanpn( 5, x, 2, 0 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { + var x; + var v; + + x = new Float64Array([ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN // 0 + ]); + + v = dnanmeanpn( 5, x, -2, 8 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnanmeanpn( x.length, x, 0, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offset` parameter', opts, function test( t ) { + var x; + var v; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + NaN, + NaN // 4 + ]); + + v = dnanmeanpn( 5, x, 2, 1 ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); From d59ec5be2d3e99a86e8b8aa4dc79b689fa677862 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 26 Mar 2025 21:23:34 +0530 Subject: [PATCH 2/4] remove: remove `stats/base/dnanmeanpn` from namespace This commit removes the `dnanmeanpn` symbol from the `@stdlib/stats/base` namespace due to a package migration. BREAKING CHANGE: remove `stats/base/dnanmeanpn` To migrate, users should access the same symbol via the `@stdlib/stats/strided/dnanmeanpn` namespace. Ref: https://github.com/stdlib-js/stdlib/issues/4797 --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/docs/types/index.d.ts | 27 ------------------- .../@stdlib/stats/base/lib/index.js | 9 ------- 2 files changed, 36 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts index b6e482d8a32e..ba35d97a4c98 100644 --- a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts @@ -35,7 +35,6 @@ import dmeanvarpn = require( '@stdlib/stats/base/dmeanvarpn' ); import dmskmax = require( '@stdlib/stats/base/dmskmax' ); import dmskmin = require( '@stdlib/stats/base/dmskmin' ); import dmskrange = require( '@stdlib/stats/base/dmskrange' ); -import dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); import dnanmeanpw = require( '@stdlib/stats/base/dnanmeanpw' ); import dnanmeanwd = require( '@stdlib/stats/base/dnanmeanwd' ); import dnanmin = require( '@stdlib/stats/base/dnanmin' ); @@ -644,32 +643,6 @@ interface Namespace { */ dmskrange: typeof dmskrange; - /** - * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @returns arithmetic mean - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); - * - * var v = ns.dnanmeanpn( x.length, x, 1 ); - * // returns ~0.3333 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); - * - * var v = ns.dnanmeanpn.ndarray( x.length, x, 1, 0 ); - * // returns ~0.3333 - */ - dnanmeanpn: typeof dnanmeanpn; - /** * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using pairwise summation. * diff --git a/lib/node_modules/@stdlib/stats/base/lib/index.js b/lib/node_modules/@stdlib/stats/base/lib/index.js index cd94806c147f..c91fa33ca131 100644 --- a/lib/node_modules/@stdlib/stats/base/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/lib/index.js @@ -171,15 +171,6 @@ setReadOnly( ns, 'dmskmin', require( '@stdlib/stats/base/dmskmin' ) ); */ setReadOnly( ns, 'dmskrange', require( '@stdlib/stats/base/dmskrange' ) ); -/** -* @name dnanmeanpn -* @memberof ns -* @readonly -* @type {Function} -* @see {@link module:@stdlib/stats/base/dnanmeanpn} -*/ -setReadOnly( ns, 'dnanmeanpn', require( '@stdlib/stats/base/dnanmeanpn' ) ); - /** * @name dnanmeanpw * @memberof ns From ea22b3a5335a43ac79e204c6cf1c92756f7bb091 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 26 Mar 2025 21:23:55 +0530 Subject: [PATCH 3/4] refactor: update paths Ref: https://github.com/stdlib-js/stdlib/issues/4797 --- 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: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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 --- --- .../@stdlib/namespace/lib/namespace/base/strided/d.js | 8 ++++---- .../@stdlib/namespace/lib/namespace/base/strided/n.js | 2 +- .../@stdlib/namespace/lib/namespace/base/strided/s.js | 2 +- lib/node_modules/@stdlib/stats/base/README.md | 4 ++-- lib/node_modules/@stdlib/stats/base/dmeanpn/README.md | 4 ++-- lib/node_modules/@stdlib/stats/base/dsnanmeanpn/README.md | 4 ++-- lib/node_modules/@stdlib/stats/base/nanmeanpn/README.md | 6 +++--- lib/node_modules/@stdlib/stats/base/snanmeanpn/README.md | 4 ++-- .../@stdlib/stats/strided/dnanmean/lib/ndarray.js | 2 +- .../@stdlib/stats/strided/dnanmean/manifest.json | 8 ++++---- .../@stdlib/stats/strided/dnanmean/src/main.c | 2 +- 11 files changed, 23 insertions(+), 23 deletions(-) diff --git a/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/d.js b/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/d.js index 4273bfa1d905..10bef09cbca7 100644 --- a/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/d.js +++ b/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/d.js @@ -567,7 +567,7 @@ ns.push({ 'type': 'Function', 'related': [ '@stdlib/stats/base/dmean', - '@stdlib/stats/base/dnanmeanpn', + '@stdlib/stats/strided/dnanmeanpn', '@stdlib/stats/base/meanpn', '@stdlib/stats/base/smeanpn' ] @@ -1044,8 +1044,8 @@ ns.push({ ns.push({ 'alias': 'base.strided.dnanmeanpn', - 'path': '@stdlib/stats/base/dnanmeanpn', - 'value': require( '@stdlib/stats/base/dnanmeanpn' ), + 'path': '@stdlib/stats/strided/dnanmeanpn', + 'value': require( '@stdlib/stats/strided/dnanmeanpn' ), 'type': 'Function', 'related': [ '@stdlib/stats/base/dmeanpn', @@ -1779,7 +1779,7 @@ ns.push({ 'value': require( '@stdlib/stats/base/dsnanmeanpn' ), 'type': 'Function', 'related': [ - '@stdlib/stats/base/dnanmeanpn', + '@stdlib/stats/strided/dnanmeanpn', '@stdlib/stats/base/dsmeanpn', '@stdlib/stats/base/dsnanmean', '@stdlib/stats/base/nanmeanpn', diff --git a/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/n.js b/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/n.js index 00e8d6a904f2..1e26bfc320cc 100644 --- a/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/n.js +++ b/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/n.js @@ -100,7 +100,7 @@ ns.push({ 'value': require( '@stdlib/stats/base/nanmeanpn' ), 'type': 'Function', 'related': [ - '@stdlib/stats/base/dnanmeanpn', + '@stdlib/stats/strided/dnanmeanpn', '@stdlib/stats/base/meanpn', '@stdlib/stats/base/nanmean', '@stdlib/stats/base/snanmeanpn' diff --git a/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/s.js b/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/s.js index 69eaaa638a4c..3f6a42ece5f8 100644 --- a/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/s.js +++ b/lib/node_modules/@stdlib/namespace/lib/namespace/base/strided/s.js @@ -1105,7 +1105,7 @@ ns.push({ 'value': require( '@stdlib/stats/base/snanmeanpn' ), 'type': 'Function', 'related': [ - '@stdlib/stats/base/dnanmeanpn', + '@stdlib/stats/strided/dnanmeanpn', '@stdlib/stats/base/nanmeanpn', '@stdlib/stats/base/smeanpn', '@stdlib/stats/base/snanmean' diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index 0b111e319c2a..4f57a4c10e26 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -71,7 +71,7 @@ The namespace contains the following statistical functions: - [`dmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmax]: calculate the maximum value of a double-precision floating-point strided array according to a mask. - [`dmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmin]: calculate the minimum value of a double-precision floating-point strided array according to a mask. - [`dmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskrange]: calculate the range of a double-precision floating-point strided array according to a mask. -- [`dnanmeanpn( N, x, strideX )`][@stdlib/stats/base/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. +- [`dnanmeanpn( N, x, strideX )`][@stdlib/stats/strided/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - [`dnanmeanpw( N, x, strideX )`][@stdlib/stats/base/dnanmeanpw]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using pairwise summation. - [`dnanmeanwd( N, x, strideX )`][@stdlib/stats/base/dnanmeanwd]: calculate the arithmetic mean of a double-precision floating-point strided array, using Welford's algorithm and ignoring `NaN` values. - [`dnanmin( N, x, strideX )`][@stdlib/stats/base/dnanmin]: calculate the minimum value of a double-precision floating-point strided array, ignoring `NaN` values. @@ -329,7 +329,7 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/dmskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmskrange -[@stdlib/stats/base/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpn +[@stdlib/stats/strided/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmeanpn [@stdlib/stats/base/dnanmeanpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpw diff --git a/lib/node_modules/@stdlib/stats/base/dmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dmeanpn/README.md index 73eda8656b1c..e79e27a38f12 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmeanpn/README.md @@ -197,7 +197,7 @@ console.log( v ); ## See Also - [`@stdlib/stats/base/dmean`][@stdlib/stats/base/dmean]: calculate the arithmetic mean of a double-precision floating-point strided array. -- [`@stdlib/stats/base/dnanmeanpn`][@stdlib/stats/base/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. +- [`@stdlib/stats/strided/dnanmeanpn`][@stdlib/stats/strided/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. - [`@stdlib/stats/base/meanpn`][@stdlib/stats/base/meanpn]: calculate the arithmetic mean of a strided array using a two-pass error correction algorithm. - [`@stdlib/stats/base/smeanpn`][@stdlib/stats/base/smeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array using a two-pass error correction algorithm. @@ -223,7 +223,7 @@ console.log( v ); [@stdlib/stats/base/dmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmean -[@stdlib/stats/base/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpn +[@stdlib/stats/strided/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmeanpn [@stdlib/stats/base/meanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/meanpn diff --git a/lib/node_modules/@stdlib/stats/base/dsnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dsnanmeanpn/README.md index caf99802374f..a8aa25b266b5 100644 --- a/lib/node_modules/@stdlib/stats/base/dsnanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/dsnanmeanpn/README.md @@ -314,7 +314,7 @@ int main( void ) { ## See Also -- [`@stdlib/stats/base/dnanmeanpn`][@stdlib/stats/base/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. +- [`@stdlib/stats/strided/dnanmeanpn`][@stdlib/stats/strided/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. - [`@stdlib/stats/base/dsmeanpn`][@stdlib/stats/base/dsmeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array using a two-pass error correction algorithm with extended accumulation and returning an extended precision result. - [`@stdlib/stats/base/dsnanmean`][@stdlib/stats/base/dsnanmean]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values, using extended accumulation, and returning an extended precision result. - [`@stdlib/stats/base/nanmeanpn`][@stdlib/stats/base/nanmeanpn]: calculate the arithmetic mean of a strided array, ignoring NaN values and using a two-pass error correction algorithm. @@ -341,7 +341,7 @@ int main( void ) { -[@stdlib/stats/base/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpn +[@stdlib/stats/strided/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmeanpn [@stdlib/stats/base/dsmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dsmeanpn diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/nanmeanpn/README.md index 4a48a17f883d..0315cbc99561 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmeanpn/README.md @@ -136,7 +136,7 @@ var v = nanmeanpn.ndarray( N, x, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - If every indexed element is `NaN`, both functions return `NaN`. -- Depending on the environment, the typed versions ([`dnanmeanpn`][@stdlib/stats/base/dnanmeanpn], [`snanmeanpn`][@stdlib/stats/base/snanmeanpn], etc.) are likely to be significantly more performant. +- Depending on the environment, the typed versions ([`dnanmeanpn`][@stdlib/stats/strided/dnanmeanpn], [`snanmeanpn`][@stdlib/stats/base/snanmeanpn], etc.) are likely to be significantly more performant. @@ -196,7 +196,7 @@ console.log( v ); ## See Also -- [`@stdlib/stats/base/dnanmeanpn`][@stdlib/stats/base/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. +- [`@stdlib/stats/strided/dnanmeanpn`][@stdlib/stats/strided/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. - [`@stdlib/stats/base/meanpn`][@stdlib/stats/base/meanpn]: calculate the arithmetic mean of a strided array using a two-pass error correction algorithm. - [`@stdlib/stats/base/nanmean`][@stdlib/stats/base/nanmean]: calculate the arithmetic mean of a strided array, ignoring NaN values. - [`@stdlib/stats/base/snanmeanpn`][@stdlib/stats/base/snanmeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. @@ -221,7 +221,7 @@ console.log( v ); -[@stdlib/stats/base/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpn +[@stdlib/stats/strided/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmeanpn [@stdlib/stats/base/meanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/meanpn diff --git a/lib/node_modules/@stdlib/stats/base/snanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/snanmeanpn/README.md index fd3db0d83922..5fe1fc1974e5 100644 --- a/lib/node_modules/@stdlib/stats/base/snanmeanpn/README.md +++ b/lib/node_modules/@stdlib/stats/base/snanmeanpn/README.md @@ -310,7 +310,7 @@ int main( void ) { ## See Also -- [`@stdlib/stats/base/dnanmeanpn`][@stdlib/stats/base/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. +- [`@stdlib/stats/strided/dnanmeanpn`][@stdlib/stats/strided/dnanmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. - [`@stdlib/stats/base/nanmeanpn`][@stdlib/stats/base/nanmeanpn]: calculate the arithmetic mean of a strided array, ignoring NaN values and using a two-pass error correction algorithm. - [`@stdlib/stats/base/smeanpn`][@stdlib/stats/base/smeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array using a two-pass error correction algorithm. - [`@stdlib/stats/base/snanmean`][@stdlib/stats/base/snanmean]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values. @@ -335,7 +335,7 @@ int main( void ) { -[@stdlib/stats/base/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmeanpn +[@stdlib/stats/strided/dnanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmeanpn [@stdlib/stats/base/nanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmeanpn diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/dnanmean/lib/ndarray.js index 9e8d811e0e39..ec0ff3d39f09 100644 --- a/lib/node_modules/@stdlib/stats/strided/dnanmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/dnanmean/lib/ndarray.js @@ -20,7 +20,7 @@ // MODULES // -var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray; +var dnanmeanpn = require( '@stdlib/stats/strided/dnanmeanpn' ).ndarray; // MAIN // diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmean/manifest.json b/lib/node_modules/@stdlib/stats/strided/dnanmean/manifest.json index fa26b6a6c37d..a8e303e431e3 100644 --- a/lib/node_modules/@stdlib/stats/strided/dnanmean/manifest.json +++ b/lib/node_modules/@stdlib/stats/strided/dnanmean/manifest.json @@ -40,7 +40,7 @@ "dependencies": [ "@stdlib/blas/base/shared", "@stdlib/strided/base/stride2offset", - "@stdlib/stats/base/dnanmeanpn", + "@stdlib/stats/strided/dnanmeanpn", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -62,7 +62,7 @@ "dependencies": [ "@stdlib/blas/base/shared", "@stdlib/strided/base/stride2offset", - "@stdlib/stats/base/dnanmeanpn" + "@stdlib/stats/strided/dnanmeanpn" ] }, { @@ -79,7 +79,7 @@ "dependencies": [ "@stdlib/blas/base/shared", "@stdlib/strided/base/stride2offset", - "@stdlib/stats/base/dnanmeanpn" + "@stdlib/stats/strided/dnanmeanpn" ] }, { @@ -96,7 +96,7 @@ "dependencies": [ "@stdlib/blas/base/shared", "@stdlib/strided/base/stride2offset", - "@stdlib/stats/base/dnanmeanpn" + "@stdlib/stats/strided/dnanmeanpn" ] } ] diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/strided/dnanmean/src/main.c index 8df973d6ec3d..3d5505055ec6 100644 --- a/lib/node_modules/@stdlib/stats/strided/dnanmean/src/main.c +++ b/lib/node_modules/@stdlib/stats/strided/dnanmean/src/main.c @@ -17,7 +17,7 @@ */ #include "stdlib/stats/strided/dnanmean.h" -#include "stdlib/stats/base/dnanmeanpn.h" +#include "stdlib/stats/strided/dnanmeanpn.h" #include "stdlib/blas/base/shared.h" #include "stdlib/strided/base/stride2offset.h" From 36c33742acaabe54f303076021c1311e4a0c6d15 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 26 Mar 2025 21:24:42 +0530 Subject: [PATCH 4/4] remove: remove `stats/base/dnanmeanpn` This commit removes `@stdlib/stats/base/dnanmeanpn` in favor of `@stdlib/stats/strided/dnanmeanpn`. BREAKING CHANGE: remove `stats/base/dnanmeanpn` To migrate, users should update their require/import paths to use `@stdlib/stats/strided/dnanmeanpn`, which provides the same API and implementation. Ref: https://github.com/stdlib-js/stdlib/issues/4797 --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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 --- --- .../@stdlib/stats/base/dnanmeanpn/README.md | 351 ------------------ .../base/dnanmeanpn/benchmark/benchmark.js | 104 ------ .../dnanmeanpn/benchmark/benchmark.native.js | 113 ------ .../dnanmeanpn/benchmark/benchmark.ndarray.js | 104 ------ .../benchmark/benchmark.ndarray.native.js | 113 ------ .../base/dnanmeanpn/benchmark/c/Makefile | 146 -------- .../dnanmeanpn/benchmark/c/benchmark.length.c | 205 ---------- .../@stdlib/stats/base/dnanmeanpn/binding.gyp | 170 --------- .../docs/img/equation_arithmetic_mean.svg | 42 --- .../stats/base/dnanmeanpn/docs/repl.txt | 94 ----- .../base/dnanmeanpn/docs/types/index.d.ts | 92 ----- .../stats/base/dnanmeanpn/docs/types/test.ts | 157 -------- .../stats/base/dnanmeanpn/examples/c/Makefile | 146 -------- .../base/dnanmeanpn/examples/c/example.c | 37 -- .../stats/base/dnanmeanpn/examples/index.js | 40 -- .../stats/base/dnanmeanpn/include.gypi | 53 --- .../include/stdlib/stats/base/dnanmeanpn.h | 45 --- .../stats/base/dnanmeanpn/lib/dnanmeanpn.js | 61 --- .../base/dnanmeanpn/lib/dnanmeanpn.native.js | 51 --- .../stats/base/dnanmeanpn/lib/index.js | 68 ---- .../@stdlib/stats/base/dnanmeanpn/lib/main.js | 35 -- .../stats/base/dnanmeanpn/lib/native.js | 35 -- .../stats/base/dnanmeanpn/lib/ndarray.js | 97 ----- .../base/dnanmeanpn/lib/ndarray.native.js | 52 --- .../stats/base/dnanmeanpn/manifest.json | 99 ----- .../stats/base/dnanmeanpn/package.json | 76 ---- .../stats/base/dnanmeanpn/src/Makefile | 70 ---- .../@stdlib/stats/base/dnanmeanpn/src/addon.c | 62 ---- .../@stdlib/stats/base/dnanmeanpn/src/main.c | 100 ----- .../base/dnanmeanpn/test/test.dnanmeanpn.js | 171 --------- .../dnanmeanpn/test/test.dnanmeanpn.native.js | 262 ------------- .../stats/base/dnanmeanpn/test/test.js | 82 ---- .../base/dnanmeanpn/test/test.ndarray.js | 168 --------- .../dnanmeanpn/test/test.ndarray.native.js | 177 --------- 34 files changed, 3678 deletions(-) delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/Makefile delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/binding.gyp delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/img/equation_arithmetic_mean.svg delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/test.ts delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/Makefile delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/include/stdlib/stats/base/dnanmeanpn.h delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/dnanmeanpn.native.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/index.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/main.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/native.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/lib/ndarray.native.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/manifest.json delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/package.json delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/Makefile delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js delete mode 100644 lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md deleted file mode 100644 index 7fb8a0f2c8bb..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/README.md +++ /dev/null @@ -1,351 +0,0 @@ - - -# dnanmeanpn - -> Calculate the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - -
- -The [arithmetic mean][arithmetic-mean] is defined as - - - -```math -\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i -``` - - - - - -
- - - -
- -## Usage - -```javascript -var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); -``` - -#### dnanmeanpn( N, x, strideX ) - -Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array `x`, ignoring `NaN` values and using a two-pass error correction algorithm. - -```javascript -var Float64Array = require( '@stdlib/array/float64' ); - -var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); - -var v = dnanmeanpn( x.length, x, 1 ); -// returns ~0.3333 -``` - -The function has the following parameters: - -- **N**: number of indexed elements. -- **x**: input [`Float64Array`][@stdlib/array/float64]. -- **strideX**: stride length for `x`. - -The `N` and stride parameters determine which elements in the strided array 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 x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ] ); - -var v = dnanmeanpn( 5, x, 2 ); -// returns 1.25 -``` - -Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. - - - -```javascript -var Float64Array = require( '@stdlib/array/float64' ); - -var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - -var v = dnanmeanpn( 5, x1, 2 ); -// returns 1.25 -``` - -#### dnanmeanpn.ndarray( N, x, strideX, offsetX ) - -Computes the [arithmetic mean][arithmetic-mean] of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. - -```javascript -var Float64Array = require( '@stdlib/array/float64' ); - -var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); - -var v = dnanmeanpn.ndarray( x.length, x, 1, 0 ); -// returns ~0.33333 -``` - -The function has the following additional parameters: - -- **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 element in `x` starting from the second element - - - -```javascript -var Float64Array = require( '@stdlib/array/float64' ); - -var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); - -var v = dnanmeanpn.ndarray( 5, x, 2, 1 ); -// returns 1.25 -``` - -
- - - -
- -## Notes - -- If `N <= 0`, both functions return `NaN`. -- If every indexed element is `NaN`, both functions return `NaN`. - -
- - - -
- -## Examples - - - -```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); -var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ); - -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( randu() * 10.0 ); - } -} -console.log( x ); - -var v = dnanmeanpn( x.length, x, 1 ); -console.log( v ); -``` - -
- - - - - -* * * - -
- -## C APIs - - - -
- -
- - - - - -
- -### Usage - -```c -#include "stdlib/stats/base/dnanmeanpn.h" -``` - -#### stdlib_strided_dnanmeanpn( N, \*X, strideX ) - -Computes arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - -```c -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 }; - -double v = stdlib_strided_dnanmeanpn( 6, x, 2 ); -// returns ~4.6667 -``` - -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_dnanmeanpn( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); -``` - -#### stdlib_strided_dnanmeanpn_ndarray( N, \*X, strideX, offsetX ) - -Computes the aithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. - -```c -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 }; - -double v = stdlib_strided_dnanmeanpn( 6, x, 2, 0 ); -// returns ~4.6667 -``` - -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_dnanmeanpn_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); -``` - -
- - - - - -
- -
- - - - - -
- -### Examples - -```c -#include "stdlib/stats/base/dnanmeanpn.h" -#include - -int main( void ) { - // Create a strided array: - 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 }; - - // Specify the number of elements: - const int N = 6; - - // Specify the stride length: - const int strideX = 2; - - // Compute the arithmetic mean: - double v = stdlib_strided_dnanmeanpn( N, x, strideX ); - - // Print the result: - printf( "mean: %lf\n", v ); -} -``` - -
- - - -
- - - -
- -## References - -- Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958][@neely:1966a]. -- Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036][@schubert:2018a]. - -
- - - - - -
- -* * * - -## See Also - -- [`@stdlib/stats/base/dmeanpn`][@stdlib/stats/base/dmeanpn]: calculate the arithmetic mean of a double-precision floating-point strided array using a two-pass error correction algorithm. -- [`@stdlib/stats/strided/dnanmean`][@stdlib/stats/strided/dnanmean]: calculate the arithmetic mean of a double-precision floating-point strided array, ignoring NaN values. -- [`@stdlib/stats/base/nanmeanpn`][@stdlib/stats/base/nanmeanpn]: calculate the arithmetic mean of a strided array, ignoring NaN values and using a two-pass error correction algorithm. -- [`@stdlib/stats/base/snanmeanpn`][@stdlib/stats/base/snanmeanpn]: calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values and using a two-pass error correction algorithm. - -
- - - - - -
- -[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean - -[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 - -[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray - -[@neely:1966a]: https://doi.org/10.1145/365719.365958 - -[@schubert:2018a]: https://doi.org/10.1145/3221269.3223036 - - - -[@stdlib/stats/base/dmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmeanpn - -[@stdlib/stats/strided/dnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmean - -[@stdlib/stats/base/nanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmeanpn - -[@stdlib/stats/base/snanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanmeanpn - - - -
- - diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js deleted file mode 100644 index 781fe434d618..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.js +++ /dev/null @@ -1,104 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var pow = require( '@stdlib/math/base/special/pow' ); -var pkg = require( './../package.json' ).name; -var dnanmeanpn = require( './../lib/dnanmeanpn.js' ); - - -// FUNCTIONS // - -/** -* Returns a random number. -* -* @private -* @returns {number} random number -*/ -function rand() { - if ( bernoulli( 0.8 ) < 1 ) { - return NaN; - } - return uniform( -10.0, 10.0 ); -} - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); - return benchmark; - - function benchmark( b ) { - var v; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = dnanmeanpn( x.length, x, 1 ); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':len='+len, f ); - } -} - -main(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js deleted file mode 100644 index d93fa5baf9d4..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.native.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var resolve = require( 'path' ).resolve; -var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var pow = require( '@stdlib/math/base/special/pow' ); -var tryRequire = require( '@stdlib/utils/try-require' ); -var pkg = require( './../package.json' ).name; - - -// VARIABLES // - -var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/dnanmeanpn.native.js' ) ); -var opts = { - 'skip': ( dnanmeanpn instanceof Error ) -}; - - -// FUNCTIONS // - -/** -* Returns a random number. -* -* @private -* @returns {number} random number -*/ -function rand() { - if ( bernoulli( 0.8 ) < 1 ) { - return NaN; - } - return uniform( -10.0, 10.0 ); -} - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); - return benchmark; - - function benchmark( b ) { - var v; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = dnanmeanpn( x.length, x, 1 ); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+'::native:len='+len, opts, f ); - } -} - -main(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js deleted file mode 100644 index 30b12f97d2bd..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.js +++ /dev/null @@ -1,104 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var pow = require( '@stdlib/math/base/special/pow' ); -var pkg = require( './../package.json' ).name; -var dnanmeanpn = require( './../lib/ndarray.js' ); - - -// FUNCTIONS // - -/** -* Returns a random number. -* -* @private -* @returns {number} random number -*/ -function rand() { - if ( bernoulli( 0.8 ) < 1 ) { - return NaN; - } - return uniform( -10.0, 10.0 ); -} - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); - return benchmark; - - function benchmark( b ) { - var v; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = dnanmeanpn( x.length, x, 1, 0 ); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':ndarray:len='+len, f ); - } -} - -main(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js deleted file mode 100644 index 56a18a6be70b..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/benchmark.ndarray.native.js +++ /dev/null @@ -1,113 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var resolve = require( 'path' ).resolve; -var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var pow = require( '@stdlib/math/base/special/pow' ); -var tryRequire = require( '@stdlib/utils/try-require' ); -var pkg = require( './../package.json' ).name; - - -// VARIABLES // - -var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); -var opts = { - 'skip': ( dnanmeanpn instanceof Error ) -}; - - -// FUNCTIONS // - -/** -* Returns a random number. -* -* @private -* @returns {number} random number -*/ -function rand() { - if ( bernoulli( 0.8 ) < 1 ) { - return NaN; - } - return uniform( -10.0, 10.0 ); -} - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', rand ); - return benchmark; - - function benchmark( b ) { - var v; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = dnanmeanpn( x.length, x, 1, 0 ); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+'::native:ndarray:len='+len, opts, f ); - } -} - -main(); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/Makefile deleted file mode 100644 index 7280962b4c4d..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/Makefile +++ /dev/null @@ -1,146 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2020 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# VARIABLES # - -ifndef VERBOSE - QUIET := @ -else - QUIET := -endif - -# Determine the OS ([1][1], [2][2]). -# -# [1]: https://en.wikipedia.org/wiki/Uname#Examples -# [2]: http://stackoverflow.com/a/27776822/2225624 -OS ?= $(shell uname) -ifneq (, $(findstring MINGW,$(OS))) - OS := WINNT -else -ifneq (, $(findstring MSYS,$(OS))) - OS := WINNT -else -ifneq (, $(findstring CYGWIN,$(OS))) - OS := WINNT -else -ifneq (, $(findstring Windows_NT,$(OS))) - OS := WINNT -endif -endif -endif -endif - -# Define the program used for compiling C source files: -ifdef C_COMPILER - CC := $(C_COMPILER) -else - CC := gcc -endif - -# Define the command-line options when compiling C files: -CFLAGS ?= \ - -std=c99 \ - -O3 \ - -Wall \ - -pedantic - -# Determine whether to generate position independent code ([1][1], [2][2]). -# -# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options -# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option -ifeq ($(OS), WINNT) - fPIC ?= -else - fPIC ?= -fPIC -endif - -# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): -INCLUDE ?= - -# List of source files: -SOURCE_FILES ?= - -# List of libraries (e.g., `-lopenblas -lpthread`): -LIBRARIES ?= - -# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): -LIBPATH ?= - -# List of C targets: -c_targets := benchmark.length.out - - -# RULES # - -#/ -# Compiles source files. -# -# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) -# @param {string} [CFLAGS] - C compiler options -# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) -# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) -# @param {string} [SOURCE_FILES] - list of source files -# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) -# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) -# -# @example -# make -# -# @example -# make all -#/ -all: $(c_targets) - -.PHONY: all - -#/ -# Compiles C source files. -# -# @private -# @param {string} CC - C compiler (e.g., `gcc`) -# @param {string} CFLAGS - C compiler options -# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) -# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) -# @param {string} SOURCE_FILES - list of source files -# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) -# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) -#/ -$(c_targets): %.out: %.c - $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) - -#/ -# Runs compiled benchmarks. -# -# @example -# make run -#/ -run: $(c_targets) - $(QUIET) ./$< - -.PHONY: run - -#/ -# Removes generated files. -# -# @example -# make clean -#/ -clean: - $(QUIET) -rm -f *.o *.out - -.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c deleted file mode 100644 index 86c2b30396d8..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/benchmark/c/benchmark.length.c +++ /dev/null @@ -1,205 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -#include "stdlib/stats/base/dnanmeanpn.h" -#include -#include -#include -#include -#include - -#define NAME "dnanmeanpn" -#define ITERATIONS 1000000 -#define REPEATS 3 -#define MIN 1 -#define MAX 6 - -/** -* Prints the TAP version. -*/ -static void print_version( void ) { - printf( "TAP version 13\n" ); -} - -/** -* Prints the TAP summary. -* -* @param total total number of tests -* @param passing total number of passing tests -*/ -static void print_summary( int total, int passing ) { - printf( "#\n" ); - printf( "1..%d\n", total ); // TAP plan - printf( "# total %d\n", total ); - printf( "# pass %d\n", passing ); - printf( "#\n" ); - printf( "# ok\n" ); -} - -/** -* Prints benchmarks results. -* -* @param iterations number of iterations -* @param elapsed elapsed time in seconds -*/ -static void print_results( int iterations, double elapsed ) { - double rate = (double)iterations / elapsed; - printf( " ---\n" ); - printf( " iterations: %d\n", iterations ); - printf( " elapsed: %0.9f\n", elapsed ); - printf( " rate: %0.9f\n", rate ); - printf( " ...\n" ); -} - -/** -* Returns a clock time. -* -* @return clock time -*/ -static double tic( void ) { - struct timeval now; - gettimeofday( &now, NULL ); - return (double)now.tv_sec + (double)now.tv_usec/1.0e6; -} - -/** -* Generates a random number on the interval [0,1). -* -* @return random number -*/ -static double rand_double( void ) { - int r = rand(); - return (double)r / ( (double)RAND_MAX + 1.0 ); -} - -/** -* Runs a benchmark. -* -* @param iterations number of iterations -* @param len array length -* @return elapsed time in seconds -*/ -static double benchmark1( int iterations, int len ) { - double elapsed; - double x[ len ]; - double v; - double t; - int i; - - for ( i = 0; i < len; i++ ) { - if ( rand_double() < 0.2 ) { - x[ i ] = 0.0 / 0.0; // NaN - } else { - x[ i ] = ( rand_double()*20000.0 ) - 10000.0; - } - } - v = 0.0; - t = tic(); - for ( i = 0; i < iterations; i++ ) { - // cppcheck-suppress uninitvar - v = stdlib_strided_dnanmeanpn( len, x, 1 ); - if ( v != v ) { - printf( "should not return NaN\n" ); - break; - } - } - elapsed = tic() - t; - if ( v != v ) { - printf( "should not return NaN\n" ); - } - return elapsed; -} - -/** -* Runs a benchmark. -* -* @param iterations number of iterations -* @param len array length -* @return elapsed time in seconds -*/ -static double benchmark2( int iterations, int len ) { - double elapsed; - double x[ len ]; - double v; - double t; - int i; - - for ( i = 0; i < len; i++ ) { - if ( rand_double() < 0.2 ) { - x[ i ] = 0.0 / 0.0; // NaN - } else { - x[ i ] = ( rand_double()*20000.0 ) - 10000.0; - } - } - v = 0.0; - t = tic(); - for ( i = 0; i < iterations; i++ ) { - // cppcheck-suppress uninitvar - v = stdlib_strided_dnanmeanpn_ndarray( len, x, 1, 0 ); - if ( v != v ) { - printf( "should not return NaN\n" ); - break; - } - } - elapsed = tic() - t; - if ( v != v ) { - printf( "should not return NaN\n" ); - } - return elapsed; -} - -/** -* Main execution sequence. -*/ -int main( void ) { - double elapsed; - int count; - int iter; - int len; - int i; - int j; - - // Use the current time to seed the random number generator: - srand( time( NULL ) ); - - print_version(); - count = 0; - for ( i = MIN; i <= MAX; i++ ) { - len = pow( 10, i ); - iter = ITERATIONS / pow( 10, i-1 ); - for ( j = 0; j < REPEATS; j++ ) { - count += 1; - printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark1( iter, len ); - print_results( iter, elapsed ); - printf( "ok %d benchmark finished\n", count ); - } - } - for ( i = MIN; i <= MAX; i++ ) { - len = pow( 10, i ); - iter = ITERATIONS / pow( 10, i-1 ); - for ( j = 0; j < REPEATS; j++ ) { - count += 1; - printf( "# c::%s:ndarray:len=%d\n", NAME, len ); - elapsed = benchmark2( iter, len ); - print_results( iter, elapsed ); - printf( "ok %d benchmark finished\n", count ); - } - } - print_summary( count, count ); -} diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/binding.gyp b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/binding.gyp deleted file mode 100644 index 7d0005b2e390..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/binding.gyp +++ /dev/null @@ -1,170 +0,0 @@ -# @license Apache-2.0 -# -# Copyright (c) 2020 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# A `.gyp` file for building a Node.js native add-on. -# -# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md -# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md -{ - # List of files to include in this file: - 'includes': [ - './include.gypi', - ], - - # Define variables to be used throughout the configuration for all targets: - 'variables': { - # Target name should match the add-on export name: - 'addon_target_name%': 'addon', - - # Set variables based on the host OS: - 'conditions': [ - [ - 'OS=="win"', - { - # Define the object file suffix: - 'obj': 'obj', - }, - { - # Define the object file suffix: - 'obj': 'o', - } - ], # end condition (OS=="win") - ], # end conditions - }, # end variables - - # Define compile targets: - 'targets': [ - - # Target to generate an add-on: - { - # The target name should match the add-on export name: - 'target_name': '<(addon_target_name)', - - # Define dependencies: - 'dependencies': [], - - # Define directories which contain relevant include headers: - 'include_dirs': [ - # Local include directory: - '<@(include_dirs)', - ], - - # List of source files: - 'sources': [ - '<@(src_files)', - ], - - # Settings which should be applied when a target's object files are used as linker input: - 'link_settings': { - # Define libraries: - 'libraries': [ - '<@(libraries)', - ], - - # Define library directories: - 'library_dirs': [ - '<@(library_dirs)', - ], - }, - - # C/C++ compiler flags: - 'cflags': [ - # Enable commonly used warning options: - '-Wall', - - # Aggressive optimization: - '-O3', - ], - - # C specific compiler flags: - 'cflags_c': [ - # Specify the C standard to which a program is expected to conform: - '-std=c99', - ], - - # C++ specific compiler flags: - 'cflags_cpp': [ - # Specify the C++ standard to which a program is expected to conform: - '-std=c++11', - ], - - # Linker flags: - 'ldflags': [], - - # Apply conditions based on the host OS: - 'conditions': [ - [ - 'OS=="mac"', - { - # Linker flags: - 'ldflags': [ - '-undefined dynamic_lookup', - '-Wl,-no-pie', - '-Wl,-search_paths_first', - ], - }, - ], # end condition (OS=="mac") - [ - 'OS!="win"', - { - # C/C++ flags: - 'cflags': [ - # Generate platform-independent code: - '-fPIC', - ], - }, - ], # end condition (OS!="win") - ], # end conditions - }, # end target <(addon_target_name) - - # Target to copy a generated add-on to a standard location: - { - 'target_name': 'copy_addon', - - # Declare that the output of this target is not linked: - 'type': 'none', - - # Define dependencies: - 'dependencies': [ - # Require that the add-on be generated before building this target: - '<(addon_target_name)', - ], - - # Define a list of actions: - 'actions': [ - { - 'action_name': 'copy_addon', - 'message': 'Copying addon...', - - # Explicitly list the inputs in the command-line invocation below: - 'inputs': [], - - # Declare the expected outputs: - 'outputs': [ - '<(addon_output_dir)/<(addon_target_name).node', - ], - - # Define the command-line invocation: - 'action': [ - 'cp', - '<(PRODUCT_DIR)/<(addon_target_name).node', - '<(addon_output_dir)/<(addon_target_name).node', - ], - }, - ], # end actions - }, # end target copy_addon - ], # end targets -} diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/img/equation_arithmetic_mean.svg b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/img/equation_arithmetic_mean.svg deleted file mode 100644 index c31439606fb6..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/img/equation_arithmetic_mean.svg +++ /dev/null @@ -1,42 +0,0 @@ - -mu equals StartFraction 1 Over n EndFraction sigma-summation Underscript i equals 0 Overscript n minus 1 Endscripts x Subscript i - - - \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt deleted file mode 100644 index 6e4a3963dccb..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( N, x, strideX ) - Computes the arithmetic mean of a double-precision floating-point strided - array, ignoring `NaN` values and using a two-pass error correction - algorithm. - - The `N` and stride parameters determine which elements in the strided array - are accessed at runtime. - - Indexing is relative to the first index. To introduce an offset, use a typed - array view. - - If `N <= 0`, the function returns `NaN`. - - If every indexed element is `NaN`, the function returns `NaN`. - - Parameters - ---------- - N: integer - Number of indexed elements. - - x: Float64Array - Input array. - - strideX: integer - Stride length. - - Returns - ------- - out: number - The arithmetic mean. - - Examples - -------- - // Standard Usage: - > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, NaN, 2.0 ] ); - > {{alias}}( x.length, x, 1 ) - ~0.3333 - - // Using `N` and stride parameters: - > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] ); - > {{alias}}( 4, x, 2 ) - ~0.3333 - - // Using view offsets: - > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); - > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > {{alias}}( 4, x1, 2 ) - ~-0.3333 - - -{{alias}}.ndarray( N, x, strideX, offsetX ) - Computes the arithmetic mean of a double-precision floating-point strided - array, ignoring `NaN` values and using a two-pass error correction algorithm - and alternative indexing semantics. - - While typed array views mandate a view offset based on the underlying - buffer, the offset parameter supports indexing semantics based on a - starting index. - - Parameters - ---------- - N: integer - Number of indexed elements. - - x: Float64Array - Input array. - - strideX: integer - Stride length. - - offsetX: integer - Starting index. - - Returns - ------- - out: number - The arithmetic mean. - - Examples - -------- - // Standard Usage: - > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, NaN, 2.0 ] ); - > {{alias}}.ndarray( x.length, x, 1, 0 ) - ~0.3333 - - // Using offset parameter: - > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); - > {{alias}}.ndarray( 4, x, 2, 1 ) - ~-0.3333 - - See Also - -------- - diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts deleted file mode 100644 index 4ceb7650acc4..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/index.d.ts +++ /dev/null @@ -1,92 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/** -* Interface describing `dnanmeanpn`. -*/ -interface Routine { - /** - * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @returns arithmetic mean - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); - * - * var v = dnanmeanpn( x.length, x, 1 ); - * // returns ~0.3333 - */ - ( N: number, x: Float64Array, strideX: number ): number; - - /** - * Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @param offsetX - starting index - * @returns arithmetic mean - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); - * - * var v = dnanmeanpn.ndarray( x.length, x, 1, 0 ); - * // returns ~0.3333 - */ - ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number; -} - -/** -* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. -* -* @param N - number of indexed elements -* @param x - input array -* @param strideX - stride length -* @returns arithmetic mean -* -* @example -* var Float64Array = require( '@stdlib/array/float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* -* var v = dnanmeanpn( x.length, x, 1 ); -* // returns ~0.3333 -* -* @example -* var Float64Array = require( '@stdlib/array/float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* -* var v = dnanmeanpn.ndarray( x.length, x, 1, 0 ); -* // returns ~0.3333 -*/ -declare var dnanmeanpn: Routine; - - -// EXPORTS // - -export = dnanmeanpn; diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/test.ts deleted file mode 100644 index 33651f5220c3..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/docs/types/test.ts +++ /dev/null @@ -1,157 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import dnanmeanpn = require( './index' ); - - -// TESTS // - -// The function returns a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn( x.length, x, 1 ); // $ExpectType number -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn( '10', x, 1 ); // $ExpectError - dnanmeanpn( true, x, 1 ); // $ExpectError - dnanmeanpn( false, x, 1 ); // $ExpectError - dnanmeanpn( null, x, 1 ); // $ExpectError - dnanmeanpn( undefined, x, 1 ); // $ExpectError - dnanmeanpn( [], x, 1 ); // $ExpectError - dnanmeanpn( {}, x, 1 ); // $ExpectError - dnanmeanpn( ( x: number ): number => x, x, 1 ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a Float64Array... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn( x.length, 10, 1 ); // $ExpectError - dnanmeanpn( x.length, '10', 1 ); // $ExpectError - dnanmeanpn( x.length, true, 1 ); // $ExpectError - dnanmeanpn( x.length, false, 1 ); // $ExpectError - dnanmeanpn( x.length, null, 1 ); // $ExpectError - dnanmeanpn( x.length, undefined, 1 ); // $ExpectError - dnanmeanpn( x.length, [], 1 ); // $ExpectError - dnanmeanpn( x.length, {}, 1 ); // $ExpectError - dnanmeanpn( x.length, ( x: number ): number => x, 1 ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn( x.length, x, '10' ); // $ExpectError - dnanmeanpn( x.length, x, true ); // $ExpectError - dnanmeanpn( x.length, x, false ); // $ExpectError - dnanmeanpn( x.length, x, null ); // $ExpectError - dnanmeanpn( x.length, x, undefined ); // $ExpectError - dnanmeanpn( x.length, x, [] ); // $ExpectError - dnanmeanpn( x.length, x, {} ); // $ExpectError - dnanmeanpn( x.length, x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn(); // $ExpectError - dnanmeanpn( x.length ); // $ExpectError - dnanmeanpn( x.length, x ); // $ExpectError - dnanmeanpn( x.length, x, 1, 10 ); // $ExpectError -} - -// Attached to main export is an `ndarray` method which returns a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn.ndarray( x.length, x, 1, 0 ); // $ExpectType number -} - -// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn.ndarray( '10', x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( true, x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( false, x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( null, x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( undefined, x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( [], x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( {}, x, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( ( x: number ): number => x, x, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn.ndarray( x.length, 10, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, '10', 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, true, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, false, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, null, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, undefined, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, [], 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, {}, 1, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, ( x: number ): number => x, 1, 0 ); // $ExpectError -} - -// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn.ndarray( x.length, x, '10', 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, true, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, false, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, null, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, undefined, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, [], 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, {}, 0 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, ( x: number ): number => x, 0 ); // $ExpectError -} - -// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn.ndarray( x.length, x, 1, '10' ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, true ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, false ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, null ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, undefined ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, [] ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, {} ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... -{ - const x = new Float64Array( 10 ); - - dnanmeanpn.ndarray(); // $ExpectError - dnanmeanpn.ndarray( x.length ); // $ExpectError - dnanmeanpn.ndarray( x.length, x ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1 ); // $ExpectError - dnanmeanpn.ndarray( x.length, x, 1, 0, 10 ); // $ExpectError -} diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/Makefile deleted file mode 100644 index ff5293d3059f..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/Makefile +++ /dev/null @@ -1,146 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2020 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# VARIABLES # - -ifndef VERBOSE - QUIET := @ -else - QUIET := -endif - -# Determine the OS ([1][1], [2][2]). -# -# [1]: https://en.wikipedia.org/wiki/Uname#Examples -# [2]: http://stackoverflow.com/a/27776822/2225624 -OS ?= $(shell uname) -ifneq (, $(findstring MINGW,$(OS))) - OS := WINNT -else -ifneq (, $(findstring MSYS,$(OS))) - OS := WINNT -else -ifneq (, $(findstring CYGWIN,$(OS))) - OS := WINNT -else -ifneq (, $(findstring Windows_NT,$(OS))) - OS := WINNT -endif -endif -endif -endif - -# Define the program used for compiling C source files: -ifdef C_COMPILER - CC := $(C_COMPILER) -else - CC := gcc -endif - -# Define the command-line options when compiling C files: -CFLAGS ?= \ - -std=c99 \ - -O3 \ - -Wall \ - -pedantic - -# Determine whether to generate position independent code ([1][1], [2][2]). -# -# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options -# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option -ifeq ($(OS), WINNT) - fPIC ?= -else - fPIC ?= -fPIC -endif - -# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): -INCLUDE ?= - -# List of source files: -SOURCE_FILES ?= - -# List of libraries (e.g., `-lopenblas -lpthread`): -LIBRARIES ?= - -# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): -LIBPATH ?= - -# List of C targets: -c_targets := example.out - - -# RULES # - -#/ -# Compiles source files. -# -# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) -# @param {string} [CFLAGS] - C compiler options -# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) -# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) -# @param {string} [SOURCE_FILES] - list of source files -# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) -# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) -# -# @example -# make -# -# @example -# make all -#/ -all: $(c_targets) - -.PHONY: all - -#/ -# Compiles C source files. -# -# @private -# @param {string} CC - C compiler (e.g., `gcc`) -# @param {string} CFLAGS - C compiler options -# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) -# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) -# @param {string} SOURCE_FILES - list of source files -# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) -# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) -#/ -$(c_targets): %.out: %.c - $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) - -#/ -# Runs compiled examples. -# -# @example -# make run -#/ -run: $(c_targets) - $(QUIET) ./$< - -.PHONY: run - -#/ -# Removes generated files. -# -# @example -# make clean -#/ -clean: - $(QUIET) -rm -f *.o *.out - -.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c deleted file mode 100644 index 5b8115ae0169..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/c/example.c +++ /dev/null @@ -1,37 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -#include "stdlib/stats/base/dnanmeanpn.h" -#include - -int main( void ) { - // Create a strided array: - 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 }; - - // Specify the number of elements: - const int N = 6; - - // Specify the stride length: - const int strideX = 2; - - // Compute the arithmetic mean: - double v = stdlib_strided_dnanmeanpn( N, x, strideX ); - - // Print the result: - printf( "mean: %lf\n", v ); -} diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js deleted file mode 100644 index f491ab5a9318..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/examples/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); -var dnanmeanpn = require( './../lib' ); - -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( randu() * 10.0 ); - } -} -console.log( x ); - -var v = dnanmeanpn( x.length, x, 1 ); -console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi deleted file mode 100644 index 26476a8c2655..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/include.gypi +++ /dev/null @@ -1,53 +0,0 @@ -# @license Apache-2.0 -# -# Copyright (c) 2020 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# A GYP include file for building a Node.js native add-on. -# -# Main documentation: -# -# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md -# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md -{ - # Define variables to be used throughout the configuration for all targets: - 'variables': { - # Source directory: - 'src_dir': './src', - - # Include directories: - 'include_dirs': [ - '=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], - "keywords": [ - "stdlib", - "stdmath", - "statistics", - "stats", - "mathematics", - "math", - "average", - "avg", - "mean", - "arithmetic mean", - "central tendency", - "strided", - "strided array", - "typed", - "array", - "float64", - "double", - "float64array" - ], - "__stdlib__": {} -} diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/Makefile b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/Makefile deleted file mode 100644 index dd720a3de8f2..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/Makefile +++ /dev/null @@ -1,70 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2020 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# VARIABLES # - -ifndef VERBOSE - QUIET := @ -else - QUIET := -endif - -# Determine the OS ([1][1], [2][2]). -# -# [1]: https://en.wikipedia.org/wiki/Uname#Examples -# [2]: http://stackoverflow.com/a/27776822/2225624 -OS ?= $(shell uname) -ifneq (, $(findstring MINGW,$(OS))) - OS := WINNT -else -ifneq (, $(findstring MSYS,$(OS))) - OS := WINNT -else -ifneq (, $(findstring CYGWIN,$(OS))) - OS := WINNT -else -ifneq (, $(findstring Windows_NT,$(OS))) - OS := WINNT -endif -endif -endif -endif - - -# RULES # - -#/ -# Removes generated files for building an add-on. -# -# @example -# make clean-addon -#/ -clean-addon: - $(QUIET) -rm -f *.o *.node - -.PHONY: clean-addon - -#/ -# Removes generated files. -# -# @example -# make clean -#/ -clean: clean-addon - -.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c deleted file mode 100644 index 9ae77c7746c2..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/addon.c +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -#include "stdlib/stats/base/dnanmeanpn.h" -#include "stdlib/napi/export.h" -#include "stdlib/napi/argv.h" -#include "stdlib/napi/argv_int64.h" -#include "stdlib/napi/argv_strided_float64array.h" -#include "stdlib/napi/create_double.h" -#include "stdlib/blas/base/shared.h" -#include - -/** -* Receives JavaScript callback invocation data. -* -* @param env environment under which the function is invoked -* @param info callback data -* @return Node-API value -*/ -static napi_value addon( napi_env env, napi_callback_info info ) { - STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); - STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); - STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmeanpn)( N, X, strideX ), v ); - return v; -} - -/** -* Receives JavaScript callback invocation data. -* -* @param env environment under which the function is invoked -* @param info callback data -* @return Node-API value -*/ -static napi_value addon_method( napi_env env, napi_callback_info info ) { - STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); - STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); - STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); - STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, offsetX ), v ); - return v; -} - -STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) - diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c deleted file mode 100644 index 3536233018ed..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/src/main.c +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -#include "stdlib/stats/base/dnanmeanpn.h" -#include "stdlib/blas/base/shared.h" -#include "stdlib/strided/base/stride2offset.h" - -/** -* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm. -* -* ## Method -* -* - This implementation uses a two-pass approach, as suggested by Neely (1966). -* -* ## References -* -* - Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958](https://doi.org/10.1145/365719.365958). -* - Schubert, Erich, and Michael Gertz. 2018. "Numerically Stable Parallel Computation of (Co-)Variance." In _Proceedings of the 30th International Conference on Scientific and Statistical Database Management_. New York, NY, USA: Association for Computing Machinery. doi:[10.1145/3221269.3223036](https://doi.org/10.1145/3221269.3223036). -* -* @param N number of indexed elements -* @param X input array -* @param strideX stride length -* @return output value -*/ -double API_SUFFIX(stdlib_strided_dnanmeanpn)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { - const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); - return API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, ox ); -} - -/** -* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm and alternative indexing semantics. -* -* @param N number of indexed elements -* @param X input array -* @param strideX stride length -* @param offsetX starting index for X -* @return output value -*/ -double API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { - CBLAS_INT ix; - CBLAS_INT i; - CBLAS_INT n; - CBLAS_INT o; - double dn; - double s; - double t; - double v; - - if ( N <= 0 ) { - return 0.0 / 0.0; // NaN - } - if ( N == 1 || strideX == 0 ) { - return X[ offsetX ]; - } - ix = offsetX; - - // Compute an estimate for the mean... - s = 0.0; - n = 0; - for ( i = 0; i < N; i++ ) { - v = X[ ix ]; - if ( v == v ) { - n += 1; - s += v; - } - ix += strideX; - } - if ( n == 0 ) { - return 0.0 / 0.0; // NaN - } - dn = (double)n; - s /= dn; - - // Compute an error term... - ix = offsetX; - t = 0.0; - for ( i = 0; i < N; i++ ) { - v = X[ ix ]; - if ( v == v ) { - t += v - s; - } - ix += strideX; - } - return s + (t/dn); -} diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js deleted file mode 100644 index b5493e3a60bf..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.js +++ /dev/null @@ -1,171 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Float64Array = require( '@stdlib/array/float64' ); -var dnanmeanpn = require( './../lib/dnanmeanpn.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function has an arity of 3', function test( t ) { - t.strictEqual( dnanmeanpn.length, 3, 'has expected arity' ); - t.end(); -}); - -tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 1 ); - t.strictEqual( v, 0.5, 'returns expected value' ); - - x = new Float64Array( [ -4.0, NaN ] ); - - v = dnanmeanpn( x.length, x, 1 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = new Float64Array( [ NaN, NaN ] ); - - v = dnanmeanpn( x.length, x, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 0, x, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - v = dnanmeanpn( -1, x, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 1, x, 1 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports a `stride` parameter', function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 0 - 2.0, - 2.0, // 1 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 3 - 2.0, - NaN // 4 - ]); - - v = dnanmeanpn( 5, x, 2 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports a negative `stride` parameter', function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 4 - 2.0, - 2.0, // 3 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 1 - 2.0, - NaN // 0 - ]); - - v = dnanmeanpn( 5, x, -2 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports view offsets', function test( t ) { - var x0; - var x1; - var v; - - x0 = new Float64Array([ - 2.0, - 1.0, // 0 - 2.0, - -2.0, // 1 - -2.0, - 2.0, // 2 - 3.0, - 4.0, // 3 - 6.0, - NaN // 4 - ]); - - x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - - v = dnanmeanpn( 5, x1, 2 ); - t.strictEqual( v, 1.25, 'returns expected value' ); - - t.end(); -}); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js deleted file mode 100644 index 9f37ef260ca1..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.dnanmeanpn.native.js +++ /dev/null @@ -1,262 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var resolve = require( 'path' ).resolve; -var tape = require( 'tape' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Float64Array = require( '@stdlib/array/float64' ); -var tryRequire = require( '@stdlib/utils/try-require' ); - - -// VARIABLES // - -var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/dnanmeanpn.native.js' ) ); -var opts = { - 'skip': ( dnanmeanpn instanceof Error ) -}; - - -// TESTS // - -tape( 'main export is a function', opts, function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function has an arity of 3', opts, function test( t ) { - t.strictEqual( dnanmeanpn.length, 3, 'has expected arity' ); - t.end(); -}); - -tape( 'the functions throws an error if provided a first argument which is not a number', opts, function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - dnanmeanpn( value, new Float64Array( 10 ), 1 ); - }; - } -}); - -tape( 'the functions throws an error if provided a second argument which is not a Float64Array', opts, function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - dnanmeanpn( 10, value, 1 ); - }; - } -}); - -tape( 'the functions throws an error if provided a third argument which is not a number', opts, function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - dnanmeanpn( 10, new Float64Array( 10 ), value ); - }; - } -}); - -tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 1 ); - t.strictEqual( v, 0.5, 'returns expected value' ); - - x = new Float64Array( [ -4.0, NaN ] ); - - v = dnanmeanpn( x.length, x, 1 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = new Float64Array( [ NaN, NaN ] ); - - v = dnanmeanpn( x.length, x, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 0, x, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - v = dnanmeanpn( -1, x, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 1, x, 1 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 0 - 2.0, - 2.0, // 1 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 3 - 2.0, - NaN // 4 - ]); - - v = dnanmeanpn( 5, x, 2 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 4 - 2.0, - 2.0, // 3 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 1 - 2.0, - NaN // 0 - ]); - - v = dnanmeanpn( 5, x, -2 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports view offsets', opts, function test( t ) { - var x0; - var x1; - var v; - - x0 = new Float64Array([ - 2.0, - 1.0, // 0 - 2.0, - -2.0, // 1 - -2.0, - 2.0, // 2 - 3.0, - 4.0, // 3 - 6.0, - NaN // 4 - ]); - - x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - - v = dnanmeanpn( 5, x1, 2 ); - t.strictEqual( v, 1.25, 'returns expected value' ); - - t.end(); -}); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.js deleted file mode 100644 index 84b1718f83d7..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var proxyquire = require( 'proxyquire' ); -var IS_BROWSER = require( '@stdlib/assert/is-browser' ); -var dnanmeanpn = require( './../lib' ); - - -// VARIABLES // - -var opts = { - 'skip': IS_BROWSER -}; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { - t.strictEqual( typeof dnanmeanpn.ndarray, 'function', 'method is a function' ); - t.end(); -}); - -tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { - var dnanmeanpn = proxyquire( './../lib', { - '@stdlib/utils/try-require': tryRequire - }); - - t.strictEqual( dnanmeanpn, mock, 'returns expected value' ); - t.end(); - - function tryRequire() { - return mock; - } - - function mock() { - // Mock... - } -}); - -tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { - var dnanmeanpn; - var main; - - main = require( './../lib/dnanmeanpn.js' ); - - dnanmeanpn = proxyquire( './../lib', { - '@stdlib/utils/try-require': tryRequire - }); - - t.strictEqual( dnanmeanpn, main, 'returns expected value' ); - t.end(); - - function tryRequire() { - return new Error( 'Cannot find module' ); - } -}); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js deleted file mode 100644 index a0c68d707448..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.js +++ /dev/null @@ -1,168 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Float64Array = require( '@stdlib/array/float64' ); -var dnanmeanpn = require( './../lib/ndarray.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function has an arity of 4', function test( t ) { - t.strictEqual( dnanmeanpn.length, 4, 'has expected arity' ); - t.end(); -}); - -tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 1, 0 ); - t.strictEqual( v, 0.5, 'returns expected value' ); - - x = new Float64Array( [ -4.0, NaN ] ); - - v = dnanmeanpn( x.length, x, 1, 0 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = new Float64Array( [ NaN, NaN ] ); - - v = dnanmeanpn( x.length, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 0, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - v = dnanmeanpn( -1, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 1, x, 1, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports a `stride` parameter', function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 0 - 2.0, - 2.0, // 1 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 3 - 2.0, - NaN // 4 - ]); - - v = dnanmeanpn( 5, x, 2, 0 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports a negative `stride` parameter', function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 4 - 2.0, - 2.0, // 3 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 1 - 2.0, - NaN // 0 - ]); - - v = dnanmeanpn( 5, x, -2, 8 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports an `offset` parameter', function test( t ) { - var x; - var v; - - x = new Float64Array([ - 2.0, - 1.0, // 0 - 2.0, - -2.0, // 1 - -2.0, - 2.0, // 2 - 3.0, - 4.0, // 3 - NaN, - NaN // 4 - ]); - - v = dnanmeanpn( 5, x, 2, 1 ); - t.strictEqual( v, 1.25, 'returns expected value' ); - - t.end(); -}); diff --git a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js deleted file mode 100644 index 36b5d91bc985..000000000000 --- a/lib/node_modules/@stdlib/stats/base/dnanmeanpn/test/test.ndarray.native.js +++ /dev/null @@ -1,177 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var resolve = require( 'path' ).resolve; -var tape = require( 'tape' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Float64Array = require( '@stdlib/array/float64' ); -var tryRequire = require( '@stdlib/utils/try-require' ); - - -// VARIABLES // - -var dnanmeanpn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); -var opts = { - 'skip': ( dnanmeanpn instanceof Error ) -}; - - -// TESTS // - -tape( 'main export is a function', opts, function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof dnanmeanpn, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function has an arity of 4', opts, function test( t ) { - t.strictEqual( dnanmeanpn.length, 4, 'has expected arity' ); - t.end(); -}); - -tape( 'the function calculates the arithmetic mean of a strided array, ignoring `NaN` values', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 1, 0 ); - t.strictEqual( v, 0.5, 'returns expected value' ); - - x = new Float64Array( [ -4.0, NaN ] ); - - v = dnanmeanpn( x.length, x, 1, 0 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = new Float64Array( [ NaN, NaN ] ); - - v = dnanmeanpn( x.length, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 0, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - v = dnanmeanpn( -1, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( 1, x, 1, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 0 - 2.0, - 2.0, // 1 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 3 - 2.0, - NaN // 4 - ]); - - v = dnanmeanpn( 5, x, 2, 0 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var x; - var v; - - x = new Float64Array([ - 1.0, // 4 - 2.0, - 2.0, // 3 - -7.0, - -2.0, // 2 - 3.0, - 4.0, // 1 - 2.0, - NaN // 0 - ]); - - v = dnanmeanpn( 5, x, -2, 8 ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -}); - -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', opts, function test( t ) { - var x; - var v; - - x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); - - v = dnanmeanpn( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports an `offset` parameter', opts, function test( t ) { - var x; - var v; - - x = new Float64Array([ - 2.0, - 1.0, // 0 - 2.0, - -2.0, // 1 - -2.0, - 2.0, // 2 - 3.0, - 4.0, // 3 - NaN, - NaN // 4 - ]); - - v = dnanmeanpn( 5, x, 2, 1 ); - t.strictEqual( v, 1.25, 'returns expected value' ); - - t.end(); -});