kmeans::Details< Index_ > Struct Template Reference

Additional statistics from the k-means algorithm. More...

#include <Details.hpp>

Public Attributes
std::vector< Index_ >	sizes
int	iterations = 0
int	status = 0

Detailed Description

template<typename Index_>
struct kmeans::Details< Index_ >

Additional statistics from the k-means algorithm.

Template Parameters

Index_

Integer type of the observation index.

Member Data Documentation

iterations

template<typename Index_ >

int kmeans::Details< Index_ >::iterations = 0

The number of iterations that were performed. This can be interpreted as the number of iterations to convergence if Details::status == 0.

sizes

template<typename Index_ >

std::vector<Index_> kmeans::Details< Index_ >::sizes

The number of observations in each cluster. This has length equal to num_centers in Refine::run(), where sizes[j] contains the number of observations in cluster j.

Some clusters may be empty, e.g., when there are more requested centers than clusters - see remove_unused_centers() to optionally remove such clusters.

status

template<typename Index_ >

int kmeans::Details< Index_ >::status = 0

The status of the algorithm on completion. A value of 0 indicates that the algorithm completed successfully. The interpretation of a non-zero value depends on the algorithm.

---

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

• kmeans/Details.hpp