MLpp
ml::Clustering::ClosestCentroid Class Reference

Initialises centroids and then assigns the responsibility for each point to its closest centroid. More...

#include <Clustering.hpp>

Inheritance diagram for ml::Clustering::ClosestCentroid:
Collaboration diagram for ml::Clustering::ClosestCentroid:

Public Member Functions

 ClosestCentroid (std::shared_ptr< const CentroidsInitialiser > centroids_initialiser)
 Constructor. More...
 
void init (Eigen::Ref< const Eigen::MatrixXd > data, std::default_random_engine &prng, unsigned int number_components, Eigen::Ref< Eigen::MatrixXd > responsibilities) const override
 Initialises component responsibilities. More...
 
- Public Member Functions inherited from ml::Clustering::ResponsibilitiesInitialiser
virtual ~ResponsibilitiesInitialiser ()
 Virtual destructor.
 

Detailed Description

Initialises centroids and then assigns the responsibility for each point to its closest centroid.

Constructor & Destructor Documentation

◆ ClosestCentroid()

ml::Clustering::ClosestCentroid::ClosestCentroid ( std::shared_ptr< const CentroidsInitialiser centroids_initialiser)

Constructor.

Parameters
centroids_initialiserNon-null pointer to CentroidsInitialiser implementation used to initialise the centroids.
Exceptions
std::invalid_argumentIf centroids_initialiser is null.

Member Function Documentation

◆ init()

void ml::Clustering::ClosestCentroid::init ( Eigen::Ref< const Eigen::MatrixXd >  data,
std::default_random_engine &  prng,
unsigned int  number_components,
Eigen::Ref< Eigen::MatrixXd >  responsibilities 
) const
overridevirtual

Initialises component responsibilities.

Parameters
[in]dataData matrix with data points in columns.
[in,out]prngPseudo-random number generator.
[in]number_componentsNumber of centroids. Must be less or equal to data.cols().
[out]responsibilitiesDestination matrix for component responsibilities, with data.cols() rows and number_components columns.

Implements ml::Clustering::ResponsibilitiesInitialiser.


The documentation for this class was generated from the following file: