diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/README.md b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/README.md new file mode 100644 index 000000000000..4c863e5ee06d --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/README.md @@ -0,0 +1,124 @@ + + +# resolve + +> Return the enumeration constant associated with a supported k-means clustering algorithm value. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var resolve = require( '@stdlib/ml/base/kmeans/algorithm-resolve-enum' ); +``` + +#### resolve( value ) + +Returns the enumeration constant associated with a supported k-means clustering algorithm value. + +```javascript +var str2enum = require( '@stdlib/ml/base/kmeans/algorithm-str2enum' ); + +var v = resolve( 'lloyd' ); +// returns + +v = resolve( str2enum( 'elkan' ) ); +// returns +``` + +If unable to resolve an enumeration constant, the function returns `null`. + +```javascript +var v = resolve( 'beep' ); +// returns null +``` + +
+ + + + + +
+ +## Notes + +- Downstream consumers of this function should **not** rely on specific integer values (e.g., `LLOYD == 0`). Instead, the function should be used in an opaque manner. + +
+ + + + + +
+ +## Examples + + + +```javascript +var resolve = require( '@stdlib/ml/base/kmeans/algorithm-resolve-enum' ); + +var v = resolve( 'lloyd' ); +// returns + +v = resolve( 'elkan' ); +// returns +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/benchmark/benchmark.js b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/benchmark/benchmark.js new file mode 100644 index 000000000000..ba13c8459087 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/benchmark/benchmark.js @@ -0,0 +1,81 @@ +/** +* @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 isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive; +var str2enum = require( '@stdlib/ml/base/kmeans/algorithm-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 = [ + 'lloyd', + 'elkan' + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = resolve( values[ i%values.length ] ); + if ( typeof out !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( !isInteger( out ) ) { + b.fail( 'should return an integer' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( format( '%s::integer', pkg ), function benchmark( b ) { + var values; + var out; + var i; + + values = [ + str2enum( 'lloyd' ), + str2enum( 'elkan' ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = resolve( values[ i%values.length ] ); + if ( typeof out !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( !isInteger( out ) ) { + b.fail( 'should return an integer' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/repl.txt b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/repl.txt new file mode 100644 index 000000000000..04aea6c623d6 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/repl.txt @@ -0,0 +1,29 @@ + +{{alias}}( value ) + Returns the enumeration constant associated with a supported k-means + clustering algorithm value. + + Downstream consumers of this function should *not* rely on specific integer + values (e.g., `LLOYD == 0`). Instead, the function should be used in an + opaque manner. + + Parameters + ---------- + value: any + Clustering algorithm value. + + Returns + ------- + out: integer|null + Enumeration constant. + + Examples + -------- + > var out = {{alias}}( 'lloyd' ) + + > out = {{alias}}( {{alias:@stdlib/ml/base/kmeans/algorithm-str2enum}}( 'lloyd' ) ) + + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/types/index.d.ts b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/types/index.d.ts new file mode 100644 index 000000000000..391ffb5d24b5 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/types/index.d.ts @@ -0,0 +1,40 @@ +/* +* @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 enumeration constant associated with a supported k-means clustering algorithm value. +* +* ## Notes +* +* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `LLOYD == 0`). Instead, the function should be used in an opaque manner. +* +* @param value - clustering algorithm value +* @returns enumeration constant +* +* @example +* var v = resolve( 'lloyd' ); +* // returns +*/ +declare function resolve( value: any ): number | null; + + +// EXPORTS // + +export = resolve; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/types/test.ts b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/docs/types/test.ts new file mode 100644 index 000000000000..70a9aa2ce477 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/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 number or null... +{ + resolve( 0 ); // $ExpectType number | null + resolve( 'lloyd' ); // $ExpectType number | null +} diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/examples/index.js b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/examples/index.js new file mode 100644 index 000000000000..95b5dedd82bb --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/examples/index.js @@ -0,0 +1,29 @@ +/** +* @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 resolve = require( './../lib' ); + +var v = resolve( 'lloyd' ); +console.log( v ); +// => + +v = resolve( 'elkan' ); +console.log( v ); +// => diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/lib/index.js b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/lib/index.js new file mode 100644 index 000000000000..17d9703d2c4d --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/lib/index.js @@ -0,0 +1,40 @@ +/** +* @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 enumeration constant associated with a supported k-means clustering algorithm value. +* +* @module @stdlib/ml/base/kmeans/algorithm-resolve-enum +* +* @example +* var resolve = require( '@stdlib/ml/base/kmeans/algorithm-resolve-enum' ); +* +* var v = resolve( 'lloyd' ); +* // returns +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/lib/main.js b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/lib/main.js new file mode 100644 index 000000000000..91b32d9a3312 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/lib/main.js @@ -0,0 +1,57 @@ +/** +* @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/algorithm-enum2str' ); +var str2enum = require( '@stdlib/ml/base/kmeans/algorithm-str2enum' ); + + +// MAIN // + +/** +* Returns the enumeration constant associated with a supported k-means clustering algorithm value. +* +* ## Notes +* +* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `LLOYD == 0`). Instead, the function should be used in an opaque manner. +* +* @param {*} value - clustering algorithm value +* @returns {(integer|null)} enumeration constant or null +* +* @example +* var v = resolve( 'lloyd' ); +* // returns +*/ +function resolve( value ) { + var t = ( typeof value ); + if ( t === 'number' ) { + return ( enum2str( value ) ) ? value : null; + } + if ( t === 'string' ) { + return str2enum( value ); + } + return null; +} + + +// EXPORTS // + +module.exports = resolve; diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/package.json b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/package.json new file mode 100644 index 000000000000..394ebee848f5 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/ml/base/kmeans/algorithm-resolve-enum", + "version": "0.0.0", + "description": "Return the enumeration constant associated with a supported k-means clustering algorithm 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", + "algorithm", + "utilities", + "utility", + "utils", + "util", + "enum" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/test/test.js b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/test/test.js new file mode 100644 index 000000000000..ecece1d33b19 --- /dev/null +++ b/lib/node_modules/@stdlib/ml/base/kmeans/algorithm-resolve-enum/test/test.js @@ -0,0 +1,74 @@ +/** +* @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/algorithm-str2enum' ); +var resolve = require( './../lib' ); + + +// VARIABLES // + +var VALUES = [ + 'lloyd', + 'elkan' +]; + + +// 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 enumeration constant associated with a k-means clustering algorithm value', function test( t ) { + var v; + var i; + for ( i = 0; i < VALUES.length; i++ ) { + v = str2enum( VALUES[ i ] ); + t.strictEqual( resolve( VALUES[ i ] ), v, 'returns expected value' ); + t.strictEqual( resolve( v ), v, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns `null` if unable to resolve an enumeration constant', 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(); +});