Template Struct global_parameter

Struct Documentation

template<typename T>
struct global_parameter

scheme for handling global parameters and options

the template type is meant to be bool, int, double or string

Public Functions

inline global_parameter()
inline global_parameter(T _def, const string &_name, const string &_des)
inline void print_latex(ostream &out)

Prints the description/help to a latex file.

inline void print_RST(ostream &out)

Prints the description/help to a RST file, such as the ones used in Sphinx documentation.

Public Members

string name

name of the parameter

string description

description, for help

T value

current value of the parameter

T default_value

default value of the parameter