#include <result.hpp>

Collaboration diagram for limes::algorithms::integration_result< T >:

Public Types
using	value_type = T

Public Member Functions
constexpr	integration_result () noexcept=default

constexpr	integration_result (T val, T err, std::size_t iters) noexcept

constexpr	integration_result (T val, T err, std::size_t iters, std::size_t evals) noexcept

constexpr T	value () const noexcept

constexpr T	error () const noexcept

constexpr std::size_t	iterations () const noexcept

constexpr std::size_t	evaluations () const noexcept

constexpr bool	converged () const noexcept

constexpr	operator T () const noexcept

constexpr	operator bool () const noexcept

constexpr T	relative_error () const noexcept

constexpr integration_result &	operator+= (const integration_result &other) noexcept

constexpr integration_result	operator+ (const integration_result &other) const noexcept

constexpr integration_result &	operator*= (T scale) noexcept

constexpr integration_result	operator* (T scale) const noexcept

Public Attributes
T	value_ {}

T	error_ {}

std::size_t	iterations_ {}

std::size_t	evaluations_ {}

bool	converged_ {true}

std::optional< T >	variance_ {}

std::optional< std::vector< T > >	intermediate_values_ {}

Friends
constexpr integration_result	operator* (T scale, const integration_result &r) noexcept

Detailed Description

template<concepts::Field T>
struct limes::algorithms::integration_result< T >

Definition at line 12 of file result.hpp.

Member Typedef Documentation

◆ value_type

template<concepts::Field T>

using limes::algorithms::integration_result< T >::value_type = T

Definition at line 13 of file result.hpp.

Constructor & Destructor Documentation

◆ integration_result() [1/3]

template<concepts::Field T>

constexpr limes::algorithms::integration_result< T >::integration_result ( )

constexprdefaultnoexcept

◆ integration_result() [2/3]

template<concepts::Field T>

constexpr limes::algorithms::integration_result< T >::integration_result	(	T	val,
		T	err,
		std::size_t	iters
	)

inlineconstexprnoexcept

Definition at line 27 of file result.hpp.

◆ integration_result() [3/3]

template<concepts::Field T>

constexpr limes::algorithms::integration_result< T >::integration_result	(	T	val,
		T	err,
		std::size_t	iters,
		std::size_t	evals
	)

inlineconstexprnoexcept

Definition at line 30 of file result.hpp.

Member Function Documentation

◆ converged()

template<concepts::Field T>

constexpr bool limes::algorithms::integration_result< T >::converged ( ) const

inlineconstexprnoexcept

Definition at line 38 of file result.hpp.

References limes::algorithms::integration_result< T >::converged_.

◆ error()

template<concepts::Field T>

constexpr T limes::algorithms::integration_result< T >::error ( ) const

inlineconstexprnoexcept

Definition at line 35 of file result.hpp.

References limes::algorithms::integration_result< T >::error_.

◆ evaluations()

template<concepts::Field T>

constexpr std::size_t limes::algorithms::integration_result< T >::evaluations ( ) const

inlineconstexprnoexcept

Definition at line 37 of file result.hpp.

References limes::algorithms::integration_result< T >::evaluations_.

◆ iterations()

template<concepts::Field T>

constexpr std::size_t limes::algorithms::integration_result< T >::iterations ( ) const

inlineconstexprnoexcept

Definition at line 36 of file result.hpp.

References limes::algorithms::integration_result< T >::iterations_.

◆ operator bool()

template<concepts::Field T>

constexpr limes::algorithms::integration_result< T >::operator bool ( ) const

inlineexplicitconstexprnoexcept

Definition at line 42 of file result.hpp.

References limes::algorithms::integration_result< T >::converged_.

◆ operator T()

template<concepts::Field T>

constexpr limes::algorithms::integration_result< T >::operator T ( ) const

inlineconstexprnoexcept

Definition at line 41 of file result.hpp.

References limes::algorithms::integration_result< T >::value_.

◆ operator*()

template<concepts::Field T>

constexpr integration_result limes::algorithms::integration_result< T >::operator* ( T scale ) const

inlineconstexprnoexcept

Definition at line 73 of file result.hpp.

◆ operator*=()

template<concepts::Field T>

constexpr integration_result & limes::algorithms::integration_result< T >::operator*= ( T scale )

inlineconstexprnoexcept

Definition at line 67 of file result.hpp.

References limes::algorithms::integration_result< T >::error_, and limes::algorithms::integration_result< T >::value_.

◆ operator+()

template<concepts::Field T>

constexpr integration_result limes::algorithms::integration_result< T >::operator+ ( const integration_result< T > & other ) const

inlineconstexprnoexcept

Definition at line 60 of file result.hpp.

◆ operator+=()

template<concepts::Field T>

constexpr integration_result & limes::algorithms::integration_result< T >::operator+= ( const integration_result< T > & other )

inlineconstexprnoexcept

Definition at line 51 of file result.hpp.

References limes::algorithms::integration_result< T >::converged_, limes::algorithms::integration_result< T >::error_, limes::algorithms::integration_result< T >::evaluations_, limes::algorithms::integration_result< T >::iterations_, and limes::algorithms::integration_result< T >::value_.

◆ relative_error()

template<concepts::Field T>

constexpr T limes::algorithms::integration_result< T >::relative_error ( ) const

inlineconstexprnoexcept

Definition at line 45 of file result.hpp.

References limes::algorithms::integration_result< T >::error_, and limes::algorithms::integration_result< T >::value_.

◆ value()

template<concepts::Field T>

constexpr T limes::algorithms::integration_result< T >::value ( ) const

inlineconstexprnoexcept

Definition at line 34 of file result.hpp.

References limes::algorithms::integration_result< T >::value_.

Friends And Related Symbol Documentation

◆ operator*

template<concepts::Field T>

constexpr integration_result operator*	(	T	scale,
		const integration_result< T > &	r
	)

friend

Definition at line 79 of file result.hpp.

Member Data Documentation

◆ converged_

template<concepts::Field T>

bool limes::algorithms::integration_result< T >::converged_ {true}

Definition at line 19 of file result.hpp.

Referenced by limes::algorithms::integration_result< T >::converged(), limes::algorithms::integration_result< T >::operator bool(), and limes::algorithms::integration_result< T >::operator+=().

◆ error_

template<concepts::Field T>

T limes::algorithms::integration_result< T >::error_ {}

Definition at line 16 of file result.hpp.

Referenced by limes::algorithms::integration_result< T >::error(), limes::algorithms::integration_result< T >::operator*=(), limes::algorithms::integration_result< T >::operator+=(), and limes::algorithms::integration_result< T >::relative_error().

◆ evaluations_

template<concepts::Field T>

std::size_t limes::algorithms::integration_result< T >::evaluations_ {}

Definition at line 18 of file result.hpp.

Referenced by limes::algorithms::integration_result< T >::evaluations(), and limes::algorithms::integration_result< T >::operator+=().

◆ intermediate_values_

template<concepts::Field T>

std::optional<std::vector<T> > limes::algorithms::integration_result< T >::intermediate_values_ {}

Definition at line 23 of file result.hpp.

◆ iterations_

template<concepts::Field T>

std::size_t limes::algorithms::integration_result< T >::iterations_ {}

Definition at line 17 of file result.hpp.

Referenced by limes::algorithms::integration_result< T >::iterations(), and limes::algorithms::integration_result< T >::operator+=().

◆ value_

template<concepts::Field T>

T limes::algorithms::integration_result< T >::value_ {}

Definition at line 15 of file result.hpp.

Referenced by limes::algorithms::integration_result< T >::operator T(), limes::algorithms::integration_result< T >::operator*=(), limes::algorithms::integration_result< T >::operator+=(), limes::algorithms::integration_result< T >::relative_error(), and limes::algorithms::integration_result< T >::value().

◆ variance_

template<concepts::Field T>

std::optional<T> limes::algorithms::integration_result< T >::variance_ {}

Definition at line 22 of file result.hpp.

Referenced by limes::methods::monte_carlo< T >::operator()().

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

include/limes/algorithms/core/result.hpp

Public Types

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ integration_result() [1/3]

◆ integration_result() [2/3]

◆ integration_result() [3/3]

Member Function Documentation

◆ converged()

◆ error()

◆ evaluations()

◆ iterations()

◆ operator bool()

◆ operator T()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ relative_error()

◆ value()

Friends And Related Symbol Documentation

◆ operator*

Member Data Documentation

◆ converged_

◆ error_

◆ evaluations_

◆ intermediate_values_

◆ iterations_

◆ value_

◆ variance_