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

#include <ns_model.hpp>

Inheritance diagram for mlpack::neighbor::SpillNSWrapper< SortPolicy >:

Collaboration diagram for mlpack::neighbor::SpillNSWrapper< SortPolicy >:

Public Member Functions
	SpillNSWrapper (const NeighborSearchMode searchMode, const double epsilon)
	Construct the SpillNSWrapper.

virtual	~SpillNSWrapper ()
	Destruct the SpillNSWrapper.

virtual SpillNSWrapper *	Clone () const
	Return a copy of the SpillNSWrapper.

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

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.

Public Member Functions inherited from mlpack::neighbor::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.

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

NeighborSearchMode	SearchMode () const
	Get the search mode.

NeighborSearchMode &	SearchMode ()
	Modify the search mode.

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

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

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

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

Public Member Functions inherited from mlpack::neighbor::NSWrapperBase
	NSWrapperBase ()
	Create the NSWrapperBase object. More...

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

Additional Inherited Members
Protected Types inherited from mlpack::neighbor::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 mlpack::neighbor::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.

Detailed Description

template<typename SortPolicy>
class mlpack::neighbor::SpillNSWrapper< SortPolicy >

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

Member Function Documentation

◆ Search()

template<typename SortPolicy >

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

virtual

Perform bichromatic search (i.e.

search with a different query set) using the given parameters.

Reimplemented from mlpack::neighbor::NSWrapper< SortPolicy, tree::SPTree, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistDualTreeTraverser, tree::SPTree< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DefeatistSingleTreeTraverser >.

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

src/mlpack/methods/neighbor_search/ns_model.hpp
src/mlpack/methods/neighbor_search/ns_model_impl.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename SortPolicy> class mlpack::neighbor::SpillNSWrapper< SortPolicy >

Member Function Documentation

◆ Search()

template<typename SortPolicy>
class mlpack::neighbor::SpillNSWrapper< SortPolicy >