mio::RectMatrixShape< FP > Class Template Reference

shape of a rectangular matrix. More...

#include <matrix_shape.h>

Public Types
using	Matrix = Eigen::MatrixX< FP >

Public Member Functions
Eigen::Index	cols () const
	number of columns. More...
bool	operator!= (const RectMatrixShape &other) const
bool	operator== (const RectMatrixShape &other) const
	equality comparators. More...
	RectMatrixShape (Eigen::Index r, Eigen::Index c)
	construct the shape of a rectangular matrix. More...
Eigen::Index	rows () const
	number of rows. More...
template<class IOContext >
void	serialize (IOContext &io) const
	serialize this. More...

Static Public Member Functions
template<class IOContext >
static IOResult< RectMatrixShape >	deserialize (IOContext &io)
	deserialize an object of this class. More...
template<class ME >
static RectMatrixShape	get_shape_of (const Eigen::MatrixBase< ME > &m)
	extract the shape of a rectangular matrix. More...

Private Attributes
Eigen::Index	m_cols
Eigen::Index	m_rows

Detailed Description

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

shape of a rectangular matrix.

variable rows and cols.

Member Typedef Documentation

Matrix

template<typename FP >

using mio::RectMatrixShape< FP >::Matrix = Eigen::MatrixX<FP>

Constructor & Destructor Documentation

RectMatrixShape()

template<typename FP >

mio::RectMatrixShape< FP >::RectMatrixShape ( Eigen::Index  r, Eigen::Index  c  )

inline

construct the shape of a rectangular matrix.

Parameters

r	number of rows.
c	number of columns.

Member Function Documentation

cols()

template<typename FP >

Eigen::Index mio::RectMatrixShape< FP >::cols ( ) const

inline

number of columns.

deserialize()

template<typename FP >

template<class IOContext >

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

inlinestatic

deserialize an object of this class.

See also

mio::deserialize

get_shape_of()

template<typename FP >

template<class ME >

static RectMatrixShape mio::RectMatrixShape< FP >::get_shape_of ( const Eigen::MatrixBase< ME > &  m )

inlinestatic

extract the shape of a rectangular matrix.

Parameters

m	matrix to take the shape of.

Template Parameters

ME	matrix expression.

operator!=()

template<typename FP >

bool mio::RectMatrixShape< FP >::operator!= ( const RectMatrixShape< FP > &  other ) const

inline

operator==()

template<typename FP >

bool mio::RectMatrixShape< FP >::operator== ( const RectMatrixShape< FP > &  other ) const

inline

equality comparators.

rows()

template<typename FP >

Eigen::Index mio::RectMatrixShape< FP >::rows ( ) const

inline

number of rows.

serialize()

template<typename FP >

template<class IOContext >

void mio::RectMatrixShape< FP >::serialize ( IOContext &  io ) const

inline

serialize this.

See also

mio::serialize

Member Data Documentation

m_cols

template<typename FP >

Eigen::Index mio::RectMatrixShape< FP >::m_cols

private

m_rows

template<typename FP >

Eigen::Index mio::RectMatrixShape< FP >::m_rows

private