.TH "/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-3.3.0/src/mlpack/tests/main_tests/range_search_utils.hpp" 3 "Mon Aug 31 2020" "Version 3.1.1" "mlpack" \" -*- nroff -*-
.ad l
.nh
.SH NAME
/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-3.3.0/src/mlpack/tests/main_tests/range_search_utils.hpp
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBCheckMatrices\fP (std::vector< std::vector< double >> &vec1, std::vector< std::vector< double >> &vec2, const double tolerance=1e\-3)"
.br
.RI "Check that 2 matrices of type vector<vector<double>> are close to equal, using the given tolerance\&. "
.ti -1c
.RI "void \fBCheckMatrices\fP (std::vector< std::vector< size_t >> &vec1, std::vector< std::vector< size_t >> &vec2)"
.br
.RI "Check that 2 matrices of type vector<vector<size_t>> are equal\&. "
.ti -1c
.RI "std::string \fBModelToString\fP (RSModel *model)"
.br
.RI "Convert a model to a string using the text_oarchive of \fBboost::serialization\fP\&. "
.ti -1c
.RI "template<typename T > std::vector< std::vector< T > > \fBReadData\fP (const std::string &filename)"
.br
.RI "Load a CSV file into a vector of vector with a templated datatype\&. "
.in -1c
.SH "Detailed Description"
.PP 

.PP
\fBAuthor:\fP
.RS 4
Niteya Shah
.RE
.PP
Helper functions used in the execution of the Range Search test\&.
.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 \fBrange_search_utils\&.hpp\fP\&.
.SH "Function Documentation"
.PP 
.SS "void CheckMatrices (std::vector< std::vector< double >> & vec1, std::vector< std::vector< double >> & vec2, const double tolerance = \fC1e\-3\fP)\fC [inline]\fP"

.PP
Check that 2 matrices of type vector<vector<double>> are close to equal, using the given tolerance\&. 
.PP
\fBParameters:\fP
.RS 4
\fIvec1\fP First vector to compare\&. 
.br
\fIvec2\fP Second vector to compare\&. 
.br
\fItolerance\fP Allowed tolerance for values\&. 
.RE
.PP

.PP
Definition at line 41 of file range_search_utils\&.hpp\&.
.SS "void CheckMatrices (std::vector< std::vector< size_t >> & vec1, std::vector< std::vector< size_t >> & vec2)\fC [inline]\fP"

.PP
Check that 2 matrices of type vector<vector<size_t>> are equal\&. 
.PP
\fBParameters:\fP
.RS 4
\fIvec1\fP First vector to compare\&. 
.br
\fIvec2\fP Second vector to compare\&. 
.RE
.PP

.PP
Definition at line 64 of file range_search_utils\&.hpp\&.
.SS "std::string ModelToString (RSModel * model)\fC [inline]\fP"

.PP
Convert a model to a string using the text_oarchive of \fBboost::serialization\fP\&. 
.PP
\fBParameters:\fP
.RS 4
\fImodel\fP RSModel to be converted to string\&. 
.RE
.PP

.PP
Definition at line 25 of file range_search_utils\&.hpp\&.
.SS "std::vector<std::vector<T> > ReadData (const std::string & filename)"

.PP
Load a CSV file into a vector of vector with a templated datatype\&. Any ',' characters are stripped from the input; lines are split on '
.br
' and elements of each line are split on spaces\&.
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP Name of the file to load\&. 
.RE
.PP

.PP
Definition at line 88 of file range_search_utils\&.hpp\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for mlpack from the source code\&.