line::retrieval::RetrievalFpiResult< T > Struct Template Reference

Mirrors the [pmiss, phit, pdh] return list, plus the iteration diagnostics. More...

#include <line/api/retrieval/retrieval_fpi.h>

Collaboration diagram for line::retrieval::RetrievalFpiResult< T >:

Public Attributes
std::vector< T >	pmiss
	(n) miss ratios pi_{i,0}
Matrix< T >	phit
	(h x n) hit ratios pi_{i,j}
Matrix< T >	pdh
	((r+1) x n) delayed-hit probabilities phi_{s,i}, s = 0..r
std::size_t	iterations = 0
bool	converged = false
bool	diverged = false
	True when the iterate left the finite range; MATLAB warns and breaks here.
std::string	warning
	The reference's line_warning text (divergence or iteration cap), empty when it did not warn.

Detailed Description

template<class T>
struct line::retrieval::RetrievalFpiResult< T >

Mirrors the [pmiss, phit, pdh] return list, plus the iteration diagnostics.

Definition at line 68 of file retrieval_fpi.h.

Member Data Documentation

converged

template<class T>

bool line::retrieval::RetrievalFpiResult< T >::converged = false

Definition at line 73 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi().

diverged

template<class T>

bool line::retrieval::RetrievalFpiResult< T >::diverged = false

True when the iterate left the finite range; MATLAB warns and breaks here.

Definition at line 75 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi().

iterations

template<class T>

std::size_t line::retrieval::RetrievalFpiResult< T >::iterations = 0

Definition at line 72 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi().

pdh

template<class T>

Matrix<T> line::retrieval::RetrievalFpiResult< T >::pdh

((r+1) x n) delayed-hit probabilities phi_{s,i}, s = 0..r

Definition at line 71 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi(), line::retrieval::retrieval_fpi_latency(), and line::mva::solver_mva_retrieval_analyzer().

phit

template<class T>

Matrix<T> line::retrieval::RetrievalFpiResult< T >::phit

(h x n) hit ratios pi_{i,j}

Definition at line 70 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi(), and line::mva::solver_mva_retrieval_analyzer().

pmiss

template<class T>

std::vector<T> line::retrieval::RetrievalFpiResult< T >::pmiss

(n) miss ratios pi_{i,0}

Definition at line 69 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi(), line::retrieval::retrieval_fpi_latency(), and line::mva::solver_mva_retrieval_analyzer().

warning

template<class T>

std::string line::retrieval::RetrievalFpiResult< T >::warning

The reference's line_warning text (divergence or iteration cap), empty when it did not warn.

Definition at line 77 of file retrieval_fpi.h.

Referenced by line::retrieval::retrieval_fpi().

---

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

• include/line/api/retrieval/retrieval_fpi.h