refactor: rename sqeuclidean to squared-euclidean

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/README.md

@@ -47,11 +47,11 @@ Returns the k-means distance metric string associated with a k-means distance me
 ```javascript
 var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 
-var v = str2enum( 'sqeuclidean' );
+var v = str2enum( 'squared-euclidean' );
 // returns <number>
 
 var s = enum2str( v );
-// returns 'sqeuclidean'
+// returns 'squared-euclidean'
 ```
 
 If unable to resolve a k-means distance metric string, the function returns `null`.
@@ -85,8 +85,8 @@ var v = enum2str( -999999999 );
 var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 var enum2str = require( '@stdlib/ml/base/kmeans/metric-enum2str' );
 
-var str = enum2str( str2enum( 'sqeuclidean' ) );
-// returns 'sqeuclidean'
+var str = enum2str( str2enum( 'squared-euclidean' ) );
+// returns 'squared-euclidean'
 
 str = enum2str( str2enum( 'cosine' ) );
 // returns 'cosine'

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/benchmark/benchmark.js

@@ -35,7 +35,7 @@ bench( pkg, function benchmark( b ) {
 	var i;
 
 	values = [
-		str2enum( 'sqeuclidean' ),
+		str2enum( 'squared-euclidean' ),
 		str2enum( 'cosine' ),
 		str2enum( 'cityblock' ),
 		str2enum( 'correlation' )

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/docs/repl.txt

@@ -15,8 +15,9 @@
 
     Examples
     --------
-    > var out = {{alias}}( {{alias:@stdlib/ml/base/kmeans/metric-str2enum}}( 'sqeuclidean' ) )
-    'sqeuclidean'
+    > var out = {{alias}}( {{alias:@stdlib/ml/base/kmeans/metric-str2enum}}(
+    ...	'squared-euclidean' ) )
+    'squared-euclidean'
 
     See Also
     --------

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/docs/types/index.d.ts

@@ -27,11 +27,11 @@
 * @example
 * var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 *
-* var v = str2enum( 'sqeuclidean' );
+* var v = str2enum( 'squared-euclidean' );
 * // returns <number>
 *
 * var s = enum2str( v );
-* // returns 'sqeuclidean'
+* // returns 'squared-euclidean'
 */
 declare function enum2str( value: number ): string | null;
 

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/examples/index.js

@@ -25,6 +25,6 @@ var str = enum2str( str2enum( 'cosine' ) );
 console.log( str );
 // => 'cosine'
 
-str = enum2str( str2enum( 'sqeuclidean' ) );
+str = enum2str( str2enum( 'squared-euclidean' ) );
 console.log( str );
-// => 'sqeuclidean'
+// => 'squared-euclidean'

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/lib/index.js

@@ -27,11 +27,11 @@
 * var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 * var enum2str = require( '@stdlib/ml/base/kmeans/metric-enum2str' );
 *
-* var v = str2enum( 'sqeuclidean' );
+* var v = str2enum( 'squared-euclidean' );
 * // returns <number>
 *
 * var s = enum2str( v );
-* // returns 'sqeuclidean'
+* // returns 'squared-euclidean'
 */
 
 // MODULES //

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/lib/main.js

@@ -43,11 +43,11 @@ var hash = objectInverse( enumeration(), {
 * @example
 * var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 *
-* var v = str2enum( 'sqeuclidean' );
+* var v = str2enum( 'squared-euclidean' );
 * // returns <number>
 *
 * var s = enum2str( v );
-* // returns 'sqeuclidean'
+* // returns 'squared-euclidean'
 */
 function enum2str( value ) {
 	var v = hash[ value ];

lib/node_modules/@stdlib/ml/base/kmeans/metric-enum2str/test/test.js

@@ -28,7 +28,7 @@ var enum2str = require( './../lib' );
 // VARIABLES //
 
 var VALUES = [
-	'sqeuclidean',
+	'squared-euclidean',
 	'cosine',
 	'cityblock',
 	'correlation'

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/README.md

@@ -47,7 +47,7 @@ Returns the enumeration constant associated with a supported k-means distance me
 ```javascript
 var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 
-var v = resolve( 'sqeuclidean' );
+var v = resolve( 'squared-euclidean' );
 // returns <number>
 
 v = resolve( str2enum( 'cosine' ) );
@@ -71,7 +71,7 @@ var v = resolve( 'beep' );
 
 ## Notes
 
--   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
+-   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
 
 </section>
 
@@ -88,7 +88,7 @@ var v = resolve( 'beep' );
 ```javascript
 var resolve = require( '@stdlib/ml/base/kmeans/metric-resolve-enum' );
 
-var v = resolve( 'sqeuclidean' );
+var v = resolve( 'squared-euclidean' );
 // returns <number>
 
 v = resolve( 'cosine' );

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/benchmark/benchmark.js

@@ -36,7 +36,7 @@ bench( format( '%s::string', pkg ), function benchmark( b ) {
 	var i;
 
 	values = [
-		'sqeuclidean',
+		'squared-euclidean',
 		'cosine',
 		'correlation',
 		'cityblock'
@@ -63,7 +63,7 @@ bench( format( '%s::integer', pkg ), function benchmark( b ) {
 	var i;
 
 	values = [
-		str2enum( 'sqeuclidean' ),
+		str2enum( 'squared-euclidean' ),
 		str2enum( 'cosine' ),
 		str2enum( 'correlation' ),
 		str2enum( 'cityblock' )

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/docs/repl.txt

@@ -4,8 +4,8 @@
     distance metric value.
 
     Downstream consumers of this function should *not* rely on specific integer
-    values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in
-    an opaque manner.
+    values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be
+    used in an opaque manner.
 
     Parameters
     ----------
@@ -19,9 +19,10 @@
 
     Examples
     --------
-    > var out = {{alias}}( 'sqeuclidean' )
+    > var out = {{alias}}( 'squared-euclidean' )
     <number>
-    > out = {{alias}}( {{alias:@stdlib/ml/base/kmeans/metric-str2enum}}( 'sqeuclidean' ) )
+    > out = {{alias}}( {{alias:@stdlib/ml/base/kmeans/metric-str2enum}}(
+    ...	'squared-euclidean' ) )
     <number>
 
     See Also

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/docs/types/index.d.ts

@@ -23,16 +23,16 @@
 *
 * ## Notes
 *
-* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
+* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
 *
 * @param value - distance metric value
 * @returns enumeration constant
 *
 * @example
-* var v = resolve( 'sqeuclidean' );
+* var v = resolve( 'squared-euclidean' );
 * // returns <number>
 */
 declare function resolve( value: any ): number | null;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/docs/types/test.ts

@@ -24,5 +24,5 @@ import resolve = require( './index' );
 // The function returns a number or null...
 {
 	resolve( 0 ); // $ExpectType number | null
-	resolve( 'sqeuclidean' ); // $ExpectType number | null
+	resolve( 'squared-euclidean' ); // $ExpectType number | null
 }

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/examples/index.js

@@ -20,7 +20,7 @@
 
 var resolve = require( './../lib' );
 
-var v = resolve( 'sqeuclidean' );
+var v = resolve( 'squared-euclidean' );
 console.log( v );
 // => <number>
 

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/lib/index.js

@@ -26,7 +26,7 @@
 * @example
 * var resolve = require( '@stdlib/ml/base/kmeans/metric-resolve-enum' );
 *
-* var v = resolve( 'sqeuclidean' );
+* var v = resolve( 'squared-euclidean' );
 * // returns <number>
 */
 

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/lib/main.js

@@ -31,13 +31,13 @@ var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 *
 * ## Notes
 *
-* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
+* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
 *
 * @param {*} value - distance metric value
 * @returns {(integer|null)} enumeration constant or null
 *
 * @example
-* var v = resolve( 'sqeuclidean' );
+* var v = resolve( 'squared-euclidean' );
 * // returns <number>
 */
 function resolve( value ) {

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-enum/test/test.js

@@ -28,7 +28,7 @@ var resolve = require( './../lib' );
 // VARIABLES //
 
 var VALUES = [
-	'sqeuclidean',
+	'squared-euclidean',
 	'cosine',
 	'correlation',
 	'cityblock'

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/README.md

@@ -88,8 +88,8 @@ var resolve = require( '@stdlib/ml/base/kmeans/metric-resolve-str' );
 var v = resolve( str2enum( 'cosine' ) );
 // returns 'cosine'
 
-v = resolve( str2enum( 'sqeuclidean' ) );
-// returns 'sqeuclidean'
+v = resolve( str2enum( 'squared-euclidean' ) );
+// returns 'squared-euclidean'
 ```
 
 </section>

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/benchmark/benchmark.js

@@ -36,7 +36,7 @@ bench( format( '%s::string', pkg ), function benchmark( b ) {
 	var i;
 
 	values = [
-		'sqeuclidean',
+		'squared-euclidean',
 		'cosine',
 		'correlation',
 		'cityblock'
@@ -63,7 +63,7 @@ bench( format( '%s::integer', pkg ), function benchmark( b ) {
 	var i;
 
 	values = [
-		str2enum( 'sqeuclidean' ),
+		str2enum( 'squared-euclidean' ),
 		str2enum( 'cosine' ),
 		str2enum( 'correlation' ),
 		str2enum( 'cityblock' )

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/examples/index.js

@@ -25,6 +25,6 @@ var v = resolve( str2enum( 'cosine' ) );
 console.log( v );
 // => 'cosine'
 
-v = resolve( str2enum( 'sqeuclidean' ) );
+v = resolve( str2enum( 'squared-euclidean' ) );
 console.log( v );
-// => 'sqeuclidean'
+// => 'squared-euclidean'

lib/node_modules/@stdlib/ml/base/kmeans/metric-resolve-str/test/test.js

@@ -28,7 +28,7 @@ var resolve = require( './../lib' );
 // VARIABLES //
 
 var VALUES = [
-	'sqeuclidean',
+	'squared-euclidean',
 	'cosine',
 	'correlation',
 	'cityblock'

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/README.md

@@ -66,7 +66,7 @@ var v = str2enum( 'beep' );
 
 ## Notes
 
--   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
+-   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
 
 </section>
 
@@ -86,7 +86,7 @@ var str2enum = require( '@stdlib/ml/base/kmeans/metric-str2enum' );
 var v = str2enum( 'cosine' );
 // returns <number>
 
-v = str2enum( 'sqeuclidean' );
+v = str2enum( 'squared-euclidean' );
 // returns <number>
 ```
 

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/benchmark/benchmark.js

@@ -34,7 +34,7 @@ bench( pkg, function benchmark( b ) {
 	var i;
 
 	values = [
-		'sqeuclidean',
+		'squared-euclidean',
 		'cosine',
 		'cityblock',
 		'correlation'

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/docs/repl.txt

@@ -4,8 +4,8 @@
     string.
 
     Downstream consumers of this function should *not* rely on specific integer
-    values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in
-    an opaque manner.
+    values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be
+    used in an opaque manner.
 
     Parameters
     ----------

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/docs/types/index.d.ts

@@ -23,7 +23,7 @@
 *
 * ## Notes
 *
-* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
+* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
 *
 * @param metric - distance metric string
 * @returns enumeration constant

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/examples/index.js

@@ -24,6 +24,6 @@ var v = str2enum( 'cosine' );
 console.log( v );
 // => <number>
 
-v = str2enum( 'sqeuclidean' );
+v = str2enum( 'squared-euclidean' );
 console.log( v );
 // => <number>

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/lib/main.js

@@ -36,7 +36,7 @@ var ENUM = enumeration();
 *
 * ## Notes
 *
-* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQEUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
+* -   Downstream consumers of this function should **not** rely on specific integer values (e.g., `SQUARED_EUCLIDEAN == 0`). Instead, the function should be used in an opaque manner.
 *
 * @param {string} metric - distance metric string
 * @returns {(integer|null)} integer value or null

lib/node_modules/@stdlib/ml/base/kmeans/metric-str2enum/test/test.js

@@ -29,7 +29,7 @@ var str2enum = require( './../lib' );
 
 var VALUES = [
 	'cosine',
-	'sqeuclidean',
+	'squared-euclidean',
 	'cityblock',
 	'correlation'
 ];