de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans

Class KMeansLloyd<V extends NumberVector>

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<R>

de.lmu.ifi.dbs.elki.algorithm.AbstractNumberVectorDistanceBasedAlgorithm<V,Clustering<M>>

de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.AbstractKMeans<V,KMeansModel>

de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.KMeansLloyd<V>

Type Parameters:

V - vector datatype

All Implemented Interfaces:

Algorithm, ClusteringAlgorithm<Clustering<KMeansModel>>, KMeans<V,KMeansModel>, DistanceBasedAlgorithm<V>

@Title(value="k-Means (Lloyd/Forgy Algorithm)")
 @Reference(authors="S. Lloyd",title="Least squares quantization in PCM",booktitle="IEEE Transactions on Information Theory 28 (2): 129\u2013137.",url="https://doi.org/10.1109/TIT.1982.1056489",bibkey="DBLP:journals/tit/Lloyd82") @Reference(authors="E. W. Forgy",title="Cluster analysis of multivariate data: efficiency versus interpretability of classifications",booktitle="Biometrics 21(3)",bibkey="journals/biometrics/Forgy65")
 @Alias(value={"lloyd","forgy","de.lmu.ifi.dbs.elki.algorithm.clustering.KMeans","de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.KMeans"})
public class KMeansLloyd<V extends NumberVector>
extends AbstractKMeans<V,KMeansModel>

The standard k-means algorithm, using bulk iterations and commonly attributed to Lloyd and Forgy (independently).

Reference:

S. Lloyd
Least squares quantization in PCM
IEEE Transactions on Information Theory 28 (2)
previously published as Bell Telephone Laboratories Paper

E. W. Forgy
Cluster analysis of multivariate data: efficiency versus interpretability of classifications
Abstract published in Biometrics 21(3)

Since:

0.5.0

Author:

Arthur Zimek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	KMeansLloyd.Instance Inner instance, storing state for a single data set.
static class	KMeansLloyd.Parameterizer<V extends NumberVector> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	LOG The logger for this class.

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.AbstractKMeans

initializer, k, maxiter

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractNumberVectorDistanceBasedAlgorithm

distanceFunction

Fields inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

ALGORITHM_ID

Fields inherited from interface de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.KMeans

INIT_ID, K_ID, MAXITER_ID, SEED_ID, VARSTAT_ID

Fields inherited from interface de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm

DISTANCE_FUNCTION_ID

Constructor Summary

Constructors

Constructor and Description
KMeansLloyd(NumberVectorDistanceFunction<? super V> distanceFunction, int k, int maxiter, KMeansInitialization initializer) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Logging	getLogger() Get the (STATIC) logger for this class.
Clustering<KMeansModel>	run(Database database, Relation<V> relation) Run the clustering algorithm.

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.clustering.kmeans.AbstractKMeans

getInputTypeRestriction, incrementalUpdateMean, initialMeans, means, minusEquals, nearestMeans, plusEquals, plusMinusEquals, setDistanceFunction, setInitializer, setK

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractNumberVectorDistanceBasedAlgorithm

getDistanceFunction

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

run

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.algorithm.clustering.ClusteringAlgorithm

run

Methods inherited from interface de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm

getDistanceFunction

Field Detail

LOG

private static final Logging LOG

The logger for this class.

Constructor Detail

KMeansLloyd

public KMeansLloyd(NumberVectorDistanceFunction<? super V> distanceFunction,
                   int k,
                   int maxiter,
                   KMeansInitialization initializer)

Constructor.

Parameters:

distanceFunction - distance function

k - k parameter

maxiter - Maxiter parameter

initializer - Initialization method

Method Detail

run

public Clustering<KMeansModel> run(Database database,
                                   Relation<V> relation)

Description copied from interface: KMeans

Run the clustering algorithm.

Parameters:

database - Database to run on.

relation - Relation to process.

Returns:

Clustering result

getLogger

protected Logging getLogger()

Description copied from class: AbstractAlgorithm

Get the (STATIC) logger for this class.

Specified by:

getLogger in class AbstractAlgorithm<Clustering<KMeansModel>>

Returns:

the static logger