mlpack  2.0.1
Public Types | Public Member Functions | Private Attributes | List of all members
mlpack::bound::BallBound< VecType, TMetricType > Class Template Reference

Ball bound encloses a set of points at a specific distance (radius) from a specific point (center). More...

Public Types

typedef TMetricType MetricType
 Needed for BinarySpaceTree. More...
 
typedef VecType Vec
 

Public Member Functions

 BallBound ()
 Empty Constructor. More...
 
 BallBound (const size_t dimension)
 Create the ball bound with the specified dimensionality. More...
 
 BallBound (const double radius, const VecType &center)
 Create the ball bound with the specified radius and center. More...
 
 BallBound (const BallBound &other)
 Copy constructor. To prevent memory leaks. More...
 
 BallBound (BallBound &&other)
 Move constructor: take possession of another bound. More...
 
 ~BallBound ()
 Destructor to release allocated memory. More...
 
const VecType & Center () const
 Get the center point of the ball. More...
 
VecType & Center ()
 Modify the center point of the ball. More...
 
void Center (VecType &center) const
 Place the center of BallBound into the given vector. More...
 
bool Contains (const VecType &point) const
 Determines if a point is within this bound. More...
 
double Diameter () const
 Returns the diameter of the ballbound. More...
 
double Dim () const
 Get the dimensionality of the ball. More...
 
template<typename OtherVecType >
double MaxDistance (const OtherVecType &point, typename boost::enable_if< IsVector< OtherVecType > > *=0) const
 Computes maximum distance. More...
 
double MaxDistance (const BallBound &other) const
 Computes maximum distance. More...
 
const TMetricType & Metric () const
 Returns the distance metric used in this bound. More...
 
TMetricType & Metric ()
 Modify the distance metric used in this bound. More...
 
template<typename OtherVecType >
double MinDistance (const OtherVecType &point, typename boost::enable_if< IsVector< OtherVecType > > *=0) const
 Calculates minimum bound-to-point squared distance. More...
 
double MinDistance (const BallBound &other) const
 Calculates minimum bound-to-bound squared distance. More...
 
double MinWidth () const
 Get the minimum width of the bound (this is same as the diameter). More...
 
BallBoundoperator= (const BallBound &other)
 For the same reason as the copy constructor: to prevent memory leaks. More...
 
math::Range operator[] (const size_t i) const
 Get the range in a certain dimension. More...
 
const BallBoundoperator|= (const BallBound &other)
 Expand the bound to include the given node. More...
 
template<typename MatType >
const BallBoundoperator|= (const MatType &data)
 Expand the bound to include the given point. More...
 
double Radius () const
 Get the radius of the ball. More...
 
double & Radius ()
 Modify the radius of the ball. More...
 
template<typename OtherVecType >
math::Range RangeDistance (const OtherVecType &other, typename boost::enable_if< IsVector< OtherVecType > > *=0) const
 Calculates minimum and maximum bound-to-point distance. More...
 
math::Range RangeDistance (const BallBound &other) const
 Calculates minimum and maximum bound-to-bound distance. More...
 
template<typename Archive >
void Serialize (Archive &ar, const unsigned int version)
 Serialize the bound. More...
 

Private Attributes

VecType center
 The center of the ball bound. More...
 
TMetricType * metric
 The metric used in this bound. More...
 
bool ownsMetric
 To know whether this object allocated memory to the metric member variable. More...
 
double radius
 The radius of the ball bound. More...
 

Detailed Description

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
class mlpack::bound::BallBound< VecType, TMetricType >

Ball bound encloses a set of points at a specific distance (radius) from a specific point (center).

TMetricType is the custom metric type that defaults to the Euclidean (L2) distance.

Template Parameters
VecTypeType of vector (arma::vec or arma::sp_vec).
TMetricTypemetric type used in the distance measure.

Definition at line 34 of file ballbound.hpp.

Member Typedef Documentation

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
typedef TMetricType mlpack::bound::BallBound< VecType, TMetricType >::MetricType

Needed for BinarySpaceTree.

Definition at line 39 of file ballbound.hpp.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
typedef VecType mlpack::bound::BallBound< VecType, TMetricType >::Vec

Definition at line 37 of file ballbound.hpp.

Constructor & Destructor Documentation

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
mlpack::bound::BallBound< VecType, TMetricType >::BallBound ( )

Empty Constructor.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
mlpack::bound::BallBound< VecType, TMetricType >::BallBound ( const size_t  dimension)

Create the ball bound with the specified dimensionality.

Parameters
dimensionDimensionality of ball bound.
template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
mlpack::bound::BallBound< VecType, TMetricType >::BallBound ( const double  radius,
const VecType &  center 
)

Create the ball bound with the specified radius and center.

Parameters
radiusRadius of ball bound.
centerCenter of ball bound.
template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
mlpack::bound::BallBound< VecType, TMetricType >::BallBound ( const BallBound< VecType, TMetricType > &  other)

Copy constructor. To prevent memory leaks.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
mlpack::bound::BallBound< VecType, TMetricType >::BallBound ( BallBound< VecType, TMetricType > &&  other)

Move constructor: take possession of another bound.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
mlpack::bound::BallBound< VecType, TMetricType >::~BallBound ( )

Destructor to release allocated memory.

Member Function Documentation

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
const VecType& mlpack::bound::BallBound< VecType, TMetricType >::Center ( ) const
inline

Get the center point of the ball.

Definition at line 95 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::center.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
VecType& mlpack::bound::BallBound< VecType, TMetricType >::Center ( )
inline

Modify the center point of the ball.

Definition at line 97 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::center.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
void mlpack::bound::BallBound< VecType, TMetricType >::Center ( VecType &  center) const
inline

Place the center of BallBound into the given vector.

Parameters
centerVector which the centroid will be written to.

Definition at line 121 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::center.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
bool mlpack::bound::BallBound< VecType, TMetricType >::Contains ( const VecType &  point) const

Determines if a point is within this bound.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::Diameter ( ) const
inline

Returns the diameter of the ballbound.

Definition at line 183 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::radius.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::Dim ( ) const
inline

Get the dimensionality of the ball.

Definition at line 100 of file ballbound.hpp.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
template<typename OtherVecType >
double mlpack::bound::BallBound< VecType, TMetricType >::MaxDistance ( const OtherVecType &  point,
typename boost::enable_if< IsVector< OtherVecType > > *  = 0 
) const

Computes maximum distance.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::MaxDistance ( const BallBound< VecType, TMetricType > &  other) const

Computes maximum distance.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
const TMetricType& mlpack::bound::BallBound< VecType, TMetricType >::Metric ( ) const
inline

Returns the distance metric used in this bound.

Definition at line 186 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::metric.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
TMetricType& mlpack::bound::BallBound< VecType, TMetricType >::Metric ( )
inline

Modify the distance metric used in this bound.

Definition at line 188 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::metric.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
template<typename OtherVecType >
double mlpack::bound::BallBound< VecType, TMetricType >::MinDistance ( const OtherVecType &  point,
typename boost::enable_if< IsVector< OtherVecType > > *  = 0 
) const

Calculates minimum bound-to-point squared distance.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::MinDistance ( const BallBound< VecType, TMetricType > &  other) const

Calculates minimum bound-to-bound squared distance.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::MinWidth ( ) const
inline

Get the minimum width of the bound (this is same as the diameter).

For ball bounds, width along all dimensions remain same.

Definition at line 106 of file ballbound.hpp.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
BallBound& mlpack::bound::BallBound< VecType, TMetricType >::operator= ( const BallBound< VecType, TMetricType > &  other)

For the same reason as the copy constructor: to prevent memory leaks.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
math::Range mlpack::bound::BallBound< VecType, TMetricType >::operator[] ( const size_t  i) const

Get the range in a certain dimension.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
const BallBound& mlpack::bound::BallBound< VecType, TMetricType >::operator|= ( const BallBound< VecType, TMetricType > &  other)

Expand the bound to include the given node.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
template<typename MatType >
const BallBound& mlpack::bound::BallBound< VecType, TMetricType >::operator|= ( const MatType &  data)

Expand the bound to include the given point.

The centroid is recalculated to be the center of all of the given points.

Template Parameters
MatTypeType of matrix; could be arma::mat, arma::spmat, or a vector.
dataData points to add.
template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::Radius ( ) const
inline

Get the radius of the ball.

Definition at line 90 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::radius.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double& mlpack::bound::BallBound< VecType, TMetricType >::Radius ( )
inline

Modify the radius of the ball.

Definition at line 92 of file ballbound.hpp.

References mlpack::bound::BallBound< VecType, TMetricType >::radius.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
template<typename OtherVecType >
math::Range mlpack::bound::BallBound< VecType, TMetricType >::RangeDistance ( const OtherVecType &  other,
typename boost::enable_if< IsVector< OtherVecType > > *  = 0 
) const

Calculates minimum and maximum bound-to-point distance.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
math::Range mlpack::bound::BallBound< VecType, TMetricType >::RangeDistance ( const BallBound< VecType, TMetricType > &  other) const

Calculates minimum and maximum bound-to-bound distance.

Example: bound1.MinDistanceSq(other) for minimum distance.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
template<typename Archive >
void mlpack::bound::BallBound< VecType, TMetricType >::Serialize ( Archive &  ar,
const unsigned int  version 
)

Serialize the bound.

Member Data Documentation

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
VecType mlpack::bound::BallBound< VecType, TMetricType >::center
private

The center of the ball bound.

Definition at line 45 of file ballbound.hpp.

Referenced by mlpack::bound::BallBound< VecType, TMetricType >::Center().

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
TMetricType* mlpack::bound::BallBound< VecType, TMetricType >::metric
private

The metric used in this bound.

Definition at line 47 of file ballbound.hpp.

Referenced by mlpack::bound::BallBound< VecType, TMetricType >::Metric().

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
bool mlpack::bound::BallBound< VecType, TMetricType >::ownsMetric
private

To know whether this object allocated memory to the metric member variable.

This will be true except in the copy constructor and the overloaded assignment operator. We need this to know whether we should delete the metric member variable in the destructor.

Definition at line 55 of file ballbound.hpp.

template<typename VecType = arma::vec, typename TMetricType = metric::LMetric<2, true>>
double mlpack::bound::BallBound< VecType, TMetricType >::radius
private

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