mlpack::kmeans::DualTreeKMeansStatistic Class Reference

Inheritance diagram for mlpack::kmeans::DualTreeKMeansStatistic:

Public Member Functions
	DualTreeKMeansStatistic ()
template<typename TreeType >
	DualTreeKMeansStatistic (TreeType &node)
const arma::vec &	Centroid () const
arma::vec &	Centroid ()
double	LowerBound () const
double &	LowerBound ()
size_t	NumTrueChildren () const
size_t	Owner () const
size_t &	Owner ()
size_t	Pruned () const
size_t &	Pruned ()
double	StaticLowerBoundMovement () const
double &	StaticLowerBoundMovement ()
bool	StaticPruned () const
bool &	StaticPruned ()
double	StaticUpperBoundMovement () const
double &	StaticUpperBoundMovement ()
void *	TrueChild (const size_t i) const
void *&	TrueChild (const size_t i)
void *	TrueParent () const
void *&	TrueParent ()
double	UpperBound () const
double &	UpperBound ()
Public Member Functions inherited from mlpack::neighbor::NeighborSearchStat< neighbor::NearestNeighborSort >
	NeighborSearchStat ()
	Initialize the statistic with the worst possible distance according to our sorting policy. More...
	NeighborSearchStat (TreeType &)
	Initialization for a fully initialized node. More...
double	AuxBound () const
	Get the aux bound. More...
double &	AuxBound ()
	Modify the aux bound. More...
double	FirstBound () const
	Get the first bound. More...
double &	FirstBound ()
	Modify the first bound. More...
double	LastDistance () const
	Get the last distance calculation. More...
double &	LastDistance ()
	Modify the last distance calculation. More...
void	Reset ()
	Reset statistic parameters to initial values. More...
double	SecondBound () const
	Get the second bound. More...
double &	SecondBound ()
	Modify the second bound. More...
void	Serialize (Archive &ar, const unsigned int)
	Serialize the statistic to/from an archive. More...

Private Attributes
arma::vec	centroid
double	lowerBound
size_t	owner
size_t	pruned
double	staticLowerBoundMovement
bool	staticPruned
double	staticUpperBoundMovement
std::vector< void * >	trueChildren
void *	trueParent
double	upperBound

Detailed Description

Definition at line 20 of file dual_tree_kmeans_statistic.hpp.

Constructor & Destructor Documentation

mlpack::kmeans::DualTreeKMeansStatistic::DualTreeKMeansStatistic ( )

inline

Definition at line 24 of file dual_tree_kmeans_statistic.hpp.

template<typename TreeType >

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

inline

Definition at line 40 of file dual_tree_kmeans_statistic.hpp.

References centroid, and trueChildren.

Member Function Documentation

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

inline

Definition at line 81 of file dual_tree_kmeans_statistic.hpp.

References centroid.

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

inline

Definition at line 82 of file dual_tree_kmeans_statistic.hpp.

References centroid.

double mlpack::kmeans::DualTreeKMeansStatistic::LowerBound ( ) const

inline

Definition at line 78 of file dual_tree_kmeans_statistic.hpp.

References lowerBound.

double& mlpack::kmeans::DualTreeKMeansStatistic::LowerBound ( )

inline

Definition at line 79 of file dual_tree_kmeans_statistic.hpp.

References lowerBound.

size_t mlpack::kmeans::DualTreeKMeansStatistic::NumTrueChildren ( ) const

inline

Definition at line 105 of file dual_tree_kmeans_statistic.hpp.

References trueChildren.

size_t mlpack::kmeans::DualTreeKMeansStatistic::Owner ( ) const

inline

Definition at line 84 of file dual_tree_kmeans_statistic.hpp.

References owner.

size_t& mlpack::kmeans::DualTreeKMeansStatistic::Owner ( )

inline

Definition at line 85 of file dual_tree_kmeans_statistic.hpp.

References owner.

size_t mlpack::kmeans::DualTreeKMeansStatistic::Pruned ( ) const

inline

Definition at line 87 of file dual_tree_kmeans_statistic.hpp.

References pruned.

size_t& mlpack::kmeans::DualTreeKMeansStatistic::Pruned ( )

inline

Definition at line 88 of file dual_tree_kmeans_statistic.hpp.

References pruned.

double mlpack::kmeans::DualTreeKMeansStatistic::StaticLowerBoundMovement ( ) const

inline

Definition at line 96 of file dual_tree_kmeans_statistic.hpp.

References staticLowerBoundMovement.

double& mlpack::kmeans::DualTreeKMeansStatistic::StaticLowerBoundMovement ( )

inline

Definition at line 97 of file dual_tree_kmeans_statistic.hpp.

References staticLowerBoundMovement.

bool mlpack::kmeans::DualTreeKMeansStatistic::StaticPruned ( ) const

inline

Definition at line 90 of file dual_tree_kmeans_statistic.hpp.

References staticPruned.

bool& mlpack::kmeans::DualTreeKMeansStatistic::StaticPruned ( )

inline

Definition at line 91 of file dual_tree_kmeans_statistic.hpp.

References staticPruned.

double mlpack::kmeans::DualTreeKMeansStatistic::StaticUpperBoundMovement ( ) const

inline

Definition at line 93 of file dual_tree_kmeans_statistic.hpp.

References staticUpperBoundMovement.

double& mlpack::kmeans::DualTreeKMeansStatistic::StaticUpperBoundMovement ( )

inline

Definition at line 94 of file dual_tree_kmeans_statistic.hpp.

References staticUpperBoundMovement.

void* mlpack::kmeans::DualTreeKMeansStatistic::TrueChild ( const size_t  i ) const

inline

Definition at line 102 of file dual_tree_kmeans_statistic.hpp.

References trueChildren.

void*& mlpack::kmeans::DualTreeKMeansStatistic::TrueChild ( const size_t  i )

inline

Definition at line 103 of file dual_tree_kmeans_statistic.hpp.

References trueChildren.

void* mlpack::kmeans::DualTreeKMeansStatistic::TrueParent ( ) const

inline

Definition at line 99 of file dual_tree_kmeans_statistic.hpp.

References trueParent.

void*& mlpack::kmeans::DualTreeKMeansStatistic::TrueParent ( )

inline

Definition at line 100 of file dual_tree_kmeans_statistic.hpp.

References trueParent.

double mlpack::kmeans::DualTreeKMeansStatistic::UpperBound ( ) const

inline

Definition at line 75 of file dual_tree_kmeans_statistic.hpp.

References upperBound.

double& mlpack::kmeans::DualTreeKMeansStatistic::UpperBound ( )

inline

Definition at line 76 of file dual_tree_kmeans_statistic.hpp.

References upperBound.

Member Data Documentation

arma::vec mlpack::kmeans::DualTreeKMeansStatistic::centroid

private

Definition at line 115 of file dual_tree_kmeans_statistic.hpp.

Referenced by Centroid(), and DualTreeKMeansStatistic().

double mlpack::kmeans::DualTreeKMeansStatistic::lowerBound

private

Definition at line 109 of file dual_tree_kmeans_statistic.hpp.

Referenced by LowerBound().

size_t mlpack::kmeans::DualTreeKMeansStatistic::owner

private

Definition at line 110 of file dual_tree_kmeans_statistic.hpp.

Referenced by Owner().

size_t mlpack::kmeans::DualTreeKMeansStatistic::pruned

private

Definition at line 111 of file dual_tree_kmeans_statistic.hpp.

Referenced by Pruned().

double mlpack::kmeans::DualTreeKMeansStatistic::staticLowerBoundMovement

private

Definition at line 114 of file dual_tree_kmeans_statistic.hpp.

Referenced by StaticLowerBoundMovement().

bool mlpack::kmeans::DualTreeKMeansStatistic::staticPruned

private

Definition at line 112 of file dual_tree_kmeans_statistic.hpp.

Referenced by StaticPruned().

double mlpack::kmeans::DualTreeKMeansStatistic::staticUpperBoundMovement

private

Definition at line 113 of file dual_tree_kmeans_statistic.hpp.

Referenced by StaticUpperBoundMovement().

std::vector<void*> mlpack::kmeans::DualTreeKMeansStatistic::trueChildren

private

Definition at line 117 of file dual_tree_kmeans_statistic.hpp.

Referenced by DualTreeKMeansStatistic(), NumTrueChildren(), and TrueChild().

void* mlpack::kmeans::DualTreeKMeansStatistic::trueParent

private

Definition at line 116 of file dual_tree_kmeans_statistic.hpp.

Referenced by TrueParent().

double mlpack::kmeans::DualTreeKMeansStatistic::upperBound

private

Definition at line 108 of file dual_tree_kmeans_statistic.hpp.

Referenced by UpperBound().

---

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

• src/mlpack/methods/kmeans/dual_tree_kmeans_statistic.hpp