All files ndarray.native.js

97.36% Statements 74/76
85.71% Branches 6/7
100% Functions 1/1
97.36% Lines 74/76

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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 772x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 21x 21x 11x 11x 21x     10x 21x 2x 2x 2x 2x 2x  
/**
* @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 resolveMetricStr = require( '@stdlib/ml/base/kmeans/metric-resolve-str' );
var resolveMetricEnum = require( '@stdlib/ml/base/kmeans/metric-resolve-enum' );
var format = require( '@stdlib/string/format' );
var addon = require( './../src/addon.node' );
 
 
// MAIN //
 
/**
* Compute inertia between double-precision floating-point centroids and data points using alternative indexing semantics.
*
* @param {PositiveInteger} M - number of samples.
* @param {PositiveInteger} N - number of features.
* @param {NonNegativeInteger} k - number of centroids
* @param {Function} metric - distance function.
* @param {Float64Array} X - input strided matrix.
* @param {integer} sx1 - stride length of first dimension of X.
* @param {integer} sx2 - stride length of second dimension of X.
* @param {integer} ox - starting index of X.
* @param {Float64Array} C - strided array centroid locations.
* @param {integer} sc1 - stride length of first dimension of c.
* @param {integer} sc2 - stride length of second dimension of c.
* @param {integer} oc - initial index of centroids.
* @param {Int32Array} labels - labels array containing cluster index of each data point.
* @param {integer} sl - stride length of labels.
* @param {integer} ol - initial index of labels.
* @throws {TypeError} fourth argument must be a supported distance metric
* @returns {number} inertia.
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var Int32Array = require( '@stdlib/array/int32' );
*
* var X = new Float64Array( [ 1.0, 1.0, 5.0, 5.0, 1.5, 1.5 ] );
* var C = new Float64Array( [ 1.0, 1.0, 5.0, 5.0 ] );
* var labels = new Int32Array( [ 0, 1, 0 ] );
*
* var inertia = dcomputeInertia( 3, 2, 2, 'sqeuclidean', X, 2, 1, 0, C, 2, 1, 0, labels, 1, 0 );
* // returns 0.5
*/
function dcomputeInertia( M, N, k, metric, X, sx1, sx2, ox, C, sc1, sc2, oc, labels, sl, ol ) { // eslint-disable-line max-len, max-params
	if ( resolveMetricStr( metric ) === null ) {
		throw new TypeError( format( 'invalid argument. Fourth argument must be a supported distance metric. Value: `%s`.', metric ) );
	}
	if ( M < 1 || N < 1 || k < 1 ) {
		return NaN;
	}
	return addon.ndarray( M, N, k, resolveMetricEnum( metric ), X, sx1, sx2, ox, C, sc1, sc2, oc, labels, sl, ol ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dcomputeInertia;