From 2ac8bd020b87405d9cab7d36c4a5560e87cab582 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Fri, 26 Dec 2025 12:47:38 +0530 Subject: [PATCH 1/7] feat: add `stats/strided/distances/deuclidean` --- 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 --- --- .../strided/distances/deuclidean/README.md | 339 ++++++++++++++++++ .../deuclidean/benchmark/benchmark.js | 98 +++++ .../deuclidean/benchmark/benchmark.native.js | 103 ++++++ .../deuclidean/benchmark/benchmark.ndarray.js | 98 +++++ .../benchmark/benchmark.ndarray.native.js | 103 ++++++ .../distances/deuclidean/benchmark/c/Makefile | 146 ++++++++ .../deuclidean/benchmark/c/benchmark.length.c | 203 +++++++++++ .../strided/distances/deuclidean/binding.gyp | 265 ++++++++++++++ .../distances/deuclidean/docs/repl.txt | 109 ++++++ .../deuclidean/docs/types/index.d.ts | 103 ++++++ .../distances/deuclidean/docs/types/test.ts | 248 +++++++++++++ .../distances/deuclidean/examples/c/Makefile | 146 ++++++++ .../distances/deuclidean/examples/c/example.c | 45 +++ .../distances/deuclidean/examples/index.js | 34 ++ .../strided/distances/deuclidean/include.gypi | 70 ++++ .../stats/strided/distances/deuclidean.h | 45 +++ .../distances/deuclidean/lib/deuclidean.js | 57 +++ .../deuclidean/lib/deuclidean.native.js | 54 +++ .../strided/distances/deuclidean/lib/index.js | 70 ++++ .../strided/distances/deuclidean/lib/main.js | 35 ++ .../distances/deuclidean/lib/native.js | 35 ++ .../distances/deuclidean/lib/ndarray.js | 56 +++ .../deuclidean/lib/ndarray.native.js | 56 +++ .../distances/deuclidean/manifest.json | 103 ++++++ .../strided/distances/deuclidean/package.json | 74 ++++ .../strided/distances/deuclidean/src/Makefile | 70 ++++ .../strided/distances/deuclidean/src/addon.c | 66 ++++ .../strided/distances/deuclidean/src/main.c | 54 +++ .../deuclidean/test/test.deuclidean.js | 215 +++++++++++ .../deuclidean/test/test.deuclidean.native.js | 222 ++++++++++++ .../strided/distances/deuclidean/test/test.js | 82 +++++ .../distances/deuclidean/test/test.ndarray.js | 209 +++++++++++ .../deuclidean/test/test.ndarray.native.js | 218 +++++++++++ 33 files changed, 3831 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/package.json create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md new file mode 100644 index 000000000000..33d78c1a67cc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md @@ -0,0 +1,339 @@ + + +# deuclidean + +> Compute the euclidean distance between two double-precision floating-point strided arrays. + +
+ +The [euclidean distance][wikipedia-euclidean-distance] is defined as + + + +```math +d = \sqrt{\sum_{i=0}^{N-1} (y_i - x_i)^2} +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' ); +``` + +#### deuclidean( N, x, strideX, y, strideY ) + +Computes the euclidean distance between two double-precision floating-point strided arrays. + +```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 = deuclidean( x.length, x, 1, y, 1 ); +// returns ~8.485 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: stride length of `x`. +- **y**: input [`Float64Array`][@stdlib/array/float64]. +- **strideY**: stride length of `y`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the euclidean distance between every other value in `x` and the first `N` elements of `y` in reverse order, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +var z = deuclidean( 3, x, 2, y, -1 ); +// returns ~4.472 +``` + +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' ); + +// Initial arrays... +var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + +// Create offset views... +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*3 ); // start at 4th element + +var z = deuclidean( 3, x1, 1, y1, 1 ); +// returns ~13.856 +``` + +#### deuclidean.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. + +```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 = deuclidean.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// returns ~8.485 +``` + +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 euclidean distance between every other value in `x` starting from the second value with the last 3 elements in `y` in reverse order + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + +var z = deuclidean.ndarray( 3, x, 2, 1, y, -1, y.length-1 ); +// returns ~12.845 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `0.0`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, 0, 100, opts ); +console.log( x ); + +var y = discreteUniform( x.length, 0, 10, opts ); +console.log( y ); + +var out = deuclidean.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +console.log( out ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/strided/distances/deuclidean.h" +``` + +#### stdlib_strided_deuclidean( N, \*X, strideX, \*Y, strideY ) + +Computes the euclidean distance between two double-precision floating-point strided arrays. + +```c +const double x[] = { 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 }; +const double y[] = { 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_deuclidean( 8, x, 1, y, 1 ); +// returns ~8.485 +``` + +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 of `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length of `Y`. + +```c +double stdlib_strided_deuclidean( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); +``` + + + +#### stdlib_strided_deuclidean_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY ) + + + +Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. + +```c +const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; +const double y[] = { 2.0, 6.0, -1.0, -4.0, 8.0 }; + +double v = stdlib_strided_deuclidean_ndarray( 5, x, -1, 4, y, -1, 4 ); +// returns ~13.638 +``` + +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 of `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length of `Y`. +- **offsetY**: `[in] CBLAS_INT` starting index for `Y`. + +```c +double stdlib_strided_deuclidean_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/strided/distances/deuclidean.h" +#include + +int main( void ) { + // Create strided arrays: + const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + const double y[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + + // Specify the number of elements: + const int N = 8; + + // Specify strides: + const int strideX = 1; + const int strideY = -1; + + // Compute the euclidean distance between `x` and `y`: + double sim = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); + + // Print the result: + printf( "euclidean distance: %lf\n", sim ); + + // Compute the euclidean distance between `x` and `y` with offsets: + sim = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + + // Print the result: + printf( "euclidean distance: %lf\n", sim ); +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[@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 + +[wikipedia-euclidean-distance]: https://en.wikipedia.org/wiki/Euclidean_distance + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js new file mode 100644 index 000000000000..2d41809893c0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js @@ -0,0 +1,98 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var deuclidean = require( './../lib/deuclidean.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 = deuclidean( 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js new file mode 100644 index 000000000000..8954b34d81a3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var deuclidean = tryRequire( resolve( __dirname, './../lib/deuclidean.native.js' ) ); +var opts = { + 'skip': ( deuclidean 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 = deuclidean( 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( format( '%s::native:len=%d', pkg, len ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..86c93b80171c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js @@ -0,0 +1,98 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var deuclidean = 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 = deuclidean( 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( format( '%s:ndarray:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..533b617150d4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var deuclidean = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( deuclidean 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 = deuclidean( 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( format( '%s::native:ndarray:len=%d', pkg, len ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..ae1b249c3f5f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c @@ -0,0 +1,203 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/deuclidean.h" +#include +#include +#include +#include +#include + +#define NAME "deuclidean" +#define ITERATIONS 10000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double z; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + y = (double *) malloc( len * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double()*20000.0 ) - 10000.0; + y[ i ] = ( rand_double()*20000.0 ) - 10000.0; + } + z = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + z = stdlib_strided_deuclidean( len, x, 1, y, 1 ); + if ( z != z ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( z != z ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( y ); + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double z; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + y = (double *) malloc( len * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double()*20000.0 ) - 10000.0; + y[ i ] = ( rand_double()*20000.0 ) - 10000.0; + } + z = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + z = stdlib_strided_deuclidean_ndarray( len, x, 1, 0, y, 1, 0 ); + if ( z != z ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( z != z ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( y ); + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp new file mode 100644 index 000000000000..08de71a2020e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp @@ -0,0 +1,265 @@ +# @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', + + # Fortran compiler (to override -Dfortran_compiler=): + 'fortran_compiler%': 'gfortran', + + # Fortran compiler flags: + 'fflags': [ + # Specify the Fortran standard to which a program is expected to conform: + '-std=f95', + + # Indicate that the layout is free-form source code: + '-ffree-form', + + # Aggressive optimization: + '-O3', + + # Enable commonly used warning options: + '-Wall', + + # Warn if source code contains problematic language features: + '-Wextra', + + # Warn if a procedure is called without an explicit interface: + '-Wimplicit-interface', + + # Do not transform names of entities specified in Fortran source files by appending underscores (i.e., don't mangle names, thus allowing easier usage in C wrappers): + '-fno-underscoring', + + # Warn if source code contains Fortran 95 extensions and C-language constructs: + '-pedantic', + + # Compile but do not link (output is an object file): + '-c', + ], + + # 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 + + # Define custom build actions for particular inputs: + 'rules': [ + { + # Define a rule for processing Fortran files: + 'extension': 'f', + + # Define the pathnames to be used as inputs when performing processing: + 'inputs': [ + # Full path of the current input: + '<(RULE_INPUT_PATH)' + ], + + # Define the outputs produced during processing: + 'outputs': [ + # Store an output object file in a directory for placing intermediate results (only accessible within a single target): + '<(INTERMEDIATE_DIR)/<(RULE_INPUT_ROOT).<(obj)' + ], + + # Define the rule for compiling Fortran based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + + # Rule to compile Fortran on Windows: + { + 'rule_name': 'compile_fortran_windows', + 'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Windows...', + + 'process_outputs_as_sources': 0, + + # Define the command-line invocation: + 'action': [ + '<(fortran_compiler)', + '<@(fflags)', + '<@(_inputs)', + '-o', + '<@(_outputs)', + ], + }, + + # Rule to compile Fortran on non-Windows: + { + 'rule_name': 'compile_fortran_linux', + 'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Linux...', + + 'process_outputs_as_sources': 1, + + # Define the command-line invocation: + 'action': [ + '<(fortran_compiler)', + '<@(fflags)', + '-fPIC', # generate platform-independent code + '<@(_inputs)', + '-o', + '<@(_outputs)', + ], + } + ], # end condition (OS=="win") + ], # end conditions + }, # end rule (extension=="f") + ], # end rules + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt new file mode 100644 index 000000000000..ab812ae46731 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt @@ -0,0 +1,109 @@ + +{{alias}}( N, x, strideX, y, strideY ) + Computes the euclidean distance between two double-precision floating-point + strided arrays. + + 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 + Index increment for `x`. + + y: Float64Array + Second input array. + + strideY: integer + Index increment for `y`. + + Returns + ------- + out: number + Euclidean distance. + + 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 ) + ~6.7 + + // 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.0 + + // 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 ) + 3 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Computes the euclidean distance between two double-precision floating-point + strided arrays using alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing based on a starting index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + y: Float64Array + Second input array. + + strideY: integer + Index increment for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + out: number + Euclidean distance. + + 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 ) + ~18.11 + + // 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 ) + 3 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts new file mode 100644 index 000000000000..b475e2ea8251 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts @@ -0,0 +1,103 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Interface describing `deuclidean`. +*/ +interface Routine { + /** + * Computes the euclidean distance between two double-precision floating-point strided arrays. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param y - second input array + * @param strideY - `y` stride length + * @returns euclidean distance + * + * @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 = deuclidean( x.length, x, 1, y, 1 ); + * // returns ~8.485 + */ + ( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): number; + + /** + * Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - second input array + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns euclidean distance + * + * @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 = deuclidean.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns ~8.485 + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): number; +} + +/** +* Computes the euclidean distance between two double-precision floating-point strided arrays. +* +* @param N - number of indexed elements +* @param x - first input array +* @param strideX - `x` stride length +* @param y - second input array +* @param strideY - `y` stride length +* @returns euclidean distance +* +* @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 = deuclidean( x.length, x, 1, y, 1 ); +* // returns ~8.485 +* +* @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 = deuclidean.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns ~8.485 +*/ +declare var deuclidean: Routine; + + +// EXPORTS // + +export = deuclidean; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts new file mode 100644 index 000000000000..80ef36752607 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts @@ -0,0 +1,248 @@ +/* +* @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 deuclidean = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + deuclidean( 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( 10 ); + + deuclidean( '10', x, 1, y, 1 ); // $ExpectError + deuclidean( true, x, 1, y, 1 ); // $ExpectError + deuclidean( false, x, 1, y, 1 ); // $ExpectError + deuclidean( null, x, 1, y, 1 ); // $ExpectError + deuclidean( undefined, x, 1, y, 1 ); // $ExpectError + deuclidean( [], x, 1, y, 1 ); // $ExpectError + deuclidean( {}, x, 1, y, 1 ); // $ExpectError + deuclidean( ( 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( 10 ); + + deuclidean( x.length, 10, 1, y, 1 ); // $ExpectError + deuclidean( x.length, '10', 1, y, 1 ); // $ExpectError + deuclidean( x.length, true, 1, y, 1 ); // $ExpectError + deuclidean( x.length, false, 1, y, 1 ); // $ExpectError + deuclidean( x.length, null, 1, y, 1 ); // $ExpectError + deuclidean( x.length, undefined, 1, y, 1 ); // $ExpectError + deuclidean( x.length, [], 1, y, 1 ); // $ExpectError + deuclidean( x.length, {}, 1, y, 1 ); // $ExpectError + deuclidean( 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( 10 ); + + deuclidean( x.length, x, '10', y, 1 ); // $ExpectError + deuclidean( x.length, x, true, y, 1 ); // $ExpectError + deuclidean( x.length, x, false, y, 1 ); // $ExpectError + deuclidean( x.length, x, null, y, 1 ); // $ExpectError + deuclidean( x.length, x, undefined, y, 1 ); // $ExpectError + deuclidean( x.length, x, [], y, 1 ); // $ExpectError + deuclidean( x.length, x, {}, y, 1 ); // $ExpectError + deuclidean( 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 ); + + deuclidean( x.length, x, 1, 10, 1 ); // $ExpectError + deuclidean( x.length, x, 1, '10', 1 ); // $ExpectError + deuclidean( x.length, x, 1, true, 1 ); // $ExpectError + deuclidean( x.length, x, 1, false, 1 ); // $ExpectError + deuclidean( x.length, x, 1, null, 1 ); // $ExpectError + deuclidean( x.length, x, 1, undefined, 1 ); // $ExpectError + deuclidean( x.length, x, 1, [], 1 ); // $ExpectError + deuclidean( x.length, x, 1, {}, 1 ); // $ExpectError + deuclidean( x.length, x, 1, ( x: number ): number => x, 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( 10 ); + + deuclidean( x.length, x, 1, y, '10' ); // $ExpectError + deuclidean( x.length, x, 1, y, true ); // $ExpectError + deuclidean( x.length, x, 1, y, false ); // $ExpectError + deuclidean( x.length, x, 1, y, null ); // $ExpectError + deuclidean( x.length, x, 1, y, undefined ); // $ExpectError + deuclidean( x.length, x, 1, y, [] ); // $ExpectError + deuclidean( x.length, x, 1, y, {} ); // $ExpectError + deuclidean( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + deuclidean(); // $ExpectError + deuclidean( x.length ); // $ExpectError + deuclidean( x.length, x ); // $ExpectError + deuclidean( x.length, x, 1 ); // $ExpectError + deuclidean( x.length, x, 1, y ); // $ExpectError + deuclidean( 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( 10 ); + + deuclidean.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( 10 ); + + deuclidean.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.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( 10 ); + + deuclidean.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + deuclidean.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( 10 ); + + deuclidean.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + deuclidean.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( 10 ); + + deuclidean.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + deuclidean.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 ); + + deuclidean.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + deuclidean.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( 10 ); + + deuclidean.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + deuclidean.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( 10 ); + + deuclidean.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + deuclidean.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( 10 ); + + deuclidean.ndarray(); // $ExpectError + deuclidean.ndarray( x.length ); // $ExpectError + deuclidean.ndarray( x.length, x ); // $ExpectError + deuclidean.ndarray( x.length, x, 1 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + deuclidean.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c new file mode 100644 index 000000000000..13548287fc5e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/deuclidean.h" +#include + +int main( void ) { + // Create strided arrays: + const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + const double y[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + + // Specify the number of elements: + const int N = 8; + + // Specify strides: + const int strideX = 1; + const int strideY = -1; + + // Compute the euclidean distance between `x` and `y`: + double sim = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); + + // Print the result: + printf( "euclidean distance: %lf\n", sim ); + + // Compute the euclidean distance between `x` and `y` with offsets: + sim = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + + // Print the result: + printf( "euclidean distance: %lf\n", sim ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js new file mode 100644 index 000000000000..dbebed2cc7eb --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/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 deuclidean = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, 0, 100, opts ); +console.log( x ); + +var y = discreteUniform( x.length, 0, 10, opts ); +console.log( y ); + +var out = deuclidean.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi new file mode 100644 index 000000000000..4217944b5d20 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi @@ -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. + +# A GYP include file for building a Node.js native add-on. +# +# Note that nesting variables is required due to how GYP processes a configuration. Any variables defined within a nested 'variables' section is defined in the outer scope. Thus, conditions in the outer variable scope are free to use these variables without running into "variable undefined" errors. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +# +# Variable nesting hacks: +# +# [3]: https://chromium.googlesource.com/external/skia/gyp/+/master/common_variables.gypi +# [4]: https://src.chromium.org/viewvc/chrome/trunk/src/build/common.gypi?revision=127004 +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + 'variables': { + # Host BLAS library (to override -Dblas=): + 'blas%': '', + + # Path to BLAS library (to override -Dblas_dir=): + 'blas_dir%': '', + }, # end variables + + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + '<@(blas_dir)', + '=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "euclidean", + "distance", + "metric", + "strided", + "strided array", + "typed", + "array", + "float64", + "double", + "float64array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c new file mode 100644 index 000000000000..13aeac62164c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/deuclidean.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_deuclidean )( 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, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 5 ); + 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_deuclidean_ndarray )( N, X, strideX, offsetX, Y, strideY, offsetY ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c new file mode 100644 index 000000000000..463f747597bc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/deuclidean.h" +#include "stdlib/blas/ext/base/drrss.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the euclidean distance between two double-precision floating-point strided arrays. +* +* @param N number of indexed elements +* @param X first array +* @param strideX X stride length +* @param Y second array +* @param strideY Y stride length +* @return euclidean distance +*/ +double API_SUFFIX( stdlib_strided_deuclidean )( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + CBLAS_INT oy = stdlib_strided_stride2offset( N, strideY ); + return API_SUFFIX( stdlib_strided_deuclidean_ndarray )( N, X, strideX, ox, Y, strideY, oy ); +} + +/** +* Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X first array +* @param strideX X stride length +* @param offsetX starting index for X +* @param Y second array +* @param strideY Y stride length +* @param offsetY starting index for Y +* @return euclidean distance +*/ +double API_SUFFIX( stdlib_strided_deuclidean_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 ) { + return stdlib_strided_drrss_ndarray( N, X, strideX, offsetX, Y, strideY, offsetY ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js new file mode 100644 index 000000000000..8fc699c665ab --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js @@ -0,0 +1,215 @@ +/** +* @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 sqrt = require( '@stdlib/math/base/special/sqrt' ); +var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); +var deuclidean = require( './../lib/deuclidean.js' ); + + +// TESTS // + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof deuclidean, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( deuclidean.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the euclidean distance', 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 = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, 14.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); + y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, 4.0e-155, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); + y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); + y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 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 = deuclidean( 0, x, 1, y, 1 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = deuclidean( -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 = deuclidean( 4, x, 2, y, 2 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x, -2, y, -2 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x1, 2, y1, 2 ); + + // sqrt( 9+0+16+25 ) = sqrt( 50 ) + t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js new file mode 100644 index 000000000000..ecbc81089376 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js @@ -0,0 +1,222 @@ +/** +* @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 tryRequire = require( '@stdlib/utils/try-require' ); +var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); + + +// VARIABLES // + +var deuclidean = tryRequire( resolve( __dirname, './../lib/deuclidean.native.js' ) ); +var opts = { + 'skip': ( deuclidean instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof deuclidean, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( deuclidean.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the euclidean distance', 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 = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, 14.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); + y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( z, 4.0e-155, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); + y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); + y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); + + z = deuclidean( x.length, x, 1, y, 1 ); + t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 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 = deuclidean( 0, x, 1, y, 1 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = deuclidean( -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 = deuclidean( 4, x, 2, y, 2 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x, -2, y, -2 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x1, 2, y1, 2 ); + + // sqrt( 9+0+16+25 ) = sqrt( 50 ) + t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js new file mode 100644 index 000000000000..a0546c5e5ca4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/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 deuclidean = 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 deuclidean, '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 deuclidean.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 deuclidean = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( deuclidean, 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 deuclidean; + var main; + + main = require( './../lib/deuclidean.js' ); + + deuclidean = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( deuclidean, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js new file mode 100644 index 000000000000..846826f0ba1c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js @@ -0,0 +1,209 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); +var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); +var deuclidean = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof deuclidean, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', function test( t ) { + t.strictEqual( deuclidean.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the euclidean distance', 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 = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 14.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); + y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 4.0e-155, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); + y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); + y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 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 = deuclidean( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = deuclidean( -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 = deuclidean( 4, x, 2, 0, y, 2, 0 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x, -2, x.length-2, y, -2, y.length-2 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x, 2, 1, y, 2, 1 ); + + // sqrt( 9+0+16+25 ) = sqrt( 50 ) + t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js new file mode 100644 index 000000000000..da6ce3cf27cc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js @@ -0,0 +1,218 @@ +/** +* @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 tryRequire = require( '@stdlib/utils/try-require' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); +var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); + + +// VARIABLES // + +var deuclidean = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( deuclidean instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof deuclidean, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', opts, function test( t ) { + t.strictEqual( deuclidean.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the euclidean distance', 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 = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + + x = new Float64Array( [ -4.0 ] ); + y = new Float64Array( [ 10.0 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 14.0, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); + y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 4.0e-155, 'returns expected value' ); + + x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); + y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); + y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + + x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); + y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); + + z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 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 = deuclidean( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( z, 0.0, 'returns expected value' ); + + z = deuclidean( -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 = deuclidean( 4, x, 2, 0, y, 2, 0 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x, -2, x.length-2, y, -2, y.length-2 ); + + // sqrt( 49+1+81+16 ) = sqrt( 147 ) + t.strictEqual( z, 12.12435565298214, '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 = deuclidean( 4, x, 2, 1, y, 2, 1 ); + + // sqrt( 9+0+16+25 ) = sqrt( 50 ) + t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.end(); +}); From e83847815f1616d63a259b760a432189e549bfd0 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Tue, 30 Dec 2025 18:58:47 +0530 Subject: [PATCH 2/7] chore: clean up --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: passed - 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 --- --- .../stats/strided/distances/deuclidean/README.md | 8 ++++---- .../strided/distances/deuclidean/docs/repl.txt | 14 +++++++------- .../distances/deuclidean/examples/c/example.c | 8 ++++---- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md index 33d78c1a67cc..be2aeddd3ab0 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md @@ -291,16 +291,16 @@ int main( void ) { const int strideY = -1; // Compute the euclidean distance between `x` and `y`: - double sim = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); + double d = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); // Print the result: - printf( "euclidean distance: %lf\n", sim ); + printf( "euclidean distance: %lf\n", d ); // Compute the euclidean distance between `x` and `y` with offsets: - sim = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + d = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); // Print the result: - printf( "euclidean distance: %lf\n", sim ); + printf( "euclidean distance: %lf\n", d ); } ``` diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt index ab812ae46731..6eb1c37b51b3 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt @@ -20,13 +20,13 @@ First input array. strideX: integer - Index increment for `x`. + Stride length for `x`. y: Float64Array Second input array. strideY: integer - Index increment for `y`. + Stride length for `y`. Returns ------- @@ -41,7 +41,7 @@ > {{alias}}( x.length, x, 1, y, 1 ) ~6.7 - // Using `N` and `stride` parameters: + // 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 ) @@ -53,7 +53,7 @@ > 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 ) - 3 + 3.0 {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) @@ -72,7 +72,7 @@ First input array. strideX: integer - Index increment for `x`. + Stride length for `x`. offsetX: integer Starting index for `x`. @@ -81,7 +81,7 @@ Second input array. strideY: integer - Index increment for `y`. + Stride length for `y`. offsetY: integer Starting index for `y`. @@ -103,7 +103,7 @@ > 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 ) - 3 + 3.0 See Also -------- diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c index 13548287fc5e..381533183677 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c @@ -32,14 +32,14 @@ int main( void ) { const int strideY = -1; // Compute the euclidean distance between `x` and `y`: - double sim = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); + double d = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); // Print the result: - printf( "euclidean distance: %lf\n", sim ); + printf( "euclidean distance: %lf\n", d ); // Compute the euclidean distance between `x` and `y` with offsets: - sim = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + d = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); // Print the result: - printf( "euclidean distance: %lf\n", sim ); + printf( "euclidean distance: %lf\n", d ); } From 0581fa4e83b72b5c00145934f8ff45e4cac2d885 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 2 Jan 2026 10:34:17 +0000 Subject: [PATCH 3/7] chore: update copyright years --- .../@stdlib/stats/strided/distances/deuclidean/README.md | 2 +- .../stats/strided/distances/deuclidean/benchmark/benchmark.js | 2 +- .../strided/distances/deuclidean/benchmark/benchmark.native.js | 2 +- .../strided/distances/deuclidean/benchmark/benchmark.ndarray.js | 2 +- .../distances/deuclidean/benchmark/benchmark.ndarray.native.js | 2 +- .../stats/strided/distances/deuclidean/benchmark/c/Makefile | 2 +- .../strided/distances/deuclidean/benchmark/c/benchmark.length.c | 2 +- .../@stdlib/stats/strided/distances/deuclidean/binding.gyp | 2 +- .../stats/strided/distances/deuclidean/docs/types/index.d.ts | 2 +- .../stats/strided/distances/deuclidean/docs/types/test.ts | 2 +- .../stats/strided/distances/deuclidean/examples/c/Makefile | 2 +- .../stats/strided/distances/deuclidean/examples/c/example.c | 2 +- .../stats/strided/distances/deuclidean/examples/index.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/include.gypi | 2 +- .../include/stdlib/stats/strided/distances/deuclidean.h | 2 +- .../stats/strided/distances/deuclidean/lib/deuclidean.js | 2 +- .../stats/strided/distances/deuclidean/lib/deuclidean.native.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/lib/index.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/lib/main.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/lib/native.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js | 2 +- .../stats/strided/distances/deuclidean/lib/ndarray.native.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/src/Makefile | 2 +- .../@stdlib/stats/strided/distances/deuclidean/src/addon.c | 2 +- .../@stdlib/stats/strided/distances/deuclidean/src/main.c | 2 +- .../stats/strided/distances/deuclidean/test/test.deuclidean.js | 2 +- .../strided/distances/deuclidean/test/test.deuclidean.native.js | 2 +- .../@stdlib/stats/strided/distances/deuclidean/test/test.js | 2 +- .../stats/strided/distances/deuclidean/test/test.ndarray.js | 2 +- .../strided/distances/deuclidean/test/test.ndarray.native.js | 2 +- 30 files changed, 30 insertions(+), 30 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md index be2aeddd3ab0..f3a1296f2b4f 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +Copyright (c) 2026 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js index 2d41809893c0..d60d06118eaf 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js index 8954b34d81a3..12978937a24e 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js index 86c93b80171c..e286edcc18c1 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js index 533b617150d4..5b65a83e02cd 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/benchmark.ndarray.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile index cce2c865d7ad..0756dc7da20a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# Copyright (c) 2026 The Stdlib Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c index ae1b249c3f5f..8d1940923e8d 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp index 08de71a2020e..60dce9d0b31a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/binding.gyp @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# Copyright (c) 2026 The Stdlib Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts index b475e2ea8251..52a4d61a8a84 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts index 80ef36752607..9dca26ed8826 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile index 25ced822f96a..c8f8e9a1517b 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# Copyright (c) 2026 The Stdlib Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c index 381533183677..7e2da62725ea 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js index dbebed2cc7eb..5a84b497c852 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi index 4217944b5d20..dcb556d250e8 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include.gypi @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# Copyright (c) 2026 The Stdlib Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h index e6acc02f3c88..7a7d86c0375a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js index f39823fddaee..50d89f0ecc5d 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js index 410791a2831c..f989b44d2ca4 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js index b0281f462e1d..56b383adc347 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/main.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/main.js index b5b06179a6b0..665c2b333ee1 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/main.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/native.js index 505d61b288b8..1528a301fb21 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js index 8c8d513c4a25..52b11c29aae9 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js index c0b27a722f8d..77756d6b05b4 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile index 7733b6180cb4..2caf905cedbe 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# Copyright (c) 2026 The Stdlib Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c index 13aeac62164c..d38c3bf9e27b 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c index 463f747597bc..651da0631194 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js index 8fc699c665ab..a839034330d3 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js index ecbc81089376..b3babfdb5f36 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js index a0546c5e5ca4..4c27e321e7bd 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js index 846826f0ba1c..5d1c7a8195c7 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js index da6ce3cf27cc..8c793374212c 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 2029a0ad41be79d3b4080a2c5f96c663d796d3d0 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Fri, 2 Jan 2026 16:06:51 +0530 Subject: [PATCH 4/7] bench: update benchmarks to follow new conventions Signed-off-by: Nakul Krishnakumar --- .../deuclidean/benchmark/c/benchmark.length.c | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c index 8d1940923e8d..53e40cf21dc9 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/benchmark/c/benchmark.length.c @@ -78,13 +78,15 @@ static double tic( void ) { } /** -* Generates a random number on the interval [0,1). +* Generates a random number on the interval [min,max). * -* @return random number +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number */ -static double rand_double( void ) { - int r = rand(); - return (double)r / ( (double)RAND_MAX + 1.0 ); +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); } /** @@ -105,8 +107,8 @@ static double benchmark1( int iterations, int len ) { x = (double *) malloc( len * sizeof( double ) ); y = (double *) malloc( len * sizeof( double ) ); for ( i = 0; i < len; i++ ) { - x[ i ] = ( rand_double()*20000.0 ) - 10000.0; - y[ i ] = ( rand_double()*20000.0 ) - 10000.0; + x[ i ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); } z = 0.0; t = tic(); @@ -144,8 +146,8 @@ static double benchmark2( int iterations, int len ) { x = (double *) malloc( len * sizeof( double ) ); y = (double *) malloc( len * sizeof( double ) ); for ( i = 0; i < len; i++ ) { - x[ i ] = ( rand_double()*20000.0 ) - 10000.0; - y[ i ] = ( rand_double()*20000.0 ) - 10000.0; + x[ i ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); } z = 0.0; t = tic(); From 435f94d199efb9bfee4d32f3fdffe256c59be564 Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Mon, 5 Jan 2026 17:56:18 +0530 Subject: [PATCH 5/7] fix: update implementation to return `NaN` when `N <= 0` Signed-off-by: Nakul Krishnakumar --- .../@stdlib/stats/strided/distances/deuclidean/README.md | 2 +- .../stats/strided/distances/deuclidean/docs/repl.txt | 2 +- .../stats/strided/distances/deuclidean/lib/ndarray.js | 3 +++ .../@stdlib/stats/strided/distances/deuclidean/src/main.c | 3 +++ .../strided/distances/deuclidean/test/test.deuclidean.js | 6 +++--- .../distances/deuclidean/test/test.deuclidean.native.js | 6 +++--- .../stats/strided/distances/deuclidean/test/test.ndarray.js | 6 +++--- .../distances/deuclidean/test/test.ndarray.native.js | 6 +++--- 8 files changed, 20 insertions(+), 14 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md index f3a1296f2b4f..c5eda0d577ae 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md @@ -143,7 +143,7 @@ var z = deuclidean.ndarray( 3, x, 2, 1, y, -1, y.length-1 ); ## Notes -- If `N <= 0`, both functions return `0.0`. +- If `N <= 0`, both functions return `NaN`. diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt index 6eb1c37b51b3..7a0694276c24 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt @@ -9,7 +9,7 @@ Indexing is relative to the first index. To introduce an offset, use a typed array view. - If `N <= 0`, the function returns `0`. + If `N <= 0`, the function returns `NaN`. Parameters ---------- diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js index 52b11c29aae9..d6291036e4ec 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js @@ -47,6 +47,9 @@ var drrss = require( '@stdlib/blas/ext/base/drrss' ).ndarray; * // returns ~8.485 */ function deuclidean( N, x, strideX, offsetX, y, strideY, offsetY ) { + if ( N <= 0.0 ) { + return NaN; + } return drrss( N, x, strideX, offsetX, y, strideY, offsetY ); } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c index 651da0631194..a14cff58507d 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c @@ -50,5 +50,8 @@ double API_SUFFIX( stdlib_strided_deuclidean )( const CBLAS_INT N, const double * @return euclidean distance */ double API_SUFFIX( stdlib_strided_deuclidean_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 ) { + if ( N <= 0.0 ) { + return 0.0 / 0.0; + } return stdlib_strided_drrss_ndarray( N, X, strideX, offsetX, Y, strideY, offsetY ); } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js index a839034330d3..3491f09d2747 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js @@ -92,7 +92,7 @@ tape( 'the function calculates the euclidean distance', function test( t ) { t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { var x; var y; var z; @@ -101,10 +101,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, y, 1 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); z = deuclidean( -1, x, 1, y, 1 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js index b3babfdb5f36..89fee51bee23 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js @@ -99,7 +99,7 @@ tape( 'the function calculates the euclidean distance', opts, function test( t ) t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', opts, function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { var x; var y; var z; @@ -108,10 +108,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, y, 1 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); z = deuclidean( -1, x, 1, y, 1 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js index 5d1c7a8195c7..969b6394341c 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js @@ -90,7 +90,7 @@ tape( 'the function calculates the euclidean distance', function test( t ) { t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { var x; var y; var z; @@ -99,10 +99,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); z = deuclidean( -1, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js index 8c793374212c..988ae5fe72bc 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js @@ -99,7 +99,7 @@ tape( 'the function calculates the euclidean distance', opts, function test( t ) t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0`', opts, function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { var x; var y; var z; @@ -108,10 +108,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); z = deuclidean( -1, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 0.0, 'returns expected value' ); + t.strictEqual( z, NaN, 'returns expected value' ); t.end(); }); From 7551fc557c74a3958760dd3e8d03a2c107b9677f Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Mon, 5 Jan 2026 18:17:07 +0530 Subject: [PATCH 6/7] test: update tests to use `isAlmostSameValue` --- 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: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../deuclidean/test/test.deuclidean.js | 26 +++++++++---------- .../deuclidean/test/test.deuclidean.native.js | 26 +++++++++---------- .../distances/deuclidean/test/test.ndarray.js | 26 +++++++++---------- .../deuclidean/test/test.ndarray.native.js | 26 +++++++++---------- 4 files changed, 52 insertions(+), 52 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js index 3491f09d2747..8780a47ad41a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js @@ -23,7 +23,7 @@ var tape = require( 'tape' ); var Float64Array = require( '@stdlib/array/float64' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); -var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); var deuclidean = require( './../lib/deuclidean.js' ); @@ -51,43 +51,43 @@ tape( 'the function calculates the euclidean distance', function test( t ) { y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, sqrt( 418.0 ), 1 ), true, 'returns expected value' ); x = new Float64Array( [ -4.0 ] ); y = new Float64Array( [ 10.0 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, 14.0, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 14.0, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 3.464101615137754e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, 4.0e-155, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.0e-155, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.82842712474619e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.8284271247461905e+50, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.967896939349689e-154, 1 ), true, 'returns expected value' ); t.end(); }); @@ -101,10 +101,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, y, 1 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); z = deuclidean( -1, x, 1, y, 1 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); t.end(); }); @@ -138,7 +138,7 @@ tape( 'the function supports stride parameters', function test( t ) { z = deuclidean( 4, x, 2, y, 2 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -171,7 +171,7 @@ tape( 'the function supports a negative stride parameters', function test( t ) { z = deuclidean( 4, x, -2, y, -2 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -210,6 +210,6 @@ tape( 'the function supports view offsets', function test( t ) { z = deuclidean( 4, x1, 2, y1, 2 ); // sqrt( 9+0+16+25 ) = sqrt( 50 ) - t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 7.0710678118654755, 1 ), true, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js index 89fee51bee23..96f800687f62 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js @@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); -var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); @@ -58,43 +58,43 @@ tape( 'the function calculates the euclidean distance', opts, function test( t ) y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, sqrt( 418.0 ), 1 ), true, 'returns expected value' ); x = new Float64Array( [ -4.0 ] ); y = new Float64Array( [ 10.0 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, 14.0, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 14.0, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 3.464101615137754e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( z, 4.0e-155, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.0e-155, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.82842712474619e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.8284271247461905e+50, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); z = deuclidean( x.length, x, 1, y, 1 ); - t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.967896939349689e-154, 1 ), true, 'returns expected value' ); t.end(); }); @@ -108,10 +108,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, y, 1 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); z = deuclidean( -1, x, 1, y, 1 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); t.end(); }); @@ -145,7 +145,7 @@ tape( 'the function supports stride parameters', opts, function test( t ) { z = deuclidean( 4, x, 2, y, 2 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -178,7 +178,7 @@ tape( 'the function supports a negative stride parameters', opts, function test( z = deuclidean( 4, x, -2, y, -2 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -217,6 +217,6 @@ tape( 'the function supports view offsets', opts, function test( t ) { z = deuclidean( 4, x1, 2, y1, 2 ); // sqrt( 9+0+16+25 ) = sqrt( 50 ) - t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 7.0710678118654755, 1 ), true, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js index 969b6394341c..5cbedd32943a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js @@ -23,7 +23,7 @@ var tape = require( 'tape' ); var Float64Array = require( '@stdlib/array/float64' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); -var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); var deuclidean = require( './../lib/ndarray.js' ); @@ -49,43 +49,43 @@ tape( 'the function calculates the euclidean distance', function test( t ) { y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, sqrt( 418.0 ), 1 ), true, 'returns expected value' ); x = new Float64Array( [ -4.0 ] ); y = new Float64Array( [ 10.0 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 14.0, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 14.0, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 3.464101615137754e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 4.0e-155, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.0e-155, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.82842712474619e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.8284271247461905e+50, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.967896939349689e-154, 1 ), true, 'returns expected value' ); t.end(); }); @@ -99,10 +99,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); z = deuclidean( -1, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); t.end(); }); @@ -136,7 +136,7 @@ tape( 'the function supports stride parameters', function test( t ) { z = deuclidean( 4, x, 2, 0, y, 2, 0 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -169,7 +169,7 @@ tape( 'the function supports negative stride parameters', function test( t ) { z = deuclidean( 4, x, -2, x.length-2, y, -2, y.length-2 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -204,6 +204,6 @@ tape( 'the function supports offset parameters', function test( t ) { z = deuclidean( 4, x, 2, 1, y, 2, 1 ); // sqrt( 9+0+16+25 ) = sqrt( 50 ) - t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 7.0710678118654755, 1 ), true, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js index 988ae5fe72bc..47e31030578b 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js @@ -24,8 +24,8 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); -var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' ); // VARIABLES // @@ -58,43 +58,43 @@ tape( 'the function calculates the euclidean distance', opts, function test( t ) y = new Float64Array( [ 5.0, 12.0, -8.0, 15.0, 9.0, 0.0 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, sqrt( 418.0 ), 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, sqrt( 418.0 ), 1 ), true, 'returns expected value' ); x = new Float64Array( [ -4.0 ] ); y = new Float64Array( [ 10.0 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 14.0, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 14.0, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e150, 1.0e150, 1.0e150 ] ); y = new Float64Array( [ -1.0e150, 1.0e150, -1.0e150, -1.0e150 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 3.464101615137754e+150, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 3.464101615137754e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e-155, 1.0e-155, 1.0e-155 ] ); y = new Float64Array( [ -1.0e-155, -1.0e-155, -1.0e-155, -1.0e-155 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, 4.0e-155, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.0e-155, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e150, 1.0e50, 1.0e150, 1.0e50 ] ); y = new Float64Array( [ -1.0e150, -1.0e50, -1.0e150, -1.0e50 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( ulpdiff( z, 2.82842712474619e+150 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.82842712474619e+150, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.0e-155, 1.0e50, 1.0e-155, 1.0e50 ] ); y = new Float64Array( [ -1.0e-155, -1.0e50, -1.0e-155, -1.0e50 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( ulpdiff( z, 2.8284271247461905e+50 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 2.8284271247461905e+50, 1 ), true, 'returns expected value' ); x = new Float64Array( [ 1.4e-154, 1.5e-154, 1.4e-154, 0.0 ] ); y = new Float64Array( [ -1.4e-154, -1.5e-154, -1.4e-154, 0.0 ] ); z = deuclidean( x.length, x, 1, 0, y, 1, 0 ); - t.strictEqual( ulpdiff( z, 4.967896939349689e-154 ) <= 1, true, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 4.967896939349689e-154, 1 ), true, 'returns expected value' ); t.end(); }); @@ -108,10 +108,10 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu y = new Float64Array( [ 3.0, -2.0, 1.0, -15.0, 3.0 ] ); z = deuclidean( 0, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); z = deuclidean( -1, x, 1, 0, y, 1, 0 ); - t.strictEqual( z, NaN, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, NaN, 1 ), true, 'returns expected value' ); t.end(); }); @@ -145,7 +145,7 @@ tape( 'the function supports stride parameters', opts, function test( t ) { z = deuclidean( 4, x, 2, 0, y, 2, 0 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -178,7 +178,7 @@ tape( 'the function supports negative stride parameters', opts, function test( t z = deuclidean( 4, x, -2, x.length-2, y, -2, y.length-2 ); // sqrt( 49+1+81+16 ) = sqrt( 147 ) - t.strictEqual( z, 12.12435565298214, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 12.12435565298214, 1 ), true, 'returns expected value' ); t.end(); }); @@ -213,6 +213,6 @@ tape( 'the function supports offset parameters', opts, function test( t ) { z = deuclidean( 4, x, 2, 1, y, 2, 1 ); // sqrt( 9+0+16+25 ) = sqrt( 50 ) - t.strictEqual( z, 7.0710678118654755, 'returns expected value' ); + t.strictEqual( isAlmostSameValue( z, 7.0710678118654755, 1 ), true, 'returns expected value' ); t.end(); }); From 15c72c822043ad2617db92b12f8ab02894bcce39 Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 5 Jan 2026 16:23:23 -0800 Subject: [PATCH 7/7] chore: clean-up --- 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: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - 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: passed - task: lint_license_headers status: passed --- --- .../strided/distances/deuclidean/README.md | 35 +++++++++---------- .../distances/deuclidean/docs/repl.txt | 11 +++--- .../deuclidean/docs/types/index.d.ts | 12 +++---- .../distances/deuclidean/examples/c/example.c | 8 ++--- .../stats/strided/distances/deuclidean.h | 8 ++--- .../distances/deuclidean/lib/deuclidean.js | 4 +-- .../deuclidean/lib/deuclidean.native.js | 4 +-- .../strided/distances/deuclidean/lib/index.js | 2 +- .../distances/deuclidean/lib/ndarray.js | 4 +-- .../deuclidean/lib/ndarray.native.js | 4 +-- .../strided/distances/deuclidean/package.json | 2 +- .../strided/distances/deuclidean/src/addon.c | 4 +-- .../strided/distances/deuclidean/src/main.c | 16 ++++----- .../deuclidean/test/test.deuclidean.js | 2 +- .../deuclidean/test/test.deuclidean.native.js | 2 +- .../distances/deuclidean/test/test.ndarray.js | 2 +- .../deuclidean/test/test.ndarray.native.js | 2 +- 17 files changed, 60 insertions(+), 62 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md index c5eda0d577ae..cb8079979352 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/README.md @@ -20,25 +20,22 @@ limitations under the License. # deuclidean -> Compute the euclidean distance between two double-precision floating-point strided arrays. +> Compute the Euclidean distance between two double-precision floating-point strided arrays.
-The [euclidean distance][wikipedia-euclidean-distance] is defined as +The [Euclidean distance][wikipedia-euclidean-distance] is defined as - + ```math -d = \sqrt{\sum_{i=0}^{N-1} (y_i - x_i)^2} +d(X,Y) = \left\lVert X - Y \right\rVert = \sqrt{\sum_{i=0}^{N-1} (y_i - x_i)^2} ``` - - +where `x_i` and `y_i` are the _ith_ components of vectors **X** and **Y**, respectively. +
@@ -53,7 +50,7 @@ var deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' ); #### deuclidean( N, x, strideX, y, strideY ) -Computes the euclidean distance between two double-precision floating-point strided arrays. +Computes the Euclidean distance between two double-precision floating-point strided arrays. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -73,7 +70,7 @@ The function has the following parameters: - **y**: input [`Float64Array`][@stdlib/array/float64]. - **strideY**: stride length of `y`. -The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the euclidean distance between every other value in `x` and the first `N` elements of `y` in reverse order, +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the Euclidean distance between every other element in `x` and the first `N` elements of `y` in reverse order, ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -106,7 +103,7 @@ var z = deuclidean( 3, x1, 1, y1, 1 ); #### deuclidean.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) -Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -123,7 +120,7 @@ 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 euclidean distance between every other value in `x` starting from the second value with the last 3 elements in `y` in reverse order +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 Euclidean distance between every other element in `x` starting from the second element with the last 3 elements in `y` in reverse order ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -204,7 +201,7 @@ console.log( out ); #### stdlib_strided_deuclidean( N, \*X, strideX, \*Y, strideY ) -Computes the euclidean distance between two double-precision floating-point strided arrays. +Computes the Euclidean distance between two double-precision floating-point strided arrays. ```c const double x[] = { 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 }; @@ -232,7 +229,7 @@ double stdlib_strided_deuclidean( const CBLAS_INT N, const double *X, const CBLA -Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. ```c const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; @@ -290,17 +287,17 @@ int main( void ) { const int strideX = 1; const int strideY = -1; - // Compute the euclidean distance between `x` and `y`: + // Compute the Euclidean distance between `x` and `y`: double d = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); // Print the result: - printf( "euclidean distance: %lf\n", d ); + printf( "Euclidean distance: %lf\n", d ); - // Compute the euclidean distance between `x` and `y` with offsets: + // Compute the Euclidean distance between `x` and `y` with offsets: d = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); // Print the result: - printf( "euclidean distance: %lf\n", d ); + printf( "Euclidean distance: %lf\n", d ); } ``` diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt index 7a0694276c24..d0bc3ccac283 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/repl.txt @@ -1,6 +1,6 @@ {{alias}}( N, x, strideX, y, strideY ) - Computes the euclidean distance between two double-precision floating-point + Computes the Euclidean distance between two double-precision floating-point strided arrays. The `N` and stride parameters determine which elements in the strided arrays @@ -57,11 +57,12 @@ {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) - Computes the euclidean distance between two double-precision floating-point + Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the offset parameters support indexing based on a starting index. + buffer, offset parameters support indexing semantics based on starting + indices. Parameters ---------- @@ -100,8 +101,8 @@ ~18.11 // 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 ]); + > 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 ) 3.0 diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts index 52a4d61a8a84..c8a40310ef4e 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/docs/types/index.d.ts @@ -23,14 +23,14 @@ */ interface Routine { /** - * Computes the euclidean distance between two double-precision floating-point strided arrays. + * Computes the Euclidean distance between two double-precision floating-point strided arrays. * * @param N - number of indexed elements * @param x - first input array * @param strideX - `x` stride length * @param y - second input array * @param strideY - `y` stride length - * @returns euclidean distance + * @returns Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -44,7 +44,7 @@ interface Routine { ( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): number; /** - * Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. + * Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. * * @param N - number of indexed elements * @param x - first input array @@ -53,7 +53,7 @@ interface Routine { * @param y - second input array * @param strideY - `y` stride length * @param offsetY - starting index for `y` - * @returns euclidean distance + * @returns Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -68,14 +68,14 @@ interface Routine { } /** -* Computes the euclidean distance between two double-precision floating-point strided arrays. +* Computes the Euclidean distance between two double-precision floating-point strided arrays. * * @param N - number of indexed elements * @param x - first input array * @param strideX - `x` stride length * @param y - second input array * @param strideY - `y` stride length -* @returns euclidean distance +* @returns Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c index 7e2da62725ea..721ecff9a586 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/examples/c/example.c @@ -31,15 +31,15 @@ int main( void ) { const int strideX = 1; const int strideY = -1; - // Compute the euclidean distance between `x` and `y`: + // Compute the Euclidean distance between `x` and `y`: double d = stdlib_strided_deuclidean( N, x, strideX, y, strideY ); // Print the result: - printf( "euclidean distance: %lf\n", d ); + printf( "Euclidean distance: %lf\n", d ); - // Compute the euclidean distance between `x` and `y` with offsets: + // Compute the Euclidean distance between `x` and `y` with offsets: d = stdlib_strided_deuclidean_ndarray( N, x, strideX, 0, y, strideY, N-1 ); // Print the result: - printf( "euclidean distance: %lf\n", d ); + printf( "Euclidean distance: %lf\n", d ); } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h index 7a7d86c0375a..6d6d0434bfe9 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/include/stdlib/stats/strided/distances/deuclidean.h @@ -29,14 +29,14 @@ extern "C" { #endif /** -* Computes the euclidean distance between two double-precision floating-point strided arrays. +* Computes the Euclidean distance between two double-precision floating-point strided arrays. */ -double API_SUFFIX( stdlib_strided_deuclidean )( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); +double API_SUFFIX(stdlib_strided_deuclidean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); /** -* Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. */ -double API_SUFFIX( stdlib_strided_deuclidean_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 API_SUFFIX(stdlib_strided_deuclidean_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 ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js index 50d89f0ecc5d..23eb0550f8c5 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.js @@ -27,14 +27,14 @@ var ndarray = require( './ndarray.js' ); // MAIN // /** -* Computes the euclidean distance between two double-precision floating-point strided arrays. +* Computes the Euclidean distance between two double-precision floating-point strided arrays. * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - first input array * @param {integer} strideX - stride length of `x` * @param {Float64Array} y - second input array * @param {integer} strideY - stride length of `y` -* @returns {number} euclidean distance +* @returns {number} Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js index f989b44d2ca4..cf4d3a69ed48 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/deuclidean.native.js @@ -26,14 +26,14 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the euclidean distance between two double-precision floating-point strided arrays. +* Computes the Euclidean distance between two double-precision floating-point strided arrays. * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - first input array * @param {integer} strideX - stride length of `x` * @param {Float64Array} y - second input array * @param {integer} strideY - stride length of `y` -* @returns {number} euclidean distance +* @returns {number} Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js index 56b383adc347..41fca196a575 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute the euclidean distance between two double-precision floating-point strided arrays. +* Compute the Euclidean distance between two double-precision floating-point strided arrays. * * @module @stdlib/stats/strided/distances/deuclidean * diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js index d6291036e4ec..d2e7b85b10fb 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.js @@ -26,7 +26,7 @@ var drrss = require( '@stdlib/blas/ext/base/drrss' ).ndarray; // MAIN // /** -* Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - first input array @@ -35,7 +35,7 @@ var drrss = require( '@stdlib/blas/ext/base/drrss' ).ndarray; * @param {Float64Array} y - second input array * @param {integer} strideY - stride length of `y` * @param {NonNegativeInteger} offsetY - starting index for `y` -* @returns {number} euclidean distance +* @returns {number} Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js index 77756d6b05b4..b6cbaf4e70d1 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/lib/ndarray.native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - first input array @@ -35,7 +35,7 @@ var addon = require( './../src/addon.node' ); * @param {Float64Array} y - second input array * @param {integer} strideY - stride length of `y` * @param {NonNegativeInteger} offsetY - starting index for `y` -* @returns {number} euclidean distance +* @returns {number} Euclidean distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/package.json b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/package.json index ea9a24e3cbce..4985255db56e 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/package.json +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/stats/strided/distances/deuclidean", "version": "0.0.0", - "description": "Compute the euclidean distance between two double-precision floating-point strided arrays.", + "description": "Compute the Euclidean distance between two double-precision floating-point strided arrays.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c index d38c3bf9e27b..768bba545308 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/addon.c @@ -39,7 +39,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { 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_deuclidean )( N, X, strideX, Y, strideY ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_deuclidean)( N, X, strideX, Y, strideY ), v ); return v; } @@ -59,7 +59,7 @@ static napi_value addon_method( napi_env env, napi_callback_info info ) { 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_deuclidean_ndarray )( N, X, strideX, offsetX, Y, strideY, offsetY ), v ); + STDLIB_NAPI_CREATE_DOUBLE( env, API_SUFFIX(stdlib_strided_deuclidean_ndarray)( N, X, strideX, offsetX, Y, strideY, offsetY ), v ); return v; } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c index a14cff58507d..e20c4c591479 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/src/main.c @@ -22,23 +22,23 @@ #include "stdlib/strided/base/stride2offset.h" /** -* Computes the euclidean distance between two double-precision floating-point strided arrays. +* Computes the Euclidean distance between two double-precision floating-point strided arrays. * * @param N number of indexed elements * @param X first array * @param strideX X stride length * @param Y second array * @param strideY Y stride length -* @return euclidean distance +* @return Euclidean distance */ -double API_SUFFIX( stdlib_strided_deuclidean )( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { +double API_SUFFIX(stdlib_strided_deuclidean)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); CBLAS_INT oy = stdlib_strided_stride2offset( N, strideY ); - return API_SUFFIX( stdlib_strided_deuclidean_ndarray )( N, X, strideX, ox, Y, strideY, oy ); + return API_SUFFIX(stdlib_strided_deuclidean_ndarray)( N, X, strideX, ox, Y, strideY, oy ); } /** -* Computes the euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the Euclidean distance between two double-precision floating-point strided arrays using alternative indexing semantics. * * @param N number of indexed elements * @param X first array @@ -47,11 +47,11 @@ double API_SUFFIX( stdlib_strided_deuclidean )( const CBLAS_INT N, const double * @param Y second array * @param strideY Y stride length * @param offsetY starting index for Y -* @return euclidean distance +* @return Euclidean distance */ -double API_SUFFIX( stdlib_strided_deuclidean_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 API_SUFFIX(stdlib_strided_deuclidean_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 ) { if ( N <= 0.0 ) { - return 0.0 / 0.0; + return 0.0/0.0; // NaN } return stdlib_strided_drrss_ndarray( N, X, strideX, offsetX, Y, strideY, offsetY ); } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js index 8780a47ad41a..2f23daa6ffe7 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.js @@ -42,7 +42,7 @@ tape( 'the function has an arity of 5', function test( t ) { t.end(); }); -tape( 'the function calculates the euclidean distance', function test( t ) { +tape( 'the function calculates the Euclidean distance', function test( t ) { var x; var y; var z; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js index 96f800687f62..36115f75f7ea 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.deuclidean.native.js @@ -49,7 +49,7 @@ tape( 'the function has an arity of 5', opts, function test( t ) { t.end(); }); -tape( 'the function calculates the euclidean distance', opts, function test( t ) { +tape( 'the function calculates the Euclidean distance', opts, function test( t ) { var x; var y; var z; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js index 5cbedd32943a..48e3423c209c 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.js @@ -40,7 +40,7 @@ tape( 'the function has an arity of 7', function test( t ) { t.end(); }); -tape( 'the function calculates the euclidean distance', function test( t ) { +tape( 'the function calculates the Euclidean distance', function test( t ) { var x; var y; var z; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js index 47e31030578b..348963f3abd6 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/deuclidean/test/test.ndarray.native.js @@ -49,7 +49,7 @@ tape( 'the function has an arity of 7', opts, function test( t ) { t.end(); }); -tape( 'the function calculates the euclidean distance', opts, function test( t ) { +tape( 'the function calculates the Euclidean distance', opts, function test( t ) { var x; var y; var z;