TEigenFormatReadOnly< Derived > Class Template Reference

Template class wrapping the serializing functionality of eigen to support stream operators using a given format. More...

#include <math/EigenFormat.h>

Inheritance diagram for TEigenFormatReadOnly< Derived >:

Public Member Functions
	TEigenFormatReadOnly (Eigen::MatrixBase< Derived > &matrix, Eigen::IOFormat format)

Static Public Member Functions
static Eigen::IOFormat	matlab (int precision=4)
static Eigen::IOFormat	clean (int precision=4)
static Eigen::IOFormat	eigen (int precision=-1)
static Eigen::IOFormat	python (int precision=4)

Protected Attributes
Eigen::MatrixBase< Derived > &	mMatrix
	The matrix that gets formatted. More...
Eigen::IOFormat	mFormat

Friends
std::ostream &	operator<< (std::ostream &s, const TEigenFormatReadOnly< Derived > &format)
	Output stream operator for writing a matrix to stream in a given format. More...
std::istream &	operator>> (std::istream &is, TEigenFormatReadOnly< Derived > format)
	not supported for read-only matrices More...

Detailed Description

template<typename Derived>
class mira::TEigenFormatReadOnly< Derived >

Template class wrapping the serializing functionality of eigen to support stream operators using a given format.

This variant is for read-only matrices (<< operator supported only)

Constructor & Destructor Documentation

TEigenFormatReadOnly()

TEigenFormatReadOnly ( Eigen::MatrixBase< Derived > &  matrix, Eigen::IOFormat  format  )

inline

Member Function Documentation

matlab()

static Eigen::IOFormat matlab ( int  precision = 4 )

inlinestaticinherited

clean()

static Eigen::IOFormat clean ( int  precision = 4 )

inlinestaticinherited

eigen()

static Eigen::IOFormat eigen ( int  precision = -1 )

inlinestaticinherited

python()

static Eigen::IOFormat python ( int  precision = 4 )

inlinestaticinherited

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  s, const TEigenFormatReadOnly< Derived > &  format  )

friend

Output stream operator for writing a matrix to stream in a given format.

Parameters

s	The output stream
format	The format class

Returns

The stream

operator>>

std::istream& operator>> ( std::istream &  is, TEigenFormatReadOnly< Derived >  format  )

friend

not supported for read-only matrices

Member Data Documentation

mMatrix

Eigen::MatrixBase<Derived>& mMatrix

protected

The matrix that gets formatted.

mFormat

Eigen::IOFormat mFormat

protectedinherited

---

The documentation for this class was generated from the following file:

• base/include/math/EigenFormat.h