Chebyshev
Unit testing for scientific software
Loading...
Searching...
No Matches
chebyshev::prec::prec_settings Class Reference

Settings for the precision testing module, used in prec_context. More...

#include <prec.h>

Public Attributes

std::string moduleName = "unknown"
 Name of the module being tested.
 
unsigned int defaultIterations = CHEBYSHEV_PREC_ITER
 Default number of iterations for integral quadrature.
 
FailFunction defaultFailFunction = fail::fail_on_max_err()
 Default fail function.
 
long double defaultTolerance = CHEBYSHEV_PREC_TOLERANCE
 Default tolerance on max absolute error.
 
std::vector< std::string > outputFiles {}
 The files to write all precision testing results to.
 
std::vector< std::string > estimateColumns
 Default columns to print for precision estimates.
 
std::vector< std::string > estimateOutputFiles {}
 The files to write estimate results to (if empty, all results are output to a generic file).
 
std::vector< std::string > equationColumns
 Default columns to print for equations.
 
std::vector< std::string > equationOutputFiles {}
 The files to write equation results to (if empty, all results are output to a generic file).
 
std::map< std::string, boolpickedTests {}
 Target tests marked for execution, can be picked by passing test case names by command line (all tests will be executed if empty).
 
bool multithreading = true
 Whether to use multithreading for the execution of accuracy estimation tasks (defaults to true).
 

Detailed Description

Settings for the precision testing module, used in prec_context.

Member Data Documentation

◆ equationColumns

std::vector<std::string> chebyshev::prec::prec_settings::equationColumns
Initial value:
= {
"name", "difference", "tolerance", "failed"
}

Default columns to print for equations.

◆ estimateColumns

std::vector<std::string> chebyshev::prec::prec_settings::estimateColumns
Initial value:
= {
"name", "meanErr", "rmsErr", "maxErr", "failed"
}

Default columns to print for precision estimates.

◆ multithreading

bool chebyshev::prec::prec_settings::multithreading = true

Whether to use multithreading for the execution of accuracy estimation tasks (defaults to true).

If your code is not thread-safe (for example, if it accesses shared memory inside the tested functions), you may need to disable multithreading.


The documentation for this class was generated from the following file: