BiSearchVisitor< SortPolicy > Class Template Reference

BiSearchVisitor executes a bichromatic neighbor search on the given NSType. More...

Inheritance diagram for BiSearchVisitor< SortPolicy >:

Public Types

template
<
template
<
typename
TreeMetricType
,
typename
TreeStatType
,
typename
TreeMatType
>
class
TreeType
>
using NSTypeT = NSType< SortPolicy, TreeType >
 Alias template necessary for visual c++ compiler. More...

 
template
<
template
<
typename
TreeMetricType
,
typename
TreeStatType
,
typename
TreeMatType
>
class
TreeType
>
using RATypeT = RAType< SortPolicy, TreeType >
 Alias template necessary for visual c++ compiler. More...

 

Public Member Functions

 BiSearchVisitor (const arma::mat &querySet, const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances, const size_t leafSize)
 Construct the BiSearchVisitor. More...

 
 BiSearchVisitor (const arma::mat &querySet, const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances, const size_t leafSize, const double tau, const double rho)
 Construct the BiSearchVisitor. More...

 
template
<
template
<
typename
TreeMetricType
,
typename
TreeStatType
,
typename
TreeMatType
>
class
TreeType
>
void operator() (RATypeT< TreeType > *ra) const
 Default Bichromatic neighbor search on the given RAType instance. More...

 
void operator() (RATypeT< tree::KDTree > *ra) const
 Bichromatic search on the given RAType specialized for KDTrees. More...

 
void operator() (RATypeT< tree::Octree > *ra) const
 Bichromatic search on the given RAType specialized for octrees. More...

 
template
<
template
<
typename
TreeMetricType
,
typename
TreeStatType
,
typename
TreeMatType
>
class
TreeType
>
void operator() (NSTypeT< TreeType > *ns) const
 Default Bichromatic neighbor search on the given NSType instance. More...

 
void operator() (NSTypeT< tree::KDTree > *ns) const
 Bichromatic neighbor search on the given NSType specialized for KDTrees. More...

 
void operator() (NSTypeT< tree::BallTree > *ns) const
 Bichromatic neighbor search on the given NSType specialized for BallTrees. More...

 
void operator() (SpillKNN *ns) const
 Bichromatic neighbor search specialized for SPTrees. More...

 
void operator() (NSTypeT< tree::Octree > *ns) const
 Bichromatic neighbor search specialized for octrees. More...

 

Detailed Description


template
<
typename
SortPolicy
>

class mlpack::neighbor::BiSearchVisitor< SortPolicy >

BiSearchVisitor executes a bichromatic neighbor search on the given NSType.

BiSearchVisitor executes a bichromatic neighbor search on the given RAType.

We use template specialization to differentiate those tree types that accept leafSize as a parameter. In these cases, before doing neighbor search, a query tree with proper leafSize is built from the querySet.

We use template specialization to differentiate those tree types types that accept leafSize as a parameter. In these cases, before doing neighbor search a query tree with proper leafSize is built from the querySet.

Definition at line 80 of file ns_model.hpp.

Member Typedef Documentation

◆ NSTypeT

using NSTypeT = NSType<SortPolicy, TreeType>

Alias template necessary for visual c++ compiler.

Definition at line 107 of file ns_model.hpp.

◆ RATypeT

using RATypeT = RAType<SortPolicy, TreeType>

Alias template necessary for visual c++ compiler.

Definition at line 98 of file ra_model.hpp.

Constructor & Destructor Documentation

◆ BiSearchVisitor() [1/2]

BiSearchVisitor ( const arma::mat &  querySet,
const size_t  k,
arma::Mat< size_t > &  neighbors,
arma::mat &  distances,
const size_t  leafSize,
const double  tau,
const double  rho 
)

Construct the BiSearchVisitor.

◆ BiSearchVisitor() [2/2]

BiSearchVisitor ( const arma::mat &  querySet,
const size_t  k,
arma::Mat< size_t > &  neighbors,
arma::mat &  distances,
const size_t  leafSize 
)

Construct the BiSearchVisitor.

Member Function Documentation

◆ operator()() [1/8]

void operator() ( RATypeT< TreeType > *  ra) const

Default Bichromatic neighbor search on the given RAType instance.

◆ operator()() [2/8]

void operator() ( RATypeT< tree::KDTree > *  ra) const

Bichromatic search on the given RAType specialized for KDTrees.

◆ operator()() [3/8]

void operator() ( RATypeT< tree::Octree > *  ra) const

Bichromatic search on the given RAType specialized for octrees.

◆ operator()() [4/8]

void operator() ( NSTypeT< TreeType > *  ns) const

Default Bichromatic neighbor search on the given NSType instance.

◆ operator()() [5/8]

void operator() ( NSTypeT< tree::KDTree > *  ns) const

Bichromatic neighbor search on the given NSType specialized for KDTrees.

◆ operator()() [6/8]

void operator() ( NSTypeT< tree::BallTree > *  ns) const

Bichromatic neighbor search on the given NSType specialized for BallTrees.

◆ operator()() [7/8]

void operator() ( SpillKNN ns) const

Bichromatic neighbor search specialized for SPTrees.

◆ operator()() [8/8]

void operator() ( NSTypeT< tree::Octree > *  ns) const

Bichromatic neighbor search specialized for octrees.


The documentation for this class was generated from the following files:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/neighbor_search/ns_model.hpp
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/rann/ra_model.hpp