From 0d31580780d1853a1ec22f15ecc5cfb3da52362e Mon Sep 17 00:00:00 2001 From: nakul-krishnakumar Date: Thu, 28 May 2026 01:10:57 +0530 Subject: [PATCH] feat: add `ml/base/kmeans/metric-resolve-str` --- .../base/kmeans/metric-resolve-str/README.md | 121 ++++++++++++++++++ .../metric-resolve-str/benchmark/benchmark.js | 85 ++++++++++++ .../kmeans/metric-resolve-str/docs/repl.txt | 25 ++++ .../metric-resolve-str/docs/types/index.d.ts | 38 ++++++ .../metric-resolve-str/docs/types/test.ts | 28 ++++ .../metric-resolve-str/examples/index.js | 30 +++++ .../kmeans/metric-resolve-str/lib/index.js | 41 ++++++ .../kmeans/metric-resolve-str/lib/main.js | 55 ++++++++ .../kmeans/metric-resolve-str/package.json | 65 ++++++++++ .../kmeans/metric-resolve-str/test/test.js | 76 +++++++++++ 10 files changed, 564 insertions(+) create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/README.md create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/examples/index.js create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/index.js create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/main.js create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/package.json create mode 100644 lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/test/test.js diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/README.md b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/README.md new file mode 100644 index 000000000000..9884888cc772 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/README.md @@ -0,0 +1,121 @@ + + +# resolve + +> Return the distance metric string associated with a supported k-means distance metric value. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var resolve = require( '@stdlib/ml/base/kmeans/metric-resolve-str' ); +``` + +#### resolve( value ) + +Returns the distance metric string associated with a supported k-means distance metric value. + +```javascript +var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); + +var v = resolve( 'cosine' ); +// returns 'cosine' + +v = resolve( str2enum( 'cosine' ) ); +// returns 'cosine' +``` + +If unable to resolve a k-means distance metric string, the function returns `null`. + +```javascript +var v = resolve( 'beep' ); +// returns null +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```javascript +var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +var resolve = require( '@stdlib/ml/base/kmeans/metric-resolve-str' ); + +var v = resolve( str2enum( 'cosine' ) ); +// returns 'cosine' + +v = resolve( str2enum( 'sqeuclidean' ) ); +// returns 'sqeuclidean' +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/benchmark/benchmark.js b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/benchmark/benchmark.js new file mode 100644 index 000000000000..7010c972692f --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/benchmark/benchmark.js @@ -0,0 +1,85 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var resolve = require( './../lib' ); + + +// MAIN // + +bench( format( '%s::string', pkg ), function benchmark( b ) { + var values; + var out; + var i; + + values = [ + 'sqeuclidean', + 'cosine', + 'correlation', + 'cityblock' + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = resolve( values[ i%values.length ] ); + if ( typeof out !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( !isString( out ) ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( format( '%s::integer', pkg ), function benchmark( b ) { + var values; + var out; + var i; + + values = [ + str2enum( 'sqeuclidean' ), + str2enum( 'cosine' ), + str2enum( 'correlation' ), + str2enum( 'cityblock' ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = resolve( values[ i%values.length ] ); + if ( typeof out !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( !isString( out ) ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/repl.txt b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/repl.txt new file mode 100644 index 000000000000..6f08b9bd2939 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/repl.txt @@ -0,0 +1,25 @@ + +{{alias}}( value ) + Returns the distance metric string associated with a supported k-means + distance metric value. + + Parameters + ---------- + value: any + Distance metric value. + + Returns + ------- + out: string|null + Distance metric string. + + Examples + -------- + > var out = {{alias}}( 'cosine' ) + 'cosine' + > out = {{alias}}( {{alias:@stdlib/ml/base/kmeans/metric-str2enum}}( 'cosine' ) ) + 'cosine' + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/index.d.ts b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/index.d.ts new file mode 100644 index 000000000000..00bfbdedba09 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/index.d.ts @@ -0,0 +1,38 @@ +/* +* @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 + +/** +* Returns the distance metric string associated with a supported k-means distance metric value. +* +* @param value - distance metric value +* @returns distance metric string or null +* +* @example +* var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +* +* var v = resolve( str2enum( 'cosine' ) ); +* // returns 'cosine' +*/ +declare function resolve( value: any ): string | null; + + +// EXPORTS // + +export = resolve; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/test.ts b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/test.ts new file mode 100644 index 000000000000..ca11e2f0806b --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/docs/types/test.ts @@ -0,0 +1,28 @@ +/* +* @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 resolve = require( './index' ); + + +// TESTS // + +// The function returns a string or null... +{ + resolve( 0 ); // $ExpectType string | null + resolve( 'cosine' ); // $ExpectType string | null +} diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/examples/index.js b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/examples/index.js new file mode 100644 index 000000000000..a600926821ee --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/examples/index.js @@ -0,0 +1,30 @@ +/** +* @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 str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +var resolve = require( './../lib' ); + +var v = resolve( str2enum( 'cosine' ) ); +console.log( v ); +// => 'cosine' + +v = resolve( str2enum( 'sqeuclidean' ) ); +console.log( v ); +// => 'sqeuclidean' diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/index.js b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/index.js new file mode 100644 index 000000000000..82a08d2fa47b --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/index.js @@ -0,0 +1,41 @@ +/** +* @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'; + +/** +* Return the distance metric string associated with a supported k-means distance metric value. +* +* @module @stdlib/ml/base/kmeans/metric-resolve-str +* +* @example +* var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +* var resolve = require( '@stdlib/ml/base/kmeans/metric-resolve-str' ); +* +* var v = resolve( str2enum( 'cosine' ) ); +* // returns 'cosine' +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/main.js b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/main.js new file mode 100644 index 000000000000..ae65166a9573 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/lib/main.js @@ -0,0 +1,55 @@ +/** +* @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 enum2str = require( '@stdlib/ml/base/kmeans/metric-enum2str' ); +var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); + + +// MAIN // + +/** +* Returns the distance metric string associated with a supported k-means distance metric value. +* +* @param {*} value - distance metric value +* @returns {(string|null)} distance metric string or null +* +* @example +* var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +* +* var v = resolve( str2enum( 'cosine' ) ); +* // returns 'cosine' +*/ +function resolve( value ) { + var t = ( typeof value ); + if ( t === 'string' ) { + return ( str2enum( value ) === null ) ? null : value; + } + if ( t === 'number' ) { + return enum2str( value ); + } + return null; +} + + +// EXPORTS // + +module.exports = resolve; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/package.json b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/package.json new file mode 100644 index 000000000000..5fe628e11775 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/ml/base/kmeans/metric-resolve-str", + "version": "0.0.0", + "description": "Return the distance metric string associated with a supported k-means distance metric value.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "ml", + "machine", + "learning", + "kmeans", + "metric", + "utilities", + "utility", + "utils", + "util", + "enum" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/test/test.js b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/test/test.js new file mode 100644 index 000000000000..eae463ded814 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/test/test.js @@ -0,0 +1,76 @@ +/** +* @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 str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' ); +var resolve = require( './../lib' ); + + +// VARIABLES // + +var VALUES = [ + 'sqeuclidean', + 'cosine', + 'correlation', + 'cityblock' +]; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof resolve, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the string associated with a k-means distance metric value', function test( t ) { + var v; + var i; + for ( i = 0; i < VALUES.length; i++ ) { + v = str2enum( VALUES[ i ] ); + t.strictEqual( resolve( VALUES[ i ] ), VALUES[ i ], 'returns expected value' ); + t.strictEqual( resolve( v ), VALUES[ i ], 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns `null` if unable to resolve a string', function test( t ) { + var values; + var i; + + values = [ + 'beep', + 'boop', + 'foo', + 'bar', + -99999999, + -9999999999, + -9999999999999, + true, + false + ]; + for ( i = 0; i < values.length; i++ ) { + t.strictEqual( resolve( values[ i ] ), null, 'returns expected value' ); + } + t.end(); +});