From 585cc71b806fd1c0c6322246057a4588032d70e8 Mon Sep 17 00:00:00 2001 From: iampratik13 Date: Tue, 3 Feb 2026 22:19:46 +0530 Subject: [PATCH] feat: stats/strided/dmeanstdevwd --- .../stats/strided/dmeanstdevwd/README.md | 416 ++++++++++++++++++ .../dmeanstdevwd/benchmark/benchmark.js | 106 +++++ .../benchmark/benchmark.native.js | 111 +++++ .../benchmark/benchmark.ndarray.js | 106 +++++ .../benchmark/benchmark.ndarray.native.js | 111 +++++ .../strided/dmeanstdevwd/benchmark/c/Makefile | 146 ++++++ .../benchmark/c/benchmark.length.c | 154 +++++++ .../stats/strided/dmeanstdevwd/binding.gyp | 170 +++++++ ...on_corrected_sample_standard_deviation.svg | 73 +++ .../docs/img/equation_population_mean.svg | 42 ++ ...equation_population_standard_deviation.svg | 66 +++ .../docs/img/equation_sample_mean.svg | 43 ++ .../stats/strided/dmeanstdevwd/docs/repl.txt | 136 ++++++ .../dmeanstdevwd/docs/types/index.d.ts | 106 +++++ .../strided/dmeanstdevwd/docs/types/test.ts | 280 ++++++++++++ .../strided/dmeanstdevwd/examples/c/Makefile | 146 ++++++ .../strided/dmeanstdevwd/examples/c/example.c | 42 ++ .../strided/dmeanstdevwd/examples/index.js | 32 ++ .../stats/strided/dmeanstdevwd/include.gypi | 53 +++ .../stdlib/stats/strided/dmeanstdevwd.h | 45 ++ .../strided/dmeanstdevwd/lib/dmeanstdevwd.js | 59 +++ .../dmeanstdevwd/lib/dmeanstdevwd.native.js | 56 +++ .../stats/strided/dmeanstdevwd/lib/index.js | 70 +++ .../stats/strided/dmeanstdevwd/lib/main.js | 35 ++ .../stats/strided/dmeanstdevwd/lib/native.js | 35 ++ .../stats/strided/dmeanstdevwd/lib/ndarray.js | 61 +++ .../dmeanstdevwd/lib/ndarray.native.js | 58 +++ .../stats/strided/dmeanstdevwd/manifest.json | 107 +++++ .../stats/strided/dmeanstdevwd/package.json | 85 ++++ .../stats/strided/dmeanstdevwd/src/Makefile | 70 +++ .../stats/strided/dmeanstdevwd/src/addon.c | 68 +++ .../stats/strided/dmeanstdevwd/src/main.c | 66 +++ .../dmeanstdevwd/test/test.dmeanstdevwd.js | 291 ++++++++++++ .../test/test.dmeanstdevwd.native.js | 300 +++++++++++++ .../stats/strided/dmeanstdevwd/test/test.js | 82 ++++ .../strided/dmeanstdevwd/test/test.ndarray.js | 281 ++++++++++++ .../dmeanstdevwd/test/test.ndarray.native.js | 290 ++++++++++++ 37 files changed, 4398 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/README.md create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_corrected_sample_standard_deviation.svg create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_standard_deviation.svg create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_sample_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/include/stdlib/stats/strided/dmeanstdevwd.h create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/dmeanstdevwd.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/dmeanstdevwd.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/package.json create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/README.md b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/README.md new file mode 100644 index 000000000000..8895ac1dfe81 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/README.md @@ -0,0 +1,416 @@ + + + + +# dmeanstdevwd + +> Calculate the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using Welford's algorithm. + +
+ +The population [standard deviation][standard-deviation] of a finite size population of size `N` is given by + + + +```math +\sigma = \sqrt{\frac{1}{N} \sum_{i=0}^{N-1} (x_i - \mu)^2} +``` + + + + + +where the population mean is given by + + + +```math +\mu = \frac{1}{N} \sum_{i=0}^{N-1} x_i +``` + + + + + +Often in the analysis of data, the true population [standard deviation][standard-deviation] is not known _a priori_ and must be estimated from a sample drawn from the population distribution. If one attempts to use the formula for the population [standard deviation][standard-deviation], the result is biased and yields an **uncorrected sample standard deviation**. To compute a **corrected sample standard deviation** for a sample of size `n`, + + + +```math +s = \sqrt{\frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x})^2} +``` + + + + + +where the sample mean is given by + + + +```math +\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i +``` + + + + + +The use of the term `n-1` is commonly referred to as Bessel's correction. Note, however, that applying Bessel's correction can increase the mean squared error between the sample standard deviation and population standard deviation. Depending on the characteristics of the population distribution, other correction factors (e.g., `n-1.5`, `n+1`, etc) can yield better estimators. + +
+ + + +
+ +## Usage + +```javascript +var dmeanstdevwd = require( '@stdlib/stats/strided/dmeanstdevwd' ); +``` + +#### dmeanstdevwd( N, correction, x, strideX, out, strideOut ) + +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using Welford's algorithm. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var out = new Float64Array( 2 ); + +var v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); +// returns [ ~0.3333, ~2.0817 ] + +var bool = ( v === out ); +// returns true +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). +- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: stride length for `x`. +- **out**: output [`Float64Array`][@stdlib/array/float64] for storing results. +- **strideOut**: stride length for `out`. + +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [standard deviation][standard-deviation] 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 ] ); +var out = new Float64Array( 2 ); + +var v = dmeanstdevwd( 4, 1, x, 2, out, 1 ); +// returns [ 1.25, 2.5 ] +``` + +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 ] ); +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var out0 = new Float64Array( 4 ); +var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at 3rd element + +var v = dmeanstdevwd( 4, 1, x1, 2, out1, 1 ); +// returns [ 1.25, 2.5 ] +``` + +#### dmeanstdevwd.ndarray( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ) + +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using Welford's algorithm and alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var out = new Float64Array( 2 ); + +var v = dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, 0 ); +// returns [ ~0.3333, ~2.0817 ] +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetOut**: starting index for `out`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the [mean][arithmetic-mean] and [standard deviation][standard-deviation] 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 ] ); +var out = new Float64Array( 4 ); + +var v = dmeanstdevwd.ndarray( 4, 1, x, 2, 1, out, 2, 1 ); +// returns [ 0.0, 1.25, 0.0, 2.5 ] +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return a [mean][arithmetic-mean] and [standard deviation][standard-deviation] equal to `NaN`. +- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), both functions return a [standard deviation][standard-deviation] equal to `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dmeanstdevwd = require( '@stdlib/stats/strided/dmeanstdevwd' ); + +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); +console.log( x ); + +var out = new Float64Array( 2 ); +dmeanstdevwd( x.length, 1, x, 1, out, 1 ); +console.log( out ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/strided/dmeanstdevwd.h" +``` + +#### stdlib_strided_dmeanstdevwd( N, correction, \*X, strideX, \*Out, strideOut ) + +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using Welford's algorithm. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; +double out[] = { 0.0, 0.0 }; + +stdlib_strided_dmeanstdevwd( 3, 1.0, x, 1, out, 1 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **correction**: `[in] double` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Out**: `[out] double*` output array. +- **strideOut**: `[in] CBLAS_INT` stride length for `Out`. + +```c +void stdlib_strided_dmeanstdevwd( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut ); +``` + +#### stdlib_strided_dmeanstdevwd_ndarray( N, correction, \*X, strideX, offsetX, \*Out, strideOut, offsetOut ) + +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using Welford's algorithm and alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; +double out[] = { 0.0, 0.0 }; + +stdlib_strided_dmeanstdevwd_ndarray( 4, 1.0, x, 2, 0, x, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **correction**: `[in] double` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Out**: `[out] double*` output array. +- **strideOut**: `[in] CBLAS_INT` stride length for `Out`. +- **offsetOut**: `[in] CBLAS_INT` starting index for `Out`. + +```c +void stdlib_strided_dmeanstdevwd_ndarray( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/strided/dmeanstdevwd.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + + // Create an output array: + double out[] = { 0.0, 0.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + const int strideOut = 1; + + // Compute the mean and standard deviation: + stdlib_strided_dmeanstdevwd( N, 1.0, x, strideX, out, strideOut ); + + // Print the result: + printf( "sample mean: %lf\n", out[ 0 ] ); + printf( "sample standard deviation: %lf\n", out[ 1 ] ); +} +``` + +
+ + + +
+ + + +
+ +## References + +- Welford, B. P. 1962. "Note on a Method for Calculating Corrected Sums of Squares and Products." _Technometrics_ 4 (3). Taylor & Francis: 419–20. doi:[10.1080/00401706.1962.10490022][@welford:1962a]. +- van Reeken, A. J. 1968. "Letters to the Editor: Dealing with Neely's Algorithms." _Communications of the ACM_ 11 (3): 149–50. doi:[10.1145/362929.362961][@vanreeken:1968a]. + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/stats/strided/dmeanwd`][@stdlib/stats/strided/dmeanwd]: calculate the arithmetic mean of a double-precision floating-point strided array using Welford's algorithm. +- [`@stdlib/stats/strided/dmeanstdev`][@stdlib/stats/strided/dmeanstdev]: calculate the mean and standard deviation of a double-precision floating-point strided array. +- [`@stdlib/stats/strided/dmeanvarwd`][@stdlib/stats/strided/dmeanvarwd]: calculate the mean and variance of a double-precision floating-point strided array using Welford's algorithm. +- [`@stdlib/stats/strided/dstdevwd`][@stdlib/stats/strided/dstdevwd]: calculate the standard deviation of a double-precision floating-point strided array using Welford's algorithm. + +
+ + + + + +
+ +[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean + +[standard-deviation]: https://en.wikipedia.org/wiki/Standard_deviation + +[@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 + +[@welford:1962a]: https://doi.org/10.1080/00401706.1962.10490022 + +[@vanreeken:1968a]: https://doi.org/10.1145/362929.362961 + + + +[@stdlib/stats/strided/dmeanwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanwd + +[@stdlib/stats/strided/dmeanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanstdev + +[@stdlib/stats/strided/dmeanvarwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanvarwd + +[@stdlib/stats/strided/dstdevwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dstdevwd + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.js new file mode 100644 index 000000000000..e72e58f825f9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var pkg = require( './../package.json' ).name; +var dmeanstdevwd = require( './../lib/dmeanstdevwd.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + if ( isnan( out[ i%2 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( out[ i%2 ] ) ) { + 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/dmeanstdevwd/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.native.js new file mode 100644 index 000000000000..de6f44d92b8f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.native.js @@ -0,0 +1,111 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dmeanstdevwd = tryRequire( resolve( __dirname, './../lib/dmeanstdevwd.native.js' ) ); +var opts = { + 'skip': ( dmeanstdevwd instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + if ( isnan( out[ i%2 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( out[ i%2 ] ) ) { + 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/dmeanstdevwd/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..0037794b839e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.ndarray.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var pkg = require( './../package.json' ).name; +var dmeanstdevwd = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + if ( isnan( out[ i%2 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( out[ i%2 ] ) ) { + 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/dmeanstdevwd/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..1b8108ef6622 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,111 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dmeanstdevwd = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dmeanstdevwd instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + if ( isnan( out[ i%2 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( out[ i%2 ] ) ) { + 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/dmeanstdevwd/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/c/Makefile new file mode 100644 index 000000000000..0756dc7da20a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/dmeanstdevwd/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..fddbb071878c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/benchmark/c/benchmark.length.c @@ -0,0 +1,154 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/dmeanstdevwd.h" +#include +#include +#include +#include +#include + +#define NAME "dmeanstdevwd" +#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 benchmark( int iterations, int len ) { + double elapsed; + double out[ 2 ]; + double x[ len ]; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double() * 20000.0 ) - 10000.0; + } + out[ 0 ] = 0.0; + out[ 1 ] = 0.0; + + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + stdlib_strided_dmeanstdevwd( len, 1.0, x, 1, out, 1 ); + if ( out[ i%2 ] != out[ i%2 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( out[ i%2 ] != out[ i%2 ] ) { + 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 = benchmark( 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/dmeanstdevwd/binding.gyp b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/binding.gyp new file mode 100644 index 000000000000..0d6508a12e99 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/dmeanstdevwd/docs/img/equation_corrected_sample_standard_deviation.svg b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_corrected_sample_standard_deviation.svg new file mode 100644 index 000000000000..6af85c9d5732 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_corrected_sample_standard_deviation.svg @@ -0,0 +1,73 @@ + +s equals StartRoot StartFraction 1 Over n minus 1 EndFraction sigma-summation Underscript i equals 0 Overscript n minus 1 Endscripts left-parenthesis x Subscript i Baseline minus x overbar right-parenthesis squared EndRoot + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_mean.svg b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_mean.svg new file mode 100644 index 000000000000..4bbdf0d2a56f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_mean.svg @@ -0,0 +1,42 @@ + +mu equals StartFraction 1 Over upper N EndFraction sigma-summation Underscript i equals 0 Overscript upper N minus 1 Endscripts x Subscript i + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_standard_deviation.svg b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_standard_deviation.svg new file mode 100644 index 000000000000..ad431efeff2a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_population_standard_deviation.svg @@ -0,0 +1,66 @@ + +sigma equals StartRoot StartFraction 1 Over upper N EndFraction sigma-summation Underscript i equals 0 Overscript upper N minus 1 Endscripts left-parenthesis x Subscript i Baseline minus mu right-parenthesis squared EndRoot + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_sample_mean.svg b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_sample_mean.svg new file mode 100644 index 000000000000..aea7a5f6687a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/img/equation_sample_mean.svg @@ -0,0 +1,43 @@ + +x overbar 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/dmeanstdevwd/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/repl.txt new file mode 100644 index 000000000000..0d56ac559900 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/repl.txt @@ -0,0 +1,136 @@ + +{{alias}}( N, c, x, strideX, out, strideOut ) + Computes the mean and standard deviation of a double-precision floating- + point strided array using Welford's 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 a mean and standard deviation equal to + `NaN`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + c: number + Degrees of freedom adjustment. Setting this parameter to a value other + than `0` has the effect of adjusting the divisor during the calculation + of the standard deviation according to `N - c` where `c` corresponds to + the provided degrees of freedom adjustment. When computing the standard + deviation of a population, setting this parameter to `0` is the standard + choice (i.e., the provided array contains data constituting an entire + population). When computing the corrected sample standard deviation, + setting this parameter to `1` is the standard choice (i.e., the provided + array contains data sampled from a larger population; this is commonly + referred to as Bessel's correction). + + x: Float64Array + Input array. + + strideX: integer + Stride length for `x`. + + out: Float64Array + Output array. + + strideOut: integer + Stride length for `out`. + + Returns + ------- + out: Float64Array + Output array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}( x.length, 1, x, 1, out, 1 ) + [ ~0.3333, ~2.0817 ] + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] ); + > out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}( 3, 1, x, 2, out, 1 ) + [ ~0.3333, ~2.0817 ] + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}( 3, 1, x1, 2, out, 1 ) + [ ~0.3333, ~2.0817 ] + + +{{alias}}.ndarray( N, c, x, strideX, offsetX, out, strideOut, offsetOut ) + Computes the mean and standard deviation of a double-precision floating- + point strided array using Welford's 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. + + c: number + Degrees of freedom adjustment. Setting this parameter to a value other + than `0` has the effect of adjusting the divisor during the calculation + of the standard deviation according to `N - c` where `c` corresponds to + the provided degrees of freedom adjustment. When computing the standard + deviation of a population, setting this parameter to `0` is the standard + choice (i.e., the provided array contains data constituting an entire + population). When computing the corrected sample standard deviation, + setting this parameter to `1` is the standard choice (i.e., the provided + array contains data sampled from a larger population; this is commonly + referred to as Bessel's correction). + + x: Float64Array + Input array. + + strideX: integer + Stride length for `x`. + + offsetX: integer + Starting index for `x`. + + out: Float64Array + Output array. + + strideOut: integer + Stride length for `out`. + + offsetOut: integer + Starting index for `out`. + + Returns + ------- + out: Float64Array + Output array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}.ndarray( x.length, 1, x, 1, 0, out, 1, 0 ) + [ ~0.3333, ~2.0817 ] + + // Using offset parameter: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); + > out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}.ndarray( 3, 1, x, 2, 1, out, 1, 0 ) + [ ~0.3333, ~2.0817 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/index.d.ts new file mode 100644 index 000000000000..d1f6f5f013f4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/index.d.ts @@ -0,0 +1,106 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 `dmeanstdevwd`. +*/ +interface Routine { + /** + * Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. + * + * @param N - number of indexed elements + * @param correction - degrees of freedom adjustment + * @param x - input array + * @param strideX - `x` stride length + * @param out - output array + * @param strideOut - `out` stride length + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * var out = new Float64Array( 2 ); + * + * var v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + * // returns [ ~0.3333, ~2.0817 ] + */ + ( N: number, correction: number, x: Float64Array, strideX: number, out: Float64Array, strideOut: number ): Float64Array; + + /** + * Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm and alternative indexing semantics. + * + * @param N - number of indexed elements + * @param correction - degrees of freedom adjustment + * @param x - input array + * @param strideX - `x` stride length + * @param offsetX - `x` starting index + * @param out - output array + * @param strideOut - `out` stride length + * @param offsetOut - `out` starting index + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * var out = new Float64Array( 2 ); + * + * var v = dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, 0 ); + * // returns [ ~0.3333, ~2.0817 ] + */ + ndarray( N: number, correction: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut: number, offsetOut: number ): Float64Array; +} + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. +* +* @param N - number of indexed elements +* @param correction - degrees of freedom adjustment +* @param x - input array +* @param strideX - `x` stride length +* @param out - output array +* @param strideOut - `out` stride length +* @returns output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); +* // returns [ ~0.3333, ~2.0817 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, 0 ); +* // returns [ ~0.3333, ~2.0817 ] +*/ +declare var dmeanstdevwd: Routine; + + +// EXPORTS // + +export = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/test.ts new file mode 100644 index 000000000000..3903a9102cf0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/docs/types/test.ts @@ -0,0 +1,280 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 dmeanstdevwd = require( './index' ); + + +// TESTS // + +// The function returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd( x.length, 1, x, 1, out, 1 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd( '10', 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( true, 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( false, 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( null, 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( undefined, 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( [], 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( {}, 1, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( ( x: number ): number => x, 1, x, 1, out, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd( x.length, '10', x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, true, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, false, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, null, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, undefined, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, [], x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, {}, x, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, ( x: number ): number => x, x, 1, out, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd( x.length, 1, 10, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, '10', 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, true, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, false, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, null, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, undefined, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, [ '1' ], 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, {}, 1, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, ( x: number ): number => x, 1, out, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd( x.length, 1, x, '10', out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, true, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, false, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, null, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, undefined, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, [], out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, {}, out, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, ( x: number ): number => x, out, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dmeanstdevwd( x.length, 1, x, 1, 10, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, '10', 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, true, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, false, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, null, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, undefined, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, [ '1' ], 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, {}, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd( x.length, 1, x, 1, out, '10' ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, true ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, false ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, null ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, undefined ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, [] ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, {} ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, ( 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 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd(); // $ExpectError + dmeanstdevwd( x.length ); // $ExpectError + dmeanstdevwd( x.length, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1 ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out ); // $ExpectError + dmeanstdevwd( x.length, 1, x, 1, out, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( '10', 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( true, 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( false, 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( null, 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( undefined, 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( [], 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( {}, 1, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( ( x: number ): number => x, 1, x, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, '10', x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, true, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, false, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, null, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, undefined, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, [], x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, {}, x, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, ( x: number ): number => x, x, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, 1, 10, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, '10', 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, true, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, false, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, null, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, undefined, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, [ '1' ], 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, {}, 1, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, ( x: number ): number => x, 1, 0, out, 1, 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 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, 1, x, '10', 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, true, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, false, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, null, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, undefined, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, [], 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, {}, 0, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, ( x: number ): number => x, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, 1, x, 1, '10', out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, true, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, false, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, null, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, undefined, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, [], out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, {}, out, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, 10, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, '10', 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, true, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, false, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, null, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, undefined, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, [ '1' ], 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, {}, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, '10', 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, true, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, false, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, null, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, undefined, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, [], 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, {}, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, '10' ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, true ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, false ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, null ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, undefined ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, [] ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, {} ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 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 ); + const out = new Float64Array( 2 ); + + dmeanstdevwd.ndarray(); // $ExpectError + dmeanstdevwd.ndarray( x.length ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1 ); // $ExpectError + dmeanstdevwd.ndarray( x.length, 1, x, 1, 0, out, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/dmeanstdevwd/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/example.c new file mode 100644 index 000000000000..317d9b48ce06 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/c/example.c @@ -0,0 +1,42 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/dmeanstdevwd.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + + // Create an output array: + double out[] = { 0.0, 0.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride lengths: + const int strideX = 2; + const int strideOut = 1; + + // Compute the mean and standard deviation: + stdlib_strided_dmeanstdevwd( N, 1.0, x, strideX, out, strideOut ); + + // Print the result: + printf( "sample mean: %lf\n", out[ 0 ] ); + printf( "sample standard deviation: %lf\n", out[ 1 ] ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/index.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/index.js new file mode 100644 index 000000000000..43ff1190d6e1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/examples/index.js @@ -0,0 +1,32 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dmeanstdevwd = require( './../lib' ); + +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); +console.log( x ); + +var out = new Float64Array( 2 ); +dmeanstdevwd( x.length, 1, x, 1, out, 1 ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/include.gypi b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 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.3333, ~2.0817 ] +*/ +function dmeanstdevwd( N, correction, x, strideX, out, strideOut ) { + var ox = stride2offset( N, strideX ); + var oo = ( strideOut >= 0 ) ? 0 : -strideOut; + ndarray( N, correction, x, strideX, ox, out, strideOut, oo ); + return out; +} + + +// EXPORTS // + +module.exports = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/dmeanstdevwd.native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/dmeanstdevwd.native.js new file mode 100644 index 000000000000..9d630b0d1681 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/dmeanstdevwd.native.js @@ -0,0 +1,56 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} correction - degrees of freedom adjustment +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {Float64Array} out - output array +* @param {integer} strideOut - `out` stride length +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); +* // returns [ ~0.3333, ~2.0817 ] +*/ +function dmeanstdevwd( N, correction, x, strideX, out, strideOut ) { + addon( N, correction, x, strideX, out, strideOut ); + return out; +} + + +// EXPORTS // + +module.exports = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/index.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/index.js new file mode 100644 index 000000000000..bf694152fa8a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/index.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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'; + +/** +* Compute the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. +* +* @module @stdlib/stats/strided/dmeanstdevwd +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dmeanstdevwd = require( '@stdlib/stats/strided/dmeanstdevwd' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); +* // returns [ ~0.3333, ~2.0817 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dmeanstdevwd = require( '@stdlib/stats/strided/dmeanstdevwd' ); +* +* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd.ndarray( 4, 1, x, 2, 1, out, 1, 0 ); +* // returns [ 1.25, 2.5 ] +*/ + +// MODULES // + +var join = require( 'path' ).join; +var tryRequire = require( '@stdlib/utils/try-require' ); +var isError = require( '@stdlib/assert/is-error' ); +var main = require( './main.js' ); + + +// MAIN // + +var dmeanstdevwd; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + dmeanstdevwd = main; +} else { + dmeanstdevwd = tmp; +} + + +// EXPORTS // + +module.exports = dmeanstdevwd; + +// exports: { "ndarray": "dmeanstdevwd.ndarray" } diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/main.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/main.js new file mode 100644 index 000000000000..a40d61d1a35e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/main.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var dmeanstdevwd = require( './dmeanstdevwd.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( dmeanstdevwd, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/native.js new file mode 100644 index 000000000000..5b49eba6f65a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/native.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var dmeanstdevwd = require( './dmeanstdevwd.native.js' ); +var ndarray = require( './ndarray.native.js' ); + + +// MAIN // + +setReadOnly( dmeanstdevwd, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.js new file mode 100644 index 000000000000..2c2f77ddcf63 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.js @@ -0,0 +1,61 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 dmeanvarwd = require( '@stdlib/stats/strided/dmeanvarwd' ).ndarray; +var sqrt = require( '@stdlib/math/base/special/sqrt' ); + + +// MAIN // + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} correction - degrees of freedom adjustment +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - `x` starting index +* @param {Float64Array} out - output array +* @param {integer} strideOut - `out` stride length +* @param {NonNegativeInteger} offsetOut - `out` starting index +* @returns {Float64Array} output array +* +* @example +* 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 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd( 4, 1, x, 2, 1, out, 1, 0 ); +* // returns [ 1.25, 2.5 ] +*/ +function dmeanstdevwd( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ) { // eslint-disable-line max-len + var io = offsetOut + strideOut; + dmeanvarwd( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ); + out[ io ] = sqrt( out[ io ] ); + return out; +} + + +// EXPORTS // + +module.exports = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.native.js new file mode 100644 index 000000000000..1c4d59b24199 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/lib/ndarray.native.js @@ -0,0 +1,58 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} correction - degrees of freedom adjustment +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - `x` starting index +* @param {Float64Array} out - output array +* @param {integer} strideOut - `out` stride length +* @param {NonNegativeInteger} offsetOut - `out` starting index +* @returns {Float64Array} output array +* +* @example +* 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 ] ); +* var out = new Float64Array( 2 ); +* +* var v = dmeanstdevwd( 4, 1, x, 2, 1, out, 1, 0 ); +* // returns [ 1.25, 2.5 ] +*/ +function dmeanstdevwd( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ) { // eslint-disable-line max-len + addon.ndarray( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ); // eslint-disable-line max-len + return out; +} + + +// EXPORTS // + +module.exports = dmeanstdevwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/manifest.json b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/manifest.json new file mode 100644 index 000000000000..945547ef714c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/manifest.json @@ -0,0 +1,107 @@ +{ + "options": { + "task": "build", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/strided/dmeanvarwd", + "@stdlib/math/base/special/sqrt", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-double", + "@stdlib/napi/argv-strided-float64array" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/strided/dmeanvarwd", + "@stdlib/math/base/special/sqrt" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/strided/dmeanvarwd", + "@stdlib/math/base/special/sqrt" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/strided/dmeanvarwd", + "@stdlib/math/base/special/sqrt" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/package.json b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/package.json new file mode 100644 index 000000000000..fb6eee8c766d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/package.json @@ -0,0 +1,85 @@ +{ + "name": "@stdlib/stats/strided/dmeanstdevwd", + "version": "0.0.0", + "description": "Calculate the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": "./lib/main.js", + "gypfile": true, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "mean", + "arithmetic mean", + "average", + "avg", + "central tendency", + "variance", + "var", + "deviation", + "dispersion", + "sample standard deviation", + "unbiased", + "stdev", + "std", + "standard deviation", + "strided", + "strided array", + "typed", + "array", + "float64", + "double", + "float64array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/Makefile b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 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/dmeanstdevwd/src/addon.c b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/addon.c new file mode 100644 index 000000000000..965a5c281bc8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/addon.c @@ -0,0 +1,68 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/dmeanstdevwd.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_double.h" +#include "stdlib/napi/argv_strided_float64array.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, 6 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut, argv, 5 ); + STDLIB_NAPI_ARGV_DOUBLE( env, correction, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Out, 2, strideOut, argv, 4 ); + API_SUFFIX(stdlib_strided_dmeanstdevwd)( N, correction, X, strideX, Out, strideOut ); + return NULL; +} + +/** +* 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, 8 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 4 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut, argv, 6 ); + STDLIB_NAPI_ARGV_INT64( env, offsetOut, argv, 7 ); + STDLIB_NAPI_ARGV_DOUBLE( env, correction, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Out, 2, strideOut, argv, 5 ); + API_SUFFIX(stdlib_strided_dmeanstdevwd_ndarray)( N, correction, X, strideX, offsetX, Out, strideOut, offsetOut ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/main.c b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/main.c new file mode 100644 index 000000000000..9633b6b9701b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/src/main.c @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/dmeanstdevwd.h" +#include "stdlib/stats/strided/dmeanvarwd.h" +#include "stdlib/math/base/special/sqrt.h" +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm. +* +* @param N number of indexed elements +* @param correction degrees of freedom adjustment +* @param X input array +* @param strideX X stride length +* @param Out output array +* @param strideOut Out stride length +*/ +void API_SUFFIX(stdlib_strided_dmeanstdevwd)( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + const CBLAS_INT oo = ( strideOut >= 0 ) ? 0 : -strideOut; + API_SUFFIX(stdlib_strided_dmeanstdevwd_ndarray)( N, correction, X, strideX, ox, Out, strideOut, oo ); + return; +} + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using Welford's algorithm and alternative indexing semantics. +* +* @param N number of indexed elements +* @param correction degrees of freedom adjustment +* @param X input array +* @param strideX X stride length +* @param offsetX starting index for X +* @param Out output array +* @param strideOut Out stride length +* @param offsetOut starting index for Out +*/ +void API_SUFFIX(stdlib_strided_dmeanstdevwd_ndarray)( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ) { + CBLAS_INT io; + + API_SUFFIX(stdlib_strided_dmeanvarwd_ndarray)( N, correction, X, strideX, offsetX, Out, strideOut, offsetOut ); + + if ( strideOut < 0 ) { + io = 0; + } else { + io = strideOut + offsetOut; + } + Out[ io ] = stdlib_base_sqrt( Out[ io ] ); + return; +} diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.js new file mode 100644 index 000000000000..a08ca602e5d2 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.js @@ -0,0 +1,291 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 sqrt = require( '@stdlib/math/base/special/sqrt' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dmeanstdevwd = require( './../lib/dmeanstdevwd.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dmeanstdevwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 6', function test( t ) { + t.strictEqual( dmeanstdevwd.length, 6, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and population standard deviation of a strided array', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, out, 1 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/x.length ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, out, 1 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, out, 1 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and sample standard deviation of a strided array', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/(x.length-1) ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` values', function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 0, 1, x, 1, out, 1 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( -1, 1, x, 1, out, 1 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns a population standard deviation of `0`', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 0, x, 1, out, 1 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns a standard deviation equal to `NaN`', function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 1, x, 1, out, 1 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 0, out, 1 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 1, out, 1 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length+1, x, 1, out, 1 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `stride` parameters', function test( t ) { + var expected; + var out; + 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 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, 2, out, 2 ); + + expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, -2, out, -2 ); + + expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns an arithmetic mean equal to the first element and a standard deviation of `0`', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + out = new Float64Array( 2 ); + + v = dmeanstdevwd( x.length, 1, x, 0, out, 1 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var expected0; + var expected1; + var out0; + var out1; + 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 + ]); + out0 = new Float64Array( 4 ); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at the 3rd element + + v = dmeanstdevwd( 4, 1, x1, 2, out1, 1 ); + + expected0 = new Float64Array( [ 0.0, 0.0, 1.25, 2.5 ] ); + expected1 = new Float64Array( [ 1.25, 2.5 ] ); + + t.deepEqual( out0, expected0, 'returns expected value' ); + t.deepEqual( v, expected1, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.native.js new file mode 100644 index 000000000000..ffd6a018f3a3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.dmeanstdevwd.native.js @@ -0,0 +1,300 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 sqrt = require( '@stdlib/math/base/special/sqrt' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dmeanstdevwd = tryRequire( resolve( __dirname, './../lib/dmeanstdevwd.native.js' ) ); +var opts = { + 'skip': ( dmeanstdevwd instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dmeanstdevwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 6', opts, function test( t ) { + t.strictEqual( dmeanstdevwd.length, 6, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and population standard deviation of a strided array', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, out, 1 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/x.length ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, out, 1 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, out, 1 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and sample standard deviation of a strided array', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/(x.length-1) ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, out, 1 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` values', opts, function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 0, 1, x, 1, out, 1 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( -1, 1, x, 1, out, 1 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns a population standard deviation of `0`', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 0, x, 1, out, 1 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns a standard deviation equal to `NaN`', opts, function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 1, x, 1, out, 1 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 0, out, 1 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 1, out, 1 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length+1, x, 1, out, 1 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `stride` parameters', opts, function test( t ) { + var expected; + var out; + 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 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, 2, out, 2 ); + + expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, -2, out, -2 ); + + expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns an arithmetic mean equal to the first element and a standard deviation of `0`', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + out = new Float64Array( 2 ); + + v = dmeanstdevwd( x.length, 1, x, 0, out, 1 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var expected0; + var expected1; + var out0; + var out1; + 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 + ]); + out0 = new Float64Array( 4 ); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at the 3rd element + + v = dmeanstdevwd( 4, 1, x1, 2, out1, 1 ); + + expected0 = new Float64Array( [ 0.0, 0.0, 1.25, 2.5 ] ); + expected1 = new Float64Array( [ 1.25, 2.5 ] ); + + t.deepEqual( out0, expected0, 'returns expected value' ); + t.deepEqual( v, expected1, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.js new file mode 100644 index 000000000000..02e4d37496a6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 dmeanstdevwd = 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 dmeanstdevwd, '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 dmeanstdevwd.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 dmeanstdevwd = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dmeanstdevwd, 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 dmeanstdevwd; + var main; + + main = require( './../lib/dmeanstdevwd.js' ); + + dmeanstdevwd = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dmeanstdevwd, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.js new file mode 100644 index 000000000000..f72155ffec33 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.js @@ -0,0 +1,281 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 sqrt = require( '@stdlib/math/base/special/sqrt' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dmeanstdevwd = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dmeanstdevwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', function test( t ) { + t.strictEqual( dmeanstdevwd.length, 8, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and population standard deviation of a strided array', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/x.length ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and sample standard deviation of a strided array', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/(x.length-1) ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` values', function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 0, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( -1, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns a population standard deviation of `0`', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 0, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns a standard deviation equal to `NaN`', function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 0, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length+1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `stride` parameters', function test( t ) { + var expected; + var out; + 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 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, 2, 0, out, 2, 0 ); + + expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, -2, 6, out, -2, 2 ); + + expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns an arithmetic mean equal to the first element and a standard deviation of `0`', function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + out = new Float64Array( 2 ); + + v = dmeanstdevwd( x.length, 1, x, 0, 0, out, 1, 0 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `offset` parameters', function test( t ) { + var expected; + var out; + 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 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, 2, 1, out, 2, 1 ); + + expected = new Float64Array( [ 0.0, 1.25, 0.0, 2.5 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.native.js new file mode 100644 index 000000000000..61b814f7e11c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dmeanstdevwd/test/test.ndarray.native.js @@ -0,0 +1,290 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 sqrt = require( '@stdlib/math/base/special/sqrt' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dmeanstdevwd = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dmeanstdevwd instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dmeanstdevwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', opts, function test( t ) { + t.strictEqual( dmeanstdevwd.length, 8, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and population standard deviation of a strided array', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/x.length ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 0, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the arithmetic mean and sample standard deviation of a strided array', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 0.5, sqrt( 53.5/(x.length-1) ) ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ -4.0, -4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -4.0, 0.0 ] ); + t.strictEqual( v, out, 'returns expected value' ); + t.deepEqual( v, expected, 'returns expected value' ); + + x = new Float64Array( [ NaN, 4.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` values', opts, function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 0, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( -1, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( isnan( v[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns a population standard deviation of `0`', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 0, x, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns a standard deviation equal to `NaN`', opts, function test( t ) { + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( 1, 1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 0, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 1.0, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + v = dmeanstdevwd( x.length, x.length+1, x, 1, 0, out, 1, 0 ); + + t.strictEqual( v[ 0 ], 0.5, 'returns expected value' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `stride` parameters', opts, function test( t ) { + var expected; + var out; + 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 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, 2, 0, out, 2, 0 ); + + expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, -2, 6, out, -2, 2 ); + + expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0`, the function returns an arithmetic mean equal to the first element and a standard deviation of `0`', opts, function test( t ) { + var expected; + var out; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + out = new Float64Array( 2 ); + + v = dmeanstdevwd( x.length, 1, x, 0, 0, out, 1, 0 ); + + expected = new Float64Array( [ 1.0, 0.0 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `offset` parameters', opts, function test( t ) { + var expected; + var out; + 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 + ]); + out = new Float64Array( 4 ); + + v = dmeanstdevwd( 4, 1, x, 2, 1, out, 2, 1 ); + + expected = new Float64Array( [ 0.0, 1.25, 0.0, 2.5 ] ); + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +});