diff --git a/src/mlpack/core/tree/ballbound.hpp b/src/mlpack/core/tree/ballbound.hpp index 0e33bb63ef..ee03f7a6ae 100644 --- a/src/mlpack/core/tree/ballbound.hpp +++ b/src/mlpack/core/tree/ballbound.hpp @@ -108,6 +108,8 @@ class BallBound /** * Determines if a point is within this bound. + * + * @param point Point to check the condition. */ bool Contains(const VecType& point) const; @@ -120,6 +122,8 @@ class BallBound /** * Calculates minimum bound-to-point squared distance. + * + * @param point Point to which the minimum distance is requested. */ template ElemType MinDistance( @@ -128,11 +132,15 @@ class BallBound /** * Calculates minimum bound-to-bound squared distance. + * + * @param other Bound to which the minimum distance is requested. */ ElemType MinDistance(const BallBound& other) const; /** * Computes maximum distance. + * + * @param point Point to which the maximum distance is requested. */ template ElemType MaxDistance( @@ -141,11 +149,16 @@ class BallBound /** * Computes maximum distance. + * + * @param other Bound to which the maximum distance is requested. */ ElemType MaxDistance(const BallBound& other) const; /** * Calculates minimum and maximum bound-to-point distance. + * + * @param point Point to which the minimum and maximum distances are + * requested. */ template math::RangeType RangeDistance( @@ -156,6 +169,9 @@ class BallBound * Calculates minimum and maximum bound-to-bound distance. * * Example: bound1.MinDistanceSq(other) for minimum distance. + * + * @param other Bound to which the minimum and maximum distances are + * requested. */ math::RangeType RangeDistance(const BallBound& other) const; diff --git a/src/mlpack/core/tree/cellbound.hpp b/src/mlpack/core/tree/cellbound.hpp index ec9eeeead2..af633bd2fe 100644 --- a/src/mlpack/core/tree/cellbound.hpp +++ b/src/mlpack/core/tree/cellbound.hpp @@ -89,6 +89,8 @@ class CellBound /** * Initializes to specified dimensionality with each dimension the empty * set. + * + * @param dimension Dimensionality of bound. */ CellBound(const size_t dimension); @@ -219,11 +221,15 @@ class CellBound /** * Expands this region to encompass another bound. + * + * @param other Bound which needs to be encompassed. */ CellBound& operator|=(const CellBound& other); /** * Determines if a point is within this bound. + * + * @param point Point to check the condition. */ template bool Contains(const VecType& point) const; diff --git a/src/mlpack/core/tree/hollow_ball_bound.hpp b/src/mlpack/core/tree/hollow_ball_bound.hpp index 9c6e210e22..72834fbff3 100644 --- a/src/mlpack/core/tree/hollow_ball_bound.hpp +++ b/src/mlpack/core/tree/hollow_ball_bound.hpp @@ -123,12 +123,16 @@ class HollowBallBound /** * Determines if a point is within this bound. + * + * @param point Point to check the condition. */ template bool Contains(const VecType& point) const; /** * Determines if another bound is within this bound. + * + * @param other Bound to check the condition. */ bool Contains(const HollowBallBound& other) const; @@ -141,7 +145,9 @@ class HollowBallBound void Center(VecType& center) const { center = this->center; } /** - * Calculates minimum bound-to-point squared distance. + * Calculates minimum bound-to-point squared distance + *. + * @param point Point to which the minimum distance is requested. */ template ElemType MinDistance(const VecType& point, @@ -150,11 +156,15 @@ class HollowBallBound /** * Calculates minimum bound-to-bound squared distance. + * + * @param other Bound to which the minimum distance is requested. */ ElemType MinDistance(const HollowBallBound& other) const; /** * Computes maximum distance. + * + * @param point Point to which the maximum distance is requested. */ template ElemType MaxDistance(const VecType& point, @@ -163,11 +173,16 @@ class HollowBallBound /** * Computes maximum distance. + * + * @param other Bound to which the maximum distance is requested. */ ElemType MaxDistance(const HollowBallBound& other) const; /** * Calculates minimum and maximum bound-to-point distance. + * + * @param point Point to which the minimum and maximum distances are + * requested. */ template math::RangeType RangeDistance( @@ -178,6 +193,9 @@ class HollowBallBound * Calculates minimum and maximum bound-to-bound distance. * * Example: bound1.MinDistanceSq(other) for minimum distance. + * + * @param other Bound to which the minimum and maximum distances are + * requested. */ math::RangeType RangeDistance(const HollowBallBound& other) const; diff --git a/src/mlpack/core/tree/hrectbound.hpp b/src/mlpack/core/tree/hrectbound.hpp index b5bafa5bc4..4f96ca5888 100644 --- a/src/mlpack/core/tree/hrectbound.hpp +++ b/src/mlpack/core/tree/hrectbound.hpp @@ -66,6 +66,8 @@ class HRectBound /** * Initializes to specified dimensionality with each dimension the empty * set. + * + * @param dimension Dimensionality of bound. */ HRectBound(const size_t dimension); @@ -190,12 +192,16 @@ class HRectBound /** * Determines if a point is within this bound. + * + * @param point Point to check the condition. */ template bool Contains(const VecType& point) const; /** * Determines if this bound partially contains a bound. + * + * @param other Bound to check the condition. */ bool Contains(const HRectBound& bound) const;