mlpack
2.0.1
|
Hyper-rectangle bound for an L-metric. More...
Public Member Functions | |
HRectBound () | |
Empty constructor; creates a bound of dimensionality 0. More... | |
HRectBound (const size_t dimension) | |
Initializes to specified dimensionality with each dimension the empty set. More... | |
HRectBound (const HRectBound &other) | |
Copy constructor; necessary to prevent memory leaks. More... | |
HRectBound (HRectBound &&other) | |
Move constructor: take possession of another bound's information. More... | |
~HRectBound () | |
Destructor: clean up memory. More... | |
void | Center (arma::vec ¢er) const |
Calculates the center of the range, placing it into the given vector. More... | |
void | Clear () |
Resets all dimensions to the empty set (so that this bound contains nothing). More... | |
template<typename VecType > | |
bool | Contains (const VecType &point) const |
Determines if a point is within this bound. More... | |
double | Diameter () const |
Returns the diameter of the hyperrectangle (that is, the longest diagonal). More... | |
size_t | Dim () const |
Gets the dimensionality. More... | |
template<typename VecType > | |
double | MaxDistance (const VecType &point, typename boost::enable_if< IsVector< VecType > > *=0) const |
Calculates maximum bound-to-point squared distance. More... | |
double | MaxDistance (const HRectBound &other) const |
Computes maximum distance. More... | |
template<typename VecType > | |
double | MinDistance (const VecType &point, typename boost::enable_if< IsVector< VecType > > *=0) const |
Calculates minimum bound-to-point distance. More... | |
double | MinDistance (const HRectBound &other) const |
Calculates minimum bound-to-bound distance. More... | |
double | MinWidth () const |
Get the minimum width of the bound. More... | |
double & | MinWidth () |
Modify the minimum width of the bound. More... | |
HRectBound & | operator= (const HRectBound &other) |
Same as copy constructor; necessary to prevent memory leaks. More... | |
math::Range & | operator[] (const size_t i) |
Get the range for a particular dimension. More... | |
const math::Range & | operator[] (const size_t i) const |
Modify the range for a particular dimension. No bounds checking. More... | |
template<typename MatType > | |
HRectBound & | operator|= (const MatType &data) |
Expands this region to include new points. More... | |
HRectBound & | operator|= (const HRectBound &other) |
Expands this region to encompass another bound. More... | |
math::Range | RangeDistance (const HRectBound &other) const |
Calculates minimum and maximum bound-to-bound distance. More... | |
template<typename VecType > | |
math::Range | RangeDistance (const VecType &point, typename boost::enable_if< IsVector< VecType > > *=0) const |
Calculates minimum and maximum bound-to-point distance. More... | |
template<typename Archive > | |
void | Serialize (Archive &ar, const unsigned int version) |
Serialize the bound object. More... | |
double | Volume () const |
Calculate the volume of the hyperrectangle. More... | |
Private Attributes | |
math::Range * | bounds |
The bounds for each dimension. More... | |
size_t | dim |
The dimensionality of the bound. More... | |
double | minWidth |
Cached minimum width of bound. More... | |
Hyper-rectangle bound for an L-metric.
This should be used in conjunction with the LMetric class. Be sure to use the same template parameters for LMetric as you do for HRectBound – otherwise odd results may occur.
Power | The metric to use; use 2 for Euclidean (L2). |
TakeRoot | Whether or not the root should be taken (see LMetric documentation). |
Definition at line 56 of file hrectbound.hpp.
mlpack::bound::HRectBound< MetricType >::HRectBound | ( | ) |
Empty constructor; creates a bound of dimensionality 0.
mlpack::bound::HRectBound< MetricType >::HRectBound | ( | const size_t | dimension | ) |
Initializes to specified dimensionality with each dimension the empty set.
mlpack::bound::HRectBound< MetricType >::HRectBound | ( | const HRectBound< MetricType > & | other | ) |
Copy constructor; necessary to prevent memory leaks.
mlpack::bound::HRectBound< MetricType >::HRectBound | ( | HRectBound< MetricType > && | other | ) |
Move constructor: take possession of another bound's information.
mlpack::bound::HRectBound< MetricType >::~HRectBound | ( | ) |
Destructor: clean up memory.
void mlpack::bound::HRectBound< MetricType >::Center | ( | arma::vec & | center | ) | const |
Calculates the center of the range, placing it into the given vector.
center | Vector which the center will be written to. |
Referenced by mlpack::tree::RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType >::Center().
void mlpack::bound::HRectBound< MetricType >::Clear | ( | ) |
Resets all dimensions to the empty set (so that this bound contains nothing).
bool mlpack::bound::HRectBound< MetricType >::Contains | ( | const VecType & | point | ) | const |
Determines if a point is within this bound.
double mlpack::bound::HRectBound< MetricType >::Diameter | ( | ) | const |
Returns the diameter of the hyperrectangle (that is, the longest diagonal).
|
inline |
Gets the dimensionality.
Definition at line 92 of file hrectbound.hpp.
double mlpack::bound::HRectBound< MetricType >::MaxDistance | ( | const VecType & | point, |
typename boost::enable_if< IsVector< VecType > > * | = 0 |
||
) | const |
Calculates maximum bound-to-point squared distance.
point | Point to which the maximum distance is requested. |
Referenced by mlpack::tree::RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType >::MaxDistance().
double mlpack::bound::HRectBound< MetricType >::MaxDistance | ( | const HRectBound< MetricType > & | other | ) | const |
Computes maximum distance.
other | Bound to which the maximum distance is requested. |
double mlpack::bound::HRectBound< MetricType >::MinDistance | ( | const VecType & | point, |
typename boost::enable_if< IsVector< VecType > > * | = 0 |
||
) | const |
Calculates minimum bound-to-point distance.
point | Point to which the minimum distance is requested. |
Referenced by mlpack::tree::RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType >::MinDistance().
double mlpack::bound::HRectBound< MetricType >::MinDistance | ( | const HRectBound< MetricType > & | other | ) | const |
Calculates minimum bound-to-bound distance.
other | Bound to which the minimum distance is requested. |
|
inline |
Get the minimum width of the bound.
Definition at line 101 of file hrectbound.hpp.
Referenced by mlpack::tree::RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType >::MinimumBoundDistance().
|
inline |
Modify the minimum width of the bound.
Definition at line 103 of file hrectbound.hpp.
HRectBound& mlpack::bound::HRectBound< MetricType >::operator= | ( | const HRectBound< MetricType > & | other | ) |
Same as copy constructor; necessary to prevent memory leaks.
|
inline |
Get the range for a particular dimension.
No bounds checking. Be careful: this may make MinWidth() invalid.
Definition at line 96 of file hrectbound.hpp.
|
inline |
Modify the range for a particular dimension. No bounds checking.
Definition at line 98 of file hrectbound.hpp.
HRectBound& mlpack::bound::HRectBound< MetricType >::operator|= | ( | const MatType & | data | ) |
Expands this region to include new points.
MatType | Type of matrix; could be Mat, SpMat, a subview, or just a vector. |
data | Data points to expand this region to include. |
HRectBound& mlpack::bound::HRectBound< MetricType >::operator|= | ( | const HRectBound< MetricType > & | other | ) |
Expands this region to encompass another bound.
math::Range mlpack::bound::HRectBound< MetricType >::RangeDistance | ( | const HRectBound< MetricType > & | other | ) | const |
Calculates minimum and maximum bound-to-bound distance.
other | Bound to which the minimum and maximum distances are requested. |
Referenced by mlpack::tree::RectangleTree< MetricType, StatisticType, MatType, SplitType, DescentType >::RangeDistance().
math::Range mlpack::bound::HRectBound< MetricType >::RangeDistance | ( | const VecType & | point, |
typename boost::enable_if< IsVector< VecType > > * | = 0 |
||
) | const |
Calculates minimum and maximum bound-to-point distance.
point | Point to which the minimum and maximum distances are requested. |
void mlpack::bound::HRectBound< MetricType >::Serialize | ( | Archive & | ar, |
const unsigned int | version | ||
) |
Serialize the bound object.
double mlpack::bound::HRectBound< MetricType >::Volume | ( | ) | const |
Calculate the volume of the hyperrectangle.
|
private |
The bounds for each dimension.
Definition at line 206 of file hrectbound.hpp.
|
private |
The dimensionality of the bound.
Definition at line 204 of file hrectbound.hpp.
|
private |
Cached minimum width of bound.
Definition at line 208 of file hrectbound.hpp.