Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
Diagonal.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2007-2009 Benoit Jacob <jacob.benoit.1@gmail.com>
5 // Copyright (C) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
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_DIAGONAL_H
12 #define EIGEN_DIAGONAL_H
13 
14 namespace Eigen {
15 
35 namespace internal {
36 template<typename MatrixType, int DiagIndex>
37 struct traits<Diagonal<MatrixType,DiagIndex> >
38  : traits<MatrixType>
39 {
40  typedef typename ref_selector<MatrixType>::type MatrixTypeNested;
41  typedef typename remove_reference<MatrixTypeNested>::type _MatrixTypeNested;
42  typedef typename MatrixType::StorageKind StorageKind;
43  enum {
44  RowsAtCompileTime = (int(DiagIndex) == DynamicIndex || int(MatrixType::SizeAtCompileTime) == Dynamic) ? Dynamic
45  : (EIGEN_PLAIN_ENUM_MIN(MatrixType::RowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0),
46  MatrixType::ColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))),
47  ColsAtCompileTime = 1,
48  MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic
49  : DiagIndex == DynamicIndex ? EIGEN_SIZE_MIN_PREFER_FIXED(MatrixType::MaxRowsAtCompileTime,
50  MatrixType::MaxColsAtCompileTime)
51  : (EIGEN_PLAIN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0),
52  MatrixType::MaxColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))),
53  MaxColsAtCompileTime = 1,
54  MaskLvalueBit = is_lvalue<MatrixType>::value ? LvalueBit : 0,
55  Flags = (unsigned int)_MatrixTypeNested::Flags & (RowMajorBit | MaskLvalueBit | DirectAccessBit) & ~RowMajorBit, // FIXME DirectAccessBit should not be handled by expressions
56  MatrixTypeOuterStride = outer_stride_at_compile_time<MatrixType>::ret,
57  InnerStrideAtCompileTime = MatrixTypeOuterStride == Dynamic ? Dynamic : MatrixTypeOuterStride+1,
58  OuterStrideAtCompileTime = 0
59  };
60 };
61 }
62 
63 template<typename MatrixType, int _DiagIndex> class Diagonal
64  : public internal::dense_xpr_base< Diagonal<MatrixType,_DiagIndex> >::type
65 {
66  public:
67 
68  enum { DiagIndex = _DiagIndex };
69  typedef typename internal::dense_xpr_base<Diagonal>::type Base;
70  EIGEN_DENSE_PUBLIC_INTERFACE(Diagonal)
71 
72  EIGEN_DEVICE_FUNC
73  explicit inline Diagonal(MatrixType& matrix, Index a_index = DiagIndex) : m_matrix(matrix), m_index(a_index)
74  {
75  eigen_assert( a_index <= m_matrix.cols() && -a_index <= m_matrix.rows() );
76  }
77 
78  EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Diagonal)
79 
80  EIGEN_DEVICE_FUNC
81  inline Index rows() const
82  {
83  return m_index.value()<0 ? numext::mini<Index>(m_matrix.cols(),m_matrix.rows()+m_index.value())
84  : numext::mini<Index>(m_matrix.rows(),m_matrix.cols()-m_index.value());
85  }
86 
87  EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
88  inline Index cols() const EIGEN_NOEXCEPT { return 1; }
89 
90  EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
91  inline Index innerStride() const EIGEN_NOEXCEPT {
92  return m_matrix.outerStride() + 1;
93  }
94 
95  EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
96  inline Index outerStride() const EIGEN_NOEXCEPT { return 0; }
97 
98  typedef typename internal::conditional<
99  internal::is_lvalue<MatrixType>::value,
100  Scalar,
101  const Scalar
102  >::type ScalarWithConstIfNotLvalue;
103 
104  EIGEN_DEVICE_FUNC
105  inline ScalarWithConstIfNotLvalue* data() { return &(m_matrix.coeffRef(rowOffset(), colOffset())); }
106  EIGEN_DEVICE_FUNC
107  inline const Scalar* data() const { return &(m_matrix.coeffRef(rowOffset(), colOffset())); }
108 
109  EIGEN_DEVICE_FUNC
110  inline Scalar& coeffRef(Index row, Index)
111  {
112  EIGEN_STATIC_ASSERT_LVALUE(MatrixType)
113  return m_matrix.coeffRef(row+rowOffset(), row+colOffset());
114  }
115 
116  EIGEN_DEVICE_FUNC
117  inline const Scalar& coeffRef(Index row, Index) const
118  {
119  return m_matrix.coeffRef(row+rowOffset(), row+colOffset());
120  }
121 
122  EIGEN_DEVICE_FUNC
123  inline CoeffReturnType coeff(Index row, Index) const
124  {
125  return m_matrix.coeff(row+rowOffset(), row+colOffset());
126  }
127 
128  EIGEN_DEVICE_FUNC
129  inline Scalar& coeffRef(Index idx)
130  {
131  EIGEN_STATIC_ASSERT_LVALUE(MatrixType)
132  return m_matrix.coeffRef(idx+rowOffset(), idx+colOffset());
133  }
134 
135  EIGEN_DEVICE_FUNC
136  inline const Scalar& coeffRef(Index idx) const
137  {
138  return m_matrix.coeffRef(idx+rowOffset(), idx+colOffset());
139  }
140 
141  EIGEN_DEVICE_FUNC
142  inline CoeffReturnType coeff(Index idx) const
143  {
144  return m_matrix.coeff(idx+rowOffset(), idx+colOffset());
145  }
146 
147  EIGEN_DEVICE_FUNC
148  inline const typename internal::remove_all<typename MatrixType::Nested>::type&
149  nestedExpression() const
150  {
151  return m_matrix;
152  }
153 
154  EIGEN_DEVICE_FUNC
155  inline Index index() const
156  {
157  return m_index.value();
158  }
159 
160  protected:
161  typename internal::ref_selector<MatrixType>::non_const_type m_matrix;
162  const internal::variable_if_dynamicindex<Index, DiagIndex> m_index;
163 
164  private:
165  // some compilers may fail to optimize std::max etc in case of compile-time constants...
166  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR
167  Index absDiagIndex() const EIGEN_NOEXCEPT { return m_index.value()>0 ? m_index.value() : -m_index.value(); }
168  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR
169  Index rowOffset() const EIGEN_NOEXCEPT { return m_index.value()>0 ? 0 : -m_index.value(); }
170  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR
171  Index colOffset() const EIGEN_NOEXCEPT { return m_index.value()>0 ? m_index.value() : 0; }
172  // trigger a compile-time error if someone try to call packet
173  template<int LoadMode> typename MatrixType::PacketReturnType packet(Index) const;
174  template<int LoadMode> typename MatrixType::PacketReturnType packet(Index,Index) const;
175 };
176 
185 template<typename Derived>
186 EIGEN_DEVICE_FUNC inline typename MatrixBase<Derived>::DiagonalReturnType
188 {
189  return DiagonalReturnType(derived());
190 }
191 
193 template<typename Derived>
194 EIGEN_DEVICE_FUNC inline typename MatrixBase<Derived>::ConstDiagonalReturnType
196 {
197  return ConstDiagonalReturnType(derived());
198 }
199 
211 template<typename Derived>
212 EIGEN_DEVICE_FUNC inline typename MatrixBase<Derived>::DiagonalDynamicIndexReturnType
214 {
215  return DiagonalDynamicIndexReturnType(derived(), index);
216 }
217 
219 template<typename Derived>
220 EIGEN_DEVICE_FUNC inline typename MatrixBase<Derived>::ConstDiagonalDynamicIndexReturnType
222 {
223  return ConstDiagonalDynamicIndexReturnType(derived(), index);
224 }
225 
237 template<typename Derived>
238 template<int Index_>
239 EIGEN_DEVICE_FUNC
240 inline typename MatrixBase<Derived>::template DiagonalIndexReturnType<Index_>::Type
242 {
243  return typename DiagonalIndexReturnType<Index_>::Type(derived());
244 }
245 
247 template<typename Derived>
248 template<int Index_>
249 EIGEN_DEVICE_FUNC
250 inline typename MatrixBase<Derived>::template ConstDiagonalIndexReturnType<Index_>::Type
252 {
253  return typename ConstDiagonalIndexReturnType<Index_>::Type(derived());
254 }
255 
256 } // end namespace Eigen
257 
258 #endif // EIGEN_DIAGONAL_H
Expression of the transpose of a matrix.
Definition: Transpose.h:52
const unsigned int DirectAccessBit
Definition: Constants.h:155
const unsigned int LvalueBit
Definition: Constants.h:144
Namespace containing all symbols from the Eigen library.
Definition: Core:141
const int DynamicIndex
Definition: Constants.h:27
const unsigned int RowMajorBit
Definition: Constants.h:66
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Definition: Eigen_Colamd.h:50
DiagonalReturnType diagonal()
Definition: Diagonal.h:187
Expression of a diagonal/subdiagonal/superdiagonal in a matrix.
Definition: Diagonal.h:63
const int Dynamic
Definition: Constants.h:22
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:48