SyTen
syten::IterativeConfig Struct Reference

Configuration for an iterative eigensolver or exponential algorithm. More...

#include <iterative.h>

+ Inheritance diagram for syten::IterativeConfig:
+ Collaboration diagram for syten::IterativeConfig:

Public Member Functions

 IterativeConfig (SRDef errTolerance_, SRDef inxTolerance_, Index maxIter_, Index minIter_, Index stepSolver_, Index maxGainlessSteps_, char mode_, char submode_)
 Standard ctor, because gcc 4.9.2 does not like braced init lists. More...
 
template<typename Archive >
void serialize (Archive &ar, const unsigned int in_version)
 Standard serialisation function. More...
 

Public Attributes

SRDef errTolerance {SYTEN_SMALL_THRESHOLD}
 Allowed error tolerance, e.g. More...
 
SRDef inxTolerance {1000 * SYTEN_SMALL_THRESHOLD}
 Allowed error from inexact arithmetic, e.g. More...
 
Index maxGainlessSteps {5}
 Maximal number of steps without gain. More...
 
Index maxIter {8}
 Maximal number of iterations. More...
 
Index minIter {2}
 Minimal number of iterations. More...
 
char mode {'C'}
 The mode of operation, see modes_help for documentation. More...
 
Index stepSolver {2}
 Check progress every stepSolver'th step. More...
 
char submode {'a'}
 Submode, primarily used for re-orthogonalisation configuration, see submodes_help for documentation. More...
 

Static Public Attributes

static std::string evolve_modes_help
 Static string describing the available modes. More...
 
static std::string evolve_submodes_help
 Static string describing the available sub-modes. More...
 
static std::string simple_modes_help
 Static string describing the available modes. More...
 
static std::string simple_submodes_help
 Static string describing the available sub-modes. More...
 
static constexpr unsigned int version = 2
 Bump this if the above changes. More...
 

Detailed Description

Configuration for an iterative eigensolver or exponential algorithm.


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