MLPACK  1.0.11
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
mlpack::bound::HRectBound< Power, TakeRoot > Class Template Reference

Hyper-rectangle bound for an L-metric. More...

Collaboration diagram for mlpack::bound::HRectBound< Power, TakeRoot >:
Collaboration graph
[legend]

Public Types

typedef metric::LMetric< Power, TakeRoot > MetricType
 This is the metric type that this bound is using. 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 ()
 Destructor: clean up memory. More...
 
void Centroid (arma::vec &centroid) const
 Calculates the centroid 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...
 
HRectBoundoperator= (const HRectBound &other)
 Same as copy constructor; necessary to prevent memory leaks. More...
 
math::Rangeoperator[] (const size_t i)
 Get the range for a particular dimension. More...
 
const math::Rangeoperator[] (const size_t i) const
 Modify the range for a particular dimension. No bounds checking. More...
 
template<typename MatType >
HRectBoundoperator|= (const MatType &data)
 Expands this region to include new points. More...
 
HRectBoundoperator|= (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...
 
std::string ToString () const
 Returns a string representation of this object. More...
 

Static Public Member Functions

static MetricType Metric ()
 Return the metric associated with this bound. More...
 

Private Attributes

math::Rangebounds
 The bounds for each dimension. More...
 
size_t dim
 The dimensionality of the bound. More...
 
double minWidth
 Cached minimum width of bound. More...
 

Detailed Description

template<int Power = 2, bool TakeRoot = true>
class mlpack::bound::HRectBound< Power, TakeRoot >

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.

Template Parameters
PowerThe metric to use; use 2 for Euclidean (L2).
TakeRootWhether or not the root should be taken (see LMetric documentation).

Definition at line 44 of file hrectbound.hpp.

Member Typedef Documentation

template<int Power = 2, bool TakeRoot = true>
typedef metric::LMetric<Power, TakeRoot> mlpack::bound::HRectBound< Power, TakeRoot >::MetricType

This is the metric type that this bound is using.

Definition at line 48 of file hrectbound.hpp.

Constructor & Destructor Documentation

template<int Power = 2, bool TakeRoot = true>
mlpack::bound::HRectBound< Power, TakeRoot >::HRectBound ( )

Empty constructor; creates a bound of dimensionality 0.

template<int Power = 2, bool TakeRoot = true>
mlpack::bound::HRectBound< Power, TakeRoot >::HRectBound ( const size_t  dimension)

Initializes to specified dimensionality with each dimension the empty set.

template<int Power = 2, bool TakeRoot = true>
mlpack::bound::HRectBound< Power, TakeRoot >::HRectBound ( const HRectBound< Power, TakeRoot > &  other)

Copy constructor; necessary to prevent memory leaks.

template<int Power = 2, bool TakeRoot = true>
mlpack::bound::HRectBound< Power, TakeRoot >::~HRectBound ( )

Destructor: clean up memory.

Member Function Documentation

template<int Power = 2, bool TakeRoot = true>
void mlpack::bound::HRectBound< Power, TakeRoot >::Centroid ( arma::vec &  centroid) const

Calculates the centroid of the range, placing it into the given vector.

Parameters
centroidVector which the centroid will be written to.
template<int Power = 2, bool TakeRoot = true>
void mlpack::bound::HRectBound< Power, TakeRoot >::Clear ( )

Resets all dimensions to the empty set (so that this bound contains nothing).

template<int Power = 2, bool TakeRoot = true>
template<typename VecType >
bool mlpack::bound::HRectBound< Power, TakeRoot >::Contains ( const VecType &  point) const

Determines if a point is within this bound.

template<int Power = 2, bool TakeRoot = true>
double mlpack::bound::HRectBound< Power, TakeRoot >::Diameter ( ) const

Returns the diameter of the hyperrectangle (that is, the longest diagonal).

template<int Power = 2, bool TakeRoot = true>
size_t mlpack::bound::HRectBound< Power, TakeRoot >::Dim ( ) const
inline

Gets the dimensionality.

Definition at line 76 of file hrectbound.hpp.

References mlpack::bound::HRectBound< Power, TakeRoot >::dim.

template<int Power = 2, bool TakeRoot = true>
template<typename VecType >
double mlpack::bound::HRectBound< Power, TakeRoot >::MaxDistance ( const VecType &  point,
typename boost::enable_if< IsVector< VecType > > *  = 0 
) const

Calculates maximum bound-to-point squared distance.

Parameters
pointPoint to which the maximum distance is requested.
template<int Power = 2, bool TakeRoot = true>
double mlpack::bound::HRectBound< Power, TakeRoot >::MaxDistance ( const HRectBound< Power, TakeRoot > &  other) const

Computes maximum distance.

Parameters
otherBound to which the maximum distance is requested.
template<int Power = 2, bool TakeRoot = true>
static MetricType mlpack::bound::HRectBound< Power, TakeRoot >::Metric ( )
inlinestatic

Return the metric associated with this bound.

Because it is an LMetric, it cannot store state, so we can make it on the fly. It is also static because the metric is only dependent on the template arguments.

Definition at line 183 of file hrectbound.hpp.

template<int Power = 2, bool TakeRoot = true>
template<typename VecType >
double mlpack::bound::HRectBound< Power, TakeRoot >::MinDistance ( const VecType &  point,
typename boost::enable_if< IsVector< VecType > > *  = 0 
) const

Calculates minimum bound-to-point distance.

Parameters
pointPoint to which the minimum distance is requested.
template<int Power = 2, bool TakeRoot = true>
double mlpack::bound::HRectBound< Power, TakeRoot >::MinDistance ( const HRectBound< Power, TakeRoot > &  other) const

Calculates minimum bound-to-bound distance.

Parameters
otherBound to which the minimum distance is requested.
template<int Power = 2, bool TakeRoot = true>
double mlpack::bound::HRectBound< Power, TakeRoot >::MinWidth ( ) const
inline

Get the minimum width of the bound.

Definition at line 85 of file hrectbound.hpp.

References mlpack::bound::HRectBound< Power, TakeRoot >::minWidth.

template<int Power = 2, bool TakeRoot = true>
double& mlpack::bound::HRectBound< Power, TakeRoot >::MinWidth ( )
inline

Modify the minimum width of the bound.

Definition at line 87 of file hrectbound.hpp.

References mlpack::bound::HRectBound< Power, TakeRoot >::minWidth.

template<int Power = 2, bool TakeRoot = true>
HRectBound& mlpack::bound::HRectBound< Power, TakeRoot >::operator= ( const HRectBound< Power, TakeRoot > &  other)

Same as copy constructor; necessary to prevent memory leaks.

template<int Power = 2, bool TakeRoot = true>
math::Range& mlpack::bound::HRectBound< Power, TakeRoot >::operator[] ( const size_t  i)
inline

Get the range for a particular dimension.

No bounds checking. Be careful: this may make MinWidth() invalid.

Definition at line 80 of file hrectbound.hpp.

References mlpack::bound::HRectBound< Power, TakeRoot >::bounds.

template<int Power = 2, bool TakeRoot = true>
const math::Range& mlpack::bound::HRectBound< Power, TakeRoot >::operator[] ( const size_t  i) const
inline

Modify the range for a particular dimension. No bounds checking.

Definition at line 82 of file hrectbound.hpp.

References mlpack::bound::HRectBound< Power, TakeRoot >::bounds.

template<int Power = 2, bool TakeRoot = true>
template<typename MatType >
HRectBound& mlpack::bound::HRectBound< Power, TakeRoot >::operator|= ( const MatType &  data)

Expands this region to include new points.

Template Parameters
MatTypeType of matrix; could be Mat, SpMat, a subview, or just a vector.
Parameters
dataData points to expand this region to include.
template<int Power = 2, bool TakeRoot = true>
HRectBound& mlpack::bound::HRectBound< Power, TakeRoot >::operator|= ( const HRectBound< Power, TakeRoot > &  other)

Expands this region to encompass another bound.

template<int Power = 2, bool TakeRoot = true>
math::Range mlpack::bound::HRectBound< Power, TakeRoot >::RangeDistance ( const HRectBound< Power, TakeRoot > &  other) const

Calculates minimum and maximum bound-to-bound distance.

Parameters
otherBound to which the minimum and maximum distances are requested.
template<int Power = 2, bool TakeRoot = true>
template<typename VecType >
math::Range mlpack::bound::HRectBound< Power, TakeRoot >::RangeDistance ( const VecType &  point,
typename boost::enable_if< IsVector< VecType > > *  = 0 
) const

Calculates minimum and maximum bound-to-point distance.

Parameters
pointPoint to which the minimum and maximum distances are requested.
template<int Power = 2, bool TakeRoot = true>
std::string mlpack::bound::HRectBound< Power, TakeRoot >::ToString ( ) const

Returns a string representation of this object.

Member Data Documentation

template<int Power = 2, bool TakeRoot = true>
math::Range* mlpack::bound::HRectBound< Power, TakeRoot >::bounds
private

The bounds for each dimension.

Definition at line 189 of file hrectbound.hpp.

Referenced by mlpack::bound::HRectBound< Power, TakeRoot >::operator[]().

template<int Power = 2, bool TakeRoot = true>
size_t mlpack::bound::HRectBound< Power, TakeRoot >::dim
private

The dimensionality of the bound.

Definition at line 187 of file hrectbound.hpp.

Referenced by mlpack::bound::HRectBound< Power, TakeRoot >::Dim().

template<int Power = 2, bool TakeRoot = true>
double mlpack::bound::HRectBound< Power, TakeRoot >::minWidth
private

Cached minimum width of bound.

Definition at line 191 of file hrectbound.hpp.

Referenced by mlpack::bound::HRectBound< Power, TakeRoot >::MinWidth().


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