.TH "/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-3.3.1/src/mlpack/methods/neighbor_search/ns_model.hpp" 3 "Sun Aug 30 2020" "Version 3.1.1" "mlpack" \" -*- nroff -*-
.ad l
.nh
.SH NAME
/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-3.3.1/src/mlpack/methods/neighbor_search/ns_model.hpp
.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBBiSearchVisitor< SortPolicy >\fP"
.br
.RI "\fBBiSearchVisitor\fP executes a bichromatic neighbor search on the given NSType\&. "
.ti -1c
.RI "class \fBDeleteVisitor\fP"
.br
.RI "\fBDeleteVisitor\fP deletes the given NSType instance\&. "
.ti -1c
.RI "class \fBEpsilonVisitor\fP"
.br
.RI "\fBEpsilonVisitor\fP exposes the Epsilon method of the given NSType\&. "
.ti -1c
.RI "class \fBMonoSearchVisitor\fP"
.br
.RI "\fBMonoSearchVisitor\fP executes a monochromatic neighbor search on the given NSType\&. "
.ti -1c
.RI "class \fBNSModel< SortPolicy >\fP"
.br
.RI "The \fBNSModel\fP class provides an easy way to serialize a model, abstracts away the different types of trees, and also reflects the \fBNeighborSearch\fP API\&. "
.ti -1c
.RI "class \fBReferenceSetVisitor\fP"
.br
.RI "\fBReferenceSetVisitor\fP exposes the referenceSet of the given NSType\&. "
.ti -1c
.RI "class \fBSearchModeVisitor\fP"
.br
.RI "\fBSearchModeVisitor\fP exposes the SearchMode() method of the given NSType\&. "
.ti -1c
.RI "class \fBTrainVisitor< SortPolicy >\fP"
.br
.RI "\fBTrainVisitor\fP sets the reference set to a new reference set on the given NSType\&. "
.in -1c
.SS "Namespaces"

.in +1c
.ti -1c
.RI " \fBmlpack\fP"
.br
.RI "strip_type\&.hpp "
.ti -1c
.RI " \fBmlpack::neighbor\fP"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "template<typename SortPolicy , template< typename TreeMetricType, typename TreeStatType, typename TreeMatType > class TreeType> using \fBNSType\fP = NeighborSearch< SortPolicy, metric::EuclideanDistance, arma::mat, TreeType, TreeType< metric::EuclideanDistance, NeighborSearchStat< SortPolicy >, arma::mat >::template DualTreeTraverser >"
.br
.RI "Alias template for euclidean neighbor search\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBBOOST_TEMPLATE_CLASS_VERSION\fP (template< typename SortPolicy >, \fBmlpack::neighbor::NSModel\fP< SortPolicy >, 1)"
.br
.RI "Set the serialization version of the NSModel class\&. "
.in -1c
.SH "Detailed Description"
.PP 

.PP
\fBAuthor:\fP
.RS 4
Ryan Curtin
.RE
.PP
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\&.
.PP
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\&. 
.PP
Definition in file \fBns_model\&.hpp\fP\&.
.SH "Function Documentation"
.PP 
.SS "BOOST_TEMPLATE_CLASS_VERSION (template< typename SortPolicy >, \fBmlpack::neighbor::NSModel\fP< SortPolicy >, 1)"

.PP
Set the serialization version of the NSModel class\&. 
.PP
Referenced by NSModel< SortPolicy >::RandomBasis()\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for mlpack from the source code\&.