SyTen
syten::IterativeExit Struct Reference

Exit description for an iterative algorithm. More...

#include <iterative.h>

+ Collaboration diagram for syten::IterativeExit:

Public Member Functions

 IterativeExit ()=default
 Default ctor. More...
 
 IterativeExit (IterativeExit const &)=default
 Copy ctor. More...
 
 IterativeExit (IterativeExitReason reason_, std::string const &message_, SRDef error_, Index iter_, SRDef value_)
 Standard ctor, GCC 4.9.2 does not like list initialisation? More...
 

Public Attributes

SRDef error {NAN}
 The error, if calculated. More...
 
Index iter {0}
 number of iterations used More...
 
std::string message {""}
 A custom, short message. More...
 
IterativeExitReason reason {IterativeExitReason::Uninitialised}
 The reason for the exit. More...
 
SRDef value {NAN}
 Space for user-defined value, e.g. More...
 

Detailed Description

Exit description for an iterative algorithm.


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