mlpack::bound::PeriodicHRectBound< t_pow > Class Template Reference
Hyper-rectangle bound for an L-metric. More...
Public Member Functions | |
| PeriodicHRectBound (const PeriodicHRectBound &other) | |
| PeriodicHRectBound (arma::vec box) | |
| Specifies the box size. | |
| PeriodicHRectBound () | |
| Empty constructor. | |
| ~PeriodicHRectBound () | |
| Destructor: clean up memory. | |
| const arma::vec & | Box () const |
| Returns the box vector. | |
| void | Centroid (arma::vec ¢roid) const |
| void | Clear () |
| Resets all dimensions to the empty set. | |
| bool | Contains (const arma::vec &point) const |
| Determines if a point is within this bound. | |
| size_t | Dim () const |
| Gets the dimensionality. | |
| double | MaxDistance (const PeriodicHRectBound &other) const |
| Computes maximum bound-to-bound squared distance in the periodic bound case. | |
| double | MaxDistance (const arma::vec &point) const |
| Calculates maximum bound-to-point squared distance in the periodic bound case. | |
| double | MinDistance (const PeriodicHRectBound &other) const |
| Calculates minimum bound-to-bound squared distance in the periodic bound case. | |
| double | MinDistance (const arma::vec &point) const |
| Calculates minimum bound-to-point squared distance in the periodic bound case. | |
| PeriodicHRectBound & | operator= (const PeriodicHRectBound &other) |
| const math::Range | operator[] (size_t i) const |
| math::Range & | operator[] (size_t i) |
| Sets and gets the range for a particular dimension. | |
| PeriodicHRectBound & | operator|= (const PeriodicHRectBound &other) |
| Expands this region to encompass another bound. | |
| PeriodicHRectBound & | operator|= (const arma::vec &vector) |
| Expands this region to include a new point. | |
| math::Range | RangeDistance (const PeriodicHRectBound &other) const |
| Calculates minimum and maximum bound-to-bound squared distance in the periodic bound case. | |
| math::Range | RangeDistance (const arma::vec &point) const |
| Calculates minimum and maximum bound-to-point squared distance in the periodic bound case. | |
| void | SetBoxSize (arma::vec box) |
| Modifies the box to the desired dimenstions. | |
| std::string | ToString () const |
| Returns a string representation of an object. | |
Private Attributes | |
| math::Range * | bounds |
| arma::vec | box |
| size_t | dim |
Detailed Description
template<int t_pow = 2>
class mlpack::bound::PeriodicHRectBound< t_pow >
Hyper-rectangle bound for an L-metric.
Template parameter t_pow is the metric to use; use 2 for Euclidean (L2).
Definition at line 38 of file periodichrectbound.hpp.
Constructor & Destructor Documentation
| mlpack::bound::PeriodicHRectBound< t_pow >::PeriodicHRectBound | ( | ) |
Empty constructor.
| mlpack::bound::PeriodicHRectBound< t_pow >::PeriodicHRectBound | ( | arma::vec | box | ) |
Specifies the box size.
The dimensionality is set to the same of the box size, and the bounds are initialized to be empty.
| mlpack::bound::PeriodicHRectBound< t_pow >::PeriodicHRectBound | ( | const PeriodicHRectBound< t_pow > & | other | ) |
| mlpack::bound::PeriodicHRectBound< t_pow >::~PeriodicHRectBound | ( | ) |
Destructor: clean up memory.
Member Function Documentation
| const arma::vec& mlpack::bound::PeriodicHRectBound< t_pow >::Box | ( | ) | const [inline] |
Returns the box vector.
Definition at line 72 of file periodichrectbound.hpp.
| void mlpack::bound::PeriodicHRectBound< t_pow >::Centroid | ( | arma::vec & | centroid | ) | const |
| void mlpack::bound::PeriodicHRectBound< t_pow >::Clear | ( | ) |
Resets all dimensions to the empty set.
| bool mlpack::bound::PeriodicHRectBound< t_pow >::Contains | ( | const arma::vec & | point | ) | const |
Determines if a point is within this bound.
| size_t mlpack::bound::PeriodicHRectBound< t_pow >::Dim | ( | ) | const [inline] |
Gets the dimensionality.
Definition at line 80 of file periodichrectbound.hpp.
References mlpack::bound::PeriodicHRectBound< t_pow >::dim.
| double mlpack::bound::PeriodicHRectBound< t_pow >::MaxDistance | ( | const PeriodicHRectBound< t_pow > & | other | ) | const |
Computes maximum bound-to-bound squared distance in the periodic bound case.
| double mlpack::bound::PeriodicHRectBound< t_pow >::MaxDistance | ( | const arma::vec & | point | ) | const |
Calculates maximum bound-to-point squared distance in the periodic bound case.
| double mlpack::bound::PeriodicHRectBound< t_pow >::MinDistance | ( | const PeriodicHRectBound< t_pow > & | other | ) | const |
Calculates minimum bound-to-bound squared distance in the periodic bound case.
Example: bound1.MinDistance(other) for minimum squared distance.
| double mlpack::bound::PeriodicHRectBound< t_pow >::MinDistance | ( | const arma::vec & | point | ) | const |
Calculates minimum bound-to-point squared distance in the periodic bound case.
| PeriodicHRectBound& mlpack::bound::PeriodicHRectBound< t_pow >::operator= | ( | const PeriodicHRectBound< t_pow > & | other | ) |
| const math::Range mlpack::bound::PeriodicHRectBound< t_pow >::operator[] | ( | size_t | i | ) | const |
| math::Range& mlpack::bound::PeriodicHRectBound< t_pow >::operator[] | ( | size_t | i | ) |
Sets and gets the range for a particular dimension.
| PeriodicHRectBound& mlpack::bound::PeriodicHRectBound< t_pow >::operator|= | ( | const PeriodicHRectBound< t_pow > & | other | ) |
Expands this region to encompass another bound.
| PeriodicHRectBound& mlpack::bound::PeriodicHRectBound< t_pow >::operator|= | ( | const arma::vec & | vector | ) |
Expands this region to include a new point.
| math::Range mlpack::bound::PeriodicHRectBound< t_pow >::RangeDistance | ( | const PeriodicHRectBound< t_pow > & | other | ) | const |
Calculates minimum and maximum bound-to-bound squared distance in the periodic bound case.
| math::Range mlpack::bound::PeriodicHRectBound< t_pow >::RangeDistance | ( | const arma::vec & | point | ) | const |
Calculates minimum and maximum bound-to-point squared distance in the periodic bound case.
| void mlpack::bound::PeriodicHRectBound< t_pow >::SetBoxSize | ( | arma::vec | box | ) |
Modifies the box to the desired dimenstions.
| std::string mlpack::bound::PeriodicHRectBound< t_pow >::ToString | ( | ) | const |
Returns a string representation of an object.
Member Data Documentation
math::Range* mlpack::bound::PeriodicHRectBound< t_pow >::bounds [private] |
Definition at line 155 of file periodichrectbound.hpp.
arma::vec mlpack::bound::PeriodicHRectBound< t_pow >::box [private] |
Definition at line 157 of file periodichrectbound.hpp.
size_t mlpack::bound::PeriodicHRectBound< t_pow >::dim [private] |
Definition at line 156 of file periodichrectbound.hpp.
Referenced by mlpack::bound::PeriodicHRectBound< t_pow >::Dim().
The documentation for this class was generated from the following file:
- src/mlpack/core/tree/periodichrectbound.hpp
