MobilityParametersStochastic< FP > Class Template Reference

CPP API: mio::MobilityParametersStochastic< FP > Class Template Reference
mio::MobilityParametersStochastic< FP > Class Template Reference

parameters that influence mobility. More...

#include <metapopulation_mobility_stochastic.h>

Collaboration diagram for mio::MobilityParametersStochastic< FP >:

Public Member Functions

 MobilityParametersStochastic (const Eigen::VectorX< FP > &coeffs)
 constructor from mobility coefficients. More...
 
 MobilityParametersStochastic (const MobilityCoefficients< FP > &coeffs)
 constructor from mobility coefficients. More...
 
bool operator!= (const MobilityParametersStochastic &other) const
 
bool operator== (const MobilityParametersStochastic &other) const
 equality comparison operators More...
 
MobilityCoefficients< FP > m_coefficients
 Get/Set the mobility coefficients. More...
 
const MobilityCoefficients< FP > & get_coefficients () const
 Get/Set the mobility coefficients. More...
 
MobilityCoefficients< FP > & get_coefficients ()
 Get/Set the mobility coefficients. More...
 
void set_coefficients (const MobilityCoefficients< FP > &coeffs)
 
template<class IOContext >
void serialize (IOContext &io) const
 serialize this. More...
 
template<class IOContext >
static IOResult< MobilityParametersStochasticdeserialize (IOContext &io)
 deserialize an object of this class. More...
 

Detailed Description

template<typename FP>
class mio::MobilityParametersStochastic< FP >

parameters that influence mobility.

Constructor & Destructor Documentation

◆ MobilityParametersStochastic() [1/2]

template<typename FP >
mio::MobilityParametersStochastic< FP >::MobilityParametersStochastic ( const MobilityCoefficients< FP > &  coeffs)
inline

constructor from mobility coefficients.

Parameters
coeffsmobility coefficients

◆ MobilityParametersStochastic() [2/2]

template<typename FP >
mio::MobilityParametersStochastic< FP >::MobilityParametersStochastic ( const Eigen::VectorX< FP > &  coeffs)
inline

constructor from mobility coefficients.

Parameters
coeffsmobility coefficients

Member Function Documentation

◆ deserialize()

template<typename FP >
template<class IOContext >
static IOResult<MobilityParametersStochastic> mio::MobilityParametersStochastic< FP >::deserialize ( IOContext &  io)
inlinestatic

deserialize an object of this class.

See also
mio::deserialize

◆ get_coefficients() [1/2]

template<typename FP >
MobilityCoefficients<FP>& mio::MobilityParametersStochastic< FP >::get_coefficients ( )
inline

Get/Set the mobility coefficients.

The coefficients represent the rates for moving from one node to another by age and infection compartment.

Returns
the mobility coefficients.

◆ get_coefficients() [2/2]

template<typename FP >
const MobilityCoefficients<FP>& mio::MobilityParametersStochastic< FP >::get_coefficients ( ) const
inline

Get/Set the mobility coefficients.

The coefficients represent the rates for moving from one node to another by age and infection compartment.

Returns
the mobility coefficients.

◆ operator!=()

template<typename FP >
bool mio::MobilityParametersStochastic< FP >::operator!= ( const MobilityParametersStochastic< FP > &  other) const
inline

◆ operator==()

template<typename FP >
bool mio::MobilityParametersStochastic< FP >::operator== ( const MobilityParametersStochastic< FP > &  other) const
inline

equality comparison operators

◆ serialize()

template<typename FP >
template<class IOContext >
void mio::MobilityParametersStochastic< FP >::serialize ( IOContext &  io) const
inline

serialize this.

See also
mio::serialize

◆ set_coefficients()

template<typename FP >
void mio::MobilityParametersStochastic< FP >::set_coefficients ( const MobilityCoefficients< FP > &  coeffs)
inline
Parameters
coeffsthe mobility coefficients.

Member Data Documentation

◆ m_coefficients

template<typename FP >
MobilityCoefficients<FP> mio::MobilityParametersStochastic< FP >::m_coefficients
private

Get/Set the mobility coefficients.

The coefficients represent the rates for moving from one node to another by age and infection compartment.

Returns
the mobility coefficients.