mio::ContactMatrixGroup< FP > Class Template Reference

represents a collection of contact frequency matrices that whose sum is the total number of contacts. More...

#include <contact_matrix.h>

Inheritance diagram for mio::ContactMatrixGroup< FP >:

Collaboration diagram for mio::ContactMatrixGroup< FP >:

Public Types
using	Base = DampingMatrixExpressionGroup< FP, ContactMatrix< FP > >
Public Types inherited from mio::DampingMatrixExpressionGroup< FP, ContactMatrix< FP > >
using	const_iterator = typename std::vector< value_type >::const_iterator
using	const_reference = const value_type &
using	DampingsType = typename value_type::DampingsType
using	iterator = typename std::vector< value_type >::iterator
using	Matrix = typename value_type::Matrix
using	reference = value_type &
using	Shape = typename value_type::Shape
using	value_type = ContactMatrix< FP >

Public Member Functions
Eigen::Index	get_num_groups () const
	get the number of groups. More...
Public Member Functions inherited from mio::DampingMatrixExpressionGroup< FP, ContactMatrix< FP > >
T class Derived static IOResult< Derived >	deserialize (IOContext &io, Tag< Derived >)
	requires (std::is_constructible_v< Shape, T... >) explicit DampingMatrixExpressionGroup(size_t num_matrices
	create a collection. More...

Static Public Member Functions
template<class IOContext >
static IOResult< ContactMatrixGroup >	deserialize (IOContext &io)
	deserialize an object of this class. More...
Static Public Member Functions inherited from mio::DampingMatrixExpressionGroup< FP, ContactMatrix< FP > >
static IOResult< DampingMatrixExpressionGroup >	deserialize (IOContext &io)
	deserialize an object of this class. More...

Additional Inherited Members
Public Attributes inherited from mio::DampingMatrixExpressionGroup< FP, ContactMatrix< FP > >
T	shape_args
T	value_type

Detailed Description

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

represents a collection of contact frequency matrices that whose sum is the total number of contacts.

can separate matrices of contacts in different contexts, e.g. work, leisure, etc.

Member Typedef Documentation

Base

template<typename FP >

using mio::ContactMatrixGroup< FP >::Base = DampingMatrixExpressionGroup<FP, ContactMatrix<FP> >

Member Function Documentation

deserialize()

template<typename FP >

template<class IOContext >

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

inlinestatic

deserialize an object of this class.

See also

mio::deserialize

get_num_groups()

template<typename FP >

Eigen::Index mio::ContactMatrixGroup< FP >::get_num_groups ( ) const

inline

get the number of groups.