The NSModel class provides an easy way to serialize a model, abstracts away the different types of trees, and also reflects the NeighborSearch API. More...

Public Types
enum	TreeTypes { KD_TREE, COVER_TREE, R_TREE, R_STAR_TREE, BALL_TREE, X_TREE, HILBERT_R_TREE, R_PLUS_TREE, R_PLUS_PLUS_TREE, VP_TREE, RP_TREE, MAX_RP_TREE, SPILL_TREE, UB_TREE, OCTREE }
	Enum type to identify each accepted tree type. More...

Public Member Functions
	NSModel (TreeTypes treeType=TreeTypes::KD_TREE, bool randomBasis=false)
	Initialize the NSModel with the given type and whether or not a random basis should be used. More...

	NSModel (const NSModel &other)
	Copy the given NSModel. More...

	NSModel (NSModel &&other)
	Take ownership of the given NSModel. More...

	~NSModel ()
	Clean memory, if necessary. More...

void	BuildModel (arma::mat &&referenceSet, const size_t leafSize, const NeighborSearchMode searchMode, const double epsilon=0)
	Build the reference tree. More...

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

double	Epsilon () const
	Expose Epsilon. More...

double &	Epsilon ()

size_t	LeafSize () const
	Expose leafSize. More...

size_t &	LeafSize ()

NSModel &	operator= (const NSModel &other)
	Copy the given NSModel. More...

NSModel &	operator= (NSModel &&other)
	Take ownership of the given NSModel. More...

bool	RandomBasis () const
	Expose randomBasis. More...

bool &	RandomBasis ()

double	Rho () const
	Expose rho. More...

double &	Rho ()

void	Search (arma::mat &&querySet, const size_t k, arma::Mat< size_t > &neighbors, arma::mat &distances)
	Perform neighbor search. The query set will be reordered. More...

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

NeighborSearchMode	SearchMode () const
	Expose SearchMode. More...

NeighborSearchMode &	SearchMode ()

template<typename Archive >
void	Serialize (Archive &ar, const unsigned int)
	Serialize the neighbor search model. More...

double	Tau () const
	Expose tau. More...

double &	Tau ()

std::string	TreeName () const
	Return a string representation of the current tree type. More...

TreeTypes	TreeType () const
	Expose treeType. More...

TreeTypes &	TreeType ()

Private Attributes
size_t	leafSize
	For tree types that accept the maxLeafSize parameter. More...

boost::variant< NSType< SortPolicy, tree::KDTree > , NSType< SortPolicy, tree::StandardCoverTree > , NSType< SortPolicy, tree::RTree > , NSType< SortPolicy, tree::RStarTree > , NSType< SortPolicy, tree::BallTree > , NSType< SortPolicy, tree::XTree > , NSType< SortPolicy, tree::HilbertRTree > , NSType< SortPolicy, tree::RPlusTree > , NSType< SortPolicy, tree::RPlusPlusTree > , NSType< SortPolicy, tree::VPTree > , NSType< SortPolicy, tree::RPTree > , NSType< SortPolicy, tree::MaxRPTree > , SpillKNN , NSType< SortPolicy, tree::UBTree > , NSType< SortPolicy, tree::Octree > * >	nSearch
	nSearch holds an instance of the NeigborSearch class for the current treeType. More...

arma::mat	q
	This is the random projection matrix; only used if randomBasis is true. More...

bool	randomBasis
	If true, random projections are used. More...

double	rho
	Balance threshold (for spill trees). More...

double	tau
	Overlapping size (for spill trees). More...

TreeTypes	treeType
	Tree type considered for neighbor search. More...

Detailed Description

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

The NSModel class provides an easy way to serialize a model, abstracts away the different types of trees, and also reflects the NeighborSearch API.

This class is meant to be used by the command-line mlpack_knn and mlpack_kfn programs, and thus does not have the same complete functionality and flexibility as the NeighborSearch class. So if you are using it outside of mlpack_knn and mlpack_kfn, be aware that it is limited!

Template Parameters

SortPolicy The sort policy for distances; see NearestNeighborSort.

Definition at line 266 of file ns_model.hpp.