.TH "/var/www/mlpack.ratml.org/mlpack.org/_src/mlpack-3.3.1/src/mlpack/tests/test_tools.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/tests/test_tools.hpp
.SH SYNOPSIS
.br
.PP
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBREQUIRE_RELATIVE_ERR\fP(L,  R,  E)   BOOST_REQUIRE_LE(std::abs((R) \- (L)), (E) * std::abs(R))"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBCheckMatrices\fP (const arma::mat &a, const arma::mat &b, double tolerance=1e\-5)"
.br
.ti -1c
.RI "void \fBCheckMatrices\fP (const arma::Mat< size_t > &a, const arma::Mat< size_t > &b)"
.br
.ti -1c
.RI "void \fBCheckMatrices\fP (const arma::cube &a, const arma::cube &b, double tolerance=1e\-5)"
.br
.ti -1c
.RI "void \fBCheckMatricesNotEqual\fP (const arma::mat &a, const arma::mat &b, double tolerance=1e\-5)"
.br
.ti -1c
.RI "void \fBCheckMatricesNotEqual\fP (const arma::Mat< size_t > &a, const arma::Mat< size_t > &b)"
.br
.ti -1c
.RI "void \fBCheckMatricesNotEqual\fP (const arma::cube &a, const arma::cube &b, double tolerance=1e\-5)"
.br
.ti -1c
.RI "std::string \fBFilterFileName\fP (const std::string &inputString)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.PP
\fBAuthor:\fP
.RS 4
Ryan Curtin
.RE
.PP
This file includes some useful macros for tests\&.
.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 \fBtest_tools\&.hpp\fP\&.
.SH "Macro Definition Documentation"
.PP 
.SS "#define REQUIRE_RELATIVE_ERR(L, R, E)   BOOST_REQUIRE_LE(std::abs((R) \- (L)), (E) * std::abs(R))"

.PP
Definition at line 20 of file test_tools\&.hpp\&.
.SH "Function Documentation"
.PP 
.SS "void CheckMatrices (const arma::mat & a, const arma::mat & b, double tolerance = \fC1e\-5\fP)\fC [inline]\fP"

.PP
Definition at line 24 of file test_tools\&.hpp\&.
.SS "void CheckMatrices (const arma::Mat< size_t > & a, const arma::Mat< size_t > & b)\fC [inline]\fP"

.PP
Definition at line 41 of file test_tools\&.hpp\&.
.SS "void CheckMatrices (const arma::cube & a, const arma::cube & b, double tolerance = \fC1e\-5\fP)\fC [inline]\fP"

.PP
Definition at line 52 of file test_tools\&.hpp\&.
.SS "void CheckMatricesNotEqual (const arma::mat & a, const arma::mat & b, double tolerance = \fC1e\-5\fP)\fC [inline]\fP"

.PP
Definition at line 70 of file test_tools\&.hpp\&.
.SS "void CheckMatricesNotEqual (const arma::Mat< size_t > & a, const arma::Mat< size_t > & b)\fC [inline]\fP"

.PP
Definition at line 102 of file test_tools\&.hpp\&.
.SS "void CheckMatricesNotEqual (const arma::cube & a, const arma::cube & b, double tolerance = \fC1e\-5\fP)\fC [inline]\fP"

.PP
Definition at line 127 of file test_tools\&.hpp\&.
.SS "std::string FilterFileName (const std::string & inputString)\fC [inline]\fP"

.PP
Definition at line 160 of file test_tools\&.hpp\&.
.PP
Referenced by mlpack::SerializeObject(), mlpack::SerializePointerObject(), and mlpack::TestArmadilloSerialization()\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for mlpack from the source code\&.