Hollow ball bound encloses a set of points at a specific distance (radius) from a specific point (center) except points at a specific distance from another point (the center of the hole). More...

Public Types
typedef TMetricType	MetricType
	A public version of the metric type. More...

Public Member Functions
	HollowBallBound ()
	Empty Constructor. More...

	HollowBallBound (const size_t dimension)
	Create the ball bound with the specified dimensionality. More...

template < typename VecType >
	HollowBallBound (const ElemType innerRadius, const ElemType outerRadius, const VecType &center)
	Create the ball bound with the specified radius and center. More...

	HollowBallBound (const HollowBallBound &other)
	Copy constructor. To prevent memory leaks. More...

	HollowBallBound (HollowBallBound &&other)
	Move constructor: take possession of another bound. More...

	~HollowBallBound ()
	Destructor to release allocated memory. More...

const arma::Col< ElemType > &	Center () const
	Get the center point of the ball. More...

arma::Col< ElemType > &	Center ()
	Modify the center point of the ball. More...

template < typename VecType >
void	Center (VecType &center) const
	Place the center of BallBound into the given vector. More...

template < typename VecType >
bool	Contains (const VecType &point) const
	Determines if a point is within this bound. More...

bool	Contains (const HollowBallBound &other) const
	Determines if another bound is within this bound. More...

ElemType	Diameter () const
	Returns the diameter of the ballbound. More...

size_t	Dim () const
	Get the dimensionality of the ball. More...

const arma::Col< ElemType > &	HollowCenter () const
	Get the center point of the hollow. More...

arma::Col< ElemType > &	HollowCenter ()
	Modify the center point of the hollow. More...

ElemType	InnerRadius () const
	Get the innner radius of the ball. More...

ElemType &	InnerRadius ()
	Modify the inner radius of the ball. More...

template < typename VecType >
ElemType	MaxDistance (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Computes maximum distance. More...

ElemType	MaxDistance (const HollowBallBound &other) const
	Computes maximum distance. More...

const MetricType &	Metric () const
	Returns the distance metric used in this bound. More...

MetricType &	Metric ()
	Modify the distance metric used in this bound. More...

template < typename VecType >
ElemType	MinDistance (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Calculates minimum bound-to-point squared distance. More...

ElemType	MinDistance (const HollowBallBound &other) const
	Calculates minimum bound-to-bound squared distance. More...

ElemType	MinWidth () const
	Get the minimum width of the bound (this is same as the diameter). More...

HollowBallBound &	operator= (const HollowBallBound &other)
	For the same reason as the copy constructor: to prevent memory leaks. More...

HollowBallBound &	operator= (HollowBallBound &&other)
	Move assignment operator. More...

math::RangeType< ElemType >	operator[] (const size_t i) const
	Get the range in a certain dimension. More...

template < typename MatType >
const HollowBallBound &	operator\|= (const MatType &data)
	Expand the bound to include the given point. More...

const HollowBallBound &	operator\|= (const HollowBallBound &other)
	Expand the bound to include the given bound. More...

ElemType	OuterRadius () const
	Get the outer radius of the ball. More...

ElemType &	OuterRadius ()
	Modify the outer radius of the ball. More...

template < typename VecType >
math::RangeType< ElemType >	RangeDistance (const VecType &other, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
	Calculates minimum and maximum bound-to-point distance. More...

math::RangeType< ElemType >	RangeDistance (const HollowBallBound &other) const
	Calculates minimum and maximum bound-to-bound distance. More...

template < typename Archive >
void	serialize (Archive &ar, const uint32_t version)
	Serialize the bound. More...

Detailed Description

template<typename TMetricType = metric::LMetric<2, true>, typename ElemType = double>
class mlpack::bound::HollowBallBound< TMetricType, ElemType >

Hollow ball bound encloses a set of points at a specific distance (radius) from a specific point (center) except points at a specific distance from another point (the center of the hole).

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

Template Parameters

TMetricType	metric type used in the distance measure.
ElemType	Type of element (float or double or similar).

Definition at line 33 of file hollow_ball_bound.hpp.

Member Typedef Documentation

◆ MetricType

typedef TMetricType MetricType

A public version of the metric type.

Definition at line 37 of file hollow_ball_bound.hpp.

Constructor & Destructor Documentation

◆ HollowBallBound() [1/5]

HollowBallBound ( )

Empty Constructor.

◆ HollowBallBound() [2/5]

HollowBallBound ( const size_t dimension )

Create the ball bound with the specified dimensionality.

Parameters

dimension Dimensionality of ball bound.

◆ HollowBallBound() [3/5]

HollowBallBound	(	const ElemType	innerRadius,
		const ElemType	outerRadius,
		const VecType &	center
	)

Create the ball bound with the specified radius and center.

Parameters

innerRadius	Inner radius of ball bound.
outerRadius	Outer radius of ball bound.
center	Center of ball bound.

◆ HollowBallBound() [4/5]

HollowBallBound ( const HollowBallBound< TMetricType, ElemType > & other )

Copy constructor. To prevent memory leaks.

◆ HollowBallBound() [5/5]

HollowBallBound ( HollowBallBound< TMetricType, ElemType > && other )

Move constructor: take possession of another bound.

◆ ~HollowBallBound()

~HollowBallBound ( )

Destructor to release allocated memory.

Member Function Documentation

◆ Center() [1/3]

const arma::Col<ElemType>& Center ( ) const

inline

Get the center point of the ball.

Definition at line 106 of file hollow_ball_bound.hpp.

◆ Center() [2/3]

arma::Col<ElemType>& Center ( )

inline

Modify the center point of the ball.

Definition at line 108 of file hollow_ball_bound.hpp.

◆ Center() [3/3]

void Center ( VecType & center ) const

inline

Place the center of BallBound into the given vector.

Parameters

center Vector which the centroid will be written to.

Definition at line 148 of file hollow_ball_bound.hpp.

References HollowBallBound< TMetricType, ElemType >::MaxDistance(), HollowBallBound< TMetricType, ElemType >::MinDistance(), HollowBallBound< TMetricType, ElemType >::operator|=(), and HollowBallBound< TMetricType, ElemType >::RangeDistance().

◆ Contains() [1/2]

bool Contains ( const VecType & point ) const

Determines if a point is within this bound.

Parameters

point Point to check the condition.

Referenced by HollowBallBound< TMetricType, ElemType >::MinWidth().

◆ Contains() [2/2]

bool Contains ( const HollowBallBound< TMetricType, ElemType > & other ) const

Determines if another bound is within this bound.

Parameters

other Bound to check the condition.

◆ Diameter()

ElemType Diameter ( ) const

inline

Returns the diameter of the ballbound.

Definition at line 229 of file hollow_ball_bound.hpp.

References RangeType< T >::Hi().

◆ Dim()

size_t Dim ( ) const

inline

Get the dimensionality of the ball.

Definition at line 116 of file hollow_ball_bound.hpp.

◆ HollowCenter() [1/2]

const arma::Col<ElemType>& HollowCenter ( ) const

inline

Get the center point of the hollow.

Definition at line 111 of file hollow_ball_bound.hpp.

◆ HollowCenter() [2/2]

arma::Col<ElemType>& HollowCenter ( )

inline

Modify the center point of the hollow.

Definition at line 113 of file hollow_ball_bound.hpp.

◆ InnerRadius() [1/2]

ElemType InnerRadius ( ) const

inline

Get the innner radius of the ball.

Definition at line 101 of file hollow_ball_bound.hpp.

References RangeType< T >::Lo().

◆ InnerRadius() [2/2]

ElemType& InnerRadius ( )

inline

Modify the inner radius of the ball.

Definition at line 103 of file hollow_ball_bound.hpp.

References RangeType< T >::Lo().

◆ MaxDistance() [1/2]

ElemType MaxDistance	(	const VecType &	point,
		typename std::enable_if_t< IsVector< VecType >::value > *	= `0`
	)		const

Computes maximum distance.

Parameters

point Point to which the maximum distance is requested.

Referenced by HollowBallBound< TMetricType, ElemType >::Center().

◆ MaxDistance() [2/2]

ElemType MaxDistance ( const HollowBallBound< TMetricType, ElemType > & other ) const

Computes maximum distance.

Parameters

other Bound to which the maximum distance is requested.

◆ Metric() [1/2]

const MetricType& Metric ( ) const

inline

Returns the distance metric used in this bound.

Definition at line 232 of file hollow_ball_bound.hpp.

◆ Metric() [2/2]

MetricType& Metric ( )

inline

Modify the distance metric used in this bound.

Definition at line 234 of file hollow_ball_bound.hpp.

References HollowBallBound< TMetricType, ElemType >::serialize().

◆ MinDistance() [1/2]

ElemType MinDistance	(	const VecType &	point,
		typename std::enable_if_t< IsVector< VecType >::value > *	= `0`
	)		const

Calculates minimum bound-to-point squared distance.

Parameters

point Point to which the minimum distance is requested.

Referenced by HollowBallBound< TMetricType, ElemType >::Center().

◆ MinDistance() [2/2]

ElemType MinDistance ( const HollowBallBound< TMetricType, ElemType > & other ) const

Calculates minimum bound-to-bound squared distance.

Parameters

other Bound to which the minimum distance is requested.

◆ MinWidth()

ElemType 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 122 of file hollow_ball_bound.hpp.

References HollowBallBound< TMetricType, ElemType >::Contains(), RangeType< T >::Hi(), and HollowBallBound< TMetricType, ElemType >::operator[]().

◆ operator=() [1/2]

HollowBallBound& operator= ( const HollowBallBound< TMetricType, ElemType > & other )

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

◆ operator=() [2/2]

HollowBallBound& operator= ( HollowBallBound< TMetricType, ElemType > && other )

Move assignment operator.

◆ operator[]()

math::RangeType<ElemType> operator[] ( const size_t i ) const

Get the range in a certain dimension.

Referenced by HollowBallBound< TMetricType, ElemType >::MinWidth().

◆ operator|=() [1/2]

const HollowBallBound& operator|= ( const MatType & data )

Expand the bound to include the given point.

The centroid will not be moved.

Template Parameters

MatType	Type of matrix; could be arma::mat, arma::spmat, or a vector.
data	Data points to add.

Referenced by HollowBallBound< TMetricType, ElemType >::Center().

◆ operator|=() [2/2]

const HollowBallBound& operator|= ( const HollowBallBound< TMetricType, ElemType > & other )

Expand the bound to include the given bound.

The centroid will not be moved.

Template Parameters

MatType	Type of matrix; could be arma::mat, arma::spmat, or a vector.
data	Data points to add.

◆ OuterRadius() [1/2]

ElemType OuterRadius ( ) const

inline

Get the outer radius of the ball.

Definition at line 96 of file hollow_ball_bound.hpp.

References RangeType< T >::Hi().

◆ OuterRadius() [2/2]

ElemType& OuterRadius ( )

inline

Modify the outer radius of the ball.

Definition at line 98 of file hollow_ball_bound.hpp.

References RangeType< T >::Hi().

◆ RangeDistance() [1/2]

math::RangeType<ElemType> RangeDistance	(	const VecType &	other,
		typename std::enable_if_t< IsVector< VecType >::value > *	= `0`
	)		const

Calculates minimum and maximum bound-to-point distance.

Parameters

other Point to which the minimum and maximum distances are requested.

Referenced by HollowBallBound< TMetricType, ElemType >::Center().

◆ RangeDistance() [2/2]

math::RangeType<ElemType> RangeDistance ( const HollowBallBound< TMetricType, ElemType > & other ) const

Calculates minimum and maximum bound-to-bound distance.

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

Parameters

other Bound to which the minimum and maximum distances are requested.

◆ serialize()

void serialize	(	Archive &	ar,
		const uint32_t	version
	)

Serialize the bound.

Referenced by HollowBallBound< TMetricType, ElemType >::Metric().

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

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/core/tree/hollow_ball_bound.hpp

Public Types

Public Member Functions

Detailed Description

template<typename TMetricType = metric::LMetric<2, true>, typename ElemType = double> class mlpack::bound::HollowBallBound< TMetricType, ElemType >

Member Typedef Documentation

◆ MetricType

Constructor & Destructor Documentation

◆ HollowBallBound() [1/5]

◆ HollowBallBound() [2/5]

◆ HollowBallBound() [3/5]

◆ HollowBallBound() [4/5]

◆ HollowBallBound() [5/5]

◆ ~HollowBallBound()

Member Function Documentation

◆ Center() [1/3]

◆ Center() [2/3]

◆ Center() [3/3]

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ Diameter()

◆ Dim()

◆ HollowCenter() [1/2]

◆ HollowCenter() [2/2]

◆ InnerRadius() [1/2]

◆ InnerRadius() [2/2]

◆ MaxDistance() [1/2]

◆ MaxDistance() [2/2]

◆ Metric() [1/2]

◆ Metric() [2/2]

◆ MinDistance() [1/2]

◆ MinDistance() [2/2]

◆ MinWidth()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]()

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ OuterRadius() [1/2]

◆ OuterRadius() [2/2]

◆ RangeDistance() [1/2]

◆ RangeDistance() [2/2]

◆ serialize()

template<typename TMetricType = metric::LMetric<2, true>, typename ElemType = double>
class mlpack::bound::HollowBallBound< TMetricType, ElemType >