SpillNSWrapper< SortPolicy > Class Template Reference

The SpillNSWrapper class wraps the NeighborSearch class when the spill tree is used. More...

Inheritance diagram for SpillNSWrapper< SortPolicy >:

Public Member Functions

 SpillNSWrapper (const NeighborSearchMode searchMode, const double epsilon)
 Construct the SpillNSWrapper. More...

 
virtual ~SpillNSWrapper ()
 Destruct the SpillNSWrapper. More...

 
virtual SpillNSWrapperClone () const
 Return a copy of the SpillNSWrapper. More...

 
virtual void Search (arma::mat &&querySet, const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances, const size_t leafSize, const double rho)
 Perform bichromatic search (i.e. More...

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

 
virtual void Train (arma::mat &&referenceSet, const size_t leafSize, const double tau, const double rho)
 Train the model using the given parameters. More...

 
- Public Member Functions inherited from NSWrapper< SortPolicy, tree::SPTree, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistDualTreeTraverser, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistSingleTreeTraverser >
 NSWrapper (const NeighborSearchMode searchMode, const double epsilon)
 Construct the NSWrapper object, initializing the internally-held NeighborSearch object. More...

 
virtual ~NSWrapper ()
 Delete the NSWrapper object. More...

 
const arma::mat & Dataset () const
 Get a reference to the reference set. More...

 
double Epsilon () const
 Get epsilon, the approximation parameter. More...

 
double & Epsilon ()
 Modify epsilon, the approximation parameter. More...

 
virtual void Search (const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances)
 Perform monochromatic neighbor search (i.e. More...

 
NeighborSearchMode SearchMode () const
 Get the search mode. More...

 
NeighborSearchModeSearchMode ()
 Modify the search mode. More...

 
void serialize (Archive &ar, const uint32_t)
 Serialize the NeighborSearch model. More...

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

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

 

Additional Inherited Members

- Protected Types inherited from NSWrapper< SortPolicy, tree::SPTree, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistDualTreeTraverser, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistSingleTreeTraverser >
typedef NeighborSearch< SortPolicy, metric::EuclideanDistance, arma::mat, tree::SPTree, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistDualTreeTraverser, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistSingleTreeTraverser > NSType
 
- Protected Attributes inherited from NSWrapper< SortPolicy, tree::SPTree, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistDualTreeTraverser, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistSingleTreeTraverser >
NSType ns
 The instantiated NeighborSearch object that we are wrapping. More...

 

Detailed Description


template
<
typename
SortPolicy
>

class mlpack::neighbor::SpillNSWrapper< SortPolicy >

The SpillNSWrapper class wraps the NeighborSearch class when the spill tree is used.

Definition at line 253 of file ns_model.hpp.

Constructor & Destructor Documentation

◆ SpillNSWrapper()

SpillNSWrapper ( const NeighborSearchMode  searchMode,
const double  epsilon 
)
inline

Construct the SpillNSWrapper.

Definition at line 266 of file ns_model.hpp.

◆ ~SpillNSWrapper()

virtual ~SpillNSWrapper ( )
inlinevirtual

Destruct the SpillNSWrapper.

Definition at line 283 of file ns_model.hpp.

Member Function Documentation

◆ Clone()

◆ Search()

virtual void Search ( arma::mat &&  querySet,
const size_t  k,
arma::Mat< size_t > &  neighbors,
arma::mat &  distances,
const size_t  leafSize,
const double  rho 
)
virtual

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)
inline

Serialize the NeighborSearch model.

Definition at line 305 of file ns_model.hpp.

◆ Train()


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