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

Parameters of an LCT-SECIR-2-DISEASES model. More...

#include <parameters.h>

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

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

Public Member Functions
bool	check_constraints () const
	Checks whether all parameters satisfy their corresponding constraints and throws errors, if they do not. More...
size_t	get_num_groups () const
	Parameters (size_t num_groups)
	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)

Private Attributes
size_t	m_num_groups

Detailed Description

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

Parameters of an LCT-SECIR-2-DISEASES model.

Constructor & Destructor Documentation

Parameters() [1/2]

template<typename FP >

mio::lsecir2d::Parameters< FP >::Parameters ( size_t  num_groups )

inline

Constructor.

Parameters

num_groups

The number of groups considered in the LCT2D model.

Parameters() [2/2]

template<typename FP >

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

inlineprivate

Member Function Documentation

check_constraints()

template<typename FP >

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

inline

Checks whether all parameters satisfy their corresponding constraints and throws errors, if they do not.

Returns

Returns true if one (or more) constraint(s) are not satisfied, otherwise false.

deserialize()

template<typename FP >

template<class IOContext >

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

inlinestatic

deserialize an object of this class.

See also

mio::deserialize

get_num_groups()

template<typename FP >

size_t mio::lsecir2d::Parameters< FP >::get_num_groups ( ) const

inline

Member Data Documentation

m_num_groups

template<typename FP >

size_t mio::lsecir2d::Parameters< FP >::m_num_groups

private