cepgen is hosted by Hepforge, IPPP Durham
CepGen N/A
Central exclusive processes event generator
Namespaces | Macros | Variables
Test.h File Reference
#include <cmath>
#include "CepGen/Core/Exception.h"
#include "CepGen/Utils/String.h"
+ Include dependency graph for Test.h:

Go to the source code of this file.

Namespaces

namespace  cepgen
 Common namespace for this Monte Carlo generator.
 
namespace  cepgen::test
 

Macros

#define CG_FAILED(name)
 
#define CG_PASSED(name)   CG_LOG << cepgen::utils::colourise("Passed ", cepgen::utils::Colour::green) << name << "."
 
#define CG_TEST_DEBUG(debugging)   cepgen::test::debug = debugging
 
#define CG_TEST_SET_FAILURE_TOLERANCE_RATE(tolerance)   cepgen::test::failure_tolerance = tolerance
 
#define CG_TEST_SET_PRECISION(precis)   cepgen::test::precision = precis
 
#define CG_TEST_RESET_PRECISION()   cepgen::test::precision = cepgen::test::base_precision
 
#define CG_TEST(test_cond, name)
 
#define CG_TEST_EQUAL(var1, var2, name)
 
#define CG_TEST_EQUIV(var1, var2, name)
 
#define CG_TEST_UNCERT(diff, unc, num_sigma, name)
 
#define CG_TEST_VALUES(val1, val2, num_sigma, name)
 
#define CG_TEST_EXCEPT(sequence, name)
 
#define CG_TEST_SUMMARY
 

Variables

bool debug = false
 
double failure_tolerance = 0.
 
constexpr double base_precision = 1.e-3
 
double precision = base_precision
 
size_t num_total = 0
 
size_t num_passed = 0
 

Macro Definition Documentation

◆ CG_FAILED

#define CG_FAILED ( name)
Value:
CG_LOG << cepgen::utils::colourise("FAILED ", cepgen::utils::Colour::red, cepgen::utils::Modifier::bold) << name \
<< "!"
CG_LOG
#define CG_LOG
Definition Message.h:196
cepgen::utils::colourise
std::string colourise(const std::string &, const Colour &, const Modifier &=Modifier::none)
Colourise a string for TTY-type output streams.

Definition at line 18 of file Test.h.

◆ CG_PASSED

#define CG_PASSED ( name)    CG_LOG << cepgen::utils::colourise("Passed ", cepgen::utils::Colour::green) << name << "."

Definition at line 21 of file Test.h.

◆ CG_TEST

#define CG_TEST ( test_cond,
name )
Value:
{ \
if (cepgen::test::debug) \
CG_LOG << cepgen::utils::colourise("TEST INFO", cepgen::utils::Colour::magenta, cepgen::utils::Modifier::bold) \
<< " " << cepgen::utils::colourise(name, cepgen::utils::Colour::magenta) << "\n" \
<< "\tcondition: " << cepgen::utils::boldify(#test_cond) << "."; \
if (!(test_cond)) \
CG_FAILED(name); \
else { \
CG_PASSED(name); \
cepgen::test::num_passed++; \
} \
cepgen::test::num_total++; \
}
cepgen::test::num_passed
size_t num_passed
Definition Test.h:15
cepgen::test::debug
bool debug
Definition Test.h:10
cepgen::test::num_total
size_t num_total
Definition Test.h:14
cepgen::utils::boldify
std::string boldify(T str)

Definition at line 28 of file Test.h.

◆ CG_TEST_DEBUG

#define CG_TEST_DEBUG ( debugging)    cepgen::test::debug = debugging

Definition at line 23 of file Test.h.

◆ CG_TEST_EQUAL

#define CG_TEST_EQUAL ( var1,
var2,
name )
Value:
{ \
if (cepgen::test::debug) \
CG_LOG << cepgen::utils::colourise("TEST INFO", cepgen::utils::Colour::magenta, cepgen::utils::Modifier::bold) \
<< " " << cepgen::utils::colourise(name, cepgen::utils::Colour::magenta) << "\n" \
<< "\tvariable 1(" << cepgen::utils::boldify(#var1) << "): " << var1 << "\n" \
<< "\tvariable 2(" << cepgen::utils::boldify(#var2) << "): " << var2 << "."; \
if ((var1) != (var2)) \
CG_FAILED(name) << " " << var1 << " != " << var2 << "."; \
else { \
CG_PASSED(name); \
cepgen::test::num_passed++; \
} \
cepgen::test::num_total++; \
}

Definition at line 43 of file Test.h.

◆ CG_TEST_EQUIV

#define CG_TEST_EQUIV ( var1,
var2,
name )
Value:
{ \
if (std::fabs((var1) - (var2)) > cepgen::test::precision) \
CG_FAILED(name) << " " << var1 << " is not within " << cepgen::test::precision << " of " << var2 << "."; \
else { \
CG_PASSED(name); \
cepgen::test::num_passed++; \
} \
cepgen::test::num_total++; \
}
cepgen::test::precision
double precision
Definition Test.h:13

Definition at line 59 of file Test.h.

◆ CG_TEST_EXCEPT

#define CG_TEST_EXCEPT ( sequence,
name )
Value:
{ \
if (cepgen::test::debug) \
CG_LOG << cepgen::utils::colourise("TEST INFO", cepgen::utils::Colour::magenta, cepgen::utils::Modifier::bold) \
<< " " << cepgen::utils::colourise(name, cepgen::utils::Colour::magenta) << "\n" \
<< "\tsequence: " << cepgen::utils::boldify(#sequence) << "."; \
try { \
sequence(); \
CG_FAILED(name) << "Exception was not thrown."; \
} catch (const cepgen::Exception& exc) { \
CG_PASSED(name) << " Resulting exception:\n" \
<< cepgen::utils::colourise(exc.message(), \
cepgen::utils::Colour::none, \
cepgen::utils::Modifier::dimmed | cepgen::utils::Modifier::italic); \
cepgen::test::num_passed++; \
} \
cepgen::test::num_total++; \
}
cepgen::Exception
Standard exception message.
Definition Exception.h:26
cepgen::LoggedMessage::message
std::string message() const
Human-readable message.
Definition Message.h:151

Definition at line 105 of file Test.h.

◆ CG_TEST_RESET_PRECISION

#define CG_TEST_RESET_PRECISION ( )    cepgen::test::precision = cepgen::test::base_precision

Definition at line 26 of file Test.h.

◆ CG_TEST_SET_FAILURE_TOLERANCE_RATE

#define CG_TEST_SET_FAILURE_TOLERANCE_RATE ( tolerance)    cepgen::test::failure_tolerance = tolerance

Definition at line 24 of file Test.h.

◆ CG_TEST_SET_PRECISION

#define CG_TEST_SET_PRECISION ( precis)    cepgen::test::precision = precis

Definition at line 25 of file Test.h.

◆ CG_TEST_SUMMARY

#define CG_TEST_SUMMARY
Value:
{ \
{ \
auto col = cepgen::utils::Colour::yellow; \
if (cepgen::test::num_passed == cepgen::test::num_total) \
col = cepgen::utils::Colour::green; \
else if ((cepgen::test::failure_tolerance > 0. && \
cepgen::test::num_total - cepgen::test::num_passed > \
cepgen::test::failure_tolerance * cepgen::test::num_total) || \
cepgen::test::num_passed < 0.1 * cepgen::test::num_total) \
col = cepgen::utils::Colour::red; \
CG_LOG << cepgen::utils::colourise(std::to_string(cepgen::test::num_passed) + " out of " + \
cepgen::utils::s("test", cepgen::test::num_total, true) + " passed.", \
col); \
} \
return (cepgen::test::num_total - cepgen::test::num_passed <= \
cepgen::test::failure_tolerance * cepgen::test::num_total) \
? 0 \
: cepgen::test::num_total - cepgen::test::num_passed; \
}
cepgen::test::failure_tolerance
double failure_tolerance
Definition Test.h:11
cepgen::utils::s
std::string s(const std::string &, float, bool=true)
Add a trailing "s" when needed.

Definition at line 124 of file Test.h.

◆ CG_TEST_UNCERT

#define CG_TEST_UNCERT ( diff,
unc,
num_sigma,
name )
Value:
{ \
if (cepgen::test::debug) \
CG_LOG << cepgen::utils::colourise("TEST INFO", cepgen::utils::Colour::magenta, cepgen::utils::Modifier::bold) \
<< " " << cepgen::utils::colourise(name, cepgen::utils::Colour::magenta) << "\n" \
<< "\tdifference: " << diff << ", sigma: " << unc << " = " << diff / unc << " * sigma " \
<< ((diff > num_sigma * unc) ? ">" : "<") << " " << num_sigma << " * sigma."; \
if (unc > 0 && diff > num_sigma * unc) \
CG_FAILED(name) << " difference " << diff << " is not within " << num_sigma << " sigmas=" << unc << "."; \
else { \
CG_PASSED(name); \
cepgen::test::num_passed++; \
} \
cepgen::test::num_total++; \
}

Definition at line 70 of file Test.h.

◆ CG_TEST_VALUES

#define CG_TEST_VALUES ( val1,
val2,
num_sigma,
name )
Value:
{ \
const auto diff = cepgen::Value(val1) - cepgen::Value(val2); \
if (cepgen::test::debug) \
CG_LOG << cepgen::utils::colourise("TEST INFO", cepgen::utils::Colour::magenta, cepgen::utils::Modifier::bold) \
<< " " << cepgen::utils::colourise(name, cepgen::utils::Colour::magenta) << "\n" \
<< "\tvals: " << val1 << ", " << val2 << ", difference: " << (val1 - val2) \
<< ", sigma: " << diff.uncertainty() << " = " << diff.relativeUncertainty() << " * sigma " \
<< ((std::fabs(1. / diff.relativeUncertainty()) > num_sigma) ? ">" : "<") << " " << num_sigma \
<< " * sigma."; \
if (diff.uncertainty() > 0 && diff > num_sigma * diff.uncertainty()) \
CG_FAILED(name) << " difference " << diff << " is not within " << num_sigma << " sigmas."; \
else { \
CG_PASSED(name); \
cepgen::test::num_passed++; \
} \
cepgen::test::num_total++; \
}
cepgen::Value
A scalar value with its uncertainty.
Definition Value.h:26

Definition at line 86 of file Test.h.