MathUtils::IntegResult Struct Reference

Result for numerical integration. Contains integral value and error estimates. More...

#include <MathUtils_Types.hxx>

Public Member Functions
bool	IsDone () const
	Returns true if integration succeeded.
	operator bool () const
	Conversion to bool for convenient checking.

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Computation status.
size_t	NbIterations = 0
	Number of adaptive iterations.
size_t	NbPoints = 0
	Total number of quadrature points used.
std::optional< double >	Value
	Computed integral value.
std::optional< double >	AbsoluteError
	Estimated absolute error (if computed)
std::optional< double >	RelativeError
	Estimated relative error (if computed)

Detailed Description

Result for numerical integration. Contains integral value and error estimates.

Member Function Documentation

IsDone()

bool MathUtils::IntegResult::IsDone ( ) const

inline

Returns true if integration succeeded.

operator bool()

MathUtils::IntegResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

AbsoluteError

std::optional<double> MathUtils::IntegResult::AbsoluteError

Estimated absolute error (if computed)

NbIterations

size_t MathUtils::IntegResult::NbIterations = 0

Number of adaptive iterations.

NbPoints

size_t MathUtils::IntegResult::NbPoints = 0

Total number of quadrature points used.

RelativeError

std::optional<double> MathUtils::IntegResult::RelativeError

Estimated relative error (if computed)

Status

MathUtils::Status MathUtils::IntegResult::Status = MathUtils::Status::NotConverged

Computation status.

Value

std::optional<double> MathUtils::IntegResult::Value

Computed integral value.

---

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

• MathUtils_Types.hxx