Class KMeansClusterer

Inheritance Relationships

public cpphots::interfaces::Clonable< KMeansClusterer, interfaces::Clusterer > (Template Struct Clonable)
public cpphots::ClustererHistogramMixin (Class ClustererHistogramMixin)
public cpphots::ClustererOfflineMixin (Class ClustererOfflineMixin)

class cpphots::KMeansClusterer : public cpphots::interfaces::Clonable<KMeansClusterer, interfaces::Clusterer>, public cpphots::ClustererHistogramMixin, public cpphots::ClustererOfflineMixin 

Public Functions

virtual uint16_t cluster(const TimeSurfaceType &surface) override

Performs clustering.

In case of online clustering algorithms, also updates the clusters, if learning is enabled.

virtual uint16_t getNumClusters() const override

Get the number of clusters.

virtual void addCentroid(const TimeSurfaceType &centroid) override

Add a new centroid to the clusterer.

This function should not be used manually, seeding should be done via a ClustererSeeding function.

If the Clusterer already has enough centroids, an exception is raised.

virtual const std::vector<TimeSurfaceType> &getCentroids() const override

Get the list of centroids.

virtual bool hasCentroids() const override

Check if clusterer has enough centroids.

A clusterer has centroids if there is a number of centroids equal to the number of clusters.

virtual void train(const std::vector<TimeSurfaceType> &tss) override

Fit a set of time surfaces.

Udpate the centroids by clustering the set of time surfaces.

virtual void toStream(std::ostream &out) const override

Insert to stream.

Insert parameters of the clusterer and centroids on the stream.

virtual void fromStream(std::istream &in) override

Extract from stream.

Parameters/current state is expected to be overwritten or invalidated.

Reads parameters and centroids from the stream.