Michael Ernst Peter / Eigen

src/Core/CommaInitializer.h@1:3b8049da21b8, 2019-09-24 (annotated)

Committer:
jsoh91
Date:
Tue Sep 24 00:18:23 2019 +0000
Revision:
1:3b8049da21b8
Parent:
0:13a5d365ba16 
ignore and revise some of error parts

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ykuroda 0:13a5d365ba16 1 // This file is part of Eigen, a lightweight C++ template library
ykuroda 0:13a5d365ba16 2 // for linear algebra.
ykuroda 0:13a5d365ba16 3 //
ykuroda 0:13a5d365ba16 4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
ykuroda 0:13a5d365ba16 5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
ykuroda 0:13a5d365ba16 6 //
ykuroda 0:13a5d365ba16 7 // This Source Code Form is subject to the terms of the Mozilla
ykuroda 0:13a5d365ba16 8 // Public License v. 2.0. If a copy of the MPL was not distributed
ykuroda 0:13a5d365ba16 9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
ykuroda 0:13a5d365ba16 10
ykuroda 0:13a5d365ba16 11 #ifndef EIGEN_COMMAINITIALIZER_H
ykuroda 0:13a5d365ba16 12 #define EIGEN_COMMAINITIALIZER_H
ykuroda 0:13a5d365ba16 13
ykuroda 0:13a5d365ba16 14 namespace Eigen {
ykuroda 0:13a5d365ba16 15
ykuroda 0:13a5d365ba16 16 /** \class CommaInitializer
ykuroda 0:13a5d365ba16 17 * \ingroup Core_Module
ykuroda 0:13a5d365ba16 18 *
ykuroda 0:13a5d365ba16 19 * \brief Helper class used by the comma initializer operator
ykuroda 0:13a5d365ba16 20 *
ykuroda 0:13a5d365ba16 21 * This class is internally used to implement the comma initializer feature. It is
ykuroda 0:13a5d365ba16 22 * the return type of MatrixBase::operator<<, and most of the time this is the only
ykuroda 0:13a5d365ba16 23 * way it is used.
ykuroda 0:13a5d365ba16 24 *
ykuroda 0:13a5d365ba16 25 * \sa \ref MatrixBaseCommaInitRef "MatrixBase::operator<<", CommaInitializer::finished()
ykuroda 0:13a5d365ba16 26 */
ykuroda 0:13a5d365ba16 27 template<typename XprType>
ykuroda 0:13a5d365ba16 28 struct CommaInitializer
ykuroda 0:13a5d365ba16 29 {
ykuroda 0:13a5d365ba16 30 typedef typename XprType::Scalar Scalar;
ykuroda 0:13a5d365ba16 31 typedef typename XprType::Index Index;
ykuroda 0:13a5d365ba16 32
ykuroda 0:13a5d365ba16 33 inline CommaInitializer(XprType& xpr, const Scalar& s)
ykuroda 0:13a5d365ba16 34 : m_xpr(xpr), m_row(0), m_col(1), m_currentBlockRows(1)
ykuroda 0:13a5d365ba16 35 {
ykuroda 0:13a5d365ba16 36 m_xpr.coeffRef(0,0) = s;
ykuroda 0:13a5d365ba16 37 }
ykuroda 0:13a5d365ba16 38
ykuroda 0:13a5d365ba16 39 template<typename OtherDerived>
ykuroda 0:13a5d365ba16 40 inline CommaInitializer(XprType& xpr, const DenseBase<OtherDerived>& other)
ykuroda 0:13a5d365ba16 41 : m_xpr(xpr), m_row(0), m_col(other.cols()), m_currentBlockRows(other.rows())
ykuroda 0:13a5d365ba16 42 {
ykuroda 0:13a5d365ba16 43 m_xpr.block(0, 0, other.rows(), other.cols()) = other;
ykuroda 0:13a5d365ba16 44 }
ykuroda 0:13a5d365ba16 45
ykuroda 0:13a5d365ba16 46 /* Copy/Move constructor which transfers ownership. This is crucial in
ykuroda 0:13a5d365ba16 47 * absence of return value optimization to avoid assertions during destruction. */
ykuroda 0:13a5d365ba16 48 // FIXME in C++11 mode this could be replaced by a proper RValue constructor
ykuroda 0:13a5d365ba16 49 inline CommaInitializer(const CommaInitializer& o)
ykuroda 0:13a5d365ba16 50 : m_xpr(o.m_xpr), m_row(o.m_row), m_col(o.m_col), m_currentBlockRows(o.m_currentBlockRows) {
ykuroda 0:13a5d365ba16 51 // Mark original object as finished. In absence of R-value references we need to const_cast:
ykuroda 0:13a5d365ba16 52 const_cast<CommaInitializer&>(o).m_row = m_xpr.rows();
ykuroda 0:13a5d365ba16 53 const_cast<CommaInitializer&>(o).m_col = m_xpr.cols();
ykuroda 0:13a5d365ba16 54 const_cast<CommaInitializer&>(o).m_currentBlockRows = 0;
ykuroda 0:13a5d365ba16 55 }
ykuroda 0:13a5d365ba16 56
ykuroda 0:13a5d365ba16 57 /* inserts a scalar value in the target matrix */
ykuroda 0:13a5d365ba16 58 CommaInitializer& operator,(const Scalar& s)
ykuroda 0:13a5d365ba16 59 {
ykuroda 0:13a5d365ba16 60 if (m_col==m_xpr.cols())
ykuroda 0:13a5d365ba16 61 {
ykuroda 0:13a5d365ba16 62 m_row+=m_currentBlockRows;
ykuroda 0:13a5d365ba16 63 m_col = 0;
ykuroda 0:13a5d365ba16 64 m_currentBlockRows = 1;
ykuroda 0:13a5d365ba16 65 eigen_assert(m_row<m_xpr.rows()
ykuroda 0:13a5d365ba16 66 && "Too many rows passed to comma initializer (operator<<)");
ykuroda 0:13a5d365ba16 67 }
ykuroda 0:13a5d365ba16 68 eigen_assert(m_col<m_xpr.cols()
ykuroda 0:13a5d365ba16 69 && "Too many coefficients passed to comma initializer (operator<<)");
ykuroda 0:13a5d365ba16 70 eigen_assert(m_currentBlockRows==1);
ykuroda 0:13a5d365ba16 71 m_xpr.coeffRef(m_row, m_col++) = s;
ykuroda 0:13a5d365ba16 72 return *this;
ykuroda 0:13a5d365ba16 73 }
ykuroda 0:13a5d365ba16 74
ykuroda 0:13a5d365ba16 75 /* inserts a matrix expression in the target matrix */
ykuroda 0:13a5d365ba16 76 template<typename OtherDerived>
ykuroda 0:13a5d365ba16 77 CommaInitializer& operator,(const DenseBase<OtherDerived>& other)
ykuroda 0:13a5d365ba16 78 {
ykuroda 0:13a5d365ba16 79 if(other.cols()==0 || other.rows()==0)
ykuroda 0:13a5d365ba16 80 return *this;
ykuroda 0:13a5d365ba16 81 if (m_col==m_xpr.cols())
ykuroda 0:13a5d365ba16 82 {
ykuroda 0:13a5d365ba16 83 m_row+=m_currentBlockRows;
ykuroda 0:13a5d365ba16 84 m_col = 0;
ykuroda 0:13a5d365ba16 85 m_currentBlockRows = other.rows();
ykuroda 0:13a5d365ba16 86 eigen_assert(m_row+m_currentBlockRows<=m_xpr.rows()
ykuroda 0:13a5d365ba16 87 && "Too many rows passed to comma initializer (operator<<)");
ykuroda 0:13a5d365ba16 88 }
ykuroda 0:13a5d365ba16 89 eigen_assert(m_col<m_xpr.cols()
ykuroda 0:13a5d365ba16 90 && "Too many coefficients passed to comma initializer (operator<<)");
ykuroda 0:13a5d365ba16 91 eigen_assert(m_currentBlockRows==other.rows());
ykuroda 0:13a5d365ba16 92 if (OtherDerived::SizeAtCompileTime != Dynamic)
ykuroda 0:13a5d365ba16 93 m_xpr.template block<OtherDerived::RowsAtCompileTime != Dynamic ? OtherDerived::RowsAtCompileTime : 1,
ykuroda 0:13a5d365ba16 94 OtherDerived::ColsAtCompileTime != Dynamic ? OtherDerived::ColsAtCompileTime : 1>
ykuroda 0:13a5d365ba16 95 (m_row, m_col) = other;
ykuroda 0:13a5d365ba16 96 else
ykuroda 0:13a5d365ba16 97 m_xpr.block(m_row, m_col, other.rows(), other.cols()) = other;
ykuroda 0:13a5d365ba16 98 m_col += other.cols();
ykuroda 0:13a5d365ba16 99 return *this;
ykuroda 0:13a5d365ba16 100 }
ykuroda 0:13a5d365ba16 101
ykuroda 0:13a5d365ba16 102 inline ~CommaInitializer()
ykuroda 0:13a5d365ba16 103 {
ykuroda 0:13a5d365ba16 104 eigen_assert((m_row+m_currentBlockRows) == m_xpr.rows()
ykuroda 0:13a5d365ba16 105 && m_col == m_xpr.cols()
ykuroda 0:13a5d365ba16 106 && "Too few coefficients passed to comma initializer (operator<<)");
ykuroda 0:13a5d365ba16 107 }
ykuroda 0:13a5d365ba16 108
ykuroda 0:13a5d365ba16 109 /** \returns the built matrix once all its coefficients have been set.
ykuroda 0:13a5d365ba16 110 * Calling finished is 100% optional. Its purpose is to write expressions
ykuroda 0:13a5d365ba16 111 * like this:
ykuroda 0:13a5d365ba16 112 * \code
ykuroda 0:13a5d365ba16 113 * quaternion.fromRotationMatrix((Matrix3f() << axis0, axis1, axis2).finished());
ykuroda 0:13a5d365ba16 114 * \endcode
ykuroda 0:13a5d365ba16 115 */
ykuroda 0:13a5d365ba16 116 inline XprType& finished() { return m_xpr; }
ykuroda 0:13a5d365ba16 117
ykuroda 0:13a5d365ba16 118 XprType& m_xpr; // target expression
ykuroda 0:13a5d365ba16 119 Index m_row; // current row id
ykuroda 0:13a5d365ba16 120 Index m_col; // current col id
ykuroda 0:13a5d365ba16 121 Index m_currentBlockRows; // current block height
ykuroda 0:13a5d365ba16 122 };
ykuroda 0:13a5d365ba16 123
ykuroda 0:13a5d365ba16 124 /** \anchor MatrixBaseCommaInitRef
ykuroda 0:13a5d365ba16 125 * Convenient operator to set the coefficients of a matrix.
ykuroda 0:13a5d365ba16 126 *
ykuroda 0:13a5d365ba16 127 * The coefficients must be provided in a row major order and exactly match
ykuroda 0:13a5d365ba16 128 * the size of the matrix. Otherwise an assertion is raised.
ykuroda 0:13a5d365ba16 129 *
ykuroda 0:13a5d365ba16 130 * Example: \include MatrixBase_set.cpp
ykuroda 0:13a5d365ba16 131 * Output: \verbinclude MatrixBase_set.out
ykuroda 0:13a5d365ba16 132 *
ykuroda 0:13a5d365ba16 133 * \note According the c++ standard, the argument expressions of this comma initializer are evaluated in arbitrary order.
ykuroda 0:13a5d365ba16 134 *
ykuroda 0:13a5d365ba16 135 * \sa CommaInitializer::finished(), class CommaInitializer
ykuroda 0:13a5d365ba16 136 */
ykuroda 0:13a5d365ba16 137 template<typename Derived>
ykuroda 0:13a5d365ba16 138 inline CommaInitializer<Derived> DenseBase<Derived>::operator<< (const Scalar& s)
ykuroda 0:13a5d365ba16 139 {
ykuroda 0:13a5d365ba16 140 return CommaInitializer<Derived>(*static_cast<Derived*>(this), s);
ykuroda 0:13a5d365ba16 141 }
ykuroda 0:13a5d365ba16 142
ykuroda 0:13a5d365ba16 143 /** \sa operator<<(const Scalar&) */
ykuroda 0:13a5d365ba16 144 template<typename Derived>
ykuroda 0:13a5d365ba16 145 template<typename OtherDerived>
ykuroda 0:13a5d365ba16 146 inline CommaInitializer<Derived>
ykuroda 0:13a5d365ba16 147 DenseBase<Derived>::operator<<(const DenseBase<OtherDerived>& other)
ykuroda 0:13a5d365ba16 148 {
ykuroda 0:13a5d365ba16 149 return CommaInitializer<Derived>(*static_cast<Derived *>(this), other);
ykuroda 0:13a5d365ba16 150 }
ykuroda 0:13a5d365ba16 151
ykuroda 0:13a5d365ba16 152 } // end namespace Eigen
ykuroda 0:13a5d365ba16 153
ykuroda 0:13a5d365ba16 154 #endif // EIGEN_COMMAINITIALIZER_H