mlpack::tree::MRKDStatistic Class Reference

Statistic for multi-resolution kd-trees. More...

Collaboration diagram for mlpack::tree::MRKDStatistic:
Collaboration graph
[legend]

List of all members.

Public Member Functions

template<typename TreeType >
 MRKDStatistic (const TreeType &)
 This constructor is called when a node is finished initializing.
 MRKDStatistic ()
 Initialize an empty statistic.
size_t & Begin ()
 Modify the index of the initial item in the dataset.
size_t Begin () const
 Get the index of the initial item in the dataset.
arma::colvec & CenterOfMass ()
 Modify the center of mass.
const arma::colvec & CenterOfMass () const
 Get the center of mass.
size_t & Count ()
 Modify the number of items in the dataset.
size_t Count () const
 Get the number of items in the dataset.
size_t & DominatingCentroid ()
 Modify the index of the dominating centroid.
size_t DominatingCentroid () const
 Get the index of the dominating centroid.
std::string ToString () const
 Returns a string representation of this object.
std::vector< size_t > & Whitelist ()
 Modify the whitelist.
const std::vector< size_t > & Whitelist () const
 Access the whitelist.

Private Attributes

size_t begin
 The initial item in the dataset, so we don't have to make a copy.
arma::colvec centerOfMass
 The center of mass for this dataset.
size_t count
 The number of items in the dataset.
const arma::mat * dataset
 The data points this object contains.
size_t dominatingCentroid
 The index of the dominating centroid of the associated hyperrectangle.
bool isWhitelistValid
 Whether or not the whitelist is valid.
const MRKDStatisticleftStat
 The left child.
const MRKDStatisticparentStat
 A link to the parent node; NULL if this is the root.
const MRKDStatisticrightStat
 The right child.
double sumOfSquaredNorms
 The sum of the squared Euclidean norms for this dataset.
std::vector< size_t > whitelist
 The list of centroids that cannot own this hyperrectangle.

Detailed Description

Statistic for multi-resolution kd-trees.

Definition at line 33 of file mrkd_statistic.hpp.


Constructor & Destructor Documentation

mlpack::tree::MRKDStatistic::MRKDStatistic (  ) 

Initialize an empty statistic.

template<typename TreeType >
mlpack::tree::MRKDStatistic::MRKDStatistic ( const TreeType &   )  [inline]

This constructor is called when a node is finished initializing.

Parameters:
node The node that has been finished.

Member Function Documentation

size_t& mlpack::tree::MRKDStatistic::Begin (  )  [inline]

Modify the index of the initial item in the dataset.

Definition at line 55 of file mrkd_statistic.hpp.

References begin.

size_t mlpack::tree::MRKDStatistic::Begin (  )  const [inline]

Get the index of the initial item in the dataset.

Definition at line 53 of file mrkd_statistic.hpp.

References begin.

arma::colvec& mlpack::tree::MRKDStatistic::CenterOfMass (  )  [inline]

Modify the center of mass.

Definition at line 65 of file mrkd_statistic.hpp.

References centerOfMass.

const arma::colvec& mlpack::tree::MRKDStatistic::CenterOfMass (  )  const [inline]

Get the center of mass.

Definition at line 63 of file mrkd_statistic.hpp.

References centerOfMass.

size_t& mlpack::tree::MRKDStatistic::Count (  )  [inline]

Modify the number of items in the dataset.

Definition at line 60 of file mrkd_statistic.hpp.

References count.

size_t mlpack::tree::MRKDStatistic::Count (  )  const [inline]

Get the number of items in the dataset.

Definition at line 58 of file mrkd_statistic.hpp.

References count.

size_t& mlpack::tree::MRKDStatistic::DominatingCentroid (  )  [inline]

Modify the index of the dominating centroid.

Definition at line 70 of file mrkd_statistic.hpp.

References dominatingCentroid.

size_t mlpack::tree::MRKDStatistic::DominatingCentroid (  )  const [inline]

Get the index of the dominating centroid.

Definition at line 68 of file mrkd_statistic.hpp.

References dominatingCentroid.

std::string mlpack::tree::MRKDStatistic::ToString (  )  const

Returns a string representation of this object.

std::vector<size_t>& mlpack::tree::MRKDStatistic::Whitelist (  )  [inline]

Modify the whitelist.

Definition at line 75 of file mrkd_statistic.hpp.

References whitelist.

const std::vector<size_t>& mlpack::tree::MRKDStatistic::Whitelist (  )  const [inline]

Access the whitelist.

Definition at line 73 of file mrkd_statistic.hpp.

References whitelist.


Member Data Documentation

The initial item in the dataset, so we don't have to make a copy.

Definition at line 81 of file mrkd_statistic.hpp.

Referenced by Begin().

The center of mass for this dataset.

Definition at line 93 of file mrkd_statistic.hpp.

Referenced by CenterOfMass().

The number of items in the dataset.

Definition at line 83 of file mrkd_statistic.hpp.

Referenced by Count().

const arma::mat* mlpack::tree::MRKDStatistic::dataset [private]

The data points this object contains.

Definition at line 79 of file mrkd_statistic.hpp.

The index of the dominating centroid of the associated hyperrectangle.

Definition at line 99 of file mrkd_statistic.hpp.

Referenced by DominatingCentroid().

Whether or not the whitelist is valid.

Definition at line 104 of file mrkd_statistic.hpp.

The left child.

Definition at line 85 of file mrkd_statistic.hpp.

A link to the parent node; NULL if this is the root.

Definition at line 89 of file mrkd_statistic.hpp.

The right child.

Definition at line 87 of file mrkd_statistic.hpp.

The sum of the squared Euclidean norms for this dataset.

Definition at line 95 of file mrkd_statistic.hpp.

std::vector<size_t> mlpack::tree::MRKDStatistic::whitelist [private]

The list of centroids that cannot own this hyperrectangle.

Definition at line 102 of file mrkd_statistic.hpp.

Referenced by Whitelist().


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

Generated on 13 Aug 2014 for MLPACK by  doxygen 1.6.1