From fe23f3259bd1364003911dca6c489c8a7cd8afda Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Tue, 6 Jan 2026 17:46:25 +0530 Subject: [PATCH 1/3] feat: add `stats/strided/distances/dcityblock` --- 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/dcityblock/README.md | 336 ++++++++++++++++++ .../dcityblock/benchmark/benchmark.js | 98 +++++ .../dcityblock/benchmark/benchmark.native.js | 103 ++++++ .../dcityblock/benchmark/benchmark.ndarray.js | 98 +++++ .../benchmark/benchmark.ndarray.native.js | 103 ++++++ .../distances/dcityblock/benchmark/c/Makefile | 146 ++++++++ .../dcityblock/benchmark/c/benchmark.length.c | 205 +++++++++++ .../strided/distances/dcityblock/binding.gyp | 265 ++++++++++++++ .../distances/dcityblock/docs/repl.txt | 110 ++++++ .../dcityblock/docs/types/index.d.ts | 103 ++++++ .../distances/dcityblock/docs/types/test.ts | 248 +++++++++++++ .../distances/dcityblock/examples/c/Makefile | 146 ++++++++ .../distances/dcityblock/examples/c/example.c | 45 +++ .../distances/dcityblock/examples/index.js | 34 ++ .../strided/distances/dcityblock/include.gypi | 70 ++++ .../stats/strided/distances/dcityblock.h | 45 +++ .../distances/dcityblock/lib/dcityblock.js | 57 +++ .../dcityblock/lib/dcityblock.native.js | 54 +++ .../strided/distances/dcityblock/lib/index.js | 70 ++++ .../strided/distances/dcityblock/lib/main.js | 35 ++ .../distances/dcityblock/lib/native.js | 35 ++ .../distances/dcityblock/lib/ndarray.js | 75 ++++ .../dcityblock/lib/ndarray.native.js | 56 +++ .../distances/dcityblock/manifest.json | 103 ++++++ .../strided/distances/dcityblock/package.json | 74 ++++ .../strided/distances/dcityblock/src/Makefile | 70 ++++ .../strided/distances/dcityblock/src/addon.c | 66 ++++ .../strided/distances/dcityblock/src/main.c | 73 ++++ .../dcityblock/test/test.dcityblock.js | 217 +++++++++++ .../dcityblock/test/test.dcityblock.native.js | 226 ++++++++++++ .../strided/distances/dcityblock/test/test.js | 82 +++++ .../distances/dcityblock/test/test.ndarray.js | 240 +++++++++++++ .../dcityblock/test/test.ndarray.native.js | 249 +++++++++++++ 33 files changed, 3937 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include/stdlib/stats/strided/distances/dcityblock.h create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/package.json create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md new file mode 100644 index 000000000000..2c0ef036be0c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md @@ -0,0 +1,336 @@ + + +# dcityblock + +> Compute the Cityblock distance between two double-precision floating-point strided arrays. + +
+ +The [Cityblock distance][wikipedia-taxicab-geometry] (also known as the Manhattan distance ) is defined as + + + +```math +{D(\mathbf {A} ,\mathbf {B} )=\left\|\mathbf {A} -\mathbf {B} \right\|_{\text{T}}=\sum _{i=1}^{n}\left|a_{i}-b_{i}\right|} +``` + + + +where `a_i` and `b_i` are the _ith_ components of vectors **A** and **B**, respectively. + +
+ + + +
+ +## Usage + +```javascript +var dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' ); +``` + +#### dcityblock( N, x, strideX, y, strideY ) + +Computes the Cityblock distance between two double-precision floating-point strided arrays. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); +var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + +var z = dcityblock( x.length, x, 1, y, 1 ); +// returns 26.0 +``` + +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 Cityblock distance between every other element 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 = dcityblock( 3, x, 2, y, -1 ); +// returns 6.0 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +// 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 = dcityblock( 3, x1, 1, y1, 1 ); +// returns 24.0 +``` + +#### dcityblock.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); +var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + +var z = dcityblock.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// returns 26.0 +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetY**: starting index for `y`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the Cityblock 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' ); + +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 = dcityblock.ndarray( 3, x, 2, 1, y, -1, y.length-1 ); +// returns 21.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' ); + +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 = dcityblock.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +console.log( out ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/strided/distances/dcityblock.h" +``` + +#### stdlib_strided_dcityblock( N, \*X, strideX, \*Y, strideY ) + +Computes the Cityblock distance between two double-precision floating-point strided arrays. + +```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_dcityblock( 5, x, 1, y, 1 ); +// returns 26.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length of `X`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` stride length of `Y`. + +```c +double stdlib_strided_dcityblock( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); +``` + + + +#### stdlib_strided_dcityblock_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY ) + + + +Computes the Cityblock 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_dcityblock_ndarray( 5, x, -1, 4, y, -1, 4 ); +// returns 26.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` stride length 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_dcityblock_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/dcityblock.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 Cityblock distance between `x` and `y`: + double d = stdlib_strided_dcityblock( N, x, strideX, y, strideY ); + + // Print the result: + printf( "Cityblock distance: %lf\n", d ); + + // Compute the Cityblock distance between `x` and `y` with offsets: + d = stdlib_strided_dcityblock_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + + // Print the result: + printf( "Cityblock distance: %lf\n", d ); +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[@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-taxicab-geometry]: https://en.wikipedia.org/wiki/Taxicab_geometry + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.js new file mode 100644 index 000000000000..b2d5a802029b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.js @@ -0,0 +1,98 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var 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 dcityblock = require( './../lib/dcityblock.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 = dcityblock( 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/dcityblock/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.native.js new file mode 100644 index 000000000000..617e47cc1c7b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.native.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var 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 dcityblock = tryRequire( resolve( __dirname, './../lib/dcityblock.native.js' ) ); +var opts = { + 'skip': ( dcityblock 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 = dcityblock( 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/dcityblock/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..e6413b3f1036 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.ndarray.js @@ -0,0 +1,98 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var 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 dcityblock = 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 = dcityblock( 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/dcityblock/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..c88f3ce2864f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var 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 dcityblock = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dcityblock 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 = dcityblock( 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/dcityblock/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/Makefile new file mode 100644 index 000000000000..0756dc7da20a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..2bbdb5971400 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/benchmark/c/benchmark.length.c @@ -0,0 +1,205 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/dcityblock.h" +#include +#include +#include +#include +#include + +#define NAME "dcityblock" +#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 [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double 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 ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); + } + z = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + z = stdlib_strided_dcityblock( 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 ] = random_uniform( -10000.0, 10000.0 ); + y[ i ] = random_uniform( -10000.0, 10000.0 ); + } + z = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + z = stdlib_strided_dcityblock_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/dcityblock/binding.gyp b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/binding.gyp new file mode 100644 index 000000000000..60dce9d0b31a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/binding.gyp @@ -0,0 +1,265 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # 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/dcityblock/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt new file mode 100644 index 000000000000..a80e8cd70a4f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt @@ -0,0 +1,110 @@ + +{{alias}}( N, x, strideX, y, strideY ) + Computes the Cityblock 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 `NaN`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Stride length for `x`. + + y: Float64Array + Second input array. + + strideY: integer + Stride length for `y`. + + Returns + ------- + out: number + Cityblock distance. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + > var out = {{alias}}( x.length, x, 1, y, 1 ) + 26.0 + + // Using N and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 0.0, 0.0, 0.0 ] ); + > out = {{alias}}( 3, x, 1, y, -1 ) + 3.0 + + // Using view offsets: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x.buffer, x.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float64}}( y.buffer, y.BYTES_PER_ELEMENT*3 ); + > out = {{alias}}( 3, x1, 1, y1, 1 ) + 24.0 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Computes the Cityblock 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, offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + First input array. + + strideX: integer + Stride length for `x`. + + offsetX: integer + Starting index for `x`. + + y: Float64Array + Second input array. + + strideY: integer + Stride length for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + out: number + Cityblock distance. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + > var out = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) + 26.0 + + // Using starting indices: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > out = {{alias}}.ndarray( 3, x, 1, 1, y, 1, 3 ) + 24.0 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts new file mode 100644 index 000000000000..0eb33faaf678 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts @@ -0,0 +1,103 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Interface describing `dcityblock`. +*/ +interface Routine { + /** + * Computes the Cityblock 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 Cityblock distance + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * + * var z = dcityblock( x.length, x, 1, y, 1 ); + * // returns 26.0 + */ + ( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): number; + + /** + * Computes the Cityblock 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 Cityblock distance + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * + * var z = dcityblock.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns 26.0 + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): number; +} + +/** +* Computes the Cityblock 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 Cityblock distance +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); +* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); +* +* var z = dcityblock( x.length, x, 1, y, 1 ); +* // returns 26.0 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); +* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); +* +* var z = dcityblock.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns 26.0 +*/ +declare var dcityblock: Routine; + + +// EXPORTS // + +export = dcityblock; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/test.ts b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/test.ts new file mode 100644 index 000000000000..eabb43d2994c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/test.ts @@ -0,0 +1,248 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import dcityblock = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcityblock( 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 ); + + dcityblock( '10', x, 1, y, 1 ); // $ExpectError + dcityblock( true, x, 1, y, 1 ); // $ExpectError + dcityblock( false, x, 1, y, 1 ); // $ExpectError + dcityblock( null, x, 1, y, 1 ); // $ExpectError + dcityblock( undefined, x, 1, y, 1 ); // $ExpectError + dcityblock( [], x, 1, y, 1 ); // $ExpectError + dcityblock( {}, x, 1, y, 1 ); // $ExpectError + dcityblock( ( 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 ); + + dcityblock( x.length, 10, 1, y, 1 ); // $ExpectError + dcityblock( x.length, '10', 1, y, 1 ); // $ExpectError + dcityblock( x.length, true, 1, y, 1 ); // $ExpectError + dcityblock( x.length, false, 1, y, 1 ); // $ExpectError + dcityblock( x.length, null, 1, y, 1 ); // $ExpectError + dcityblock( x.length, undefined, 1, y, 1 ); // $ExpectError + dcityblock( x.length, [], 1, y, 1 ); // $ExpectError + dcityblock( x.length, {}, 1, y, 1 ); // $ExpectError + dcityblock( 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 ); + + dcityblock( x.length, x, '10', y, 1 ); // $ExpectError + dcityblock( x.length, x, true, y, 1 ); // $ExpectError + dcityblock( x.length, x, false, y, 1 ); // $ExpectError + dcityblock( x.length, x, null, y, 1 ); // $ExpectError + dcityblock( x.length, x, undefined, y, 1 ); // $ExpectError + dcityblock( x.length, x, [], y, 1 ); // $ExpectError + dcityblock( x.length, x, {}, y, 1 ); // $ExpectError + dcityblock( 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 ); + + dcityblock( x.length, x, 1, 10, 1 ); // $ExpectError + dcityblock( x.length, x, 1, '10', 1 ); // $ExpectError + dcityblock( x.length, x, 1, true, 1 ); // $ExpectError + dcityblock( x.length, x, 1, false, 1 ); // $ExpectError + dcityblock( x.length, x, 1, null, 1 ); // $ExpectError + dcityblock( x.length, x, 1, undefined, 1 ); // $ExpectError + dcityblock( x.length, x, 1, [], 1 ); // $ExpectError + dcityblock( x.length, x, 1, {}, 1 ); // $ExpectError + dcityblock( 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 ); + + dcityblock( x.length, x, 1, y, '10' ); // $ExpectError + dcityblock( x.length, x, 1, y, true ); // $ExpectError + dcityblock( x.length, x, 1, y, false ); // $ExpectError + dcityblock( x.length, x, 1, y, null ); // $ExpectError + dcityblock( x.length, x, 1, y, undefined ); // $ExpectError + dcityblock( x.length, x, 1, y, [] ); // $ExpectError + dcityblock( x.length, x, 1, y, {} ); // $ExpectError + dcityblock( 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 ); + + dcityblock(); // $ExpectError + dcityblock( x.length ); // $ExpectError + dcityblock( x.length, x ); // $ExpectError + dcityblock( x.length, x, 1 ); // $ExpectError + dcityblock( x.length, x, 1, y ); // $ExpectError + dcityblock( 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 ); + + dcityblock.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 ); + + dcityblock.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + dcityblock.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 ); + + dcityblock.ndarray(); // $ExpectError + dcityblock.ndarray( x.length ); // $ExpectError + dcityblock.ndarray( x.length, x ); // $ExpectError + dcityblock.ndarray( x.length, x, 1 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + dcityblock.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c new file mode 100644 index 000000000000..db48362cfc24 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/dcityblock.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 Cityblock distance between `x` and `y`: + double d = stdlib_strided_dcityblock( N, x, strideX, y, strideY ); + + // Print the result: + printf( "Cityblock distance: %lf\n", d ); + + // Compute the Cityblock distance between `x` and `y` with offsets: + d = stdlib_strided_dcityblock_ndarray( N, x, strideX, 0, y, strideY, N-1 ); + + // Print the result: + printf( "Cityblock distance: %lf\n", d ); +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/index.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/index.js new file mode 100644 index 000000000000..585c6c4623ba --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/index.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var dcityblock = 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 = dcityblock.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include.gypi b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include.gypi new file mode 100644 index 000000000000..dcb556d250e8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include.gypi @@ -0,0 +1,70 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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", + "cityblock", + "distance", + "metric", + "strided", + "strided array", + "typed", + "array", + "float64", + "double", + "float64array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/Makefile b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/addon.c b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/addon.c new file mode 100644 index 000000000000..5d60e3994ade --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/addon.c @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/dcityblock.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_dcityblock)( 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_dcityblock_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/dcityblock/src/main.c b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c new file mode 100644 index 000000000000..e5f9b58cabb9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c @@ -0,0 +1,73 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/strided/distances/dcityblock.h" +#include "stdlib/math/base/special/abs.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the Cityblock 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 Cityblock distance +*/ +double API_SUFFIX(stdlib_strided_dcityblock)( 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_dcityblock_ndarray)( N, X, strideX, ox, Y, strideY, oy ); +} + +/** +* Computes the Cityblock 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 Cityblock distance +*/ +double API_SUFFIX(stdlib_strided_dcityblock_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ) { + CBLAS_INT ox; + CBLAS_INT oy; + CBLAS_INT i; + double d; + + if ( N <= 0 ) { + return 0.0 / 0.0; // NaN + } + ox = offsetX; + oy = offsetY; + + d = stdlib_base_abs( X[ ox ] - Y[ oy ] ); + ox += strideX; + oy += strideY; + for ( i = 1; i < N; i++ ) { + d += stdlib_base_abs( X[ ox ] - Y[ oy ] ); + ox += strideX; + oy += strideY; + } + return d; +} diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js new file mode 100644 index 000000000000..96399c98bbd8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js @@ -0,0 +1,217 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var dcityblock = require( './../lib/dcityblock.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcityblock, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( dcityblock.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Cityblock distance between two strided arrays', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Test against textbook formula: 2+4+2+9+9+6+7+9=48 + d = dcityblock( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, 48.0, 0 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Test against textbook formula: 2+2+2=6 + d = dcityblock( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, 6.0, 0 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + d = dcityblock( 0, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + + d = dcityblock( -4, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Test against textbook formula: 6+7+9=22 + d = dcityblock( 3, x, 2, y, 1 ); + t.strictEqual( isAlmostSameValue( d, 22.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Test against textbook formula: 6+0+1=7 + d = dcityblock( 3, x, 1, y, 2 ); + t.strictEqual( isAlmostSameValue( d, 7.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Test against textbook formula: 3+4+5=12 + d = dcityblock( 3, x, -2, y, -1 ); + t.strictEqual( isAlmostSameValue( d, 12.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Test against textbook formula: 7+4+1=12 + d = dcityblock( 3, x, 2, y, -1 ); + t.strictEqual( isAlmostSameValue( d, 12.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var x0; + var y0; + var x1; + var y1; + var d; + + x0 = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y0 = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + + // Test against textbook formula: 7+6+5=18 + d = dcityblock( 3, x1, 2, y1, 1 ); + t.strictEqual( isAlmostSameValue( d, 18.0, 0 ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js new file mode 100644 index 000000000000..406dd44db43a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js @@ -0,0 +1,226 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dcityblock = tryRequire( resolve( __dirname, './../lib/dcityblock.native.js' ) ); +var opts = { + 'skip': ( dcityblock instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcityblock, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( dcityblock.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Cityblock distance between two strided arrays', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Test against textbook formula: 2+4+2+9+9+6+7+9=48 + d = dcityblock( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, 48.0, 0 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Test against textbook formula: 2+2+2=6 + d = dcityblock( x.length, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, 6.0, 0 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + d = dcityblock( 0, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + + d = dcityblock( -4, x, 1, y, 1 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Test against textbook formula: 6+7+9=22 + d = dcityblock( 3, x, 2, y, 1 ); + t.strictEqual( isAlmostSameValue( d, 22.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Test against textbook formula: 6+0+1=7 + d = dcityblock( 3, x, 1, y, 2 ); + t.strictEqual( isAlmostSameValue( d, 7.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Test against textbook formula: 3+4+5=12 + d = dcityblock( 3, x, -2, y, -1 ); + t.strictEqual( isAlmostSameValue( d, 12.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Test against textbook formula: 7+4+1=12 + d = dcityblock( 3, x, 2, y, -1 ); + t.strictEqual( isAlmostSameValue( d, 12.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var x0; + var y0; + var x1; + var y1; + var d; + + x0 = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y0 = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + + // Test against textbook formula: 7+6+5=18 + d = dcityblock( 3, x1, 2, y1, 1 ); + t.strictEqual( isAlmostSameValue( d, 18.0, 0 ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.js new file mode 100644 index 000000000000..e44c7b555b49 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); +var dcityblock = 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 dcityblock, '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 dcityblock.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 dcityblock = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dcityblock, 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 dcityblock; + var main; + + main = require( './../lib/dcityblock.js' ); + + dcityblock = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dcityblock, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js new file mode 100644 index 000000000000..2536004b0329 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js @@ -0,0 +1,240 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var dcityblock = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcityblock, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', function test( t ) { + t.strictEqual( dcityblock.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Cityblock distance between two strided arrays', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Test against textbook formula: 2+4+2+9+9+6+7+9=48 + d = dcityblock( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 48.0, 0 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Test against textbook formula: 2+2+2=6 + d = dcityblock( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 6.0, 0 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + d = dcityblock( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + + d = dcityblock( -4, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Test against textbook formula: 6+7+9=22 + d = dcityblock( 3, x, 2, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 22.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` offset', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0, + 11.0 + ]); + + // Test against textbook formula: 4+3+2=9 + d = dcityblock( 3, x, 2, 1, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 9.0, 0 ), true, 'returns expected value' + d ); + t.end(); +}); + +tape( 'the function supports a `y` stride', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Test against textbook formula: 6+0+1=7 + d = dcityblock( 3, x, 1, 0, y, 2, 0 ); + t.strictEqual( isAlmostSameValue( d, 7.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + y = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + // Test against textbook formula: 8+7+6=21 + d = dcityblock( 3, x, 2, 0, y, 1, 3 ); + t.strictEqual( isAlmostSameValue( d, 21.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Test against textbook formula: 3+4+5=12 + d = dcityblock( 3, x, -2, x.length-1, y, -1, 2 ); + t.strictEqual( isAlmostSameValue( d, 12.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ]); + + // Test against textbook formula: 8+5+2=15 + d = dcityblock( 3, x, 2, 0, y, -1, y.length-2 ); + t.strictEqual( isAlmostSameValue( d, 15.0, 0 ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js new file mode 100644 index 000000000000..3b66d59a6729 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js @@ -0,0 +1,249 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var isAlmostSameValue = require( '@stdlib/assert/is-almost-same-value' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dcityblock = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dcityblock instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcityblock, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 7', opts, function test( t ) { + t.strictEqual( dcityblock.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the function calculates the Cityblock distance between two strided arrays', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + // Test against textbook formula: 2+4+2+9+9+6+7+9=48 + d = dcityblock( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 48.0, 0 ), true, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + // Test against textbook formula: 2+2+2=6 + d = dcityblock( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 6.0, 0 ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + d = dcityblock( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + + d = dcityblock( -4, x, 1, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, NaN, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` stride', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + // Test against textbook formula: 6+7+9=22 + d = dcityblock( 3, x, 2, 0, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 22.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` offset', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0, + 11.0 + ]); + + // Test against textbook formula: 4+3+2=9 + d = dcityblock( 3, x, 2, 1, y, 1, 0 ); + t.strictEqual( isAlmostSameValue( d, 9.0, 0 ), true, 'returns expected value' + d ); + t.end(); +}); + +tape( 'the function supports a `y` stride', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + // Test against textbook formula: 6+0+1=7 + d = dcityblock( 3, x, 1, 0, y, 2, 0 ); + t.strictEqual( isAlmostSameValue( d, 7.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + y = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + // Test against textbook formula: 8+7+6=21 + d = dcityblock( 3, x, 2, 0, y, 1, 3 ); + t.strictEqual( isAlmostSameValue( d, 21.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + // Test against textbook formula: 3+4+5=12 + d = dcityblock( 3, x, -2, x.length-1, y, -1, 2 ); + t.strictEqual( isAlmostSameValue( d, 12.0, 0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', opts, function test( t ) { + var d; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ]); + + // Test against textbook formula: 8+5+2=15 + d = dcityblock( 3, x, 2, 0, y, -1, y.length-2 ); + t.strictEqual( isAlmostSameValue( d, 15.0, 0 ), true, 'returns expected value' ); + t.end(); +}); From 50d7e53dc2cc26f3861aaa2ec1530b7367975efb Mon Sep 17 00:00:00 2001 From: Nakul Krishnakumar Date: Tue, 6 Jan 2026 18:08:06 +0530 Subject: [PATCH 2/3] docs: 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: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: 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 --- --- .../@stdlib/stats/strided/distances/dcityblock/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md index 2c0ef036be0c..8e3c0fcc49a9 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md @@ -26,7 +26,7 @@ limitations under the License. The [Cityblock distance][wikipedia-taxicab-geometry] (also known as the Manhattan distance ) is defined as - + ```math {D(\mathbf {A} ,\mathbf {B} )=\left\|\mathbf {A} -\mathbf {B} \right\|_{\text{T}}=\sum _{i=1}^{n}\left|a_{i}-b_{i}\right|} From 894ae40fffba7506c994b97ce54199275ffbff17 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 9 Jan 2026 18:34:13 -0800 Subject: [PATCH 3/3] 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/dcityblock/README.md | 28 +++++++++---------- .../distances/dcityblock/docs/repl.txt | 12 ++++---- .../dcityblock/docs/types/index.d.ts | 12 ++++---- .../distances/dcityblock/examples/c/example.c | 8 +++--- .../stats/strided/distances/dcityblock.h | 4 +-- .../distances/dcityblock/lib/dcityblock.js | 4 +-- .../dcityblock/lib/dcityblock.native.js | 4 +-- .../strided/distances/dcityblock/lib/index.js | 2 +- .../distances/dcityblock/lib/ndarray.js | 4 +-- .../dcityblock/lib/ndarray.native.js | 4 +-- .../strided/distances/dcityblock/package.json | 5 +++- .../strided/distances/dcityblock/src/main.c | 8 +++--- .../dcityblock/test/test.dcityblock.js | 2 +- .../dcityblock/test/test.dcityblock.native.js | 2 +- .../distances/dcityblock/test/test.ndarray.js | 8 +++--- .../dcityblock/test/test.ndarray.native.js | 8 +++--- 16 files changed, 59 insertions(+), 56 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md index 8e3c0fcc49a9..4f5e2fb3b05a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/README.md @@ -20,16 +20,16 @@ limitations under the License. # dcityblock -> Compute the Cityblock distance between two double-precision floating-point strided arrays. +> Compute the city block (Manhattan) distance between two double-precision floating-point strided arrays.
-The [Cityblock distance][wikipedia-taxicab-geometry] (also known as the Manhattan distance ) is defined as +The [city block distance][wikipedia-taxicab-geometry] (also known as the Manhattan or taxicab distance) is defined as - + ```math -{D(\mathbf {A} ,\mathbf {B} )=\left\|\mathbf {A} -\mathbf {B} \right\|_{\text{T}}=\sum _{i=1}^{n}\left|a_{i}-b_{i}\right|} +D(\mathbf{A}, \mathbf{B}) = \left\| \mathbf{A} - \mathbf{B} \right\|_{\text{T}} = \sum_{i=0}^{N-1} \left| a_{i} - b_{i} \right| ``` @@ -50,7 +50,7 @@ var dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' ); #### dcityblock( N, x, strideX, y, strideY ) -Computes the Cityblock distance between two double-precision floating-point strided arrays. +Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -70,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 Cityblock distance between every other element 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 city block (Manhattan) distance between every other element in `x` and the first `N` elements of `y` in reverse order, ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -103,7 +103,7 @@ var z = dcityblock( 3, x1, 1, y1, 1 ); #### dcityblock.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) -Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. +Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays using alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -120,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 Cityblock distance between every other element in `x` starting from the second element 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 city block (Manhattan) 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' ); @@ -201,7 +201,7 @@ console.log( out ); #### stdlib_strided_dcityblock( N, \*X, strideX, \*Y, strideY ) -Computes the Cityblock distance between two double-precision floating-point strided arrays. +Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays. ```c const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; @@ -229,7 +229,7 @@ double stdlib_strided_dcityblock( const CBLAS_INT N, const double *X, const CBLA -Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. +Computes the city block (Manhattan) 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 }; @@ -287,17 +287,17 @@ int main( void ) { const int strideX = 1; const int strideY = -1; - // Compute the Cityblock distance between `x` and `y`: + // Compute the city block (Manhattan) distance between `x` and `y`: double d = stdlib_strided_dcityblock( N, x, strideX, y, strideY ); // Print the result: - printf( "Cityblock distance: %lf\n", d ); + printf( "City block (Manhattan) distance: %lf\n", d ); - // Compute the Cityblock distance between `x` and `y` with offsets: + // Compute the city block (Manhattan) distance between `x` and `y` with offsets: d = stdlib_strided_dcityblock_ndarray( N, x, strideX, 0, y, strideY, N-1 ); // Print the result: - printf( "Cityblock distance: %lf\n", d ); + printf( "City block (Manhattan) distance: %lf\n", d ); } ``` diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt index a80e8cd70a4f..3aae3dfaf77a 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( N, x, strideX, y, strideY ) - Computes the Cityblock distance between two double-precision floating-point - strided arrays. + Computes the city block (Manhattan) 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. @@ -31,7 +31,7 @@ Returns ------- out: number - Cityblock distance. + City block (Manhattan) distance. Examples -------- @@ -57,8 +57,8 @@ {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) - Computes the Cityblock distance between two double-precision floating-point - strided arrays using alternative indexing semantics. + Computes the city block (Manhattan) 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, offset parameters support indexing semantics based on starting @@ -90,7 +90,7 @@ Returns ------- out: number - Cityblock distance. + City block (Manhattan) distance. Examples -------- diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts index 0eb33faaf678..e201fd4f1c56 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/docs/types/index.d.ts @@ -23,14 +23,14 @@ */ interface Routine { /** - * Computes the Cityblock distance between two double-precision floating-point strided arrays. + * Computes the city block (Manhattan) 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 Cityblock distance + * @returns city block (Manhattan) 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 Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. + * Computes the city block (Manhattan) 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 Cityblock distance + * @returns city block (Manhattan) distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); @@ -68,14 +68,14 @@ interface Routine { } /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays. +* Computes the city block (Manhattan) 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 Cityblock distance +* @returns city block (Manhattan) distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c index db48362cfc24..9ec9993a7a0f 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/examples/c/example.c @@ -31,15 +31,15 @@ int main( void ) { const int strideX = 1; const int strideY = -1; - // Compute the Cityblock distance between `x` and `y`: + // Compute the city block (Manhattan) distance between `x` and `y`: double d = stdlib_strided_dcityblock( N, x, strideX, y, strideY ); // Print the result: - printf( "Cityblock distance: %lf\n", d ); + printf( "City block (Manhattan) distance: %lf\n", d ); - // Compute the Cityblock distance between `x` and `y` with offsets: + // Compute the city block (Manhattan) distance between `x` and `y` with offsets: d = stdlib_strided_dcityblock_ndarray( N, x, strideX, 0, y, strideY, N-1 ); // Print the result: - printf( "Cityblock distance: %lf\n", d ); + printf( "City block (Manhattan) distance: %lf\n", d ); } diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include/stdlib/stats/strided/distances/dcityblock.h b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include/stdlib/stats/strided/distances/dcityblock.h index 8963cd622153..5b508ee30ac4 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include/stdlib/stats/strided/distances/dcityblock.h +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/include/stdlib/stats/strided/distances/dcityblock.h @@ -29,12 +29,12 @@ extern "C" { #endif /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays. +* Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays. */ double API_SUFFIX(stdlib_strided_dcityblock)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays using alternative indexing semantics. */ double API_SUFFIX(stdlib_strided_dcityblock_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 ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.js index 24455816f5dc..47584c08688c 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.js @@ -27,14 +27,14 @@ var ndarray = require( './ndarray.js' ); // MAIN // /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays. +* Computes the city block (Manhattan) 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} Cityblock distance +* @returns {number} city block (Manhattan) distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.native.js index 1634bb1d9668..ba05fea2d75d 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/dcityblock.native.js @@ -26,14 +26,14 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays. +* Computes the city block (Manhattan) 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} Cityblock distance +* @returns {number} city block (Manhattan) distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/index.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/index.js index efd6ae3bfb15..1d008996c284 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/index.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute the Cityblock distance between two double-precision floating-point strided arrays. +* Compute the city block (Manhattan) distance between two double-precision floating-point strided arrays. * * @module @stdlib/stats/strided/distances/dcityblock * diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.js index e4d7c5bffb4d..d48afbdcfffd 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.js @@ -26,7 +26,7 @@ var abs = require( '@stdlib/math/base/special/abs' ); // MAIN // /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the city block (Manhattan) 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 abs = require( '@stdlib/math/base/special/abs' ); * @param {Float64Array} y - second input array * @param {integer} strideY - stride length of `y` * @param {NonNegativeInteger} offsetY - starting index for `y` -* @returns {number} Cityblock distance +* @returns {number} city block (Manhattan) distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.native.js index 1a897e7c45b0..b11c07664d31 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/lib/ndarray.native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the city block (Manhattan) 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} Cityblock distance +* @returns {number} city block (Manhattan) distance * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/package.json b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/package.json index d79a06dcc08c..40c47262fe6e 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/package.json +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/stats/strided/distances/dcityblock", "version": "0.0.0", - "description": "Compute the Cityblock distance between two double-precision floating-point strided arrays.", + "description": "Compute the city block (Manhattan) distance between two double-precision floating-point strided arrays.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -60,6 +60,9 @@ "mathematics", "math", "cityblock", + "manhattan", + "minkowski", + "taxicab", "distance", "metric", "strided", diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c index e5f9b58cabb9..ab11af002c5f 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/src/main.c @@ -22,14 +22,14 @@ #include "stdlib/strided/base/stride2offset.h" /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays. +* Computes the city block (Manhattan) 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 Cityblock distance +* @return city block (Manhattan) distance */ double API_SUFFIX(stdlib_strided_dcityblock)( 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 ); @@ -38,7 +38,7 @@ double API_SUFFIX(stdlib_strided_dcityblock)( const CBLAS_INT N, const double *X } /** -* Computes the Cityblock distance between two double-precision floating-point strided arrays using alternative indexing semantics. +* Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays using alternative indexing semantics. * * @param N number of indexed elements * @param X first array @@ -47,7 +47,7 @@ double API_SUFFIX(stdlib_strided_dcityblock)( const CBLAS_INT N, const double *X * @param Y second array * @param strideY Y stride length * @param offsetY starting index for Y -* @return Cityblock distance +* @return city block (Manhattan) distance */ double API_SUFFIX(stdlib_strided_dcityblock_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ) { CBLAS_INT ox; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js index 96399c98bbd8..0ad2621c0fde 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.js @@ -39,7 +39,7 @@ tape( 'the function has an arity of 5', function test( t ) { t.end(); }); -tape( 'the function calculates the Cityblock distance between two strided arrays', function test( t ) { +tape( 'the function calculates the city block (Manhattan) distance between two strided arrays', function test( t ) { var d; var x; var y; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js index 406dd44db43a..1ae1426e0919 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.dcityblock.native.js @@ -48,7 +48,7 @@ tape( 'the function has an arity of 5', opts, function test( t ) { t.end(); }); -tape( 'the function calculates the Cityblock distance between two strided arrays', opts, function test( t ) { +tape( 'the function calculates the city block (Manhattan) distance between two strided arrays', opts, function test( t ) { var d; var x; var y; diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js index 2536004b0329..4c8793520472 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.js @@ -39,7 +39,7 @@ tape( 'the function has an arity of 7', function test( t ) { t.end(); }); -tape( 'the function calculates the Cityblock distance between two strided arrays', function test( t ) { +tape( 'the function calculates the city block (Manhattan) distance between two strided arrays', function test( t ) { var d; var x; var y; @@ -227,9 +227,9 @@ tape( 'the function supports complex access patterns', function test( t ) { ]); y = new Float64Array([ 6.0, - 7.0, // 2 - 8.0, // 1 - 9.0, // 0 + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 10.0 ]); diff --git a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js index 3b66d59a6729..b3d7092a8a1b 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/strided/distances/dcityblock/test/test.ndarray.native.js @@ -48,7 +48,7 @@ tape( 'the function has an arity of 7', opts, function test( t ) { t.end(); }); -tape( 'the function calculates the Cityblock distance between two strided arrays', opts, function test( t ) { +tape( 'the function calculates the city block (Manhattan) distance between two strided arrays', opts, function test( t ) { var d; var x; var y; @@ -236,9 +236,9 @@ tape( 'the function supports complex access patterns', opts, function test( t ) ]); y = new Float64Array([ 6.0, - 7.0, // 2 - 8.0, // 1 - 9.0, // 0 + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 10.0 ]);