mlpack  2.0.1
Public Member Functions | Private Attributes | List of all members
mlpack::kmeans::DualTreeKMeansStatistic Class Reference
Inheritance diagram for mlpack::kmeans::DualTreeKMeansStatistic:
Inheritance graph
[legend]

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 Bound () const
 Get the overall bound (the better of the two bounds). More...
 
double & Bound ()
 Modify the overall bound (it should be the better of the two bounds). 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...
 
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 22 of file dual_tree_kmeans_statistic.hpp.

Constructor & Destructor Documentation

◆ DualTreeKMeansStatistic() [1/2]

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

Definition at line 26 of file dual_tree_kmeans_statistic.hpp.

◆ DualTreeKMeansStatistic() [2/2]

template<typename TreeType >
mlpack::kmeans::DualTreeKMeansStatistic::DualTreeKMeansStatistic ( TreeType &  node)
inline

Definition at line 42 of file dual_tree_kmeans_statistic.hpp.

References centroid, and trueChildren.

Member Function Documentation

◆ Centroid() [1/2]

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

Definition at line 83 of file dual_tree_kmeans_statistic.hpp.

References centroid.

◆ Centroid() [2/2]

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

Definition at line 84 of file dual_tree_kmeans_statistic.hpp.

References centroid.

◆ LowerBound() [1/2]

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

Definition at line 80 of file dual_tree_kmeans_statistic.hpp.

References lowerBound.

◆ LowerBound() [2/2]

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

Definition at line 81 of file dual_tree_kmeans_statistic.hpp.

References lowerBound.

◆ NumTrueChildren()

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

Definition at line 107 of file dual_tree_kmeans_statistic.hpp.

References trueChildren.

◆ Owner() [1/2]

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

Definition at line 86 of file dual_tree_kmeans_statistic.hpp.

References owner.

◆ Owner() [2/2]

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

Definition at line 87 of file dual_tree_kmeans_statistic.hpp.

References owner.

◆ Pruned() [1/2]

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

Definition at line 89 of file dual_tree_kmeans_statistic.hpp.

References pruned.

◆ Pruned() [2/2]

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

Definition at line 90 of file dual_tree_kmeans_statistic.hpp.

References pruned.

◆ StaticLowerBoundMovement() [1/2]

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

Definition at line 98 of file dual_tree_kmeans_statistic.hpp.

References staticLowerBoundMovement.

◆ StaticLowerBoundMovement() [2/2]

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

Definition at line 99 of file dual_tree_kmeans_statistic.hpp.

References staticLowerBoundMovement.

◆ StaticPruned() [1/2]

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

Definition at line 92 of file dual_tree_kmeans_statistic.hpp.

References staticPruned.

◆ StaticPruned() [2/2]

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

Definition at line 93 of file dual_tree_kmeans_statistic.hpp.

References staticPruned.

◆ StaticUpperBoundMovement() [1/2]

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

Definition at line 95 of file dual_tree_kmeans_statistic.hpp.

References staticUpperBoundMovement.

◆ StaticUpperBoundMovement() [2/2]

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

Definition at line 96 of file dual_tree_kmeans_statistic.hpp.

References staticUpperBoundMovement.

◆ TrueChild() [1/2]

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

Definition at line 104 of file dual_tree_kmeans_statistic.hpp.

References trueChildren.

◆ TrueChild() [2/2]

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

Definition at line 105 of file dual_tree_kmeans_statistic.hpp.

References trueChildren.

◆ TrueParent() [1/2]

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

Definition at line 101 of file dual_tree_kmeans_statistic.hpp.

References trueParent.

◆ TrueParent() [2/2]

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

Definition at line 102 of file dual_tree_kmeans_statistic.hpp.

References trueParent.

◆ UpperBound() [1/2]

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

Definition at line 77 of file dual_tree_kmeans_statistic.hpp.

References upperBound.

◆ UpperBound() [2/2]

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

Definition at line 78 of file dual_tree_kmeans_statistic.hpp.

References upperBound.

Member Data Documentation

◆ centroid

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

Definition at line 117 of file dual_tree_kmeans_statistic.hpp.

Referenced by Centroid(), and DualTreeKMeansStatistic().

◆ lowerBound

double mlpack::kmeans::DualTreeKMeansStatistic::lowerBound
private

Definition at line 111 of file dual_tree_kmeans_statistic.hpp.

Referenced by LowerBound().

◆ owner

size_t mlpack::kmeans::DualTreeKMeansStatistic::owner
private

Definition at line 112 of file dual_tree_kmeans_statistic.hpp.

Referenced by Owner().

◆ pruned

size_t mlpack::kmeans::DualTreeKMeansStatistic::pruned
private

Definition at line 113 of file dual_tree_kmeans_statistic.hpp.

Referenced by Pruned().

◆ staticLowerBoundMovement

double mlpack::kmeans::DualTreeKMeansStatistic::staticLowerBoundMovement
private

Definition at line 116 of file dual_tree_kmeans_statistic.hpp.

Referenced by StaticLowerBoundMovement().

◆ staticPruned

bool mlpack::kmeans::DualTreeKMeansStatistic::staticPruned
private

Definition at line 114 of file dual_tree_kmeans_statistic.hpp.

Referenced by StaticPruned().

◆ staticUpperBoundMovement

double mlpack::kmeans::DualTreeKMeansStatistic::staticUpperBoundMovement
private

Definition at line 115 of file dual_tree_kmeans_statistic.hpp.

Referenced by StaticUpperBoundMovement().

◆ trueChildren

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

◆ trueParent

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

Definition at line 118 of file dual_tree_kmeans_statistic.hpp.

Referenced by TrueParent().

◆ upperBound

double mlpack::kmeans::DualTreeKMeansStatistic::upperBound
private

Definition at line 110 of file dual_tree_kmeans_statistic.hpp.

Referenced by UpperBound().


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