Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / src / Core / CommaInitializer.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_COMMAINITIALIZER_H
27 #define EIGEN_COMMAINITIALIZER_H
28
29 /** \class CommaInitializer
30   * \ingroup Core_Module
31   *
32   * \brief Helper class used by the comma initializer operator
33   *
34   * This class is internally used to implement the comma initializer feature. It is
35   * the return type of MatrixBase::operator<<, and most of the time this is the only
36   * way it is used.
37   *
38   * \sa \ref MatrixBaseCommaInitRef "MatrixBase::operator<<", CommaInitializer::finished()
39   */
40 template<typename XprType>
41 struct CommaInitializer
42 {
43   typedef typename XprType::Scalar Scalar;
44   typedef typename XprType::Index Index;
45
46   inline CommaInitializer(XprType& xpr, const Scalar& s)
47     : m_xpr(xpr), m_row(0), m_col(1), m_currentBlockRows(1)
48   {
49     m_xpr.coeffRef(0,0) = s;
50   }
51
52   template<typename OtherDerived>
53   inline CommaInitializer(XprType& xpr, const DenseBase<OtherDerived>& other)
54     : m_xpr(xpr), m_row(0), m_col(other.cols()), m_currentBlockRows(other.rows())
55   {
56     m_xpr.block(0, 0, other.rows(), other.cols()) = other;
57   }
58
59   /* inserts a scalar value in the target matrix */
60   CommaInitializer& operator,(const Scalar& s)
61   {
62     if (m_col==m_xpr.cols())
63     {
64       m_row+=m_currentBlockRows;
65       m_col = 0;
66       m_currentBlockRows = 1;
67       eigen_assert(m_row<m_xpr.rows()
68         && "Too many rows passed to comma initializer (operator<<)");
69     }
70     eigen_assert(m_col<m_xpr.cols()
71       && "Too many coefficients passed to comma initializer (operator<<)");
72     eigen_assert(m_currentBlockRows==1);
73     m_xpr.coeffRef(m_row, m_col++) = s;
74     return *this;
75   }
76
77   /* inserts a matrix expression in the target matrix */
78   template<typename OtherDerived>
79   CommaInitializer& operator,(const DenseBase<OtherDerived>& other)
80   {
81     if (m_col==m_xpr.cols())
82     {
83       m_row+=m_currentBlockRows;
84       m_col = 0;
85       m_currentBlockRows = other.rows();
86       eigen_assert(m_row+m_currentBlockRows<=m_xpr.rows()
87         && "Too many rows passed to comma initializer (operator<<)");
88     }
89     eigen_assert(m_col<m_xpr.cols()
90       && "Too many coefficients passed to comma initializer (operator<<)");
91     eigen_assert(m_currentBlockRows==other.rows());
92     if (OtherDerived::SizeAtCompileTime != Dynamic)
93       m_xpr.template block<OtherDerived::RowsAtCompileTime != Dynamic ? OtherDerived::RowsAtCompileTime : 1,
94                               OtherDerived::ColsAtCompileTime != Dynamic ? OtherDerived::ColsAtCompileTime : 1>
95                     (m_row, m_col) = other;
96     else
97       m_xpr.block(m_row, m_col, other.rows(), other.cols()) = other;
98     m_col += other.cols();
99     return *this;
100   }
101
102   inline ~CommaInitializer()
103   {
104     eigen_assert((m_row+m_currentBlockRows) == m_xpr.rows()
105          && m_col == m_xpr.cols()
106          && "Too few coefficients passed to comma initializer (operator<<)");
107   }
108
109   /** \returns the built matrix once all its coefficients have been set.
110     * Calling finished is 100% optional. Its purpose is to write expressions
111     * like this:
112     * \code
113     * quaternion.fromRotationMatrix((Matrix3f() << axis0, axis1, axis2).finished());
114     * \endcode
115     */
116   inline XprType& finished() { return m_xpr; }
117
118   XprType& m_xpr;   // target expression
119   Index m_row;              // current row id
120   Index m_col;              // current col id
121   Index m_currentBlockRows; // current block height
122 };
123
124 /** \anchor MatrixBaseCommaInitRef
125   * Convenient operator to set the coefficients of a matrix.
126   *
127   * The coefficients must be provided in a row major order and exactly match
128   * the size of the matrix. Otherwise an assertion is raised.
129   *
130   * Example: \include MatrixBase_set.cpp
131   * Output: \verbinclude MatrixBase_set.out
132   *
133   * \sa CommaInitializer::finished(), class CommaInitializer
134   */
135 template<typename Derived>
136 inline CommaInitializer<Derived> DenseBase<Derived>::operator<< (const Scalar& s)
137 {
138   return CommaInitializer<Derived>(*static_cast<Derived*>(this), s);
139 }
140
141 /** \sa operator<<(const Scalar&) */
142 template<typename Derived>
143 template<typename OtherDerived>
144 inline CommaInitializer<Derived>
145 DenseBase<Derived>::operator<<(const DenseBase<OtherDerived>& other)
146 {
147   return CommaInitializer<Derived>(*static_cast<Derived *>(this), other);
148 }
149
150 #endif // EIGEN_COMMAINITIALIZER_H