ns_model.hpp File Reference
Include dependency graph for ns_model.hpp:

Go to the source code of this file.

Classes

class  BiSearchVisitor< SortPolicy >
 BiSearchVisitor executes a bichromatic neighbor search on the given NSType. More...

 
class  DeleteVisitor
 DeleteVisitor deletes the given NSType instance. More...

 
class  EpsilonVisitor
 EpsilonVisitor exposes the Epsilon method of the given NSType. More...

 
class  MonoSearchVisitor
 MonoSearchVisitor executes a monochromatic neighbor search on the given NSType. More...

 
class  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. More...

 
class  ReferenceSetVisitor
 ReferenceSetVisitor exposes the referenceSet of the given NSType. More...

 
class  SearchModeVisitor
 SearchModeVisitor exposes the SearchMode() method of the given NSType. More...

 
class  TrainVisitor< SortPolicy >
 TrainVisitor sets the reference set to a new reference set on the given NSType. More...

 

Namespaces

 mlpack
 
.hpp
 
 mlpack::neighbor
 

Typedefs

template
<
typename
SortPolicy
,
template
<
typename
TreeMetricType
,
typename
TreeStatType
,
typename
TreeMatType
>
class
TreeType
>
using NSType = NeighborSearch< SortPolicy, metric::EuclideanDistance, arma::mat, TreeType, TreeType< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DualTreeTraverser >
 Alias template for euclidean neighbor search. More...

 

Functions

 BOOST_TEMPLATE_CLASS_VERSION (template< typename SortPolicy >, mlpack::neighbor::NSModel< SortPolicy >, 1)
 Set the serialization version of the NSModel class. More...

 

Detailed Description

Author
Ryan Curtin

This is a model for nearest or furthest neighbor search. It is useful in that it provides an easy way to serialize a model, abstracts away the different types of trees, and also reflects the NeighborSearch API and automatically directs to the right tree type.

mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information.

Definition in file ns_model.hpp.

Function Documentation

◆ BOOST_TEMPLATE_CLASS_VERSION()

BOOST_TEMPLATE_CLASS_VERSION (
template
<
typename
SortPolicy
>
,
mlpack::neighbor::NSModel< SortPolicy >  ,
 
)

Set the serialization version of the NSModel class.

Referenced by NSModel< SortPolicy >::RandomBasis().