line::pfqn::ExplicitResult< T > Struct Template Reference

Return value of pfqn_explicit, mirroring [lG, G, method, lossDigits]. More...

#include <line/api/pfqn/pfqn_explicit.h>

Collaboration diagram for line::pfqn::ExplicitResult< T >:

Public Attributes
T	lG
	logarithm of the normalizing constant
T	G
	the normalizing constant
std::string	method
	expression used, "distinct" (Eq. 15) or "repeated" (Eq. 16)
double	lossDigits = 0.0
	decimal digits lost to cancellation
bool	valid = true
	False when a caller's cancellation budget was exceeded: lG and G are then meaningless and the caller is expected to fall back.

Detailed Description

template<class T>
struct line::pfqn::ExplicitResult< T >

Return value of pfqn_explicit, mirroring [lG, G, method, lossDigits].

Definition at line 63 of file pfqn_explicit.h.

Member Data Documentation

G

template<class T>

T line::pfqn::ExplicitResult< T >::G

the normalizing constant

Definition at line 65 of file pfqn_explicit.h.

Referenced by line::pfqn::pfqn_explicit(), and line::pfqn::pfqn_explicit_ld().

lG

template<class T>

T line::pfqn::ExplicitResult< T >::lG

logarithm of the normalizing constant

Definition at line 64 of file pfqn_explicit.h.

Referenced by line::pfqn::pfqn_explicit(), line::pfqn::pfqn_explicit_ld(), line::pfqn::pfqn_nc(), and line::pfqn::pfqn_ncld().

lossDigits

template<class T>

double line::pfqn::ExplicitResult< T >::lossDigits = 0.0

decimal digits lost to cancellation

Definition at line 67 of file pfqn_explicit.h.

Referenced by line::pfqn::pfqn_explicit(), line::pfqn::pfqn_explicit_ld(), and line::pfqn::pfqn_ncld().

method

template<class T>

std::string line::pfqn::ExplicitResult< T >::method

expression used, "distinct" (Eq. 15) or "repeated" (Eq. 16)

Definition at line 66 of file pfqn_explicit.h.

Referenced by line::pfqn::pfqn_explicit(), line::pfqn::pfqn_explicit_ld(), line::pfqn::pfqn_nc(), and line::pfqn::pfqn_ncld().

valid

template<class T>

bool line::pfqn::ExplicitResult< T >::valid = true

False when a caller's cancellation budget was exceeded: lG and G are then meaningless and the caller is expected to fall back.

Definition at line 70 of file pfqn_explicit.h.

Referenced by line::pfqn::pfqn_explicit(), line::pfqn::pfqn_explicit_ld(), and line::pfqn::pfqn_ncld().

---

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

• include/line/api/pfqn/pfqn_explicit.h