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 SpillNSWrapper * | Clone () const |
| Return a copy of the SpillNSWrapper. More... | |
| virtual void | Search (util::Timers &timers, 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 (util::Timers &timers, 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 (util::Timers &timers, 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... | |
| NeighborSearchMode & | SearchMode () |
| 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... | |
Detailed Description
template<typenameSortPolicy>
class mlpack::neighbor::SpillNSWrapper< SortPolicy >
template
<
typename
SortPolicy
>
The SpillNSWrapper class wraps the NeighborSearch class when the spill tree is used.
Definition at line 261 of file ns_model.hpp.
Constructor & Destructor Documentation
◆ SpillNSWrapper()
|
inline |
Construct the SpillNSWrapper.
Definition at line 274 of file ns_model.hpp.
◆ ~SpillNSWrapper()
|
inlinevirtual |
Destruct the SpillNSWrapper.
Definition at line 291 of file ns_model.hpp.
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Return a copy of the SpillNSWrapper.
Definition at line 294 of file ns_model.hpp.
References NSWrapperBase::Search(), and NSWrapperBase::Train().
◆ Search()
|
virtual |
Perform bichromatic search (i.e.
search with a different query set) using the given parameters.
◆ serialize()
|
inline |
Serialize the NeighborSearch model.
Definition at line 315 of file ns_model.hpp.
◆ Train()
|
virtual |
Train the model using the given parameters.
The documentation for this class was generated from the following file:
- /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/neighbor_search/ns_model.hpp