Initial commit
This commit is contained in:
140
include/testlib.hpp
Normal file
140
include/testlib.hpp
Normal file
@@ -0,0 +1,140 @@
|
||||
/** @file testlib.hpp
|
||||
*
|
||||
* @author Cory Alexander Balaton (coryab)
|
||||
* @author Janita Ovidie Sandtrøen Willumsen (janitaws)
|
||||
*
|
||||
* @version 1.0
|
||||
*
|
||||
* @brief A small test library.
|
||||
*
|
||||
* @details This a small testing library that is tailored for the needs of the
|
||||
* project. Anything that is in the details namespace should not be used
|
||||
* directly, or else it might cause undefined behavior if not used correctly.
|
||||
*
|
||||
* @bug No known bugs
|
||||
* */
|
||||
#ifndef __TESTLIB__
|
||||
#define __TESTLIB__
|
||||
|
||||
#include "utils.hpp"
|
||||
|
||||
#include <armadillo>
|
||||
#include <string>
|
||||
#include <type_traits>
|
||||
|
||||
/** @def ASSERT(expr)
|
||||
* @brief A prettier assertion function.
|
||||
*
|
||||
* This macro calls the m_assert function which is a more informative
|
||||
* assertion function than the regular assert function from cassert.
|
||||
* */
|
||||
#define ASSERT(expr, msg) \
|
||||
details::m_assert(expr, #expr, __METHOD_NAME__, __FILE__, __LINE__, msg)
|
||||
|
||||
namespace details {
|
||||
|
||||
/** @brief Test an expression, confirm that test is ok, or abort execution.
|
||||
*
|
||||
* @details This function takes in an expression and prints an OK message if
|
||||
* it's true, or it prints a fail message and aborts execution if it fails.
|
||||
*
|
||||
* @param expr The expression to be evaluated
|
||||
* @param expr_str The stringified version of the expression
|
||||
* @param func The function name of the caller
|
||||
* @param file The file of the caller
|
||||
* @param line The line number where this function is called from
|
||||
* @param msg The message to be displayed
|
||||
* */
|
||||
void m_assert(bool expr, std::string expr_str, std::string func,
|
||||
std::string file, int line, std::string msg);
|
||||
} // namespace details
|
||||
|
||||
namespace testlib {
|
||||
|
||||
/** @brief Test if two armadillo matrices/vectors are close to each other.
|
||||
*
|
||||
* @details This function takes in 2 matrices/vectors and checks if they are
|
||||
* approximately equal to each other given a tolerance.
|
||||
*
|
||||
* @param a Matrix/vector a
|
||||
* @param b Matrix/vector b
|
||||
* @param tol The tolerance
|
||||
*
|
||||
* @return bool
|
||||
* */
|
||||
template <class T,
|
||||
class = typename std::enable_if<std::is_arithmetic<T>::value>::type>
|
||||
static bool close_to(arma::Mat<T> &a, arma::Mat<T> &b, double tol = 1e-8)
|
||||
{
|
||||
if (a.n_elem != b.n_elem) {
|
||||
return false;
|
||||
}
|
||||
|
||||
for (size_t i = 0; i < a.n_elem; i++) {
|
||||
if (!close_to(a(i), b(i))) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/** @brief Test if two numbers are close to each other.
|
||||
*
|
||||
* @details This function takes in 2 matrices/vectors and checks if they are
|
||||
* approximately equal to each other given a tolerance.
|
||||
*
|
||||
* @param a Matrix/vector a
|
||||
* @param b Matrix/vector b
|
||||
* @param tol The tolerance
|
||||
*
|
||||
* @return bool
|
||||
* */
|
||||
template <class T,
|
||||
class = typename std::enable_if<std::is_arithmetic<T>::value>::type>
|
||||
static bool close_to(T a, T b, double tol = 1e-8)
|
||||
{
|
||||
return std::fabs(a - b) < tol;
|
||||
}
|
||||
|
||||
/** @brief Test if two armadillo matrices/vectors are equal.
|
||||
*
|
||||
* @details This function takes in 2 matrices/vectors and checks if they are
|
||||
* equal to each other. This should only be used for integral types.
|
||||
*
|
||||
* @param a Matrix/vector a
|
||||
* @param b Matrix/vector b
|
||||
*
|
||||
* @return bool
|
||||
* */
|
||||
template <class T,
|
||||
class = typename std::enable_if<std::is_integral<T>::value>::type>
|
||||
static bool is_equal(arma::Mat<T> &a, arma::Mat<T> &b)
|
||||
{
|
||||
for (size_t i = 0; i < a.n_elem; i++) {
|
||||
if (!(a(i) == b(i))) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/** @brief Test that all elements fulfill the condition.
|
||||
*
|
||||
* @param expr The boolean expression to apply to each element
|
||||
* @param M The matrix/vector to iterate over
|
||||
*
|
||||
* @return bool
|
||||
* */
|
||||
template <class T,
|
||||
class = typename std::enable_if<std::is_arithmetic<T>::value>::type>
|
||||
static bool assert_each(std::function<bool(T)> expr, arma::Mat<T> &M)
|
||||
{
|
||||
for (size_t i = 0; i < M.n_elem; i++) {
|
||||
if (!expr(M(i))) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
} // namespace testlib
|
||||
#endif
|
||||
134
include/utils.hpp
Normal file
134
include/utils.hpp
Normal file
@@ -0,0 +1,134 @@
|
||||
/** @file utils.hpp
|
||||
*
|
||||
* @author Cory Alexander Balaton (coryab)
|
||||
* @author Janita Ovidie Sandtrøen Willumsen (janitaws)
|
||||
*
|
||||
* @version 1.0
|
||||
*
|
||||
* @brief Function prototypes and macros that are useful.
|
||||
*
|
||||
* These utility function are mainly for convenience and aren't directly
|
||||
* related to the project. Anything that is in the details namespace should
|
||||
* not be used directly, or else it might cause undefined behavior if not used
|
||||
* correctly.
|
||||
*
|
||||
* @bug No known bugs
|
||||
* */
|
||||
#ifndef __UTILS__
|
||||
#define __UTILS__
|
||||
|
||||
#include <armadillo>
|
||||
#include <iomanip>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
#include <sys/stat.h>
|
||||
#include <vector>
|
||||
|
||||
/** @def DEBUG(msg)
|
||||
* @brief Writes a debug message
|
||||
*
|
||||
* This macro writes a debug message that includes the filename,
|
||||
* line number, and a custom message. The function is wrapped in an ifdef
|
||||
* that checks if DBG is defined, so one can choose to display the debug
|
||||
* messages by adding the -DDBG flag when compiling.
|
||||
* */
|
||||
#ifdef DBG
|
||||
#define DEBUG(msg) \
|
||||
std::cout << __FILE__ << " " << __LINE__ << ": " << msg << std::endl
|
||||
#else
|
||||
#define DEBUG(msg)
|
||||
#endif
|
||||
|
||||
/** @def __METHOD_NAME__
|
||||
* @brief Get the name of the current method/function without the return type.
|
||||
* */
|
||||
#define __METHOD_NAME__ details::methodName(__PRETTY_FUNCTION__)
|
||||
|
||||
namespace details {
|
||||
/** @brief Takes in the __PRETTY_FUNCTION__ string and removes the return type.
|
||||
*
|
||||
* @details This function should only be used for the __METHOD_NAME__ macro,
|
||||
* since it takes the output from __PRETTY_FUNCTION__ and strips the return
|
||||
* type.
|
||||
*
|
||||
* @param pretty_function The string from __PRETTY_FUNCTION__
|
||||
*
|
||||
* @return std::string
|
||||
* */
|
||||
inline std::string methodName(const std::string &pretty_function)
|
||||
{
|
||||
size_t colons = pretty_function.find("::");
|
||||
size_t begin = pretty_function.substr(0, colons).rfind(" ") + 1;
|
||||
size_t end = pretty_function.rfind("(") - begin;
|
||||
|
||||
return pretty_function.substr(begin, end) + "()";
|
||||
}
|
||||
|
||||
} // namespace details
|
||||
|
||||
namespace utils {
|
||||
|
||||
/** @brief Turns a double into a string written in scientific format.
|
||||
*
|
||||
* @details The code is stolen from https://github.com/anderkve/FYS3150.
|
||||
*
|
||||
* @param d The number to stringify
|
||||
* @param width The reserved width of the string
|
||||
* @param prec The precision of the stringified number
|
||||
*
|
||||
* @return std::string
|
||||
* */
|
||||
std::string scientific_format(double d, int width = 20, int prec = 10);
|
||||
|
||||
/** @brief Turns a vector of doubles into a string written in scientific
|
||||
* format.
|
||||
*
|
||||
* @details The code is stolen from https://github.com/anderkve/FYS3150.
|
||||
*
|
||||
* @param v The vector to stringify
|
||||
* @param width The reserved width of the string
|
||||
* @param prec The precision of the stringified number
|
||||
*
|
||||
* @return std::string
|
||||
* */
|
||||
std::string scientific_format(const std::vector<double> &v, int width = 20,
|
||||
int prec = 10);
|
||||
|
||||
/** @brief Make path given.
|
||||
*
|
||||
* @details This tries to be the equivalent to "mkdir -p" and creates a new
|
||||
* directory whenever it needs to.
|
||||
*
|
||||
* @param path The path to be created
|
||||
* @param mode The mode/permissions for all the new directories
|
||||
*
|
||||
* @return bool Success/Fail
|
||||
* */
|
||||
bool mkpath(std::string path, int mode = 0777);
|
||||
|
||||
/** @brief Get the directory name of the path
|
||||
*
|
||||
* @param path The path to use.
|
||||
*
|
||||
* @return string
|
||||
* */
|
||||
std::string dirname(const std::string &path);
|
||||
|
||||
/** @brief Take 2 strings and concatenate them and make sure there is a
|
||||
* directory separator (/) between them.
|
||||
*
|
||||
* @details This function doesn't care whether or not the values given as
|
||||
* parameters are valid path strings. It is the responsibility of the user to make
|
||||
* sure that the values given are valid path strings.
|
||||
* The function only guarantees that the output string is a valid path string.
|
||||
*
|
||||
* @param left The left hand side of the result string
|
||||
* @param right The right hand side of the result string
|
||||
*
|
||||
* @return string
|
||||
* */
|
||||
std::string concatpath(const std::string &left, const std::string &right);
|
||||
|
||||
} // namespace utils
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user