org.apache.ignite.ml.clustering.kmeans

Class KMeansModel

java.lang.Object

org.apache.ignite.ml.clustering.kmeans.KMeansModel

All Implemented Interfaces:

Serializable, Function<Vector,Integer>, ClusterizationModel<Vector,Integer>, Exportable<KMeansModelFormat>, IgniteFunction<Vector,Integer>, Model<Vector,Integer>

public class KMeansModel
extends Object
implements ClusterizationModel<Vector,Integer>, Exportable<KMeansModelFormat>

This class encapsulates result of clusterization by KMeans algorithm.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KMeansModel(Vector[] centers, DistanceMeasure distanceMeasure) Construct KMeans model with given centers and distanceMeasure measure.

Method Summary

Modifier and Type	Method and Description
Integer	apply(Vector vec) Predict closest center index for a given vector.
DistanceMeasure	distanceMeasure() Distance measure.
boolean	equals(Object obj)
int	getAmountOfClusters() Amount of centers in clusterization.
Vector[]	getCenters() Get centers of clusters.
int	hashCode()
<P> void	saveModel(Exporter<KMeansModelFormat,P> exporter, P path) Save model by the given path.
String	toString()
String	toString(boolean pretty)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.ignite.ml.Model

combine

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

KMeansModel

public KMeansModel(Vector[] centers,
                   DistanceMeasure distanceMeasure)

Construct KMeans model with given centers and distanceMeasure measure.

Parameters:

centers - Centers.

distanceMeasure - Distance measure.

Method Detail

distanceMeasure

public DistanceMeasure distanceMeasure()

Distance measure.

getAmountOfClusters

public int getAmountOfClusters()

Amount of centers in clusterization.

Specified by:

getAmountOfClusters in interface ClusterizationModel<Vector,Integer>

getCenters

public Vector[] getCenters()

Get centers of clusters.

Specified by:

getCenters in interface ClusterizationModel<Vector,Integer>

apply

public Integer apply(Vector vec)

Predict closest center index for a given vector.

Specified by:

apply in interface Function<Vector,Integer>

Parameters:

vec - Vector.

saveModel

public <P> void saveModel(Exporter<KMeansModelFormat,P> exporter,
                          P path)

Save model by the given path.

Specified by:

saveModel in interface Exportable<KMeansModelFormat>

Parameters:

exporter - Exporter.

path - Path to saved model.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean pretty)

Specified by:

toString in interface Model<Vector,Integer>

Parameters:

pretty - Use pretty mode.