smash::Result Class Reference

#include <integrate.h>

The result type returned from integrations, containing the value and an error.

Definition at line 54 of file integrate.h.

Inheritance diagram for smash::Result:

Public Member Functions
	operator double () const
	Conversion to double yields the value of the integral. More...
double	value () const
	Access the first entry in the pair as the value. More...
double	error () const
	Access the second entry in the pair as the absolute error. More...
void	check_error (const std::string &integration_name, double relative_tolerance=5e-4, double absolute_tolerance=1e-9) const
	Check whether the error is small and alert if it is not. More...

Private Types
using	Base = std::pair< double, double >
	The data type to store the value and the error of the integration. More...

Member Typedef Documentation

Base

using smash::Result::Base = std::pair<double, double>

private

The data type to store the value and the error of the integration.

Definition at line 56 of file integrate.h.

Member Function Documentation

operator double()

smash::Result::operator double ( ) const

inline

Conversion to double yields the value of the integral.

Definition at line 63 of file integrate.h.

{ return Base::first; }

value()

double smash::Result::value ( ) const

inline

Access the first entry in the pair as the value.

Definition at line 66 of file integrate.h.

{ return Base::first; }

error()

double smash::Result::error ( ) const

inline

Access the second entry in the pair as the absolute error.

Definition at line 69 of file integrate.h.

{ return Base::second; }

check_error()

void smash::Result::check_error ( const std::string &  integration_name, double  relative_tolerance = 5e-4, double  absolute_tolerance = 1e-9  ) const

inline

Check whether the error is small and alert if it is not.

Parameters

[in]	integration_name	Name of the integration used for error message.
[in]	relative_tolerance	Relative error tolerance.
[in]	absolute_tolerance	Absolute error tolerance.

Definition at line 79 of file integrate.h.

                                                           {
    const double allowed_error =
        std::max(absolute_tolerance, value() * relative_tolerance);
    if (error() > allowed_error) {
      std::stringstream error_msg;
      error_msg << integration_name << " resulted in I = " << value() << " ± "
                << error()
                << ", but the required precision is either absolute error < "
                << absolute_tolerance << " or relative error < "
                << relative_tolerance << std::endl;
      throw std::runtime_error(error_msg.str());
    }
  }

---

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

• src/include/smash/integrate.h