HyperplaneBase defines a splitting hyperplane based on a projection vector and projection value.
More...
|
| HyperplaneBase () |
| Empty Constructor. More...
|
|
| HyperplaneBase (const ProjVectorType &projVect, double splitVal) |
| Create the hyperplane with the specified projection vector and split value. More...
|
|
template<typename VecType > |
bool | Left (const VecType &point, typename boost::enable_if< IsVector< VecType > >::type *=0) const |
| Determine if the given point is to the left of the hyperplane, this means if the projection over the projection vector is negative or zero. More...
|
|
bool | Left (const BoundType &bound) const |
| Determine if the given bound is to the left of the hyperplane. More...
|
|
template<typename VecType > |
double | Project (const VecType &point, typename boost::enable_if< IsVector< VecType > >::type *=0) const |
| Project the given point on the projection vector and subtract the split value. More...
|
|
template<typename VecType > |
bool | Right (const VecType &point, typename boost::enable_if< IsVector< VecType > >::type *=0) const |
| Determine if the given point is to the right of the hyperplane, this means if the projection over the projection vector is positive. More...
|
|
bool | Right (const BoundType &bound) const |
| Determine if the given bound is to the right of the hyperplane. More...
|
|
template<typename Archive > |
void | Serialize (Archive &ar, const unsigned int) |
| Serialization. More...
|
|
template<typename BoundT, typename ProjVectorT>
class mlpack::tree::HyperplaneBase< BoundT, ProjVectorT >
HyperplaneBase defines a splitting hyperplane based on a projection vector and projection value.
- Template Parameters
-
Definition at line 30 of file hyperplane.hpp.
◆ BoundType
Useful typedef for the bound type.
Definition at line 34 of file hyperplane.hpp.
◆ ProjVectorType
Useful typedef for the projection vector type.
Definition at line 36 of file hyperplane.hpp.
◆ HyperplaneBase() [1/2]
Empty Constructor.
By default will consider all points to the left.
Definition at line 49 of file hyperplane.hpp.
◆ HyperplaneBase() [2/2]
Create the hyperplane with the specified projection vector and split value.
- Parameters
-
projVect | Projection vector. |
splitVal | Split value. |
Definition at line 59 of file hyperplane.hpp.
◆ Left() [1/2]
bool Left |
( |
const VecType & |
point, |
|
|
typename boost::enable_if< IsVector< VecType > >::type * |
= 0 |
|
) |
| const |
|
inline |
◆ Left() [2/2]
Determine if the given bound is to the left of the hyperplane.
- Parameters
-
point | Bound to be analyzed. |
Definition at line 110 of file hyperplane.hpp.
◆ Project()
double Project |
( |
const VecType & |
point, |
|
|
typename boost::enable_if< IsVector< VecType > >::type * |
= 0 |
|
) |
| const |
|
inline |
◆ Right() [1/2]
bool Right |
( |
const VecType & |
point, |
|
|
typename boost::enable_if< IsVector< VecType > >::type * |
= 0 |
|
) |
| const |
|
inline |
◆ Right() [2/2]
Determine if the given bound is to the right of the hyperplane.
- Parameters
-
point | Bound to be analyzed. |
Definition at line 122 of file hyperplane.hpp.
◆ Serialize()
void Serialize |
( |
Archive & |
ar, |
|
|
const unsigned |
int |
|
) |
| |
|
inline |
The documentation for this class was generated from the following file: