diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/README.md b/lib/node_modules/@stdlib/stats/strided/scovarmtk/README.md new file mode 100644 index 000000000000..853b9c082f68 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/README.md @@ -0,0 +1,386 @@ + + + + +# scovarmtk + +> Calculate the [covariance][covariance] of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm. + +
+ +The population [covariance][covariance] of two finite size populations of size `N` is given by + + + +```math +\mathop{\mathrm{cov_N}} = \frac{1}{N} \sum_{i=0}^{N-1} (x_i - \mu_x)(y_i - \mu_y) +``` + + + +where the population means are given by + + + +```math +\mu_x = \frac{1}{N} \sum_{i=0}^{N-1} x_i +``` + + + +and + + + +```math +\mu_y = \frac{1}{N} \sum_{i=0}^{N-1} y_i +``` + + + +Often in the analysis of data, the true population [covariance][covariance] is not known _a priori_ and must be estimated from samples drawn from population distributions. If one attempts to use the formula for the population [covariance][covariance], the result is biased and yields a **biased sample covariance**. To compute an **unbiased sample covariance** for samples of size `n`, + + + +```math +\mathop{\mathrm{cov_n}} = \frac{1}{n-1} \sum_{i=0}^{n-1} (x_i - \bar{x}_n)(y_i - \bar{y}_n) +``` + + + +where sample means are given by + + + +```math +\bar{x} = \frac{1}{n} \sum_{i=0}^{n-1} x_i +``` + + + +and + + + +```math +\bar{y} = \frac{1}{n} \sum_{i=0}^{n-1} y_i +``` + + + +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 scovarmtk = require( '@stdlib/stats/strided/scovarmtk' ); +``` + +#### scovarmtk( N, correction, meanx, x, strideX, meany, y, strideY ) + +Computes the [covariance][covariance] of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); +var y = new Float32Array( [ 2.0, -2.0, 1.0 ] ); + +var v = scovarmtk( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, y, 1 ); +// returns ~3.8333 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [covariance][covariance] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the population [covariance][covariance], setting this parameter to `0` is the standard choice (i.e., the provided arrays contain data constituting entire populations). When computing the unbiased sample [covariance][covariance], setting this parameter to `1` is the standard choice (i.e., the provided arrays contain data sampled from larger populations; this is commonly referred to as Bessel's correction). +- **meanx**: mean of `x`. +- **x**: first input [`Float32Array`][@stdlib/array/float32]. +- **strideX**: stride length for `x`. +- **meany**: mean of `y`. +- **y**: second input [`Float32Array`][@stdlib/array/float32]. +- **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 [covariance][covariance] of every other element in `x` and `y`, + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); +var y = new Float32Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + +var v = scovarmtk( 4, 1, 1.25, x, 2, 1.25, y, 2 ); +// returns 5.25 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +var y0 = new Float32Array( [ 2.0, -2.0, 2.0, 1.0, -2.0, 4.0, 3.0, 2.0 ] ); + +var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var v = scovarmtk( 4, 1, 1.25, x1, 2, 1.25, y1, 2 ); +// returns ~1.9167 +``` + +#### scovarmtk.ndarray( N, correction, meanx, x, strideX, offsetX, meany, y, strideY, offsetY ) + +Computes the [covariance][covariance] of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm and alternative indexing semantics. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); +var y = new Float32Array( [ 2.0, -2.0, 1.0 ] ); + +var v = scovarmtk.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, y, 1, 0 ); +// returns ~3.8333 +``` + +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 [covariance][covariance] for every other element in `x` and `y` starting from the second element + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +var y = new Float32Array( [ -7.0, 2.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + +var v = scovarmtk.ndarray( 4, 1, 1.25, x, 2, 1, 1.25, y, 2, 1 ); +// returns 6.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `NaN`. +- If `N - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment), both functions return `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var scovarmtk = require( '@stdlib/stats/strided/scovarmtk' ); + +var opts = { + 'dtype': 'float32' +}; +var x = discreteUniform( 10, -50, 50, opts ); +console.log( x ); + +var y = discreteUniform( 10, -50, 50, opts ); +console.log( y ); + +var v = scovarmtk( x.length, 1, 0.0, x, 1, 0.0, y, 1 ); +console.log( v ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/strided/scovarmtk.h" +``` + +#### stdlib_strided_scovarmtk( N, correction, meanx, \*X, strideX, meany, \*Y, strideY ) + +Computes the [covariance][covariance] of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm. + +```c +const float x[] = { 1.0f, -2.0f, 2.0f }; +const float y[] = { 2.0f, -2.0f, 1.0f }; + +float v = stdlib_strided_scovarmtk( 3, 1.0f, 1.0f/3.0f, x, 1, 1.0f/3.0f, y, 1 ); +// returns ~3.8333f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **correction**: `[in] float` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [covariance][covariance] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the population [covariance][covariance], setting this parameter to `0` is the standard choice (i.e., the provided arrays contain data constituting entire populations). When computing the unbiased sample [covariance][covariance], setting this parameter to `1` is the standard choice (i.e., the provided arrays contain data sampled from larger populations; this is commonly referred to as Bessel's correction). +- **meanx**: `[in] float` mean of `X`. +- **X**: `[in] float*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **meany**: `[in] float` mean of `Y`. +- **Y**: `[in] float*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. + +```c +float stdlib_strided_scovarmtk( const CBLAS_INT N, const float correction, const float meanx, const float *X, const CBLAS_INT strideX, const float meany, const float *Y, const CBLAS_INT strideY ); +``` + +#### stdlib_strided_scovarmtk_ndarray( N, correction, meanx, \*X, strideX, offsetX, meany, \*Y, strideY, offsetY ) + +Computes the [covariance][covariance] of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm and alternative indexing semantics. + +```c +const float x[] = { 1.0f, -2.0f, 2.0f }; +const float y[] = { 2.0f, -2.0f, 1.0f }; + +float v = stdlib_strided_scovarmtk_ndarray( 3, 1.0f, 1.0f/3.0f, x, 1, 0, 1.0f/3.0f, y, 1, 0 ); +// returns ~3.8333f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **correction**: `[in] float` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [covariance][covariance] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the population [covariance][covariance], setting this parameter to `0` is the standard choice (i.e., the provided arrays contain data constituting entire populations). When computing the unbiased sample [covariance][covariance], setting this parameter to `1` is the standard choice (i.e., the provided arrays contain data sampled from larger populations; this is commonly referred to as Bessel's correction). +- **meanx**: `[in] float` mean of `X`. +- **X**: `[in] float*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **meany**: `[in] float` mean of `Y`. +- **Y**: `[in] float*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. +- **offsetY**: `[in] CBLAS_INT` starting index for `Y`. + +```c +float stdlib_strided_scovarmtk_ndarray( const CBLAS_INT N, const float correction, const float meanx, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const float meany, const float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/strided/scovarmtk.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the covariance of `x` with itself: + float v = stdlib_strided_scovarmtk( N, 1.0f, 4.5f, x, strideX, 4.5f, x, -strideX ); + + // Print the result: + printf( "covariance: %f\n", v ); +} +``` + +
+ + + +
+ + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.js new file mode 100644 index 000000000000..65062d7766ec --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.js @@ -0,0 +1,96 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var scovarmtk = require( './../lib/scovarmtk.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -10.0, 10.0, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, 1 ); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.native.js new file mode 100644 index 000000000000..e5b0c5e13aec --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.native.js @@ -0,0 +1,101 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var scovarmtk = tryRequire( resolve( __dirname, './../lib/scovarmtk.native.js' ) ); +var opts = { + 'skip': ( scovarmtk instanceof Error ) +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -10.0, 10.0, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, 1 ); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+'::native:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..df5a9d67a2bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.ndarray.js @@ -0,0 +1,96 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var scovarmtk = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -10.0, 10.0, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = scovarmtk( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':ndarray:len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..23555b77d3f6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,101 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var scovarmtk = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( scovarmtk instanceof Error ) +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -10.0, 10.0, options ); + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = scovarmtk( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+'::native:ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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/scovarmtk/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..90430dccae37 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/benchmark/c/benchmark.length.c @@ -0,0 +1,197 @@ +/** +* @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/scovarmtk.h" +#include +#include +#include +#include +#include + +#define NAME "scovarmtk" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0f ); +} + +/** +* 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; + float x[ len ]; + double t; + float v; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_float()*20000.0f ) - 10000.0f; + } + v = 0.0f; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_scovarmtk( len, 1.0f, 0.0f, x, 1, 0.0f, x, 1 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + float x[ len ]; + double t; + float v; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_float()*20000.0f ) - 10000.0f; + } + v = 0.0f; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_scovarmtk_ndarray( len, 1.0f, 0.0f, x, 1, 0, 0.0f, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/binding.gyp b/lib/node_modules/@stdlib/stats/strided/scovarmtk/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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/scovarmtk/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/repl.txt new file mode 100644 index 000000000000..d567f6c4c9d0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/repl.txt @@ -0,0 +1,142 @@ + +{{alias}}( N, correction, meanx, x, sx, meany, y, sy ) + Computes the covariance of two single-precision floating-point strided + arrays provided known means and using a one-pass textbook 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. + + correction: number + Degrees of freedom adjustment. Setting this parameter to a value other + than `0` has the effect of adjusting the divisor during the calculation + of the covariance according to `N - c` where `c` corresponds to the + provided degrees of freedom adjustment. When computing the population + covariance, setting this parameter to `0` is the standard choice (i.e., + the provided arrays contain data constituting entire populations). When + computing the unbiased sample covariance, setting this parameter to `1` + is the standard choice (i.e., the provided array contains data sampled + from larger populations; this is commonly referred to as Bessel's + correction). + + meanx: number + Mean of `x`. + + x: Float32Array + First input array. + + sx: integer + Stride length of `x`. + + meany: number + Mean of `y`. + + y: Float32Array + Second input array. + + sy: integer + Stride length of `y`. + + Returns + ------- + out: number + The covariance. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] ); + > {{alias}}( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, x, 1 ) + ~4.3333 + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] ); + > {{alias}}( 3, 1, 1.0/3.0, x, 2, 1.0/3.0, x, 2 ) + ~4.3333 + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); + > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > {{alias}}( 3, 1, 1.0/3.0, x1, 2, 1.0/3.0, x1, 2 ) + ~4.3333 + + +{{alias}}.ndarray( N, correction, meanx, x, sx, ox, meany, y, sy, oy ) + Computes the covariance of two single-precision floating-point strided + arrays provided known means and using a one-pass textbook 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. + + correction: number + Degrees of freedom adjustment. Setting this parameter to a value other + than `0` has the effect of adjusting the divisor during the calculation + of the covariance according to `N - c` where `c` corresponds to the + provided degrees of freedom adjustment. When computing the population + covariance, setting this parameter to `0` is the standard choice (i.e., + the provided arrays contain data constituting entire populations). When + computing the unbiased sample covariance, setting this parameter to + `1` is the standard choice (i.e., the provided arrays contain data + sampled from larger populations; this is commonly referred to as + Bessel's correction). + + meanx: number + Mean of `x`. + + x: Float32Array + First input array. + + sx: integer + Stride length of `x`. + + ox: integer + Starting index of `x`. + + meany: number + Mean of `y`. + + y: Float32Array + Second input array. + + sy: integer + Stride length of `y`. + + oy: integer + Starting index of `y`. + + Returns + ------- + out: number + The covariance. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] ); + > {{alias}}.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, x, 1, 0 ) + ~4.3333 + + // Using offset parameters: + > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); + > {{alias}}.ndarray( 3, 1, 1.0/3.0, x, 2, 1, 1.0/3.0, x, 2, 1 ) + ~4.3333 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/types/index.d.ts new file mode 100644 index 000000000000..96a60ee3f731 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/types/index.d.ts @@ -0,0 +1,112 @@ +/* +* @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 `scovarmtk`. +*/ +interface Routine { + /** + * Computes the covariance of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm. + * + * @param N - number of indexed elements + * @param correction - degrees of freedom adjustment + * @param meanx - mean of `x` + * @param x - first input array + * @param strideX - stride length of `x` + * @param meany - mean of `y` + * @param y - second input array + * @param strideY - stride length of `y` + * @returns covariance + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); + * var y = new Float32Array( [ 2.0, -2.0, 1.0 ] ); + * + * var v = scovarmtk( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, y, 1 ); + * // returns ~3.8333 + */ + ( N: number, correction: number, meanx: number, x: Float32Array, strideX: number, meany: number, y: Float32Array, strideY: number ): number; + + /** + * Computes the covariance of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm and alternative indexing semantics. + * + * @param N - number of indexed elements + * @param correction - degrees of freedom adjustment + * @param meanx - mean of `x` + * @param x - first input array + * @param strideX - stride length of `x` + * @param offsetX - starting index of `x` + * @param meany - mean of `y` + * @param y - second input array + * @param strideY - stride length of `y` + * @param offsetY - starting index of `y` + * @returns covariance + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); + * var y = new Float32Array( [ 2.0, -2.0, 1.0 ] ); + * + * var v = scovarmtk.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, y, 1, 0 ); + * // returns ~3.8333 + */ + ndarray( N: number, correction: number, meanx: number, x: Float32Array, strideX: number, offsetX: number, meany: number, y: Float32Array, strideY: number, offsetY: number ): number; +} + +/** +* Computes the covariance of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm. +* +* @param N - number of indexed elements +* @param correction - degrees of freedom adjustment +* @param meanx - mean of `x` +* @param x - first input array +* @param strideX - stride length of `x` +* @param meany - mean of `y` +* @param y - second input array +* @param strideY - stride length of `y` +* @returns covariance +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); +* var y = new Float32Array( [ 2.0, -2.0, 1.0 ] ); +* +* var v = scovarmtk( x.length, 1, 1.0/3.0, x, 1, 1.0/3.0, y, 1 ); +* // returns ~3.8333 +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); +* var y = new Float32Array( [ 2.0, -2.0, 1.0 ] ); +* +* var v = scovarmtk.ndarray( x.length, 1, 1.0/3.0, x, 1, 0, 1.0/3.0, y, 1, 0 ); +* // returns ~3.8333 +*/ +declare var scovarmtk: Routine; + + +// EXPORTS // + +export = scovarmtk; diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/types/test.ts new file mode 100644 index 000000000000..d2a294eb0202 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/docs/types/test.ts @@ -0,0 +1,324 @@ +/* +* @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 scovarmtk = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( '10', 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( true, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( false, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( null, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( undefined, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( [], 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( {}, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( ( x: number ): number => x, 1, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, '10', 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, true, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, false, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, null, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, undefined, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, [], 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, {}, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, ( x: number ): number => x, 0.0, x, 1, 0.0, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, '10', x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, true, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, false, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, null, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, undefined, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, [], x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, {}, x, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, ( x: number ): number => x, x, 1, 0.0, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, 0.0, 10, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, '10', 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, true, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, false, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, null, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, undefined, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, [ '1' ], 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, {}, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, ( x: number ): number => x, 1, 0.0, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, 0.0, x, '10', 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, true, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, false, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, null, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, undefined, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, [], 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, {}, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, ( x: number ): number => x, 0.0, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, 0.0, x, 1, '10', x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, true, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, false, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, null, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, undefined, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, [], x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, {}, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, ( x: number ): number => x, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a seventh argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, 10, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, '10', 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, true, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, false, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, null, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, undefined, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, [ '1' ], 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, {}, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an eighth argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, '10' ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, true ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, false ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, null ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, undefined ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, [] ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, {} ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float32Array( 10 ); + + scovarmtk(); // $ExpectError + scovarmtk( x.length ); // $ExpectError + scovarmtk( x.length, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0 ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x ); // $ExpectError + scovarmtk( x.length, 1, 0.0, x, 1, 0.0, x, 1, 0 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( '10', 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( true, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( false, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( null, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( undefined, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( [], 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( {}, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( ( x: number ): number => x, 1, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, '10', 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, true, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, false, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, null, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, undefined, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, [], 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, {}, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, ( x: number ): number => x, 0.0, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, '10', x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, true, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, false, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, null, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, undefined, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, [], x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, {}, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, ( x: number ): number => x, x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, 10, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, '10', 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, true, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, false, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, null, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, undefined, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, [ '1' ], 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, {}, 1, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, ( x: number ): number => x, 1, 0, 0.0, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, '10', 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, true, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, false, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, null, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, undefined, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, [], 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, {}, 0, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, ( x: number ): number => x, 0, 0.0, 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 Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, '10', 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, true, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, false, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, null, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, undefined, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, [], 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, {}, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, ( x: number ): number => x, 0.0, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, '10', x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, true, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, false, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, null, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, undefined, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, [], x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, {}, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, ( x: number ): number => x, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, 10, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, '10', 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, true, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, false, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, null, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, undefined, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, [ '1' ], 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, {}, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a ninth argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, '10', 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, true, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, false, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, null, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, undefined, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, [], 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, {}, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a tenth argument which is not a number... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, '10' ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, true ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, false ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, null ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, undefined ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, [] ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, {} ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float32Array( 10 ); + + scovarmtk.ndarray(); // $ExpectError + scovarmtk.ndarray( x.length ); // $ExpectError + scovarmtk.ndarray( x.length, 1 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1 ); // $ExpectError + scovarmtk.ndarray( x.length, 1, 0.0, x, 1, 0, 0.0, x, 1, 0, 0 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/scovarmtk/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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/scovarmtk/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/scovarmtk/examples/c/example.c new file mode 100644 index 000000000000..69119698306c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/examples/c/example.c @@ -0,0 +1,37 @@ +/** +* @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/scovarmtk.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the covariance of `x` with itself: + float v = stdlib_strided_scovarmtk( N, 1.0f, 4.5f, x, strideX, 4.5f, x, -strideX ); + + // Print the result: + printf( "covariance: %f\n", v ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/examples/index.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/examples/index.js new file mode 100644 index 000000000000..c8f7acb0e7e4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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 scovarmtk = require( './../lib' ); + +var opts = { + 'dtype': 'float32' +}; +var x = discreteUniform( 10, -50, 50, opts ); +console.log( x ); + +var y = discreteUniform( 10, -50, 50, opts ); +console.log( y ); + +var v = scovarmtk( x.length, 1, 0.0, x, 1, 0.0, y, 1 ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/include.gypi b/lib/node_modules/@stdlib/stats/strided/scovarmtk/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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", + "covariance", + "covar", + "sample covariance", + "unbiased", + "correlation", + "variance", + "strided", + "strided array", + "typed", + "array", + "float32", + "float", + "float32array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/src/Makefile b/lib/node_modules/@stdlib/stats/strided/scovarmtk/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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/scovarmtk/src/addon.c b/lib/node_modules/@stdlib/stats/strided/scovarmtk/src/addon.c new file mode 100644 index 000000000000..d86d6bd23079 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/src/addon.c @@ -0,0 +1,73 @@ +/** +* @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/scovarmtk.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_float32array.h" +#include "stdlib/napi/create_double.h" +#include "stdlib/napi/argv_float.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, 8 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_FLOAT( env, correction, argv, 1 ); + STDLIB_NAPI_ARGV_FLOAT( env, meanx, argv, 2 ); + STDLIB_NAPI_ARGV_FLOAT( env, meany, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 4 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 7 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, Y, N, strideY, argv, 6 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)API_SUFFIX(stdlib_strided_scovarmtk)( N, correction, meanx, X, strideX, meany, 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, 10 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_FLOAT( env, correction, argv, 1 ); + STDLIB_NAPI_ARGV_FLOAT( env, meanx, argv, 2 ); + STDLIB_NAPI_ARGV_FLOAT( env, meany, argv, 6 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 4 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 8 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, offsetY, argv, 9 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, Y, N, strideY, argv, 7 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)API_SUFFIX(stdlib_strided_scovarmtk_ndarray)( N, correction, meanx, X, strideX, offsetX, meany, 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/scovarmtk/src/main.c b/lib/node_modules/@stdlib/stats/strided/scovarmtk/src/main.c new file mode 100644 index 000000000000..381e3f62ff5a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/src/main.c @@ -0,0 +1,77 @@ +/** +* @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/scovarmtk.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the covariance of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm. +* +* @param N number of indexed elements +* @param correction degrees of freedom adjustment +* @param meanx mean of `X` +* @param X first input array +* @param strideX stride length of `X` +* @param meany mean of `Y` +* @param Y second input array +* @param strideY stride length of `Y` +* @return output value +*/ +float API_SUFFIX(stdlib_strided_scovarmtk)( const CBLAS_INT N, const float correction, const float meanx, const float *X, const CBLAS_INT strideX, const float meany, const float *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_scovarmtk_ndarray)( N, correction, meanx, X, strideX, ox, meany, Y, strideY, oy ); +} + +/** +* Computes the covariance of two single-precision floating-point strided arrays provided known means and using a one-pass textbook algorithm and alternative indexing semantics. +* +* @param N number of indexed elements +* @param correction degrees of freedom adjustment +* @param meanx mean of `X` +* @param X first input array +* @param strideX stride length of `X` +* @param offsetX starting index for X +* @param meany mean of `Y` +* @param Y second input array +* @param strideY stride length of `Y` +* @param offsetY starting index for Y +* @return output value +*/ +float API_SUFFIX(stdlib_strided_scovarmtk_ndarray)( const CBLAS_INT N, const float correction, const float meanx, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const float meany, const float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ) { + CBLAS_INT ix; + CBLAS_INT iy; + CBLAS_INT i; + float C; + float n; + + n = (float)N - correction; + if ( N <= 0 || n <= 0.0f ) { + return 0.0f / 0.0f; // NaN + } + ix = offsetX; + iy = offsetY; + C = 0.0f; + for ( i = 0; i < N; i++ ) { + C += ( X[ ix ] - meanx ) * ( Y[ iy ] - meany ); + ix += strideX; + iy += strideY; + } + return C / n; +} diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.js new file mode 100644 index 000000000000..3aa5d47bb870 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/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 scovarmtk = 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 scovarmtk, '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 scovarmtk.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 scovarmtk = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( scovarmtk, 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 scovarmtk; + var main; + + main = require( './../lib/scovarmtk.js' ); + + scovarmtk = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( scovarmtk, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.ndarray.js new file mode 100644 index 000000000000..47907203240d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.ndarray.js @@ -0,0 +1,212 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var scovarmtk = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof scovarmtk, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 10', function test( t ) { + t.strictEqual( scovarmtk.length, 10, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the population covariance', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 0, 0.5, x, 1, 0, 0.5, y, 1, 0 ); + t.strictEqual( v, f32( -45.5/x.length ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 0, -4.0, x, 1, 0, -4.0, x, 1, 0 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 0, 4.0, x, 1, 0, 4.0, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the sample covariance', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 1, 0.5, x, 1, 0, 0.5, y, 1, 0 ); + t.strictEqual( v, f32( -45.5/(x.length-1) ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 1, -4.0, x, 1, 0, -4.0, x, 1, 0 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 1, 4.0, x, 1, 0, 4.0, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( 0, 1, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( -1, 1, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( x.length, x.length, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( x.length, x.length+1, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 0 + 2.0, + 1.0, // 1 + -7.0, + 4.0, // 2 + 3.0, + -2.0, // 3 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, 2, 0, 1.25, y, 2, 0 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative stride parameters', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 3 + 2.0, + 1.0, // 2 + -7.0, + 4.0, // 1 + 3.0, + -2.0, // 0 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, -2, 6, 1.25, y, -2, 6 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports offset parameters', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]); + + y = new Float32Array([ + 2.0, + 4.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 1.0, // 2 + 3.0, + 2.0 // 3 + ]); + + v = scovarmtk( 4, 1, 1.25, x, 2, 1, 1.25, y, 2, 1 ); + t.strictEqual( v, f32( 11.75/3 ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.ndarray.native.js new file mode 100644 index 000000000000..bdf3129ea512 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.ndarray.native.js @@ -0,0 +1,221 @@ +/** +* @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 tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var scovarmtk = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( scovarmtk instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof scovarmtk, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 10', opts, function test( t ) { + t.strictEqual( scovarmtk.length, 10, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the population covariance', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 0, 0.5, x, 1, 0, 0.5, y, 1, 0 ); + t.strictEqual( v, f32( -45.5/x.length ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 0, -4.0, x, 1, 0, -4.0, x, 1, 0 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 0, 4.0, x, 1, 0, 4.0, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the sample covariance', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 1, 0.5, x, 1, 0, 0.5, y, 1, 0 ); + t.strictEqual( v, f32( -45.5/(x.length-1) ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 1, -4.0, x, 1, 0, -4.0, x, 1, 0 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 1, 4.0, x, 1, 0, 4.0, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( 0, 1, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( -1, 1, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( x.length, x.length, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( x.length, x.length+1, 0.6, x, 1, 0, 0.6, x, 1, 0 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 0 + 2.0, + 1.0, // 1 + -7.0, + 4.0, // 2 + 3.0, + -2.0, // 3 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, 2, 0, 1.25, y, 2, 0 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative stride parameters', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 3 + 2.0, + 1.0, // 2 + -7.0, + 4.0, // 1 + 3.0, + -2.0, // 0 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, -2, 6, 1.25, y, -2, 6 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports offset parameters', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]); + + y = new Float32Array([ + 2.0, + 4.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 1.0, // 2 + 3.0, + 2.0 // 3 + ]); + + v = scovarmtk( 4, 1, 1.25, x, 2, 1, 1.25, y, 2, 1 ); + t.strictEqual( v, f32( 11.75/3 ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.scovarmtk.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.scovarmtk.js new file mode 100644 index 000000000000..123a9ac41673 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.scovarmtk.js @@ -0,0 +1,219 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var scovarmtk = require( './../lib/scovarmtk.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof scovarmtk, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', function test( t ) { + t.strictEqual( scovarmtk.length, 8, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the population covariance', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 0, 0.5, x, 1, 0.5, y, 1 ); + t.strictEqual( v, f32( -45.5/x.length ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 0, -4.0, x, 1, -4.0, x, 1 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 0, 4.0, x, 1, 4.0, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the sample covariance', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 1, 0.5, x, 1, 0.5, y, 1 ); + t.strictEqual( v, f32( -45.5/(x.length-1) ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 1, -4.0, x, 1, -4.0, x, 1 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 1, 4.0, x, 1, 4.0, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( 0, 1, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( -1, 1, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( x.length, x.length, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( x.length, x.length+1, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 0 + 2.0, + 1.0, // 1 + -7.0, + 4.0, // 2 + 3.0, + -2.0, // 3 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, 2, 1.25, y, 2 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative stride parameters', function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 3 + 2.0, + 1.0, // 2 + -7.0, + 4.0, // 1 + 3.0, + -2.0, // 0 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, -2, 1.25, y, -2 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var x0; + var x1; + var y0; + var y1; + var v; + + x0 = new Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + + y0 = new Float32Array([ + 2.0, + -2.0, // 0 + 2.0, + 1.0, // 1 + -2.0, + 4.0, // 2 + 3.0, + 2.0, // 3 + 6.0 + ]); + + x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = scovarmtk( 4, 1, 1.25, x1, 2, 1.25, y1, 2 ); + t.strictEqual( v, f32( 5.75/3 ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.scovarmtk.native.js b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.scovarmtk.native.js new file mode 100644 index 000000000000..c8cb2785df38 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/scovarmtk/test/test.scovarmtk.native.js @@ -0,0 +1,228 @@ +/** +* @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 tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var scovarmtk = tryRequire( resolve( __dirname, './../lib/scovarmtk.native.js' ) ); +var opts = { + 'skip': ( scovarmtk instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof scovarmtk, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', opts, function test( t ) { + t.strictEqual( scovarmtk.length, 8, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the population covariance', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 0, 0.5, x, 1, 0.5, y, 1 ); + t.strictEqual( v, f32( -45.5/x.length ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 0, -4.0, x, 1, -4.0, x, 1 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 0, 4.0, x, 1, 4.0, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the sample covariance', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float32Array( [ -2.0, 1.0, 5.0, -4.0, 3.0, 0.0 ] ); + v = scovarmtk( x.length, 1, 0.5, x, 1, 0.5, y, 1 ); + t.strictEqual( v, f32( -45.5/(x.length-1) ), 'returns expected value' ); + + x = new Float32Array( [ -4.0, -4.0 ] ); + v = scovarmtk( x.length, 1, -4.0, x, 1, -4.0, x, 1 ); + t.strictEqual( v, f32( 0.0 ), 'returns expected value' ); + + x = new Float32Array( [ NaN, 4.0 ] ); + v = scovarmtk( x.length, 1, 4.0, x, 1, 4.0, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( 0, 1, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( -1, 1, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `correction` parameter yielding `N-correction` less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + + v = scovarmtk( x.length, x.length, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + v = scovarmtk( x.length, x.length+1, 0.6, x, 1, 0.6, x, 1 ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 0 + 2.0, + 1.0, // 1 + -7.0, + 4.0, // 2 + 3.0, + -2.0, // 3 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, 2, 1.25, y, 2 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative stride parameters', opts, function test( t ) { + var x; + var y; + var v; + + x = new Float32Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + y = new Float32Array([ + 2.0, // 3 + 2.0, + 1.0, // 2 + -7.0, + 4.0, // 1 + 3.0, + -2.0, // 0 + 2.0 + ]); + + v = scovarmtk( 4, 1, 1.25, x, -2, 1.25, y, -2 ); + + t.strictEqual( v, f32( -18.25/3 ), 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var x0; + var x1; + var y0; + var y1; + var v; + + x0 = new Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + + y0 = new Float32Array([ + 2.0, + -2.0, // 0 + 2.0, + 1.0, // 1 + -2.0, + 4.0, // 2 + 3.0, + 2.0, // 3 + 6.0 + ]); + + x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = scovarmtk( 4, 1, 1.25, x1, 2, 1.25, y1, 2 ); + t.strictEqual( v, f32( 5.75/3 ), 'returns expected value' ); + + t.end(); +});