From f039fdece8d0808d5174a031678ba2b2c2882269 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Tue, 16 Dec 2025 14:16:03 +0530 Subject: [PATCH 1/2] feat: add `blas/ext/base/drssors` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/drssors/README.md | 339 ++++++++++++++++++ .../ext/base/drssors/benchmark/benchmark.js | 97 +++++ .../drssors/benchmark/benchmark.native.js | 102 ++++++ .../drssors/benchmark/benchmark.ndarray.js | 97 +++++ .../benchmark/benchmark.ndarray.native.js | 102 ++++++ .../ext/base/drssors/benchmark/c/Makefile | 146 ++++++++ .../drssors/benchmark/c/benchmark.length.c | 211 +++++++++++ .../@stdlib/blas/ext/base/drssors/binding.gyp | 170 +++++++++ .../blas/ext/base/drssors/docs/repl.txt | 114 ++++++ .../ext/base/drssors/docs/types/index.d.ts | 105 ++++++ .../blas/ext/base/drssors/docs/types/test.ts | 245 +++++++++++++ .../blas/ext/base/drssors/examples/c/Makefile | 146 ++++++++ .../ext/base/drssors/examples/c/example.c | 49 +++ .../blas/ext/base/drssors/examples/index.js | 34 ++ .../blas/ext/base/drssors/include.gypi | 53 +++ .../include/stdlib/blas/ext/base/drssors.h | 45 +++ .../blas/ext/base/drssors/lib/drssors.js | 57 +++ .../ext/base/drssors/lib/drssors.native.js | 54 +++ .../blas/ext/base/drssors/lib/index.js | 70 ++++ .../@stdlib/blas/ext/base/drssors/lib/main.js | 35 ++ .../blas/ext/base/drssors/lib/native.js | 35 ++ .../blas/ext/base/drssors/lib/ndarray.js | 97 +++++ .../ext/base/drssors/lib/ndarray.native.js | 56 +++ .../blas/ext/base/drssors/manifest.json | 103 ++++++ .../blas/ext/base/drssors/package.json | 81 +++++ .../blas/ext/base/drssors/src/Makefile | 70 ++++ .../@stdlib/blas/ext/base/drssors/src/addon.c | 66 ++++ .../@stdlib/blas/ext/base/drssors/src/main.c | 100 ++++++ .../ext/base/drssors/test/test.drssors.js | 212 +++++++++++ .../base/drssors/test/test.drssors.native.js | 221 ++++++++++++ .../blas/ext/base/drssors/test/test.js | 82 +++++ .../ext/base/drssors/test/test.ndarray.js | 208 +++++++++++ .../base/drssors/test/test.ndarray.native.js | 217 +++++++++++ 33 files changed, 3819 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/binding.gyp create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/include.gypi create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/include/stdlib/blas/ext/base/drssors.h create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/drssors.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/drssors.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/src/addon.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/src/main.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/README.md b/lib/node_modules/@stdlib/blas/ext/base/drssors/README.md new file mode 100644 index 000000000000..c7756689495d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/README.md @@ -0,0 +1,339 @@ + + +# drssors + +> Calculate the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation. + +
+ +The [residual sum of squares][wikipedia-residual-sum-of-squares] (also referred to as the **sum of squared residuals** (SSR) and the **sum of squared errors** (SSE)) is defined as + + + +```math +\mathop{\mathrm{RSS}} = \sum_{i=0}^{n-1} (y_i - x_i)^2 +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var drssors = require( '@stdlib/blas/ext/base/drssors' ); +``` + +#### drssors( N, x, strideX, y, strideY ) + +Computes the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, -4.0 ] ); + +var z = drssors( x.length, x, 1, y, 1 ); +// returns 45.0 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: first input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: stride length for `x`. +- **y**: second input [`Float64Array`][@stdlib/array/float64]. +- **strideY**: stride length for `y`. + +The `N` and stride parameters determine which elements in strided arrays are accessed at runtime. For example, to compute the [residual sum of squares][wikipedia-residual-sum-of-squares] of every other element in `x` and `y` + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); +var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + +var z = drssors( x.length, x, 1, y, 1 ); +// returns 72.0 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +var y0 = new Float64Array( [ 8.0, -2.0, 3.0, -2.0, 7.0, -2.0, 0.0, -1.0 ] ); + +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var z = drssors( 4, x1, 2, y1, 2 ); +// returns 50.0 +``` + +If `N` is less than or equal to `0`, the function returns `0`. + +#### drssors.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Computes the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation and alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, -4.0 ] ); + +var z = drssors.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// returns 45.0 +``` + +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 [residual sum of squares][wikipedia-residual-sum-of-squares] for every other element in `x` and `y` starting from the second element + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 6.0 ] ); +var y = new Float64Array( [ 8.0, -2.0, 3.0, -2.0, 7.0, -2.0, 0.0, -1.0, 4.0 ] ); + +var z = drssors.ndarray( 4, x, 2, 1, y, 2, 1 ); +// returns 50.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `0.0`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var drssors = require( '@stdlib/blas/ext/base/drssors' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, -50, 50, opts ); +console.log( x ); + +var y = discreteUniform( 10, -50, 50, opts ); +console.log( y ); + +var d = drssors( x.length, x, 1, y, 1 ); +console.log( d ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/drssors.h" +``` + +#### stdlib_strided_drssors( N, \*X, strideX, \*Y, strideY ) + +Computes the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; +const double y[] = { 1.0, 1.0, -4.0 }; + +double z = stdlib_strided_drssors( 3, x, 1, y, 1 ); +// returns 45.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. + +```c +double stdlib_strided_drssors( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); +``` + + + +#### stdlib_strided_drssors_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY ) + + + +Computes the [residual sum of squares][wikipedia-residual-sum-of-squares] of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation and alternative indexing semantics. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; +const double y[] = { 1.0, 1.0, -4.0 }; + +double v = stdlib_strided_drssors_ndarray( 3, x, 1, 0, 1, 0 ); +// returns 45.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. +- **offsetY**: `[in] CBLAS_INT` starting index for `Y`. + +```c +double stdlib_strided_drssors_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/drssors.h" +#include + +int main( void ) { + // Create two strided arrays: + const double x[] = { 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 }; + const double y[] = { 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride lengths: + const int strideX = 1; + const int strideY = 1; + + // Compute the residual sum of squares of `x` and `y`: + double d = stdlib_strided_drssors( N, x, strideX, y, strideY ); + + // Print the result: + printf( "drssors: %lf\n", d ); + + // Specify index offsets: + const int offsetX = 1; + const int offsetY = 1; + + // Compute the residual sum of squares of `x` and `y` with offsets: + d = stdlib_strided_drssors_ndarray( N, x, strideX, offsetX, y, strideY, offsetY ); + + // Print the result: + printf( "drssors: %lf\n", d ); +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[wikipedia-residual-sum-of-squares]: https://en.wikipedia.org/wiki/Residual_sum_of_squares + +[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +
+ + diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js new file mode 100644 index 000000000000..927f7e128e74 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js @@ -0,0 +1,97 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var drssors = require( './../lib/drssors.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + function benchmark( b ) { + var d; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = drssors( x.length, x, 1, y, 1 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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/blas/ext/base/drssors/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js new file mode 100644 index 000000000000..a3e8c6490880 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js @@ -0,0 +1,102 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var drssors = tryRequire( resolve( __dirname, './../lib/drssors.native.js' ) ); +var opts = { + 'skip': ( drssors instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + function benchmark( b ) { + var d; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = drssors( x.length, x, 1, y, 1 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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/blas/ext/base/drssors/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..3e9eac1f230a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js @@ -0,0 +1,97 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var drssors = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + function benchmark( b ) { + var d; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = drssors( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..4754ef21a05f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,102 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var drssors = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( drssors instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + function benchmark( b ) { + var d; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = drssors( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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/blas/ext/base/drssors/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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/blas/ext/base/drssors/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..8c2ecabc9f66 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/c/benchmark.length.c @@ -0,0 +1,211 @@ +/** +* @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/blas/ext/base/drssors.h" +#include +#include +#include +#include +#include + +#define NAME "drssors" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double v; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + y = (double *) malloc( len * sizeof( double ) ); + + for ( i = 0; i < len; i++ ) { + x[ i ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); + } + + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_drssors( len, x, 1, y, 1 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double v; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + y = (double *) malloc( len * sizeof( double ) ); + + for ( i = 0; i < len; i++ ) { + x[ i ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); + } + + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_drssors_ndarray( len, x, 1, 0, y, 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/blas/ext/base/drssors/binding.gyp b/lib/node_modules/@stdlib/blas/ext/base/drssors/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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/blas/ext/base/drssors/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/repl.txt new file mode 100644 index 000000000000..c68a971e9948 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/repl.txt @@ -0,0 +1,114 @@ + +{{alias}}( N, x, strideX, y, strideY ) + Computes the residual sum of squares of two double- + precision floating-point strided arrays, ignoring `NaN` + values and using ordinary recursive summation. + + 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 `0`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Stride length of `x`. + + y: Float64Array + Second input array. + + strideY: integer + Stride length of `y`. + + Returns + ------- + out: number + Residual sum of squares. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, -4.0 ] ); + > {{alias}}( x.length, x, 1, y, 1 ) + 45 + + // Using `N` and `stride` parameters: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 2.0, -7.0, -2.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 2.0, 1.0, 2.0, 1.0, -2.0 ] ); + > {{alias}}( 3, x, 2, y, 2 ) + 1 + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 2.0, 1.0, 2.0, -2.0 ] ); + > var y0 = new {{alias:@stdlib/array/float64}}( [ 8.0, -2.0, 3.0, -2.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); + > {{alias}}( 2, x1, 2, y1, 2 ) + 9 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Computes the residual sum of squares of two double- + precision floating-point strided arrays, ignoring `NaN` + values and using ordinary recursive summation and alternative + indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Stride length of `x`. + + offsetX: integer + Starting index of `x`. + + y: Float64Array + Second input array. + + strideY: integer + Stride length of `y`. + + offsetY: integer + Starting index of `y`. + + Returns + ------- + out: number + Residual sum of squares. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, -4.0, 5.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 5.0, 12.0, -8.0, 15.0 ] ); + > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) + 328 + + // Using offset parameters: + > x = new {{alias:@stdlib/array/float64}}([ 2.0, 1.0, 2.0, -2.0 ]); + > y = new {{alias:@stdlib/array/float64}}([ 8.0, -2.0, 3.0, -2.0 ]); + > {{alias}}.ndarray( 2, x, 2, 1, y, 2, 1 ) + 9 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/index.d.ts new file mode 100644 index 000000000000..05fec26694c5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/index.d.ts @@ -0,0 +1,105 @@ +/* +* @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 `drssors`. +*/ +interface Routine { + /** + * Computes the residual sum of squares of two double-precision floating-point strided arrays, ignoring `NaN` values and using ordinary recursive summation. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - stride length of `x` + * @param y - second input array + * @param strideY - stride length of `y` + * @returns residual sum of squares + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); + * var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + * + * var z = drssors( x.length, x, 1, y, 1 ); + * // returns 72 + */ + ( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): number; + + /** + * Computes the residual sum of squares of two double-precision floating-point strided arrays, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - stride length of `x` + * @param offsetX - starting index of `x` + * @param y - second input array + * @param strideY - stride length of `y` + * @param offsetY - starting index of `y` + * @returns residual sum of squares + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); + * var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); + * + * var z = drssors.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns 72 + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): number; +} + +/** +* Compute the residual sum of squares of two double-precision floating-point strided arrays, ignoring `NaN` values and using ordinary recursive summation. +* +* @param N - number of indexed elements +* @param x - first input array +* @param strideX - stride length of `x` +* @param y - second input array +* @param strideY - stride length of `y` +* @returns residual sum of squares +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var drssors = require( '@stdlib/blas/ext/base/drssors' ); +* +* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] ); +* +* var out = drssors( x.length, x, 1, y, 1 ); +* // returns 45 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var drssors = require( '@stdlib/blas/ext/base/drssors' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); +* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); +* +* var z = drssors.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns 72 +*/ +declare var drssors: Routine; + + +// EXPORTS // + +export = drssors; diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/test.ts new file mode 100644 index 000000000000..6640f58d6e97 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/docs/types/test.ts @@ -0,0 +1,245 @@ +/* +* @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 drssors = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors( x.length, x, 1, y, 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors( '10', x, 1, y, 1 ); // $ExpectError + drssors( true, x, 1, y, 1 ); // $ExpectError + drssors( false, x, 1, y, 1 ); // $ExpectError + drssors( null, x, 1, y, 1 ); // $ExpectError + drssors( undefined, x, 1, y, 1 ); // $ExpectError + drssors( [], x, 1, y, 1 ); // $ExpectError + drssors( {}, x, 1, y, 1 ); // $ExpectError + drssors( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors( x.length, 10, 1, y, 1 ); // $ExpectError + drssors( x.length, '10', 1, y, 1 ); // $ExpectError + drssors( x.length, true, 1, y, 1 ); // $ExpectError + drssors( x.length, false, 1, y, 1 ); // $ExpectError + drssors( x.length, null, 1, y, 1 ); // $ExpectError + drssors( x.length, undefined, 1, y, 1 ); // $ExpectError + drssors( x.length, [], 1, y, 1 ); // $ExpectError + drssors( x.length, {}, 1, y, 1 ); // $ExpectError + drssors( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors( x.length, x, '10', y, 1 ); // $ExpectError + drssors( x.length, x, true, y, 1 ); // $ExpectError + drssors( x.length, x, false, y, 1 ); // $ExpectError + drssors( x.length, x, null, y, 1 ); // $ExpectError + drssors( x.length, x, undefined, y, 1 ); // $ExpectError + drssors( x.length, x, [], y, 1 ); // $ExpectError + drssors( x.length, x, {}, y, 1 ); // $ExpectError + drssors( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + drssors( x.length, x, 1, '10', 1 ); // $ExpectError + drssors( x.length, x, 1, true, 1 ); // $ExpectError + drssors( x.length, x, 1, false, 1 ); // $ExpectError + drssors( x.length, x, 1, null, 1 ); // $ExpectError + drssors( x.length, x, 1, undefined, 1 ); // $ExpectError + drssors( x.length, x, 1, [], 1 ); // $ExpectError + drssors( x.length, x, 1, {}, 1 ); // $ExpectError + drssors( x.length, x, 1, ( y: number ): number => y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors( x.length, x, 1, y, '10' ); // $ExpectError + drssors( x.length, x, 1, y, true ); // $ExpectError + drssors( x.length, x, 1, y, false ); // $ExpectError + drssors( x.length, x, 1, y, null ); // $ExpectError + drssors( x.length, x, 1, y, undefined ); // $ExpectError + drssors( x.length, x, 1, y, [] ); // $ExpectError + drssors( x.length, x, 1, y, {} ); // $ExpectError + drssors( x.length, x, 1, y, ( y: number ): number => y ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors(); // $ExpectError + drssors( x.length ); // $ExpectError + drssors( x.length, x ); // $ExpectError + drssors( x.length, x, 1, y ); // $ExpectError + drssors( x.length, x, 1, y, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + drssors.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 20 ); + + drssors.ndarray(); // $ExpectError + drssors.ndarray( x.length ); // $ExpectError + drssors.ndarray( x.length, x ); // $ExpectError + drssors.ndarray( x.length, x, 1 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + drssors.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/examples/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/drssors/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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/blas/ext/base/drssors/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/drssors/examples/c/example.c new file mode 100644 index 000000000000..44390b167113 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/examples/c/example.c @@ -0,0 +1,49 @@ +/** +* @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/blas/ext/base/drssors.h" +#include + +int main( void ) { + // Create two strided arrays: + const double x[] = { 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 }; + const double y[] = { 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride lengths: + const int strideX = 1; + const int strideY = 1; + + // Compute the square root of the residual sum of squares of `x` and `y`: + double d = stdlib_strided_drssors( N, x, strideX, y, strideY ); + + // Print the result: + printf( "drssors: %lf\n", d ); + + // Specify index offsets: + const int offsetX = 1; + const int offsetY = 1; + + // Compute the square root of the residual sum of squares of `x` and `y` with offsets: + d = stdlib_strided_drssors_ndarray( N, x, strideX, offsetX, y, strideY, offsetY ); + + // Print the result: + printf( "drssors: %lf\n", d ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/examples/index.js new file mode 100644 index 000000000000..d1aa985f68eb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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 drssors = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, -50, 50, opts ); +console.log( x ); + +var y = discreteUniform( 10, -50, 50, opts ); +console.log( y ); + +var d = drssors( x.length, x, 1, y, 1 ); +console.log( d ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/drssors/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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", + "mathematics", + "math", + "blas", + "extended", + "residual", + "residuals", + "sum", + "squares", + "summation", + "ors", + "drssors", + "drss", + "rss", + "strided", + "array", + "ndarray", + "float64", + "double", + "float64array" + ], + "__stdlib__": { + "wasm": false + } +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/src/Makefile b/lib/node_modules/@stdlib/blas/ext/base/drssors/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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/blas/ext/base/drssors/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/drssors/src/addon.c new file mode 100644 index 000000000000..331b3132d5a0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/src/addon.c @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/blas/ext/base/drssors.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_float64array.h" +#include "stdlib/napi/create_double.h" +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data_ +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Y, N, strideY, argv, 3 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_drssors )( N, X, strideX, Y, strideY ), v ); + return v; +} + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 7 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetY, argv, 6 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Y, N, strideY, argv, 4 ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX( stdlib_strided_drssors_ndarray )( N, X, strideX, offsetX, Y, strideY, offsetY ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/drssors/src/main.c new file mode 100644 index 000000000000..c6d6e610be45 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/src/main.c @@ -0,0 +1,100 @@ +/** +* @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/blas/ext/base/drssors.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/strided/base/stride2offset.h" +#include + + +/** +* Computes the residual sum of squares of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation. + +* +* @param N number of indexed elements +* @param X first input array +* @param strideX stride length of `X` +* @param Y second input array +* @param strideY stride length of `Y` +* @return output value +*/ +double API_SUFFIX( stdlib_strided_drssors )( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + const CBLAS_INT oy = stdlib_strided_stride2offset( N, strideY ); + return API_SUFFIX( stdlib_strided_drssors_ndarray )( N, X, strideX, ox, Y, strideY, oy ); +} + +/** +* Computes the residual sum of squares of two double-precision floating-point strided arrays, ignoring `NaN` values and using an ordinary recursive summation and alternative indexing semantics. + +* +* @param N number of indexed elements +* @param X first input array +* @param strideX stride length of `X` +* @param offsetX starting index for X +* @param Y second input array +* @param strideY stride length of `Y` +* @param offsetY starting index for Y +* @return output value +*/ +double API_SUFFIX( stdlib_strided_drssors_ndarray )( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ) { + double sum; + CBLAS_INT ix; + CBLAS_INT iy; + double r; + CBLAS_INT i; + + if ( N <= 0 ) { + return 0.0; + } + ix = offsetX; + iy = offsetY; + if ( strideX == 0 && strideY == 0 ) { + if ( stdlib_base_is_nan( X[ ix ] ) || stdlib_base_is_nan( Y[ iy ] ) ) { + return 0.0; + } + r = X[ ix ] - Y[ iy ]; + return N * r * r; + } + // Find the first non-NaN element pair... + for ( i = 0; i < N; i++ ) { + if ( stdlib_base_is_nan( X[ ix ] ) == false && stdlib_base_is_nan( Y[ iy ] ) == false ) { + break; + } + ix += strideX; + iy += strideY; + } + if ( i == N ) { + return 0.0; + } + r = X[ ix ] - Y[ iy ]; + sum = r * r; + ix += strideX; + iy += strideY; + + for ( i = 1; i < N; i++ ) { + if ( stdlib_base_is_nan( X[ ix ] ) == false && stdlib_base_is_nan( Y[ iy ] ) == false ) { + r = X[ ix ] - Y[ iy ]; + sum += r * r; + } + ix += strideX; + iy += strideY; + } + return sum; +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.js new file mode 100644 index 000000000000..4e2c1e6655b1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.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 Float64Array = require( '@stdlib/array/float64' ); +var ulpdiff = require( '@stdlib/number/float32/base/ulp-difference' ); +var drssors = require( './../lib/drssors.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof drssors, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( drssors.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the residual sum of squares (ignoring NaN values)', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 418.0, 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 196.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e10, 1.0e10, 1.0e10 ] ); + y = new Float64Array( [ -1.0e10, 1.0e10, -1.0e10, -1.0e10 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 1.2e+21, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e-15, 1.0e-15, 1.0e-15 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e-15, -1.0e-15, -1.0e-15 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 1.6e-29, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e5, 1.0e10, 1.0e5 ] ); + y = new Float64Array( [ -1.0e10, -1.0e5, -1.0e10, -1.0e5 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 8.0000000008e+20 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e5, 1.0e-15, 1.0e5 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e5, -1.0e-15, -1.0e5 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 80000000000 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-14, 1.5e-14, 1.4e-14, 0.0 ] ); + y = new Float64Array( [ -1.4e-14, -1.5e-14, -1.4e-14, 0.0 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 2.468e-27 ) <= 1, true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); + + z = drssors( 0, x, 1, y, 1 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = drssors( -1, x, 1, y, 1 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 0 + -2.0, + 3.0, // 1 + -2.0, + 7.0, // 2 + -2.0, + 0.0, // 3 + -1.0 + ]); + + z = drssors( 4, x, 2, y, 2 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride parameters', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 3 + -2.0, + 3.0, // 2 + -2.0, + 7.0, // 1 + -2.0, + 0.0, // 0 + -1.0 + ]); + + z = drssors( 4, x, -2, y, -2 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var x0; + var x1; + var y0; + var y1; + var z; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + y0 = new Float64Array([ + 8.0, + -2.0, // 0 + 3.0, + -2.0, // 1 + 7.0, + -2.0, // 2 + 0.0, + -1.0, // 3 + 4.0 + ]); + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + z = drssors( 4, x1, 2, y1, 2 ); + + // 9+0+16+25 = 50 + t.strictEqual( z, 50, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.native.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.native.js new file mode 100644 index 000000000000..a099a6eb206a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.drssors.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 Float64Array = require( '@stdlib/array/float64' ); +var ulpdiff = require( '@stdlib/number/float32/base/ulp-difference' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var drssors = tryRequire( resolve( __dirname, './../lib/drssors.native.js' ) ); +var opts = { + 'skip': ( drssors instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof drssors, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( drssors.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the residual sum of squares (ignoring NaN values)', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 418.0, 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 196.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e10, 1.0e10, 1.0e10 ] ); + y = new Float64Array( [ -1.0e10, 1.0e10, -1.0e10, -1.0e10 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 1.2e+21, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e-15, 1.0e-15, 1.0e-15 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e-15, -1.0e-15, -1.0e-15 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( z, 1.6e-29, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e5, 1.0e10, 1.0e5 ] ); + y = new Float64Array( [ -1.0e10, -1.0e5, -1.0e10, -1.0e5 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 8.0000000008e+20 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e5, 1.0e-15, 1.0e5 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e5, -1.0e-15, -1.0e5 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 80000000000 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-14, 1.5e-14, 1.4e-14, 0.0 ] ); + y = new Float64Array( [ -1.4e-14, -1.5e-14, -1.4e-14, 0.0 ] ); + + z = drssors( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 2.468e-27 ) <= 1, true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); + + z = drssors( 0, x, 1, y, 1 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = drssors( -1, x, 1, y, 1 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 0 + -2.0, + 3.0, // 1 + -2.0, + 7.0, // 2 + -2.0, + 0.0, // 3 + -1.0 + ]); + + z = drssors( 4, x, 2, y, 2 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride parameters', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 3 + -2.0, + 3.0, // 2 + -2.0, + 7.0, // 1 + -2.0, + 0.0, // 0 + -1.0 + ]); + + z = drssors( 4, x, -2, y, -2 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var x0; + var x1; + var y0; + var y1; + var z; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + y0 = new Float64Array([ + 8.0, + -2.0, // 0 + 3.0, + -2.0, // 1 + 7.0, + -2.0, // 2 + 0.0, + -1.0, // 3 + 4.0 + ]); + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + z = drssors( 4, x1, 2, y1, 2 ); + + // 9+0+16+25 = 50 + t.strictEqual( z, 50, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.js new file mode 100644 index 000000000000..9a39edab0a33 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/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 drssors = 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 drssors, '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 drssors.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 drssors = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( drssors, 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 drssors; + var main; + + main = require( './../lib/drssors.js' ); + + drssors = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( drssors, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.js new file mode 100644 index 000000000000..12d5663002a2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.js @@ -0,0 +1,208 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var ulpdiff = require( '@stdlib/number/float32/base/ulp-difference' ); +var drssors = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof drssors, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', function test( t ) { + t.strictEqual( drssors.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the residual sum of squares of two vectors (ignoring NaN values)', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 418.0, 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 196.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e10, 1.0e10, 1.0e10 ] ); + y = new Float64Array( [ -1.0e10, 1.0e10, -1.0e10, -1.0e10 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 1.2e+21, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e-15, 1.0e-15, 1.0e-15 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e-15, -1.0e-15, -1.0e-15 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 1.6e-29, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e5, 1.0e10, 1.0e5 ] ); + y = new Float64Array( [ -1.0e10, -1.0e5, -1.0e10, -1.0e5 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 8.0000000008e+20 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e5, 1.0e-15, 1.0e5 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e5, -1.0e-15, -1.0e5 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 80000000000 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-14, 1.5e-14, 1.4e-14, 0.0 ] ); + y = new Float64Array( [ -1.4e-14, -1.5e-14, -1.4e-14, 0.0 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 2.468e-27 ) <= 1, true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); + + z = drssors( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = drssors( -1, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 0 + -2.0, + 3.0, // 1 + -2.0, + 7.0, // 2 + -2.0, + 0.0, // 3 + -1.0 + ]); + + z = drssors( 4, x, 2, 0, y, 2, 0 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative stride parameters', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 3 + -2.0, + 3.0, // 2 + -2.0, + 7.0, // 1 + -2.0, + 0.0, // 0 + -1.0 + ]); + + z = drssors( 4, x, -2, x.length-2, y, -2, y.length-2 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports offset parameters', function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + y = new Float64Array([ + 8.0, + -2.0, // 0 + 3.0, + -2.0, // 1 + 7.0, + -2.0, // 2 + 0.0, + -1.0, // 3 + 4.0 + ]); + + z = drssors( 4, x, 2, 1, y, 2, 1 ); + + // 9+0+16+25 = 50 + t.strictEqual( z, 50, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.native.js new file mode 100644 index 000000000000..1aa7a400cc6b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/test/test.ndarray.native.js @@ -0,0 +1,217 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var ulpdiff = require( '@stdlib/number/float32/base/ulp-difference' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var drssors = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( drssors instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof drssors, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', opts, function test( t ) { + t.strictEqual( drssors.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the residual sum of squares of two vectors (ignoring NaN values)', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 418.0, 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 196.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e10, 1.0e10, 1.0e10 ] ); + y = new Float64Array( [ -1.0e10, 1.0e10, -1.0e10, -1.0e10 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 1.2e+21, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e-15, 1.0e-15, 1.0e-15 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e-15, -1.0e-15, -1.0e-15 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 1.6e-29, 'returns expected value' ); + + x = new Float64Array( [ 1.0e10, 1.0e5, 1.0e10, 1.0e5 ] ); + y = new Float64Array( [ -1.0e10, -1.0e5, -1.0e10, -1.0e5 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 8.0000000008e+20 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-15, 1.0e5, 1.0e-15, 1.0e5 ] ); + y = new Float64Array( [ -1.0e-15, -1.0e5, -1.0e-15, -1.0e5 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 80000000000 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-14, 1.5e-14, 1.4e-14, 0.0 ] ); + y = new Float64Array( [ -1.4e-14, -1.5e-14, -1.4e-14, 0.0 ] ); + + z = drssors( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 2.468e-27 ) <= 1, true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); + + z = drssors( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = drssors( -1, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports stride parameters', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 0 + -2.0, + 3.0, // 1 + -2.0, + 7.0, // 2 + -2.0, + 0.0, // 3 + -1.0 + ]); + + z = drssors( 4, x, 2, 0, y, 2, 0 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative stride parameters', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + y = new Float64Array([ + 8.0, // 3 + -2.0, + 3.0, // 2 + -2.0, + 7.0, // 1 + -2.0, + 0.0, // 0 + -1.0 + ]); + + z = drssors( 4, x, -2, x.length-2, y, -2, y.length-2 ); + + // 49+1+81+16 = 147 + t.strictEqual( z, 147, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports offset parameters', opts, function test( t ) { + var x; + var y; + var z; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + y = new Float64Array([ + 8.0, + -2.0, // 0 + 3.0, + -2.0, // 1 + 7.0, + -2.0, // 2 + 0.0, + -1.0, // 3 + 4.0 + ]); + + z = drssors( 4, x, 2, 1, y, 2, 1 ); + + // 9+0+16+25 = 50 + t.strictEqual( z, 50, 'returns expected value' ); + t.end(); +}); From 14a05ed2429afce7a19407c9f0014313a384ad25 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Tue, 16 Dec 2025 14:24:51 +0530 Subject: [PATCH 2/2] chore: use string interpolation in JavaScript benchmarks for the benchmark name --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/drssors/benchmark/benchmark.js | 3 ++- .../blas/ext/base/drssors/benchmark/benchmark.native.js | 3 ++- .../blas/ext/base/drssors/benchmark/benchmark.ndarray.js | 3 ++- .../ext/base/drssors/benchmark/benchmark.ndarray.native.js | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js index 927f7e128e74..b5465c8c7525 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.js @@ -24,6 +24,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var drssors = require( './../lib/drssors.js' ); @@ -90,7 +91,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+':len='+len, f ); + bench( format( '%s:len=%d', pkg, len ), f ); } } diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js index a3e8c6490880..3f5ff4ce0fdc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.native.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -95,7 +96,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+'::native:len='+len, opts, f ); + bench( format( '%s::native:len=%d', pkg, len ), opts, f ); } } diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js index 3e9eac1f230a..a8b8f28f9b73 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.js @@ -24,6 +24,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var drssors = require( './../lib/ndarray.js' ); @@ -90,7 +91,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+':ndarray:len='+len, f ); + bench( format( '%s:ndarray:len=%d', pkg, len ), f ); } } diff --git a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js index 4754ef21a05f..ff561482b2e8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/drssors/benchmark/benchmark.ndarray.native.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -95,7 +96,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+'::native:ndarray:len='+len, opts, f ); + bench( format( '%s::native:ndarray:len=%d', pkg, len ), opts, f ); } }