From 4d6f43ca2d2503ac0c4aa423da885d54c0755f23 Mon Sep 17 00:00:00 2001 From: nakul-krishnakumar Date: Tue, 3 Mar 2026 18:46:00 +0530 Subject: [PATCH 1/3] feat: add `stats/strided/dpcorrwd` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/stats/strided/dpcorrwd/README.md | 349 ++++++++++++++++++ .../strided/dpcorrwd/benchmark/benchmark.js | 104 ++++++ .../dpcorrwd/benchmark/benchmark.native.js | 109 ++++++ .../dpcorrwd/benchmark/benchmark.ndarray.js | 104 ++++++ .../benchmark/benchmark.ndarray.native.js | 109 ++++++ .../strided/dpcorrwd/benchmark/c/Makefile | 146 ++++++++ .../dpcorrwd/benchmark/c/benchmark.length.c | 209 +++++++++++ .../stats/strided/dpcorrwd/binding.gyp | 170 +++++++++ .../stats/strided/dpcorrwd/docs/repl.txt | 112 ++++++ .../strided/dpcorrwd/docs/types/index.d.ts | 103 ++++++ .../stats/strided/dpcorrwd/docs/types/test.ts | 249 +++++++++++++ .../strided/dpcorrwd/examples/c/Makefile | 146 ++++++++ .../strided/dpcorrwd/examples/c/example.c | 45 +++ .../stats/strided/dpcorrwd/examples/index.js | 34 ++ .../stats/strided/dpcorrwd/include.gypi | 53 +++ .../include/stdlib/stats/strided/dpcorrwd.h | 45 +++ .../stats/strided/dpcorrwd/lib/dpcorrwd.js | 57 +++ .../strided/dpcorrwd/lib/dpcorrwd.native.js | 54 +++ .../stats/strided/dpcorrwd/lib/index.js | 70 ++++ .../stats/strided/dpcorrwd/lib/main.js | 35 ++ .../stats/strided/dpcorrwd/lib/native.js | 35 ++ .../stats/strided/dpcorrwd/lib/ndarray.js | 100 +++++ .../strided/dpcorrwd/lib/ndarray.native.js | 56 +++ .../stats/strided/dpcorrwd/manifest.json | 104 ++++++ .../stats/strided/dpcorrwd/package.json | 76 ++++ .../stats/strided/dpcorrwd/src/Makefile | 70 ++++ .../stats/strided/dpcorrwd/src/addon.c | 66 ++++ .../@stdlib/stats/strided/dpcorrwd/src/main.c | 98 +++++ .../strided/dpcorrwd/test/test.dpcorrwd.js | 217 +++++++++++ .../dpcorrwd/test/test.dpcorrwd.native.js | 226 ++++++++++++ .../stats/strided/dpcorrwd/test/test.js | 82 ++++ .../strided/dpcorrwd/test/test.ndarray.js | 240 ++++++++++++ .../dpcorrwd/test/test.ndarray.native.js | 249 +++++++++++++ 33 files changed, 3922 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/include/stdlib/stats/strided/dpcorrwd.h create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/package.json create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md new file mode 100644 index 000000000000..ef87ae5d8f76 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md @@ -0,0 +1,349 @@ + + +# dpcorrwd + +> Calculate the [sample Pearson product-moment correlation coefficient][pearson-correlation] of two double-precision floating-point strided arrays using Welford algorithm. + +
+ +The [Pearson product-moment correlation coefficient][pearson-correlation] (also known as Pearson's r) between random variables `X` and `Y` is defined as + + + + +```math +\rho_{X,Y} = \frac{\mathop{\mathrm{cov}}(X,Y)}{\sigma_X \sigma_Y} +``` + + + +where the numerator is the [covariance][covariance] and the denominator is the product of the respective standard deviations. + +For a sample of size `n`, the [sample Pearson product-moment correlation coefficient][pearson-correlation] is defined as + + + +```math +r_{xy} = \frac{\displaystyle\sum_{i=0}^{N-1} (x_i - \bar{x})(y_i - \bar{y})}{\displaystyle\sqrt{\sum_{i=0}^{N-1} (x_i - \bar{x})^2} \sqrt{\sum_{i=0}^{N-1} (y_i - \bar{y})^2}} +``` + + + +where `x_i` and `y_i` are the _ith_ components of vectors **X** and **Y**, respectively. + +The use of the term `n-1` is commonly referred to as Bessel's correction. Depending on the characteristics of the population distributions, other correction factors (e.g., `n-1.5`, `n+1`, etc) can yield better estimators. + +
+ + + +
+ +## Usage + +```javascript +var dpcorrwd = require( '@stdlib/stats/strided/dpcorrwd' ); +``` + +#### dpcorrwd( N, x, strideX, y, strideY ) + +Computes the [sample Pearson product-moment correlation coefficient][pearson-correlation] of two double-precision floating-point strided arrays using Welford algorithm. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var y = new Float64Array( [ 2.0, -2.0, 1.0 ] ); + +var c = dpcorrwd( x.length, x, 1, y, 1 ); +// returns ~0.885 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: first input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: stride length for `x`. +- **y**: second input [`Float64Array`][@stdlib/array/float64]. +- **strideY**: stride length for `y`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the [sample Pearson product-moment correlation coefficient][pearson-correlation] of every other element in `x` and `y`, + +```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 y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + +var c = dpcorrwd( 4, x, 2, y, 2 ); +// returns ~0.947 +``` + +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 y0 = new Float64Array( [ 2.0, -2.0, 2.0, 1.0, -2.0, 4.0, 3.0, 2.0 ] ); + +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var c = dpcorrwd( 4, x1, 2, y1, 2 ); +// returns ~0.307 +``` + +#### dpcorrwd.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Computes the [sample Pearson product-moment correlation coefficient][pearson-correlation] of two double-precision floating-point strided arrays using Welford algorithm and alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var y = new Float64Array( [ 2.0, -2.0, 1.0 ] ); + +var c = dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// returns ~0.885 +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetY**: starting index for `y`. + +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 [sample Pearson product-moment correlation coefficient][pearson-correlation] for every other element in `x` and `y` 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 y = new Float64Array( [ -7.0, 2.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + +var c = dpcorrwd.ndarray( 4, x, 2, 1, y, 2, 1 ); +// returns ~0.927 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var dpcorrwd = require( '@stdlib/stats/strided/dpcorrwd' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, -50, 50, opts ); +console.log( x ); + +var y = discreteUniform( 10, -50, 50, opts ); +console.log( y ); + +var c = dpcorrwd( x.length, x, 1, y, 1 ); +console.log( c ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/strided/dpcorrwd.h" +``` + +#### stdlib_strided_dpcorrwd( N, \*X, strideX, \*Y, strideY ) + +Computes the [sample Pearson product-moment correlation coefficient][pearson-correlation] of two double-precision floating-point strided arrays using Welford algorithm. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; +const double y[] = { 2.0, -2.0, 1.0 }; + +double c = stdlib_strided_dpcorrwd( 3, x, 1, y, 1 ); +// returns ~0.885 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. + +```c +double stdlib_strided_dpcorrwd( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); +``` + +#### stdlib_strided_dpcorrwd_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY ) + +Computes the [sample Pearson product-moment correlation coefficient][pearson-correlation] of two double-precision floating-point strided arrays using Welford algorithm and alternative indexing semantics. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; +const double y[] = { 2.0, -2.0, 1.0 }; + +double c = stdlib_strided_dpcorrwd_ndarray( 3, x, 1, 0, y, 1, 0 ); +// returns ~0.885 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. +- **offsetY**: `[in] CBLAS_INT` starting index for `Y`. + +```c +double stdlib_strided_dpcorrwd_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/strided/dpcorrwd.h" +#include + +int main( void ) { + // Create strided arrays: + const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + const double y[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + + // Specify the number of elements: + const int N = 8; + + // Specify strides: + const int strideX = 1; + const int strideY = -1; + + // Compute the Pearson product-moment correlation coefficient between `x` and `y`: + double d = stdlib_strided_dpcorrwd( N, x, strideX, y, strideY ); + + // Print the result: + printf( "Pearson Correlation Coefficient: %lf\n", d ); + + // Compute the Pearson product-moment correlation coefficient between `x` and `y` with offsets: + d = stdlib_strided_dpcorrwd_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + + // Print the result: + printf( "Pearson Correlation Coefficient: %lf\n", d ); +} +``` + +
+ + + +
+ + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +[pearson-correlation]: https://en.wikipedia.org/wiki/Pearson_correlation_coefficient + +[covariance]: https://en.wikipedia.org/wiki/Covariance + +[@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 + +
+ + diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js new file mode 100644 index 000000000000..1bea253d1ca8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var format = require( '@stdlib/string/format' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var dpcorrwd = require( './../lib/dpcorrwd.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 x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var c; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + c = dpcorrwd( x.length, x, 1, y, 1 ); + if ( isnan( c ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( c ) ) { + 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js new file mode 100644 index 000000000000..56d378078778 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js @@ -0,0 +1,109 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var format = require( '@stdlib/string/format' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dpcorrwd = tryRequire( resolve( __dirname, './../lib/dpcorrwd.native.js' ) ); +var opts = { + 'skip': ( dpcorrwd 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 x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var c; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + c = dpcorrwd( x.length, x, 1, y, 1 ); + if ( isnan( c ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( c ) ) { + 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( format( '%s::native:len=%d', pkg, len ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..177ed6fdcd33 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var format = require( '@stdlib/string/format' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var dpcorrwd = 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 x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var c; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + c = dpcorrwd( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( c ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( c ) ) { + 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( format( '%s:ndarray:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..2744d4884cf4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,109 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var format = require( '@stdlib/string/format' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dpcorrwd = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dpcorrwd 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 x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var c; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + c = dpcorrwd( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( c ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( c ) ) { + 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( format( '%s::native:ndarray:len=%d', pkg, len ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/dpcorrwd/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..fd50e2751812 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c @@ -0,0 +1,209 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/dpcorrwd.h" +#include +#include +#include +#include +#include + +#define NAME "dpcorrwd" +#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 [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double c; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + y = (double *) malloc( len * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); + } + c = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + c = stdlib_strided_dpcorrwd( len, x, 1, y, 1 ); + if ( c != c ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( c != c ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( y ); + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double c; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + y = (double *) malloc( len * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); + } + c = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + c = stdlib_strided_dpcorrwd_ndarray( len, x, 1, 0, x, 1, 0 ); + if ( c != c ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( c != c ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( y ); + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/dpcorrwd/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/repl.txt new file mode 100644 index 000000000000..d72a97c844cf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/repl.txt @@ -0,0 +1,112 @@ + +{{alias}}( N, x, strideX, y, strideY ) + Computes the sample Pearson product-moment correlation coefficient of two + double-precision floating-point strided arrays using Welford algorithm. + + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use a typed + array view. + + If `N <= 0`, the function returns `NaN`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Stride length of `x`. + + y: Float64Array + Second input array. + + strideY: integer + Stride length of `y`. + + Returns + ------- + out: number + Pearson product-moment correlation coefficient. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 2.0, -2.0, 1.0 ] ); + > var out = {{alias}}( x.length, x, 1, y, 1 ) + ~0.885 + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 5.0, 1.0, 2.0, 7.0, 2.0, 4.0 ] ); + > out = {{alias}}( 3, x, 1, y, -1 ) + ~0.721 + + // Using view offsets: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x.buffer, x.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float64}}( y.buffer, y.BYTES_PER_ELEMENT*3 ); + > out = {{alias}}( 3, x1, 1, y1, 1 ) + 1.0 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Computes the sample Pearson product-moment correlation coefficient of two + double-precision floating-point strided arrays using Welford algorithm and + alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Stride length of `x`. + + offsetX: integer + Starting index of `x`. + + y: Float64Array + Second input array. + + strideY: integer + Stride length of `y`. + + offsetY: integer + Starting index of `y`. + + Returns + ------- + out: number + Pearson product-moment correlation coefficient. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 2.0, -2.0, 1.0 ] ); + > var out = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) + ~0.885 + + // Using offset parameters: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > out = {{alias}}.ndarray( 3, x, 1, 1, y, 1, 3 ) + 1.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts new file mode 100644 index 000000000000..3d15bd451e33 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts @@ -0,0 +1,103 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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 `dpcorrwd`. +*/ +interface Routine { + /** + * Computes the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford algorithm. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - stride length of `x` + * @param y - second input array + * @param strideY - stride length of `y` + * @returns pearson correlation coefficient + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * var y = new Float64Array( [ 2.0, -2.0, 1.0 ] ); + * + * var v = dpcorrwd( x.length, x, 1, y, 1 ); + * // returns ~0.885 + */ + ( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): number; + + /** + * Computes the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford algorithm and alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - stride length of `x` + * @param offsetX - starting index of `x` + * @param y - second input array + * @param strideY - stride length of `y` + * @param offsetY - starting index of `y` + * @returns pearson correlation coefficient + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * var y = new Float64Array( [ 2.0, -2.0, 1.0 ] ); + * + * var v = dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns ~0.885 + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): number; +} + +/** +* Computes the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford algorithm. +* +* @param N - number of indexed elements +* @param x - first input array +* @param strideX - stride length of `x +* @param y - second input array +* @param strideY - stride length of `y` +* @returns pearson correlation coefficient +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] ); +* +* var v = dpcorrwd( x.length, x, 1, y, 1 ); +* // returns ~0.885 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] ); +* +* var v = dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns ~0.885 +*/ +declare var dpcorrwd: Routine; + + +// EXPORTS // + +export = dpcorrwd; diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts new file mode 100644 index 000000000000..c93ea6122b68 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts @@ -0,0 +1,249 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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 dpcorrwd = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd( x.length, x, 1, y, 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd( '10', x, 1, y, 1 ); // $ExpectError + dpcorrwd( true, x, 1, y, 1 ); // $ExpectError + dpcorrwd( false, x, 1, y, 1 ); // $ExpectError + dpcorrwd( null, x, 1, y, 1 ); // $ExpectError + dpcorrwd( undefined, x, 1, y, 1 ); // $ExpectError + dpcorrwd( [], x, 1, y, 1 ); // $ExpectError + dpcorrwd( {}, x, 1, y, 1 ); // $ExpectError + dpcorrwd( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd( x.length, 10, 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, '10', 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, true, 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, false, 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, null, 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, undefined, 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, [ '1' ], 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, {}, 1, y, 1 ); // $ExpectError + dpcorrwd( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd( x.length, x, '10', y, 1 ); // $ExpectError + dpcorrwd( x.length, x, true, y, 1 ); // $ExpectError + dpcorrwd( x.length, x, false, y, 1 ); // $ExpectError + dpcorrwd( x.length, x, null, y, 1 ); // $ExpectError + dpcorrwd( x.length, x, undefined, y, 1 ); // $ExpectError + dpcorrwd( x.length, x, [], y, 1 ); // $ExpectError + dpcorrwd( x.length, x, {}, y, 1 ); // $ExpectError + dpcorrwd( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dpcorrwd( x.length, x, 1, 10, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, '10', 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, true, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, false, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, null, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, undefined, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, [ '1' ], 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, {}, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd( x.length, x, 1, y, '10' ); // $ExpectError + dpcorrwd( x.length, x, 1, y, true ); // $ExpectError + dpcorrwd( x.length, x, 1, y, false ); // $ExpectError + dpcorrwd( x.length, x, 1, y, null ); // $ExpectError + dpcorrwd( x.length, x, 1, y, undefined ); // $ExpectError + dpcorrwd( x.length, x, 1, y, [] ); // $ExpectError + dpcorrwd( x.length, x, 1, y, {} ); // $ExpectError + dpcorrwd( x.length, x, 1, y, ( 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 y = new Float64Array( 20 ); + + dpcorrwd(); // $ExpectError + dpcorrwd( x.length ); // $ExpectError + dpcorrwd( x.length, x ); // $ExpectError + dpcorrwd( x.length, x, 1 ); // $ExpectError + dpcorrwd( x.length, x, 1, y ); // $ExpectError + dpcorrwd( x.length, x, 1, y, 1, 0 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, [ '1' ], 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, ( x: number ): number => x, 0, y, 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 y = new Float64Array( 20 ); + + dpcorrwd.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an fifth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dpcorrwd.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, [ '1' ], 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + dpcorrwd.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 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 y = new Float64Array( 20 ); + + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 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 y = new Float64Array( 20 ); + + dpcorrwd.ndarray(); // $ExpectError + dpcorrwd.ndarray( x.length ); // $ExpectError + dpcorrwd.ndarray( x.length, x ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + dpcorrwd.ndarray( x.length, x, 1, 0, y, 1, 0, 0 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/dpcorrwd/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c new file mode 100644 index 000000000000..c6d728bd85cd --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/dpcorrwd.h" +#include + +int main( void ) { + // Create strided arrays: + const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + const double y[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + + // Specify the number of elements: + const int N = 8; + + // Specify strides: + const int strideX = 1; + const int strideY = -1; + + // Compute the Pearson product-moment correlation coefficient between `x` and `y`: + double d = stdlib_strided_dpcorrwd( N, x, strideX, y, strideY ); + + // Print the result: + printf( "Pearson Correlation Coefficient: %lf\n", d ); + + // Compute the Pearson product-moment correlation coefficient between `x` and `y` with offsets: + d = stdlib_strided_dpcorrwd_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + + // Print the result: + printf( "Pearson Correlation Coefficient: %lf\n", d ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js new file mode 100644 index 000000000000..4b719cbf6132 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 dpcorrwd = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, -50, 50, opts ); +console.log( x ); + +var y = discreteUniform( 10, -50, 50, opts ); +console.log( y ); + +var c = dpcorrwd( x.length, x, 1, y, 1 ); +console.log( c ); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + '=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "pearson", + "correlation", + "corr", + "pcorr", + "welford", + "strided", + "strided array", + "typed", + "array", + "float64", + "double", + "float64array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/dpcorrwd/src/addon.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c new file mode 100644 index 000000000000..6315d0dec037 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/dpcorrwd.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_strided_float64array.h" +#include "stdlib/napi/create_double.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, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Y, N, strideY, argv, 3 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dpcorrwd)( N, X, strideX, Y, strideY ), v ); + return v; +} + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 7 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetY, argv, 6 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Y, N, strideY, argv, 4 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_dpcorrwd_ndarray)( N, X, strideX, offsetX, Y, strideY, offsetY ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c new file mode 100644 index 000000000000..0a1538c89bdb --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c @@ -0,0 +1,98 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/dpcorrwd.h" +#include "stdlib/math/base/special/sqrt.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford algorithm. +* +* @param N number of indexed elements +* @param X first input array +* @param strideX stride length of `X` +* @param Y second input array +* @param strideY stride length of `Y` +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dpcorrwd)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + const CBLAS_INT oy = stdlib_strided_stride2offset( N, strideY ); + return API_SUFFIX(stdlib_strided_dpcorrwd_ndarray)( N, X, strideX, ox, Y, strideY, oy ); +} + +/** +* Computes the sample Pearson product-moment correlation coefficient of two double-precision floating-point strided arrays using Welford algorithm and alternative indexing semantics. +* +* @param N number of indexed elements +* @param X first input array +* @param strideX stride length of `X` +* @param offsetX starting index for X +* @param Y second input array +* @param strideY stride length of `Y` +* @param offsetY starting index for Y +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dpcorrwd_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ) { + CBLAS_INT iy; + CBLAS_INT ix; + CBLAS_INT i; + double M2x; + double M2y; + double dy1; + double dy2; + double dx; + double my; + double mx; + double sy; + double sx; + double C; + + if ( N <= 0 ) { + return 0.0 / 0.0; // NaN + } + ix = offsetX; + iy = offsetY; + C = 0.0; + mx = 0.0; + my = 0.0; + M2x = 0.0; + M2y = 0.0; + for ( i = 0; i < N; i++ ) { + dx = X[ ix ] - mx; + mx += dx / ( i+1 ); + M2x += dx * ( X[ ix ] - mx ); + + dy1 = Y[ iy ] - my; + my += dy1 / ( i+1 ); + dy2 = Y[ iy ] - my; + M2y += dy2 * dy1; + + C += dx * dy2; + + ix += strideX; + iy += strideY; + } + if ( M2x == 0.0 || M2y == 0.0 ) { + return 0.0 / 0.0; // NaN + } + sx = stdlib_base_sqrt( M2x/N ); + sy = stdlib_base_sqrt( M2y/N ); + return ( C/N ) / ( sx*sy ); // Note: why all the dividing by `N`? To avoid overflow. +} diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.js new file mode 100644 index 000000000000..54287e3c6681 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.js @@ -0,0 +1,217 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var dpcorrwd = require( './../lib/dpcorrwd.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dpcorrwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( dpcorrwd.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Pearson product-moment correlation coefficient between two strided arrays', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, -0.3035656199908971, 1 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, 0.7714542762891773, 1 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + c = dpcorrwd( 0, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + + c = dpcorrwd( -4, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, y, 1 ); + t.strictEqual( isAlmostSameValue( c, -0.30980091032971513, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 1, y, 2 ); + t.strictEqual( isAlmostSameValue( c, 0.978883465889473, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, -2, y, -1 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, y, -1 ); + t.strictEqual( isAlmostSameValue( c, -0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var x0; + var y0; + var x1; + var y1; + var c; + + x0 = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y0 = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x1, 2, y1, 1 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.native.js new file mode 100644 index 000000000000..c1ea27108035 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.dpcorrwd.native.js @@ -0,0 +1,226 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dpcorrwd = tryRequire( resolve( __dirname, './../lib/dpcorrwd.native.js' ) ); +var opts = { + 'skip': ( dpcorrwd instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dpcorrwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( dpcorrwd.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Pearson product-moment correlation coefficient between two strided arrays', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, -0.3035656199908971, 1 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, 0.7714542762891773, 1 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + c = dpcorrwd( 0, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + + c = dpcorrwd( -4, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, y, 1 ); + t.strictEqual( isAlmostSameValue( c, -0.30980091032971513, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 1, y, 2 ); + t.strictEqual( isAlmostSameValue( c, 0.978883465889473, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, -2, y, -1 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, y, -1 ); + t.strictEqual( isAlmostSameValue( c, -0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var x0; + var y0; + var x1; + var y1; + var c; + + x0 = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y0 = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x1, 2, y1, 1 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js new file mode 100644 index 000000000000..de2fd218f60d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 dpcorrwd = 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 dpcorrwd, '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 dpcorrwd.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 dpcorrwd = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dpcorrwd, 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 dpcorrwd; + var main; + + main = require( './../lib/dpcorrwd.js' ); + + dpcorrwd = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dpcorrwd, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.js new file mode 100644 index 000000000000..13910753e781 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.js @@ -0,0 +1,240 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var dpcorrwd = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dpcorrwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', function test( t ) { + t.strictEqual( dpcorrwd.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Pearson product-moment correlation coefficient between two strided arrays', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, -0.3035656199908971, 1 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, 0.7714542762891773, 1 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + c = dpcorrwd( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + + c = dpcorrwd( -4, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, -0.30980091032971513, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` offset', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0, + 11.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 1, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 1, 0, y, 2, 0 ); + t.strictEqual( isAlmostSameValue( c, 0.978883465889473, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + y = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 0, y, 1, 3 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, -2, x.length-1, y, -1, 2 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 0, y, -1, y.length-2 ); + t.strictEqual( isAlmostSameValue( c, -0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.native.js new file mode 100644 index 000000000000..a219638a6f4f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.ndarray.native.js @@ -0,0 +1,249 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dpcorrwd = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dpcorrwd instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dpcorrwd, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', opts, function test( t ) { + t.strictEqual( dpcorrwd.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Pearson product-moment correlation coefficient between two strided arrays', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, -0.3035656199908971, 1 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, 0.7714542762891773, 1 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + c = dpcorrwd( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + + c = dpcorrwd( -4, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, -0.30980091032971513, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` offset', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0, + 11.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 1, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 1, 0, y, 2, 0 ); + t.strictEqual( isAlmostSameValue( c, 0.978883465889473, 1 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + y = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 0, y, 1, 3 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, -2, x.length-1, y, -1, 2 ); + t.strictEqual( isAlmostSameValue( c, 0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', opts, function test( t ) { + var c; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ]); + + // Tested against SciPy's `spatial.stats.pearsonr`: + c = dpcorrwd( 3, x, 2, 0, y, -1, y.length-2 ); + t.strictEqual( isAlmostSameValue( c, -0.9999999999999998, 2 ), true, 'returns expected value' ); + t.end(); +}); From 8655c07ba762ad9bc27aada805f31ab5c8e7e38a Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 3 Mar 2026 17:32:02 +0000 Subject: [PATCH 2/3] chore: update copyright years --- lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md | 2 +- .../@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js | 2 +- .../stats/strided/dpcorrwd/benchmark/benchmark.native.js | 2 +- .../stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js | 2 +- .../strided/dpcorrwd/benchmark/benchmark.ndarray.native.js | 2 +- .../@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile | 2 +- .../stats/strided/dpcorrwd/benchmark/c/benchmark.length.c | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp | 2 +- .../@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts | 2 +- .../@stdlib/stats/strided/dpcorrwd/docs/types/test.ts | 2 +- .../@stdlib/stats/strided/dpcorrwd/examples/c/Makefile | 2 +- .../@stdlib/stats/strided/dpcorrwd/examples/c/example.c | 2 +- .../@stdlib/stats/strided/dpcorrwd/examples/index.js | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi | 2 +- .../strided/dpcorrwd/include/stdlib/stats/strided/dpcorrwd.h | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.js | 2 +- .../@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.native.js | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/index.js | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/main.js | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/native.js | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.js | 2 +- .../@stdlib/stats/strided/dpcorrwd/lib/ndarray.native.js | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c | 2 +- lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js | 2 +- 26 files changed, 26 insertions(+), 26 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md index ef87ae5d8f76..c314bb79af8f 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js index 1bea253d1ca8..ce9647af254d 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js index 56d378078778..b12395f1d9f0 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js index 177ed6fdcd33..725af2030e4b 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js index 2744d4884cf4..3b1bd06f7347 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/benchmark.ndarray.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile index cce2c865d7ad..0756dc7da20a 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c index fd50e2751812..1d735b3bc491 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/benchmark/c/benchmark.length.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp index 68a1ca11d160..0d6508a12e99 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/binding.gyp @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts index 3d15bd451e33..dc11b048ba61 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts index c93ea6122b68..bfeef828b54a 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile index 25ced822f96a..c8f8e9a1517b 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c index c6d728bd85cd..a05b9243caa9 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/c/example.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js index 4b719cbf6132..972b033ecfb1 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi index ecfaf82a3279..bee8d41a2caf 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include.gypi @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include/stdlib/stats/strided/dpcorrwd.h b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include/stdlib/stats/strided/dpcorrwd.h index 89e221cd3ffc..434d5cf89f83 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include/stdlib/stats/strided/dpcorrwd.h +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/include/stdlib/stats/strided/dpcorrwd.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.js index 0eaee312a0f2..e8c0fbf05139 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.native.js index eb98687a3d79..189d8c97198d 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.native.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/dpcorrwd.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/index.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/index.js index f4ffa2b38bab..db89aa62c1da 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/index.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/main.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/main.js index b6fd94077b92..143a2657a95e 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/main.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/native.js index 27366b7e12d6..909ac0075b11 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/native.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.js index ac767a67815c..bf50fcd4be34 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.native.js index d55d4659bf77..cc906f1fb169 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/lib/ndarray.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile index 7733b6180cb4..2caf905cedbe 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c index 6315d0dec037..f778211d1802 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c index 0a1538c89bdb..631b7949a517 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js index de2fd218f60d..a6febe1f7da7 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* 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. From f8ac88b631b7723b0ac9c7b02e2fd1c10fedcbb8 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Wed, 4 Mar 2026 00:16:26 +0530 Subject: [PATCH 3/3] chore: update according to code review Signed-off-by: Nakul Krishnakumar --- .../@stdlib/stats/strided/dpcorrwd/docs/types/test.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts index bfeef828b54a..a36e327c3f7d 100644 --- a/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/strided/dpcorrwd/docs/types/test.ts @@ -90,7 +90,7 @@ import dpcorrwd = require( './index' ); dpcorrwd( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError } -// The compiler throws an error if the function is provided an fifth argument which is not a number... +// The compiler throws an error if the function is provided a fifth argument which is not a number... { const x = new Float64Array( 10 ); const y = new Float64Array( 20 ); @@ -187,7 +187,7 @@ import dpcorrwd = require( './index' ); dpcorrwd.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError } -// The compiler throws an error if the `ndarray` method is provided an fifth argument which is not a Float64Array... +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float64Array... { const x = new Float64Array( 10 );