-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: add stats/strided/distances/dminkowski
#10567
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nakul-krishnakumar
wants to merge
13
commits into
stdlib-js:develop
Choose a base branch
from
nakul-krishnakumar:dist-minkowski
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+4,368
−0
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
3cb1cdd
feat: add `stats/strided/distances/dminkowski`
nakul-krishnakumar 6695ab7
refactor: update parameter `P` to lowercase
nakul-krishnakumar 3d5e646
bench: move declaration
kgryte c3c6734
bench: fix loop limit
kgryte e60279a
fix: update according to code review
nakul-krishnakumar c233c14
fix: update according to code review
nakul-krishnakumar 13f393b
style: remove trailing whitespace
nakul-krishnakumar c856dbd
bench: reorder declarations
kgryte 6faa847
bench: reorder declarations
kgryte cdf3a62
bench: reorder declarations
kgryte 1f924b3
bench: reorder declarations
kgryte 1f04cf2
bench: fix declarations
kgryte e28dc9f
chore: update according to code review
nakul-krishnakumar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
342 changes: 342 additions & 0 deletions
342
lib/node_modules/@stdlib/stats/strided/distances/dminkowski/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,342 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # dminkowski | ||
|
|
||
| > Compute the Minkowski distance between two double-precision floating-point strided arrays. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| The [minkowski distance][wikipedia-minkowski-distance] is defined as | ||
|
|
||
| <!-- <equation class="equation" label="eq:minkowski_distance" align="center" raw="D(A,B) = \left( \sum_{i=0}^{N-1} \left| a_i - b_i \right|^p \right)^{\frac{1}{p}}" alt="Equation for the Minkowski distance."> --> | ||
|
|
||
| ```math | ||
| D(A,B) = \left( \sum_{i=0}^{N-1} \left| a_i - b_i \right|^p \right)^{\frac{1}{p}} | ||
| ``` | ||
|
|
||
| <!-- </equation> --> | ||
|
|
||
| where `a_i` and `b_i` are the _ith_ components of vectors **A** and **B**, respectively. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var dminkowski = require( '@stdlib/stats/strided/distances/dminkowski' ); | ||
| ``` | ||
|
|
||
| #### dminkowski( N, p, x, strideX, y, strideY ) | ||
|
|
||
| Computes the Minkowski 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 = dminkowski( x.length, 3, x, 1, y, 1 ); | ||
| // returns ~11.543 | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **p**: order of the Minkowski norm. | ||
| - **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 Minkowski 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 = dminkowski( 3, 3, x, 2, y, -1 ); | ||
| // returns ~4.16 | ||
| ``` | ||
|
|
||
| Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. | ||
|
|
||
| <!-- eslint-disable stdlib/capitalized-comments --> | ||
|
|
||
| ```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 = dminkowski( 3, 3, x1, 1, y1, 1 ); | ||
| // returns ~11.538 | ||
| ``` | ||
|
|
||
| #### dminkowski.ndarray( N, p, x, strideX, offsetX, y, strideY, offsetY ) | ||
|
|
||
| Computes the Minkowski 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 = dminkowski.ndarray( x.length, 3, x, 1, 0, y, 1, 0 ); | ||
| // returns ~11.543 | ||
| ``` | ||
|
|
||
| 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 Minkowski 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 = dminkowski.ndarray( 3, 3, x, 2, 1, y, -1, y.length-1 ); | ||
| // returns ~11.206 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0`, both functions return `NaN`. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var dminkowski = require( '@stdlib/stats/strided/distances/dminkowski' ); | ||
|
|
||
| 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 = dminkowski.ndarray( x.length, 3, x, 1, 0, y, -1, y.length-1 ); | ||
| console.log( out ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- C interface documentation. --> | ||
|
|
||
| * * * | ||
|
|
||
| <section class="c"> | ||
|
|
||
| ## C APIs | ||
|
|
||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- C usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ### Usage | ||
|
|
||
| ```c | ||
| #include "stdlib/stats/strided/distances/dminkowski.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dminkowski( N, p, \*X, strideX, \*Y, strideY ) | ||
|
|
||
| Computes the Minkowski 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_dminkowski( 5, 3, x, 1, y, 1 ); | ||
| // returns ~11.543 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **p**: `[in] double` order of the Minkowski norm. | ||
| - **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_dminkowski( const CBLAS_INT N, const double p, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); | ||
| ``` | ||
|
|
||
| <!--lint disable maximum-heading-length--> | ||
|
|
||
| #### stdlib_strided_dminkowski_ndarray( N, p, \*X, strideX, offsetX, \*Y, strideY, offsetY ) | ||
|
|
||
| <!--lint enable maximum-heading-length--> | ||
|
|
||
| Computes the Minkowski 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_dminkowski_ndarray( 5, 3, x, -1, 4, y, -1, 4 ); | ||
| // returns ~11.543 | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **p**: `[in] double` order of the Minkowski norm. | ||
| - **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_dminkowski_ndarray( const CBLAS_INT N, const double p, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- C API usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ### Examples | ||
|
|
||
| ```c | ||
| #include "stdlib/stats/strided/distances/dminkowski.h" | ||
| #include <stdio.h> | ||
|
|
||
| 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 the order of the Minkowski norm: | ||
| const double p = 3.0; | ||
|
|
||
| // Specify strides: | ||
| const int strideX = 1; | ||
| const int strideY = -1; | ||
|
|
||
| // Compute the Minkowski distance between `x` and `y`: | ||
| double d = stdlib_strided_dminkowski( N, p, x, strideX, y, strideY ); | ||
|
|
||
| // Print the result: | ||
| printf( "Minkowski distance: %lf\n", d ); | ||
|
|
||
| // Compute the Minkowski distance between `x` and `y` with offsets: | ||
| d = stdlib_strided_dminkowski_ndarray( N, p, x, strideX, 0, y, strideY, N-1 ); | ||
|
|
||
| // Print the result: | ||
| printf( "Minkowski distance: %lf\n", d ); | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
|
||
| <section class="related"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.related --> | ||
|
|
||
| <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="links"> | ||
|
|
||
| [@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-minkowski-distance]: https://en.wikipedia.org/wiki/Minkowski_distance | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.