LeafSizeRSWrapper< TreeType > Class Template Reference

Forward declaration. More...

Inheritance diagram for LeafSizeRSWrapper< TreeType >:

Public Member Functions

 LeafSizeRSWrapper (const bool singleMode, const bool naive)
 Construct the LeafSizeRSWrapper by delegating to the RSWrapper constructor. More...

 
virtual ~LeafSizeRSWrapper ()
 Delete the LeafSizeRSWrapper. More...

 
virtual LeafSizeRSWrapperClone () const
 Return a copy of the LeafSizeRSWrapper. More...

 
virtual void Search (arma::mat &&querySet, const math::Range &range, std::vector< std::vector< size_t >> &neighbors, std::vector< std::vector< double >> &distances, const size_t leafSize)
 Perform bichromatic search (e.g. More...

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

 
virtual void Train (arma::mat &&referenceSet, const size_t leafSize)
 Train a model with the given parameters. This overload uses leafSize. More...

 
- Public Member Functions inherited from RSWrapper< TreeType >
 RSWrapper (const bool singleMode, const bool naive)
 Create the RSWrapper object. More...

 
virtual ~RSWrapper ()
 Destruct the RSWrapper (nothing to do). More...

 
const arma::mat & Dataset () const
 Get the dataset. More...

 
bool Naive () const
 Get whether naive search is being used. More...

 
bool & Naive ()
 Modify whether naive search is being used. More...

 
virtual void Search (const math::Range &range, std::vector< std::vector< size_t >> &neighbors, std::vector< std::vector< double >> &distances)
 Perform monochromatic range search (i.e. More...

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

 
bool SingleMode () const
 Get whether single-tree search is being used. More...

 
bool & SingleMode ()
 Modify whether single-tree search is being used. More...

 
- Public Member Functions inherited from RSWrapperBase
 RSWrapperBase ()
 Create the RSWrapperBase object. More...

 
virtual ~RSWrapperBase ()
 Destruct the RSWrapperBase (nothing to do). More...

 

Additional Inherited Members

- Protected Types inherited from RSWrapper< TreeType >
typedef RangeSearch< metric::EuclideanDistance, arma::mat, TreeType > RSType
 
- Protected Attributes inherited from RSWrapper< TreeType >
RSType rs
 The instantiated RangeSearch object that we are wrapping. More...

 

Detailed Description


template
<
template
<
typename
TreeMetricType
,
typename
TreeStatType
,
typename
TreeMatType
>
class
TreeType
>

class mlpack::range::LeafSizeRSWrapper< TreeType >

Forward declaration.

LeafSizeRSWrapper wraps any RangeSearch type that needs to be able to take the leaf size into account when building trees.

The implementations of Train() and bichromatic Search() take this leaf size into account.

Definition at line 28 of file range_search.hpp.

Constructor & Destructor Documentation

◆ LeafSizeRSWrapper()

LeafSizeRSWrapper ( const bool  singleMode,
const bool  naive 
)
inline

Construct the LeafSizeRSWrapper by delegating to the RSWrapper constructor.

Definition at line 162 of file rs_model.hpp.

◆ ~LeafSizeRSWrapper()

virtual ~LeafSizeRSWrapper ( )
inlinevirtual

Delete the LeafSizeRSWrapper.

Definition at line 169 of file rs_model.hpp.

Member Function Documentation

◆ Clone()

virtual LeafSizeRSWrapper* Clone ( ) const
inlinevirtual

Return a copy of the LeafSizeRSWrapper.

Reimplemented from RSWrapper< TreeType >.

Definition at line 172 of file rs_model.hpp.

References RSWrapperBase::Search(), and RSWrapperBase::Train().

◆ Search()

virtual void Search ( arma::mat &&  querySet,
const math::Range range,
std::vector< std::vector< size_t >> &  neighbors,
std::vector< std::vector< double >> &  distances,
const size_t  leafSize 
)
virtual

Perform bichromatic search (e.g.

search with a separate query set). This overload takes the leaf size into account when building the query tree.

Reimplemented from RSWrapper< TreeType >.

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)
inline

Serialize the RangeSearch model.

Definition at line 191 of file rs_model.hpp.

◆ Train()

virtual void Train ( arma::mat &&  referenceSet,
const size_t  leafSize 
)
virtual

Train a model with the given parameters. This overload uses leafSize.

Reimplemented from RSWrapper< TreeType >.


The documentation for this class was generated from the following files:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/methods/range_search/range_search.hpp
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/methods/range_search/rs_model.hpp