mio::glsecir::Parameters< FP > Class Template Reference

Parameters of an GLCT-SECIR model. More...

#include <parameters.h>

Inheritance diagram for mio::glsecir::Parameters< FP >:

Collaboration diagram for mio::glsecir::Parameters< FP >:

Public Member Functions
bool	check_constraints () const
	Checks that all parameters satisfy their corresponding constraints and logs an error if constraints are not satisfied. More...
	Parameters ()
	Default constructor. More...
Public Member Functions inherited from mio::ParameterSet< Tags >
template<class Tag >
ParameterTagTraits< Tag >::Type &	get ()
	get value of a parameter More...
template<class Tag >
const ParameterTagTraits< Tag >::Type &	get () const
	get value of a parameter More...
bool	operator!= (const ParameterSet &b) const
bool	operator== (const ParameterSet &b) const
template<class Dummy = void, class = std::enable_if_t< details::AllOf<has_get_default_member_function, ParameterTagTraits<Tags>...>::value, Dummy>>
	ParameterSet ()
	default initializing constructor Initializes each parameter using either the get_default function defined in the parameter tag or the default constructor. More...
template<class Dummy = void, class = std::enable_if_t<details::AllOf<std::is_default_constructible, typename Tags::Type...>::value, Dummy>>
	ParameterSet (NoDefaultInit)
	Non-initializing default constructor. More...
template<class T1 , class... TN, class = std::enable_if_t< !std::is_same_v<std::decay_t<T1>, ParameterSet> && details::AllOf<details::BindTail<has_get_default_member_function, T1, TN...>::template type, ParameterTagTraits<Tags>...>::value>>
	ParameterSet (T1 &&arg1, TN &&... argn)
	default initializing constructor. More...
template<class IOContext >
void	serialize (IOContext &io) const
	serialize this. More...
template<class Tag >
void	set (const typename ParameterTagTraits< Tag >::Type &value)
	set value of a parameter More...
template<class Tag , class T >
void	set (T &&arg)
	set value of a parameter More...
template<class Tag , class... T>
std::enable_if_t< has_get_default_member_function< ParameterTagTraits< Tag >, T... >::value, void >	set_default (T &&... ts)
	(re)set parameter to its default value More...

Static Public Member Functions
template<class IOContext >
static IOResult< Parameters >	deserialize (IOContext &io)
	deserialize an object of this class. More...
Static Public Member Functions inherited from mio::ParameterSet< Tags >
template<class IOContext >
static IOResult< ParameterSet >	deserialize (IOContext &io)
	deserialize an object of this class. More...
static constexpr size_t	size ()
	returns the number of parameters More...

Private Member Functions
	Parameters (ParametersBase< FP > &&base)

Detailed Description

template<typename FP>
class mio::glsecir::Parameters< FP >

Parameters of an GLCT-SECIR model.

Constructor & Destructor Documentation

Parameters() [1/2]

template<typename FP >

mio::glsecir::Parameters< FP >::Parameters ( )

inline

Default constructor.

Parameters() [2/2]

template<typename FP >

mio::glsecir::Parameters< FP >::Parameters ( ParametersBase< FP > &&  base )

inlineprivate

Member Function Documentation

check_constraints()

template<typename FP >

bool mio::glsecir::Parameters< FP >::check_constraints ( ) const

inline

Checks that all parameters satisfy their corresponding constraints and logs an error if constraints are not satisfied.

Returns

Returns true if one or more constraints are not satisfied, false otherwise.

deserialize()

template<typename FP >

template<class IOContext >

static IOResult<Parameters> mio::glsecir::Parameters< FP >::deserialize ( IOContext &  io )

inlinestatic

deserialize an object of this class.

See also

mio::deserialize