Helper class used by the comma initializer operator. More...

#include <CommaInitializer.h>

Public Types
typedef XprType::Scalar	Scalar

Public Member Functions
EIGEN_DEVICE_FUNC	CommaInitializer (XprType &xpr, const Scalar &s)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC	CommaInitializer (XprType &xpr, const DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC	CommaInitializer (const CommaInitializer &o)

EIGEN_DEVICE_FUNC CommaInitializer &	operator, (const Scalar &s)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer &	operator, (const DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC	~CommaInitializer ()

EIGEN_DEVICE_FUNC XprType &	finished ()

Public Attributes
XprType &	m_xpr

Index	m_row

Index	m_col

Index	m_currentBlockRows

Detailed Description

template<typename XprType>
class Eigen::CommaInitializer< XprType >

Helper class used by the comma initializer operator.

This class is internally used to implement the comma initializer feature. It is the return type of MatrixBase::operator<<, and most of the time this is the only way it is used.

See also: \blank MatrixBase::operator<<, CommaInitializer::finished()

Member Typedef Documentation

◆ Scalar

template<typename XprType >

typedef XprType::Scalar Eigen::CommaInitializer< XprType >::Scalar

Constructor & Destructor Documentation

◆ CommaInitializer() [1/3]

template<typename XprType >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::CommaInitializer	(	XprType &	xpr,
		const Scalar &	s
	)

inline

       : m_xpr(xpr), m_row(0), m_col(1), m_currentBlockRows(1) {
     eigen_assert(m_xpr.rows() > 0 && m_xpr.cols() > 0 && "Cannot comma-initialize a 0x0 matrix (operator<<)");
     m_xpr.coeffRef(0, 0) = s;
   }

References eigen_assert, Eigen::CommaInitializer< XprType >::m_xpr, and s.

◆ CommaInitializer() [2/3]

template<typename XprType >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::CommaInitializer	(	XprType &	xpr,
		const DenseBase< OtherDerived > &	other
	)

inline

       : m_xpr(xpr), m_row(0), m_col(other.cols()), m_currentBlockRows(other.rows()) {
     eigen_assert(m_xpr.rows() >= other.rows() && m_xpr.cols() >= other.cols() &&
                  "Cannot comma-initialize a 0x0 matrix (operator<<)");
     m_xpr.template block<OtherDerived::RowsAtCompileTime, OtherDerived::ColsAtCompileTime>(0, 0, other.rows(),
                                                                                            other.cols()) = other;
   }

References eigen_assert, and Eigen::CommaInitializer< XprType >::m_xpr.

◆ CommaInitializer() [3/3]

template<typename XprType >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::CommaInitializer ( const CommaInitializer< XprType > & o )

inline

       : m_xpr(o.m_xpr), m_row(o.m_row), m_col(o.m_col), m_currentBlockRows(o.m_currentBlockRows) {
     // Mark original object as finished. In absence of R-value references we need to const_cast:
     const_cast<CommaInitializer&>(o).m_row = m_xpr.rows();
     const_cast<CommaInitializer&>(o).m_col = m_xpr.cols();
     const_cast<CommaInitializer&>(o).m_currentBlockRows = 0;
   }

References Eigen::CommaInitializer< XprType >::m_col, Eigen::CommaInitializer< XprType >::m_currentBlockRows, Eigen::CommaInitializer< XprType >::m_row, and Eigen::CommaInitializer< XprType >::m_xpr.

◆ ~CommaInitializer()

template<typename XprType >

EIGEN_DEVICE_FUNC Eigen::CommaInitializer< XprType >::~CommaInitializer ( )

inline

   {
     finished();
   }

References Eigen::CommaInitializer< XprType >::finished().

Member Function Documentation

◆ finished()

template<typename XprType >

EIGEN_DEVICE_FUNC XprType& Eigen::CommaInitializer< XprType >::finished ( )

inline

Returns: the built matrix once all its coefficients have been set. Calling finished is 100% optional. Its purpose is to write expressions like this:
quaternion.fromRotationMatrix((Matrix3f() << axis0, axis1, axis2).finished());

quaternion
void quaternion(void)
Definition: geo_quaternion.cpp:47

                                                {
     eigen_assert(((m_row + m_currentBlockRows) == m_xpr.rows() || m_xpr.cols() == 0) && m_col == m_xpr.cols() &&
                  "Too few coefficients passed to comma initializer (operator<<)");
     return m_xpr;
   }

References eigen_assert, Eigen::CommaInitializer< XprType >::m_col, Eigen::CommaInitializer< XprType >::m_currentBlockRows, Eigen::CommaInitializer< XprType >::m_row, and Eigen::CommaInitializer< XprType >::m_xpr.

Referenced by Eigen::CommaInitializer< XprType >::~CommaInitializer().

◆ operator,() [1/2]

template<typename XprType >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC CommaInitializer& Eigen::CommaInitializer< XprType >::operator, ( const DenseBase< OtherDerived > & other )

inline

                                                                                       {
     if (m_col == m_xpr.cols() && (other.cols() != 0 || other.rows() != m_currentBlockRows)) {
       m_row += m_currentBlockRows;
       m_col = 0;
       m_currentBlockRows = other.rows();
       eigen_assert(m_row + m_currentBlockRows <= m_xpr.rows() &&
                    "Too many rows passed to comma initializer (operator<<)");
     }
     eigen_assert((m_col + other.cols() <= m_xpr.cols()) &&
                  "Too many coefficients passed to comma initializer (operator<<)");
     eigen_assert(m_currentBlockRows == other.rows());
     m_xpr.template block<OtherDerived::RowsAtCompileTime, OtherDerived::ColsAtCompileTime>(m_row, m_col, other.rows(),
                                                                                            other.cols()) = other;
     m_col += other.cols();
     return *this;
   }

References eigen_assert, Eigen::CommaInitializer< XprType >::m_col, Eigen::CommaInitializer< XprType >::m_currentBlockRows, Eigen::CommaInitializer< XprType >::m_row, and Eigen::CommaInitializer< XprType >::m_xpr.

◆ operator,() [2/2]

template<typename XprType >

EIGEN_DEVICE_FUNC CommaInitializer& Eigen::CommaInitializer< XprType >::operator, ( const Scalar & s )

inline

                                                                  {
     if (m_col == m_xpr.cols()) {
       m_row += m_currentBlockRows;
       m_col = 0;
       m_currentBlockRows = 1;
       eigen_assert(m_row < m_xpr.rows() && "Too many rows passed to comma initializer (operator<<)");
     }
     eigen_assert(m_col < m_xpr.cols() && "Too many coefficients passed to comma initializer (operator<<)");
     eigen_assert(m_currentBlockRows == 1);
     m_xpr.coeffRef(m_row, m_col++) = s;
     return *this;
   }