All files dkmeans_compute_inertia.native.js

97.95% Statements 96/98
93.75% Branches 15/16
100% Functions 1/1
97.95% Lines 96/98

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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 992x 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 2x 2x 2x 38x 38x 38x 38x 38x 13x 13x 38x 20x 20x 38x 5x 5x 5x 38x 11x 11x 38x 4x 4x 38x 4x 4x 38x     6x 38x 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 isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var resolveMetricStr = require( '@stdlib/ml/base/kmeans/metric-resolve-str' );
var resolveMetricEnum = require( '@stdlib/ml/base/kmeans/metric-resolve-enum' );
var resolveOrder = require( '@stdlib/blas/base/layout-resolve-enum' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var addon = require( './../src/addon.node' );
 
 
// MAIN //
 
/**
* Compute inertia between double-precision floating-point centroids and data points.
*
* @param {string} order - storage layout
* @param {NonNegativeInteger} M - number of data points
* @param {NonNegativeInteger} N - number of features
* @param {NonNegativeInteger} k - number of centroids
* @param {string} metric - distance metric
* @param {Float64Array} X - input data matrix
* @param {integer} LDX - stride of the first dimension of `X` (a.k.a., leading dimension of the matrix `X`)
* @param {Float64Array} C - centroid matrix
* @param {integer} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
* @param {Int32Array} labels - labels array containing cluster index of each data point.
* @param {integer} sl - stride length of labels.
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} fifth argument must be a supported distance metric
* @throws {RangeError} seventh argument must be greater than or equal to max(1,N) (row-major) or max(1,M) (column-major)
* @throws {RangeError} ninth argument must be greater than or equal to max(1,N) (row-major) or max(1,k) (column-major)
* @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( 'row-major', 3, 2, 2, 'sqeuclidean', X, 2, C, 2, labels, 1 );
* // returns 0.5
*/
function dcomputeInertia( order, M, N, k, metric, X, LDX, C, LDC, labels, sl ) { // eslint-disable-line max-params
	var sx;
	var sc;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isRowMajor( order ) ) {
		sx = N;
		sc = N;
	} else {
		sx = M;
		sc = k;
	}
	if ( resolveMetricStr( metric ) === null ) {
		throw new TypeError( format( 'invalid argument. Fifth argument must be a supported distance metric. Value: `%s`.', metric ) );
	}
	if ( LDX < max( 1, sx ) ) {
		throw new RangeError( format( 'invalid argument. Seventh argument must be greater than or equal to max(1,%d). Value: `%d`.', sx, LDX ) );
	}
	if ( LDC < max( 1, sc ) ) {
		throw new RangeError( format( 'invalid argument. Ninth argument must be greater than or equal to max(1,%d). Value: `%d`.', sc, LDC ) );
	}
	if ( M < 1 || N < 1 || k < 1 ) {
		return NaN;
	}
	return addon( resolveOrder( order ), M, N, k, resolveMetricEnum( metric ), X, LDX, C, LDC, labels, sl ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dcomputeInertia;