All files main.js

100% Statements 104/104
100% Branches 2/2
100% Functions 1/1
100% Lines 104/104

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 99 100 101 102 103 104 1051x 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 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 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 struct = require( '@stdlib/dstructs/struct' );
 
 
// MAIN //
 
/**
* Returns a new struct constructor tailored to a specified floating-point data type.
*
* @param {string} dtype - floating-point data type
* @returns {Function} struct constructor
*
* @example
* var Struct = factory( 'float64' );
* // returns <Function>
*
* var s = new Struct();
* // returns <Struct>
*/
function factory( dtype ) {
	var schema = [
		{
			'name': 'replicates',
			'description': 'number of times the data was clustered with different initial centroids',
			'type': 'int64',
			'castingMode': 'safe'
		},
		{
			'name': 'replicate',
			'description': 'index of the initial centroids which produced the best result',
			'type': 'int64',
			'castingMode': 'safe'
		},
		{
			'name': 'metric',
			'description': 'distance metric',
			'type': 'int8',
			'castingMode': 'none'
		},
		{
			'name': 'iterations',
			'description': 'number of iterations for best results',
			'type': 'int64',
			'castingMode': 'safe'
		},
		{
			'name': 'algorithm',
			'description': 'clustering algorithm',
			'type': 'int8',
			'castingMode': 'none'
		},
		{
			'name': 'inertia',
			'description': 'sum of squared distances to the closest centroid for all samples',
			'type': dtype,
			'castingMode': 'mostly-safe'
		},
		{
			'name': 'k',
			'description': 'number of clusters',
			'type': 'int64',
			'castingMode': 'safe'
		},
		{
			'name': 'samples',
			'description': 'number of samples',
			'type': 'int64',
			'castingMode': 'safe'
		},
		{
			'name': 'features',
			'description': 'number of features',
			'type': 'int64',
			'castingMode': 'safe'
		}
	];
	return struct( schema );
}
 
 
// EXPORTS //
 
module.exports = factory;