test_catch_tools.hpp File Reference

Include dependency graph for test_catch_tools.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	REQUIRE_RELATIVE_ERR(L, R, E)   REQUIRE(std::abs((R) - (L)) <= (E) * std::abs(R))

Functions
template<typename FieldType , typename = std::enable_if_t< arma::is_arma_type<typename FieldType::object_type>::value>>
void	CheckFields (const FieldType &a, const FieldType &b)
void	CheckMatrices (const arma::mat &a, const arma::mat &b, double tolerance=1e-5)
void	CheckMatrices (const arma::Mat< size_t > &a, const arma::Mat< size_t > &b)
void	CheckMatrices (const arma::cube &a, const arma::cube &b, double tolerance=1e-5)
void	CheckMatricesNotEqual (const arma::mat &a, const arma::mat &b, double tolerance=1e-5)
void	CheckMatricesNotEqual (const arma::Mat< size_t > &a, const arma::Mat< size_t > &b)
void	CheckMatricesNotEqual (const arma::cube &a, const arma::cube &b, double tolerance=1e-5)
std::string	FilterFileName (const std::string &inputString)

Detailed Description

Author

Ryan Curtin

This file includes some useful macros for tests.

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 test_catch_tools.hpp.

Macro Definition Documentation

REQUIRE_RELATIVE_ERR

#define REQUIRE_RELATIVE_ERR	(		L,
			R,
			E
	)		REQUIRE(std::abs((R) - (L)) <= (E) * std::abs(R))

Definition at line 21 of file test_catch_tools.hpp.

Function Documentation

CheckFields()

void CheckFields ( const FieldType &  a, const FieldType &  b  )

inline

Definition at line 56 of file test_catch_tools.hpp.

References CheckMatrices().

CheckMatrices() [1/3]

void CheckMatrices ( const arma::mat &  a, const arma::mat &  b, double  tolerance = 1e-5  )

inline

Definition at line 25 of file test_catch_tools.hpp.

Referenced by CheckFields().

CheckMatrices() [2/3]

void CheckMatrices ( const arma::Mat< size_t > &  a, const arma::Mat< size_t > &  b  )

inline

Definition at line 42 of file test_catch_tools.hpp.

CheckMatrices() [3/3]

void CheckMatrices ( const arma::cube &  a, const arma::cube &  b, double  tolerance = 1e-5  )

inline

Definition at line 67 of file test_catch_tools.hpp.

CheckMatricesNotEqual() [1/3]

void CheckMatricesNotEqual ( const arma::mat &  a, const arma::mat &  b, double  tolerance = 1e-5  )

inline

Definition at line 85 of file test_catch_tools.hpp.

CheckMatricesNotEqual() [2/3]

void CheckMatricesNotEqual ( const arma::Mat< size_t > &  a, const arma::Mat< size_t > &  b  )

inline

Definition at line 117 of file test_catch_tools.hpp.

CheckMatricesNotEqual() [3/3]

void CheckMatricesNotEqual ( const arma::cube &  a, const arma::cube &  b, double  tolerance = 1e-5  )

inline

Definition at line 142 of file test_catch_tools.hpp.

FilterFileName()

std::string FilterFileName ( const std::string &  inputString )

inline

Definition at line 175 of file test_catch_tools.hpp.

Referenced by mlpack::SerializeObject(), mlpack::SerializePointerObject(), and mlpack::TestArmadilloSerialization().