mlpack: mlpack::kmeans::PellegMooreKMeansStatistic Class Reference

mlpack master

A statistic for trees which holds the blacklist for Pelleg-Moore k-means clustering (which represents the clusters that cannot possibly own any points in a node). More...

Public Member Functions
	PellegMooreKMeansStatistic ()
	Initialize the statistic without a node (this does nothing). More...

template<typename TreeType >
	PellegMooreKMeansStatistic (TreeType &node)
	Initialize the statistic for a node; this calculates the centroid and caches it. More...

const arma::uvec &	Blacklist () const
	Get the cluster blacklist. More...

arma::uvec &	Blacklist ()
	Modify the cluster blacklist. More...

const arma::vec &	Centroid () const
	Get the node's centroid. More...

arma::vec &	Centroid ()
	Modify the node's centroid (be careful!). More...

Private Attributes
arma::uvec	blacklist
	The cluster blacklist for the node. More...

arma::vec	centroid
	The centroid of the node, cached for use during prunes. More...

Detailed Description

A statistic for trees which holds the blacklist for Pelleg-Moore k-means clustering (which represents the clusters that cannot possibly own any points in a node).

Definition at line 24 of file pelleg_moore_kmeans_statistic.hpp.

Constructor & Destructor Documentation

mlpack::kmeans::PellegMooreKMeansStatistic::PellegMooreKMeansStatistic ( )

inline

Initialize the statistic without a node (this does nothing).

Definition at line 28 of file pelleg_moore_kmeans_statistic.hpp.

template<typename TreeType >

mlpack::kmeans::PellegMooreKMeansStatistic::PellegMooreKMeansStatistic ( TreeType & node )

inline

Initialize the statistic for a node; this calculates the centroid and caches it.

Definition at line 33 of file pelleg_moore_kmeans_statistic.hpp.

References centroid.

Member Function Documentation

const arma::uvec& mlpack::kmeans::PellegMooreKMeansStatistic::Blacklist ( ) const

inline

Get the cluster blacklist.

Definition at line 57 of file pelleg_moore_kmeans_statistic.hpp.

References blacklist.

arma::uvec& mlpack::kmeans::PellegMooreKMeansStatistic::Blacklist ( )

inline

Modify the cluster blacklist.

Definition at line 59 of file pelleg_moore_kmeans_statistic.hpp.

References blacklist.

const arma::vec& mlpack::kmeans::PellegMooreKMeansStatistic::Centroid ( ) const

inline

Get the node's centroid.

Definition at line 62 of file pelleg_moore_kmeans_statistic.hpp.

References centroid.

arma::vec& mlpack::kmeans::PellegMooreKMeansStatistic::Centroid ( )

inline

Modify the node's centroid (be careful!).

Definition at line 64 of file pelleg_moore_kmeans_statistic.hpp.

References centroid.

Member Data Documentation

arma::uvec mlpack::kmeans::PellegMooreKMeansStatistic::blacklist

private

The cluster blacklist for the node.

Definition at line 68 of file pelleg_moore_kmeans_statistic.hpp.

Referenced by Blacklist().

arma::vec mlpack::kmeans::PellegMooreKMeansStatistic::centroid

private

The centroid of the node, cached for use during prunes.

Definition at line 70 of file pelleg_moore_kmeans_statistic.hpp.

Referenced by Centroid(), and PellegMooreKMeansStatistic().

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

src/mlpack/methods/kmeans/pelleg_moore_kmeans_statistic.hpp