NSWrapperBase Class Referenceabstract

NSWrapperBase is a base wrapper class for holding all NeighborSearch types supported by NSModel. More...

Inheritance diagram for NSWrapperBase:

Public Member Functions

 NSWrapperBase ()
 Create the NSWrapperBase object. More...

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

 
virtual NSWrapperBaseClone () const =0
 Create a new NSWrapperBase that is the same as this one. More...

 
virtual const arma::mat & Dataset () const =0
 Return a reference to the dataset. More...

 
virtual double Epsilon () const =0
 Get the approximation parameter epsilon. More...

 
virtual double & Epsilon ()=0
 Modify the approximation parameter epsilon. 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)=0
 Perform bichromatic neighbor search (i.e. More...

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

 
virtual NeighborSearchMode SearchMode () const =0
 Get the search mode. More...

 
virtual NeighborSearchModeSearchMode ()=0
 Modify the search modem. More...

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

 

Detailed Description

NSWrapperBase is a base wrapper class for holding all NeighborSearch types supported by NSModel.

All NeighborSearch type wrappers inherit from this class, allowing a simple interface via inheritance for all the different types we want to support.

Definition at line 35 of file ns_model.hpp.

Constructor & Destructor Documentation

◆ NSWrapperBase()

NSWrapperBase ( )
inline

Create the NSWrapperBase object.

The base class does not hold anything, so this constructor does not do anything.

Definition at line 40 of file ns_model.hpp.

References NSWrapperBase::Clone().

◆ ~NSWrapperBase()

virtual ~NSWrapperBase ( )
inlinevirtual

Member Function Documentation

◆ Clone()

◆ Dataset()

◆ Epsilon() [1/2]

◆ Epsilon() [2/2]

◆ Search() [1/2]

◆ Search() [2/2]

◆ SearchMode() [1/2]

◆ SearchMode() [2/2]

◆ 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