Unit Test Macros and Functions

Classes
struct	smash::Test::Position
	A FourVector that is marked as a position vector. More...
struct	smash::Test::Momentum
	A FourVector that is marked as a momentum vector. More...

Macros
#define	TEST(function_name)
	Defines a test function. More...
#define	TEST_CATCH(function_name, ExceptionType)
	Same as above, but expects the code to throw an exception of type ExceptionType. More...
#define	TEST_TYPES(T, test_name, typelist)
	Define a test function template, with type parameter T, which is specialized for all types in the typelist. More...
#define	VERIFY(condition)
	Verifies that condition is true. More...
#define	COMPARE(test_value, reference)
	Verifies that test_value is equal to reference. More...
#define	COMPARE_ABSOLUTE_ERROR(test_value, reference, allowed_difference)
	Verifies that the difference between test_value and reference is smaller than allowed_difference. More...
#define	COMPARE_RELATIVE_ERROR(test_value, reference, allowed_relative_difference)
	Verifies that the difference between test_value and reference is smaller than allowed_relative_difference * reference. More...
#define	FUZZY_COMPARE(test_value, reference)
	Verifies that test_value is equal to reference within a pre-defined distance in units of least precision (ulp). More...
#define	FAIL()
	Call this to fail a test. More...

Typedefs
using	smash::Test::ParticlesPtr = std::unique_ptr< Particles >
	A type alias for a unique_ptr of Particles. More...

Functions
void	smash::Test::create_actual_particletypes ()
	Creates the ParticleType list containing the actual particles that SMASH uses. More...
void	smash::Test::create_actual_decaymodes ()
	Creates the DecayModes list containing the actual decay modes that SMASH uses. More...
void	smash::Test::create_smashon_particletypes ()
	Creates a ParticleType list containing only the smashon test particle. More...
void	smash::Test::create_stable_smashon_particletypes ()
	Creates a ParticleType list containing only the smashon test particle with width 0 (stable). More...
ParticleData	smash::Test::smashon (int id=-1)
	Create a particle with 0 position and momentum vectors and optionally a given id. More...
ParticleData	smash::Test::smashon (const Position &position, int id=-1)
	Create a particle with 0 momentum vector, the given position, and optionally a given id. More...
ParticleData	smash::Test::smashon (const Momentum &momentum, int id=-1)
	Create a particle with 0 position vector, the given momentum, and optionally a given id. More...
ParticleData	smash::Test::smashon (const Position &position, const Momentum &momentum, int id=-1)
	Create a particle with the given position and momentum vectors, and optionally a given id. More...
ParticleData	smash::Test::smashon (const Momentum &momentum, const Position &position, int id=-1)
	Create a particle with the given position and momentum vectors, and optionally a given id. More...
ParticleData	smash::Test::smashon_random (int id=-1)
	Create a particle with random position and momentum vectors and optionally a given id. More...
std::unique_ptr< ExperimentBase >	smash::Test::experiment (Configuration c)
	Create an experiment given an input configuration. More...
template<typename G >
ParticleList	smash::Test::create_particle_list (std::size_t n, G &&generator)
	Generate a list of particles from the given generator function. More...
template<typename G >
ParticlesPtr	smash::Test::create_particles (int n, G &&generator)
	Creates a Particles object and fills it with n particles generated by the generator function. More...
ParticlesPtr	smash::Test::create_particles (const std::initializer_list< ParticleData > &init)
	Creates a Particles object and fills it with the particles passed as initializer_list to this function. More...
ReactionsBitSet	smash::Test::all_reactions_included ()
	returns BitSet of 2->2 reactions, where everything is on More...
MultiParticleReactionsBitSet	smash::Test::no_multiparticle_reactions ()
	returns BitSet for multi-particle reactions, where everything is off More...
ExperimentParameters	smash::Test::default_parameters (int testparticles=1, double dt=0.1, CollisionCriterion criterion=CollisionCriterion::Geometric, bool strings=false, NNbarTreatment nnbar_treatment=NNbarTreatment::NoAnnihilation, ReactionsBitSet included_2to2=all_reactions_included())
	Creates a standard ExperimentParameters object which works for almost all testing purposes. More...
ScatterActionsFinderParameters	smash::Test::default_finder_parameters (double elastic_parameter=10, NNbarTreatment nnbar_treatment=NNbarTreatment::NoAnnihilation, ReactionsBitSet included_2to2=all_reactions_included(), bool strings_switch=true, bool use_AQM=false, bool strings_with_probability=false, TotalCrossSectionStrategy xs_strategy=TotalCrossSectionStrategy::BottomUp)
	Creates a standard ScatterActionsFinderParameters object which works for almost all testing purposes. More...
EventInfo	smash::Test::default_event_info (double impact_parameter=0.0, bool empty_event=false)
	Creates default EventInfo object for testing purposes. More...
std::unique_ptr< StringProcess >	smash::Test::default_string_process_interface ()
	Creates a default StringProcessInterface object for testing. More...
InitialConditionParameters	smash::Test::default_dynamic_IC_parameters ()
	Creates default parameters for dynamic IC. More...

Variables
static constexpr double	smash::Test::smashon_mass = 0.123
	The mass of the smashon particle. More...
static constexpr double	smash::Test::smashon_width = 1.2
	The decay width of the smashon particle. More...
static constexpr const char	smash::Test::smashon_pdg_string [] = "661"
	The PDG code of the smashon particle. More...

Macro Definition Documentation

TEST

#define TEST

(

function_name

)

Defines a test function.

Consider this to expand to void function_name(). The function_name will also be the name that appears in the output after PASS/FAIL.

Definition at line 234 of file unittest.h.

TEST_CATCH

#define TEST_CATCH	(		function_name,
			ExceptionType
	)

Same as above, but expects the code to throw an exception of type ExceptionType.

If the code does not throw (or throws a different exception), the test is considered failed.

Definition at line 243 of file unittest.h.

TEST_TYPES

#define TEST_TYPES	(		T,
			test_name,
			typelist
	)

Define a test function template, with type parameter T, which is specialized for all types in the typelist.

Definition at line 249 of file unittest.h.

VERIFY

#define VERIFY

(

condition

)

Verifies that condition is true.

Definition at line 254 of file unittest.h.

COMPARE

#define COMPARE	(		test_value,
			reference
	)

Verifies that test_value is equal to reference.

Definition at line 259 of file unittest.h.

COMPARE_ABSOLUTE_ERROR

#define COMPARE_ABSOLUTE_ERROR	(		test_value,
			reference,
			allowed_difference
	)

Verifies that the difference between test_value and reference is smaller than allowed_difference.

If the test fails the output will show the actual difference between test_value and reference. If this value is positive test_value is too large. If it is negative test_value is too small.

Definition at line 269 of file unittest.h.

COMPARE_RELATIVE_ERROR

#define COMPARE_RELATIVE_ERROR	(		test_value,
			reference,
			allowed_relative_difference
	)

Verifies that the difference between test_value and reference is smaller than allowed_relative_difference * reference.

If the test fails the output will show the actual difference between test_value and reference. If this value is positive test_value is too large. If it is negative test_value is too small.

The following example tests that a is no more than 1% different from b:

COMPARE_ABSOLUTE_ERROR(a, b, 0.01);

Note

This test macro still works even if reference is set to 0. It will then compare the difference against allowed_relative_difference * <smallest positive normalized value of reference type>.

Definition at line 288 of file unittest.h.

FUZZY_COMPARE

#define FUZZY_COMPARE	(		test_value,
			reference
	)

Verifies that test_value is equal to reference within a pre-defined distance in units of least precision (ulp).

If the test fails it will print the distance in ulp between test_value and reference as well as the maximum allowed distance. Often this difference is not visible in the value because the conversion of a double/float to a string needs to round the value to a sensible length.

The allowed distance can be modified by calling:

vir::test::setFuzzyness<float>(4);
vir::test::setFuzzyness<double>(7);

ulp

Unit of least precision is a unit that is derived from the the least significant bit in the mantissa of a floating-point value. Consider a single-precision number (23 mantissa bits) with exponent \(e\). Then 1 ulp is \(2^{e-23}\). Thus, \(\log_2(u)\) signifies the the number incorrect mantissa bits (with \(u\) the distance in ulp).

If test_value and reference have a different exponent the meaning of ulp depends on the variable you look at. The FUZZY_COMPARE code always uses reference to determine the magnitude of 1 ulp.

Example: The value 1. is 0x3f800000 in binary. The value 1.00000011920928955078125 with binary representation 0x3f800001 therefore has a distance of 1 ulp. A positive distance means the test_value is larger than the reference. A negative distance means the test_value is smaller than the reference.

• FUZZY_COMPARE(1.00000011920928955078125, 1.) will show a distance of 1
• FUZZY_COMPARE(1., 1.00000011920928955078125) will show a distance of -1

The value 0.999999940395355224609375 with binary representation 0x3f7fffff has a smaller exponent than 1.:

• FUZZY_COMPARE(0.999999940395355224609375, 1.) will show a distance of -0.5
• FUZZY_COMPARE(1., 0.999999940395355224609375) will show a distance of 1

Comparing to 0

Distance to 0 is implemented as comparing to std::numeric_limits<T>::min() instead and adding 1 to the resulting distance.

Definition at line 337 of file unittest.h.

FAIL

#define FAIL

(

)

Call this to fail a test.

Definition at line 342 of file unittest.h.

Typedef Documentation

ParticlesPtr

using smash::Test::ParticlesPtr = typedef std::unique_ptr<Particles>

A type alias for a unique_ptr of Particles.

Definition at line 187 of file setup.h.

Function Documentation

create_actual_particletypes()

void smash::Test::create_actual_particletypes ( )

inline

Creates the ParticleType list containing the actual particles that SMASH uses.

Definition at line 36 of file setup.h.

                                          {
#ifndef DOXYGEN
#include <particles.txt.h>
#endif
  ParticleType::create_type_list(data);
}

create_actual_decaymodes()

void smash::Test::create_actual_decaymodes ( )

inline

Creates the DecayModes list containing the actual decay modes that SMASH uses.

Definition at line 48 of file setup.h.

                                       {
#ifndef DOXYGEN
#include <decaymodes.txt.h>
#endif
  DecayModes::load_decaymodes(data);
}

create_smashon_particletypes()

void smash::Test::create_smashon_particletypes ( )

inline

Creates a ParticleType list containing only the smashon test particle.

Definition at line 66 of file setup.h.

                                           {
  ParticleType::create_type_list(
      "# NAME MASS[GEV] WIDTH[GEV] PARITY PDG\n"
      "σ " +
      std::to_string(smashon_mass) + " " + std::to_string(smashon_width) +
      " + 661\n");
}

create_stable_smashon_particletypes()

void smash::Test::create_stable_smashon_particletypes ( )

inline

Creates a ParticleType list containing only the smashon test particle with width 0 (stable).

Definition at line 78 of file setup.h.

                                                  {
  ParticleType::create_type_list(
      "# NAME MASS[GEV] WIDTH[GEV] PARITY PDG\n"
      "σ " +
      std::to_string(smashon_mass) + " 0.0 + 661\n");
}

smashon() [1/5]

ParticleData smash::Test::smashon ( int  id = -1 )

inline

Create a particle with 0 position and momentum vectors and optionally a given id.

Definition at line 98 of file setup.h.

                                         {
  ParticleData p{ParticleType::find(0x661), id};
  return p;
}

smashon() [2/5]

ParticleData smash::Test::smashon ( const Position &  position, int  id = -1  )

inline

Create a particle with 0 momentum vector, the given position, and optionally a given id.

Definition at line 106 of file setup.h.

                                                                   {
  ParticleData p{ParticleType::find(0x661), id};
  p.set_4position(position);
  p.set_formation_time(position[0]);
  return p;
}

smashon() [3/5]

ParticleData smash::Test::smashon ( const Momentum &  momentum, int  id = -1  )

inline

Create a particle with 0 position vector, the given momentum, and optionally a given id.

Definition at line 116 of file setup.h.

                                                                   {
  ParticleData p{ParticleType::find(0x661), id};
  p.set_4momentum(momentum);
  return p;
}

smashon() [4/5]

ParticleData smash::Test::smashon ( const Position &  position, const Momentum &  momentum, int  id = -1  )

inline

Create a particle with the given position and momentum vectors, and optionally a given id.

Definition at line 125 of file setup.h.

                                         {
  ParticleData p{ParticleType::find(0x661), id};
  p.set_4position(position);
  p.set_4momentum(momentum);
  p.set_formation_time(position[0]);
  p.set_unpolarized_spin_vector();
  return p;
}

smashon() [5/5]

ParticleData smash::Test::smashon ( const Momentum &  momentum, const Position &  position, int  id = -1  )

inline

Create a particle with the given position and momentum vectors, and optionally a given id.

Convenience overload of the above to allow arbitrary order of momentum and position.

Definition at line 141 of file setup.h.

                                         {
  ParticleData p{ParticleType::find(0x661), id};
  p.set_4position(position);
  p.set_4momentum(momentum);
  p.set_formation_time(position[0]);
  p.set_unpolarized_spin_vector();
  return p;
}

smashon_random()

ParticleData smash::Test::smashon_random ( int  id = -1 )

inline

Create a particle with random position and momentum vectors and optionally a given id.

Definition at line 154 of file setup.h.

                                                {
  auto random_value = random::make_uniform_distribution(-15.0, +15.0);
  ParticleData p{ParticleType::find(0x661), id};
  auto random_time = random_value();
  p.set_formation_time(random_time);
  p.set_4position(
      {random_time, random_value(), random_value(), random_value()});
  p.set_4momentum(smashon_mass,
                  {random_value(), random_value(), random_value()});
  return p;
}

experiment()

std::unique_ptr<ExperimentBase> smash::Test::experiment ( Configuration  c )

inline

Create an experiment given an input configuration.

Definition at line 169 of file setup.h.

                                                                 {
  return ExperimentBase::create(c, ".");
}

create_particle_list()

template<typename G >

ParticleList smash::Test::create_particle_list ( std::size_t  n, G &&  generator  )

inline

Generate a list of particles from the given generator function.

Definition at line 177 of file setup.h.

                                                                     {
  ParticleList list;
  list.reserve(n);
  for (auto i = n; i; --i) {
    list.emplace_back(generator());
  }
  return list;
}

create_particles() [1/2]

template<typename G >

ParticlesPtr smash::Test::create_particles ( int  n, G &&  generator  )

inline

Creates a Particles object and fills it with n particles generated by the generator function.

Definition at line 194 of file setup.h.

                                                           {
  ParticlesPtr p = std::make_unique<Particles>();
  for (auto i = n; i; --i) {
    p->insert(generator());
  }
  return p;
}

create_particles() [2/2]

ParticlesPtr smash::Test::create_particles ( const std::initializer_list< ParticleData > &  init )

inline

Creates a Particles object and fills it with the particles passed as initializer_list to this function.

Definition at line 206 of file setup.h.

                                                   {
  ParticlesPtr p = std::make_unique<Particles>();
  for (const auto &data : init) {
    p->insert(data);
  }
  return p;
}

all_reactions_included()

ReactionsBitSet smash::Test::all_reactions_included ( )

inline

returns BitSet of 2->2 reactions, where everything is on

Definition at line 216 of file setup.h.

                                                {
  return ReactionsBitSet().set();
}

no_multiparticle_reactions()

MultiParticleReactionsBitSet smash::Test::no_multiparticle_reactions ( )

inline

returns BitSet for multi-particle reactions, where everything is off

Definition at line 221 of file setup.h.

                                                                 {
  return MultiParticleReactionsBitSet().reset();
}

default_parameters()

ExperimentParameters smash::Test::default_parameters ( int  testparticles = 1, double  dt = 0.1, CollisionCriterion  criterion = CollisionCriterion::Geometric, bool  strings = false, NNbarTreatment  nnbar_treatment = NNbarTreatment::NoAnnihilation, ReactionsBitSet  included_2to2 = all_reactions_included()  )

inline

Creates a standard ExperimentParameters object which works for almost all testing purposes.

If needed you can set the testparticles parameter to a different value than 1.

Definition at line 232 of file setup.h.

                                                              {
  return ExperimentParameters{
      std::make_unique<UniformClock>(0., dt, 300.0),  // labclock
      std::make_unique<UniformClock>(0., 1., 300.0),  // outputclock
      1,                                              // ensembles
      testparticles,                                  // testparticles
      DerivativesMode::CovariantGaussian,             // derivatives mode
      RestFrameDensityDerivativesMode::Off,  // rest frame derivatives mode
      FieldDerivativesMode::ChainRule,       // field derivatives mode
      SmearingMode::CovariantGaussian,       // smearing mode
      1.0,                                   // Gaussian smearing width
      4.0,                                   // Gaussian smearing cut-off
      0.333333,                              // discrete smearing weight
      2.0,                                   // triangular smearing range
      criterion,                             // collision criterion
      true,                                  // two_to_one
      included_2to2,
      no_multiparticle_reactions(),
      strings,
      1.0,
      nnbar_treatment,
      0.,     // low energy sigma_NN cut-off
      false,  // potential_affect_threshold
      -1.0,   // box_length
      200.0,  // max. cross section
      2.5,    // fixed min. cell length
      1.0,    // cross section scaling
      false,  // in thermodynamics outputs spectators are included
      false,  // do weak decays
      true,   // decay initial particles
      SpinInteractionType::Off,  // no spin interactions
      std::nullopt               // use monash tune, not known
  };
}

default_finder_parameters()

ScatterActionsFinderParameters smash::Test::default_finder_parameters ( double  elastic_parameter = 10, NNbarTreatment  nnbar_treatment = NNbarTreatment::NoAnnihilation, ReactionsBitSet  included_2to2 = all_reactions_included(), bool  strings_switch = true, bool  use_AQM = false, bool  strings_with_probability = false, TotalCrossSectionStrategy  xs_strategy = TotalCrossSectionStrategy::BottomUp  )

inline

Creates a standard ScatterActionsFinderParameters object which works for almost all testing purposes.

The selected arguments are changed between different tests, which requires setting the key by hand. This is not directly possible for enums, so one must do it case by case.

Definition at line 280 of file setup.h.

                                           {
  Configuration config{
      R"(
  Collision_Term:
    Only_Warn_For_High_Probability: true
    Pseudoresonance: None
  )"};
  config.set_value(InputKeys::collTerm_elasticCrossSection, elastic_parameter);
  config.set_value(InputKeys::collTerm_useAQM, use_AQM);
  config.set_value(InputKeys::collTerm_stringsWithProbability,
                   strings_with_probability);
 
  if (xs_strategy == TotalCrossSectionStrategy::BottomUp) {
    config.merge_yaml(InputKeys::collTerm_totXsStrategy.as_yaml("BottomUp"));
  } else if (xs_strategy == TotalCrossSectionStrategy::TopDown) {
    config.merge_yaml(InputKeys::collTerm_totXsStrategy.as_yaml("TopDown"));
  } else if (xs_strategy == TotalCrossSectionStrategy::TopDownMeasured) {
    config.merge_yaml(
        InputKeys::collTerm_totXsStrategy.as_yaml("TopDownMeasured"));
  }
  return ScatterActionsFinderParameters(

default_event_info()

EventInfo smash::Test::default_event_info ( double  impact_parameter = 0.0, bool  empty_event = false  )

inline

Creates default EventInfo object for testing purposes.

Definition at line 310 of file setup.h.

                                                              {

default_string_process_interface()

std::unique_ptr<StringProcess> smash::Test::default_string_process_interface ( )

inline

Creates a default StringProcessInterface object for testing.

Definition at line 317 of file setup.h.

                                                                       {
  return std::make_unique<StringProcess>(
      1.0,      // String_Tension
      1.0,      // String_Formation_Time
      0.5,      // Gluon_Beta
      0.001,    // Gluon_Pmin
      2.0,      // Quark_Alpha
      7.0,      // Quark_Beta
      0.16,     // Strange_Supp
      0.036,    // Diquark_Supp
      0.42,     // Sigma_Perp
      0.2,      // StringZ_A_Leading
      2.0,      // StringZ_B_Leading
      2.0,      // StringZ_A
      0.55,     // StringZ_B
      0.5,      // String_Sigma_T
      1.0,      // Form_Time_Factor
      false,    // Mass_Dependent_Formation_Times
      1. / 3.,  // Prob_proton_to_d_uu

default_dynamic_IC_parameters()

InitialConditionParameters smash::Test::default_dynamic_IC_parameters ( )

inline

Creates default parameters for dynamic IC.

Definition at line 342 of file setup.h.

                                                                  {
  InitialConditionParameters parameters{};
  parameters.type = FluidizationType::Dynamic;
  parameters.fluidizable_processes = FluidizableProcessesBitSet{}.set();
  parameters.energy_density_threshold = 0.5;
  parameters.min_time = 0;
  parameters.max_time = 100;
  parameters.num_fluid_cells = 50;
  parameters.formation_time_fraction = 1;

Variable Documentation

smashon_mass

constexpr double smash::Test::smashon_mass = 0.123

staticconstexpr

The mass of the smashon particle.

Definition at line 57 of file setup.h.

smashon_width

constexpr double smash::Test::smashon_width = 1.2

staticconstexpr

The decay width of the smashon particle.

Definition at line 59 of file setup.h.

smashon_pdg_string

constexpr const char smash::Test::smashon_pdg_string[] = "661"

staticconstexpr

The PDG code of the smashon particle.

Definition at line 61 of file setup.h.