All files main.js

100% Statements 60/60
100% Branches 4/4
100% Functions 1/1
100% Lines 60/60

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 611x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 7x 7x 7x 7x 1x 1x 1x 1x 1x  
/**
* @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 isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var objectInverse = require( '@stdlib/object/inverse' );
var enumeration = require( '@stdlib/ml/base/kmeans/metrics' ).enum;
 
 
// VARIABLES //
 
var hash = objectInverse( enumeration(), {
	'duplicates': false
});
 
 
// MAIN //
 
/**
* Returns the k-means distance metric string associated with a k-means distance metric enumeration constant.
*
* @param {integer} value - distance metric enumeration constant
* @returns {(string|null)} distance metric string or null
*
* @example
* var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
*
* var v = str2enum( 'squared-euclidean' );
* // returns <number>
*
* var s = enum2str( v );
* // returns 'squared-euclidean'
*/
function enum2str( value ) {
	var v = hash[ value ];
	return ( isString( v ) ) ? v : null; // note: we include this guard to prevent walking the prototype chain
}
 
 
// EXPORTS //
 
module.exports = enum2str;