mlpack
Public Member Functions | List of all members
mlpack::tree::AxisParallelProjVector Class Reference

AxisParallelProjVector defines an axis-parallel projection vector. More...

#include <projection_vector.hpp>

Public Member Functions

 AxisParallelProjVector (size_t dim=0)
 Create the projection vector based on the specified dimension. More...
 
template<typename VecType >
double Project (const VecType &point, typename std::enable_if_t< IsVector< VecType >::value > *=0) const
 Project the given point on the projection vector. More...
 
template<typename MetricType , typename ElemType >
math::RangeType< ElemType > Project (const bound::HRectBound< MetricType, ElemType > &bound) const
 Project the given hrect bound on the projection vector. More...
 
template<typename MetricType , typename VecType >
math::RangeType< typename VecType::elem_type > Project (const bound::BallBound< MetricType, VecType > &bound) const
 Project the given ball bound on the projection vector. More...
 
template<typename Archive >
void serialize (Archive &ar, const uint32_t)
 Serialization.
 

Detailed Description

AxisParallelProjVector defines an axis-parallel projection vector.

We can efficiently project points, simply analyzing a specific dimension.

Constructor & Destructor Documentation

◆ AxisParallelProjVector()

mlpack::tree::AxisParallelProjVector::AxisParallelProjVector ( size_t  dim = 0)
inline

Create the projection vector based on the specified dimension.

Parameters
dimDimension to be considered.

Member Function Documentation

◆ Project() [1/3]

template<typename VecType >
double mlpack::tree::AxisParallelProjVector::Project ( const VecType &  point,
typename std::enable_if_t< IsVector< VecType >::value > *  = 0 
) const
inline

Project the given point on the projection vector.

Parameters
pointPoint to be projected.

◆ Project() [2/3]

template<typename MetricType , typename ElemType >
math::RangeType<ElemType> mlpack::tree::AxisParallelProjVector::Project ( const bound::HRectBound< MetricType, ElemType > &  bound) const
inline

Project the given hrect bound on the projection vector.

Parameters
boundBound to be projected.
Returns
Range of projected values.

◆ Project() [3/3]

template<typename MetricType , typename VecType >
math::RangeType<typename VecType::elem_type> mlpack::tree::AxisParallelProjVector::Project ( const bound::BallBound< MetricType, VecType > &  bound) const
inline

Project the given ball bound on the projection vector.

Parameters
boundBound to be projected.
Returns
Range of projected values.

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