Eigen  3.2.10
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 // This Source Code Form is subject to the terms of the Mozilla
8 // Public License v. 2.0. If a copy of the MPL was not distributed
9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 
11 #ifndef EIGEN_COMMAINITIALIZER_H
12 #define EIGEN_COMMAINITIALIZER_H
13 
14 namespace Eigen {
15 
27 template<typename XprType>
29 {
30  typedef typename XprType::Scalar Scalar;
31  typedef typename XprType::Index Index;
32 
33  inline CommaInitializer(XprType& xpr, const Scalar& s)
34  : m_xpr(xpr), m_row(0), m_col(1), m_currentBlockRows(1)
35  {
36  m_xpr.coeffRef(0,0) = s;
37  }
38 
39  template<typename OtherDerived>
40  inline CommaInitializer(XprType& xpr, const DenseBase<OtherDerived>& other)
41  : m_xpr(xpr), m_row(0), m_col(other.cols()), m_currentBlockRows(other.rows())
42  {
43  m_xpr.block(0, 0, other.rows(), other.cols()) = other;
44  }
45 
46  /* Copy/Move constructor which transfers ownership. This is crucial in
47  * absence of return value optimization to avoid assertions during destruction. */
48  // FIXME in C++11 mode this could be replaced by a proper RValue constructor
49  inline CommaInitializer(const CommaInitializer& o)
50  : m_xpr(o.m_xpr), m_row(o.m_row), m_col(o.m_col), m_currentBlockRows(o.m_currentBlockRows) {
51  // Mark original object as finished. In absence of R-value references we need to const_cast:
52  const_cast<CommaInitializer&>(o).m_row = m_xpr.rows();
53  const_cast<CommaInitializer&>(o).m_col = m_xpr.cols();
54  const_cast<CommaInitializer&>(o).m_currentBlockRows = 0;
55  }
56 
57  /* inserts a scalar value in the target matrix */
58  CommaInitializer& operator,(const Scalar& s)
59  {
60  if (m_col==m_xpr.cols())
61  {
62  m_row+=m_currentBlockRows;
63  m_col = 0;
64  m_currentBlockRows = 1;
65  eigen_assert(m_row<m_xpr.rows()
66  && "Too many rows passed to comma initializer (operator<<)");
67  }
68  eigen_assert(m_col<m_xpr.cols()
69  && "Too many coefficients passed to comma initializer (operator<<)");
70  eigen_assert(m_currentBlockRows==1);
71  m_xpr.coeffRef(m_row, m_col++) = s;
72  return *this;
73  }
74 
75  /* inserts a matrix expression in the target matrix */
76  template<typename OtherDerived>
77  CommaInitializer& operator,(const DenseBase<OtherDerived>& other)
78  {
79  if (m_col==m_xpr.cols() && (other.cols()!=0 || other.rows()!=m_currentBlockRows))
80  {
81  m_row+=m_currentBlockRows;
82  m_col = 0;
83  m_currentBlockRows = other.rows();
84  eigen_assert(m_row+m_currentBlockRows<=m_xpr.rows()
85  && "Too many rows passed to comma initializer (operator<<)");
86  }
87  eigen_assert((m_col + other.cols() <= m_xpr.cols())
88  && "Too many coefficients passed to comma initializer (operator<<)");
89  eigen_assert(m_currentBlockRows==other.rows());
90  m_xpr.template block<OtherDerived::RowsAtCompileTime, OtherDerived::ColsAtCompileTime>
91  (m_row, m_col, other.rows(), other.cols()) = other;
92  m_col += other.cols();
93  return *this;
94  }
95 
96  inline ~CommaInitializer()
97  {
98  finished();
99  }
100 
108  inline XprType& finished() {
109  eigen_assert(((m_row+m_currentBlockRows) == m_xpr.rows() || m_xpr.cols() == 0)
110  && m_col == m_xpr.cols()
111  && "Too few coefficients passed to comma initializer (operator<<)");
112  return m_xpr;
113  }
114 
115  XprType& m_xpr; // target expression
116  Index m_row; // current row id
117  Index m_col; // current col id
118  Index m_currentBlockRows; // current block height
119 };
120 
134 template<typename Derived>
136 {
137  return CommaInitializer<Derived>(*static_cast<Derived*>(this), s);
138 }
139 
141 template<typename Derived>
142 template<typename OtherDerived>
145 {
146  return CommaInitializer<Derived>(*static_cast<Derived *>(this), other);
147 }
148 
149 } // end namespace Eigen
150 
151 #endif // EIGEN_COMMAINITIALIZER_H
Definition: LDLT.h:16
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
Helper class used by the comma initializer operator.
Definition: CommaInitializer.h:28
CommaInitializer< Derived > operator<<(const Scalar &s)
Definition: CommaInitializer.h:135
XprType & finished()
Definition: CommaInitializer.h:108