kmeans
A C++ library for k-means
Loading...
Searching...
No Matches
kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ > Class Template Referencefinal

Initialize by sampling random observations without replacement. More...

#include <InitializeRandom.hpp>

Inheritance diagram for kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ >:
Collaboration diagram for kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ >:

Public Member Functions

 InitializeRandom (InitializeRandomOptions options)
 
 InitializeRandom ()=default
 
InitializeRandomOptionsget_options ()
 
- Public Member Functions inherited from kmeans::Initialize< Index_, Data_, Cluster_, Float_, Matrix_ >
virtual Cluster_ run (const Matrix_ &data, Cluster_ num_centers, Float_ *centers) const =0
 

Detailed Description

template<typename Index_, typename Data_, typename Cluster_, typename Float_, class Matrix_ = Matrix<Index_, Data_>>
class kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ >

Initialize by sampling random observations without replacement.

Template Parameters
Index_Integer type for the observation indices in the input dataset.
Data_Numeric type for the input dataset.
Cluster_Integer type for the cluster assignments.
Float_Floating-point type for the centroids. This will also be used for any internal distance calculations.
Matrix_Class of the input data matrix. This should satisfy the Matrix interface.

Constructor & Destructor Documentation

◆ InitializeRandom() [1/2]

template<typename Index_ , typename Data_ , typename Cluster_ , typename Float_ , class Matrix_ = Matrix<Index_, Data_>>
kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ >::InitializeRandom ( InitializeRandomOptions options)
inline
Parameters
optionsOptions for random initialization.

◆ InitializeRandom() [2/2]

template<typename Index_ , typename Data_ , typename Cluster_ , typename Float_ , class Matrix_ = Matrix<Index_, Data_>>
kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ >::InitializeRandom ( )
default

Default constructor.

Member Function Documentation

◆ get_options()

template<typename Index_ , typename Data_ , typename Cluster_ , typename Float_ , class Matrix_ = Matrix<Index_, Data_>>
InitializeRandomOptions & kmeans::InitializeRandom< Index_, Data_, Cluster_, Float_, Matrix_ >::get_options ( )
inline
Returns
Options for random initialization, to be modified prior to calling run().

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