Precision testing context, handling precision test cases. More...

#include <prec.h>

Public Member Functions
void	setup (const std::string &moduleName, int argc=0, const char **argv=nullptr)
	Setup the precision testing module.

void	terminate (bool exit=false)
	Terminate the precision testing module.

	prec_context (const std::string &moduleName, int argc, const char **argv)
	Construct a precision testing context.

	~prec_context ()
	Destructor for the context, automatically terminates the module.

	prec_context (const prec_context &other)
	Custom copy constructor to avoid copying std::mutex.

prec_context &	operator= (const prec_context &other)
	Custom assignment operator to avoid copying std::mutex.

template<typename R , typename ... Args, typename Function1 = std::function<R(Args...)>, typename Function2 = Function1>
void	estimate (const std::string &name, Function1 funcApprox, Function2 funcExpected, estimate_options< R, Args... > opt)
	Estimate error integrals over a function with respect to an exact function, with the given options.

template<typename R , typename ... Args, typename Function1 = std::function<R(Args...)>, typename Function2 = Function1>
void	estimate (const std::string &name, Function1 funcApprox, Function2 funcExpected, std::vector< interval > domain, long double tolerance, unsigned int iterations, FailFunction fail, Estimator< R, Args... > estimator, bool quiet=false)
	Estimate error integrals over a function with respect to an exact function.

void	estimate (const std::string &name, EndoFunction< double > funcApprox, EndoFunction< double > funcExpected, interval domain, long double tolerance=get_nan(), unsigned int iterations=0, FailFunction fail=fail::fail_on_max_err(), Estimator< double, double > estimator=estimator::quadrature1D< double >(), bool quiet=false)
	Estimate error integrals over a real function of real variable, with respect to an exact function.

template<typename Type , typename Identity = EndoFunction<Type>>
void	identity (const std::string &name, Identity id, const estimate_options< Type, Type > &opt)
	Precision testing of an endofunction which is equivalent to the identity.

template<typename Type , typename Involution = EndoFunction<Type>>
void	involution (const std::string &name, Involution invol, const estimate_options< Type, Type > &opt)
	Precision testing of an endofunction which is an involution.

template<typename Type , typename Involution = EndoFunction<Type>>
void	idempotence (const std::string &name, Involution idem, const estimate_options< Type, Type > &opt)
	Precision testing of an endofunction which is idempotent.

template<typename InputType , typename OutputType = InputType, typename Homogeneous = std::function<OutputType(InputType)>>
void	homogeneous (const std::string &name, Homogeneous hom, const estimate_options< InputType, OutputType > &opt, OutputType zero_element=OutputType(0.0))
	Precision testing of an function which is homogeneous over the domain.

template<typename Type = double>
void	equals (const std::string &name, const Type &evaluated, const Type &expected, equation_options< Type > opt=equation_options< Type >())
	Test an equivalence up to a tolerance, with the given options (e.g.

template<typename Type = double>
void	equals (const std::string &name, const Type &evaluated, const Type &expected, long double tolerance, DistanceFunction< Type > distance, bool quiet=false)
	Test an equivalence up to a tolerance, with the given options (e.g.

void	equals (const std::string &name, long double evaluated, long double expected, long double tolerance=get_nan(), bool quiet=false)
	Test an equivalence up to a tolerance, with the given options (e.g.

template<typename Type >
void	equals (const std::string &name, std::vector< std::array< Type, 2 > > values, long double tolerance=get_nan(), bool quiet=false)
	Evaluate multiple pairs of values for equivalence up to the given tolerance (e.g.

void	wait_results ()
	Wait for all concurrent test cases to finish execution.

std::vector< estimate_result >	get_estimate (const std::string &name)
	Get the results of error estimation by label.

estimate_result	get_estimate (const std::string &name, unsigned int i)
	Get a single result of error estimation by label and index.

std::vector< equation_result >	get_equation (const std::string &name)
	Get the results of equation testing by label.

equation_result	get_equation (const std::string &name, unsigned int i)
	Get a single result of equation testing by label and index.

Public Attributes
prec_settings	settings
	Settings for the precision testing context.

std::shared_ptr< output::output_context >	output
	Output module settings for the context, dynamically allocated and possibly shared between multiple contexts.

std::shared_ptr< random::random_context >	random
	Random module settings for the context, dynamically allocated and possibly shared between multiple contexts.

Detailed Description

Precision testing context, handling precision test cases.

Constructor & Destructor Documentation

◆ prec_context()

chebyshev::prec::prec_context::prec_context	(	const std::string &	moduleName,
		int	argc,
		const char **	argv
	)

inline

Construct a precision testing context.

Parameters

moduleName	Name of the module under test
argc	Number of command line arguments
argv	List of command line arguments as C strings

Member Function Documentation

◆ equals() [1/4]

template<typename Type = double>

void chebyshev::prec::prec_context::equals	(	const std::string &	name,
		const Type &	evaluated,
		const Type &	expected,
		equation_options< Type >	opt = `equation_options<Type>()`
	)

inline

Test an equivalence up to a tolerance, with the given options (e.g.

for residual testing).

Parameters

name	The name of the test case
evaluate	The evaluated value
expected	The expected value
opt	The options for the evaluation

◆ equals() [2/4]

template<typename Type = double>

void chebyshev::prec::prec_context::equals	(	const std::string &	name,
		const Type &	evaluated,
		const Type &	expected,
		long double	tolerance,
		DistanceFunction< Type >	distance,
		bool	quiet = `false`
	)

inline

Test an equivalence up to a tolerance, with the given options (e.g.

for residual testing).

Parameters

name	The name of the test case
evaluate	The evaluated value
expected	The expected value
distance	The distance function to use
tolerance	The tolerance for the evaluation
quiet	Whether to output the result

◆ equals() [3/4]

void chebyshev::prec::prec_context::equals	(	const std::string &	name,
		long double	evaluated,
		long double	expected,
		long double	tolerance = `get_nan()`,
		bool	quiet = `false`
	)

inline

Test an equivalence up to a tolerance, with the given options (e.g.

for residual testing).

Parameters

name	The name of the test case
evaluate	The evaluated value
expected	The expected value
tolerance	The tolerance for the evaluation
quiet	Whether to output the result

◆ equals() [4/4]

template<typename Type >

void chebyshev::prec::prec_context::equals	(	const std::string &	name,
		std::vector< std::array< Type, 2 > >	values,
		long double	tolerance = `get_nan()`,
		bool	quiet = `false`
	)

inline

Evaluate multiple pairs of values for equivalence up to the given tolerance (e.g.

for residual testing).

Parameters

name	The name of the function or test case
values	A list of values to equate
tolerance	The tolerance for the evaluation
quiet	Whether to output the result

◆ estimate() [1/3]

void chebyshev::prec::prec_context::estimate	(	const std::string &	name,
		EndoFunction< double >	funcApprox,
		EndoFunction< double >	funcExpected,
		interval	domain,
		long double	tolerance = `get_nan()`,
		unsigned int	iterations = `0`,
		FailFunction	fail = `fail::fail_on_max_err()`,
		Estimator< double, double >	estimator = `estimator::quadrature1D<double>()`,
		bool	quiet = `false`
	)

inline

Estimate error integrals over a real function of real variable, with respect to an exact function.

Parameters

name	The name of the test case.
funcApprox	The approximation to test.
funcExpected	The expected result.
intervals	The (potentially multidimensional) domain of estimation.
iterations	The number of function evaluations.
fail	The fail function to determine whether the test failed (defaults to fail_on_max_err).
estimator	The precision estimator to use (defaults to the trapezoid<double> estimator).
quiet	Whether to output the result.

◆ estimate() [2/3]

template<typename R , typename ... Args, typename Function1 = std::function<R(Args...)>, typename Function2 = Function1>

void chebyshev::prec::prec_context::estimate	(	const std::string &	name,
		Function1	funcApprox,
		Function2	funcExpected,
		estimate_options< R, Args... >	opt
	)

inline

Estimate error integrals over a function with respect to an exact function, with the given options.

Parameters

name	The name of the test case
funcApprox	The approximation to test
funcExpected	The expected result
opt	The options for the estimation

◆ estimate() [3/3]

template<typename R , typename ... Args, typename Function1 = std::function<R(Args...)>, typename Function2 = Function1>

void chebyshev::prec::prec_context::estimate	(	const std::string &	name,
		Function1	funcApprox,
		Function2	funcExpected,
		std::vector< interval >	domain,
		long double	tolerance,
		unsigned int	iterations,
		FailFunction	fail,
		Estimator< R, Args... >	estimator,
		bool	quiet = `false`
	)

inline

Estimate error integrals over a function with respect to an exact function.

Parameters

name	The name of the test case.
funcApprox	The approximation to test.
funcExpected	The expected result.
intervals	The (potentially multidimensional) domain of estimation.
iterations	The number of function evaluations.
fail	The fail function to determine whether the test failed.
estimator	The precision estimator to use.
quiet	Whether to output the result.

◆ get_estimate() [1/2]

std::vector< estimate_result > chebyshev::prec::prec_context::get_estimate ( const std::string & name )

inline

Get the results of error estimation by label.

Note: This function waits for all previous test cases to end before returning, so it is advised to retrieve test results after all tests have been requested.

◆ get_estimate() [2/2]

estimate_result chebyshev::prec::prec_context::get_estimate	(	const std::string &	name,
		unsigned int	i
	)

inline

Get a single result of error estimation by label and index.

Note: This function waits for all previous test cases to end before returning, so it is advised to retrieve test results after all tests have been requested.

◆ homogeneous()

template<typename InputType , typename OutputType = InputType, typename Homogeneous = std::function<OutputType(InputType)>>

void chebyshev::prec::prec_context::homogeneous	(	const std::string &	name,
		Homogeneous	hom,
		const estimate_options< InputType, OutputType > &	opt,
		OutputType	zero_element = `OutputType(0.0)`
	)

inline

Precision testing of an function which is homogeneous over the domain.

The function is applied to input values and it is checked against zero. The zero value is constructed as OutputType(0.0), but may be specified as an additional argument.

Parameters

name	The name of the test case.
hom	The homogeneous function to test.
opt	The options for estimation.
zero_element	The zero element of type OutputType (defaults to OutputType(0.0)).

◆ idempotence()

template<typename Type , typename Involution = EndoFunction<Type>>

void chebyshev::prec::prec_context::idempotence	(	const std::string &	name,
		Involution	idem,
		const estimate_options< Type, Type > &	opt
	)

inline

Precision testing of an endofunction which is idempotent.

The function is applied two times to input values and it is checked against itself.

Parameters

name	The name of the test case.
idem	The idempotent function to test.
opt	The options for estimation.

◆ identity()

template<typename Type , typename Identity = EndoFunction<Type>>

void chebyshev::prec::prec_context::identity	(	const std::string &	name,
		Identity	id,
		const estimate_options< Type, Type > &	opt
	)

inline

Precision testing of an endofunction which is equivalent to the identity.

Parameters

name	The name of the test case.
id	The identity function to test.
opt	The options for estimation.

◆ involution()

template<typename Type , typename Involution = EndoFunction<Type>>

void chebyshev::prec::prec_context::involution	(	const std::string &	name,
		Involution	invol,
		const estimate_options< Type, Type > &	opt
	)

inline

Precision testing of an endofunction which is an involution.

The function is applied two times to input values and it is checked against the identity.

Parameters

name	The name of the test case.
involution	The involution to test.
opt	The options for estimation.

◆ setup()

void chebyshev::prec::prec_context::setup	(	const std::string &	moduleName,
		int	argc = `0`,
		const char **	argv = `nullptr`
	)

inline

Setup the precision testing module.

Parameters

moduleName	Name of the module under test
argc	Number of command line arguments
argv	List of command line arguments as C strings

◆ terminate()

void chebyshev::prec::prec_context::terminate ( bool exit = false )

inline

Terminate the precision testing module.

Parameters

exit	Whether to exit after finishing execution.

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

prec.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ prec_context()

Member Function Documentation

◆ equals() [1/4]

◆ equals() [2/4]

◆ equals() [3/4]

◆ equals() [4/4]

◆ estimate() [1/3]

◆ estimate() [2/3]

◆ estimate() [3/3]

◆ get_estimate() [1/2]

◆ get_estimate() [2/2]

◆ homogeneous()

◆ idempotence()

◆ identity()

◆ involution()

◆ setup()

◆ terminate()