WPILibC++ 2023.4.3-108-ge5452e3
Eigen::WithFormat< ExpressionType > Class Template Reference

Pseudo expression providing matrix output with given format. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/IO.h>

Public Member Functions

 WithFormat (const ExpressionType &matrix, const IOFormat &format)
 

Protected Attributes

ExpressionType::Nested m_matrix
 
IOFormat m_format
 

Friends

std::ostream & operator<< (std::ostream &s, const WithFormat &wf)
 

Detailed Description

template<typename ExpressionType>
class Eigen::WithFormat< ExpressionType >

Pseudo expression providing matrix output with given format.

Template Parameters
ExpressionTypethe type of the object on which IO stream operations are performed

This class represents an expression with stream operators controlled by a given IOFormat. It is the return type of DenseBase::format() and most of the time this is the only way it is used.

See class IOFormat for some examples.

See also
DenseBase::format(), class IOFormat

Constructor & Destructor Documentation

◆ WithFormat()

template<typename ExpressionType >
Eigen::WithFormat< ExpressionType >::WithFormat ( const ExpressionType &  matrix,
const IOFormat format 
)
inline

Friends And Related Function Documentation

◆ operator<<

template<typename ExpressionType >
std::ostream & operator<< ( std::ostream &  s,
const WithFormat< ExpressionType > &  wf 
)
friend

Member Data Documentation

◆ m_format

template<typename ExpressionType >
IOFormat Eigen::WithFormat< ExpressionType >::m_format
protected

◆ m_matrix

template<typename ExpressionType >
ExpressionType::Nested Eigen::WithFormat< ExpressionType >::m_matrix
protected

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