Michael Ernst Peter / Eigen

src/Core/Diagonal.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) 2007-2009 Benoit Jacob <jacob.benoit.1@gmail.com>
ykuroda 0:13a5d365ba16 5 // Copyright (C) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
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_DIAGONAL_H
ykuroda 0:13a5d365ba16 12 #define EIGEN_DIAGONAL_H
ykuroda 0:13a5d365ba16 13
ykuroda 0:13a5d365ba16 14 namespace Eigen {
ykuroda 0:13a5d365ba16 15
ykuroda 0:13a5d365ba16 16 /** \class Diagonal
ykuroda 0:13a5d365ba16 17 * \ingroup Core_Module
ykuroda 0:13a5d365ba16 18 *
ykuroda 0:13a5d365ba16 19 * \brief Expression of a diagonal/subdiagonal/superdiagonal in a matrix
ykuroda 0:13a5d365ba16 20 *
ykuroda 0:13a5d365ba16 21 * \param MatrixType the type of the object in which we are taking a sub/main/super diagonal
ykuroda 0:13a5d365ba16 22 * \param DiagIndex the index of the sub/super diagonal. The default is 0 and it means the main diagonal.
ykuroda 0:13a5d365ba16 23 * A positive value means a superdiagonal, a negative value means a subdiagonal.
ykuroda 0:13a5d365ba16 24 * You can also use Dynamic so the index can be set at runtime.
ykuroda 0:13a5d365ba16 25 *
ykuroda 0:13a5d365ba16 26 * The matrix is not required to be square.
ykuroda 0:13a5d365ba16 27 *
ykuroda 0:13a5d365ba16 28 * This class represents an expression of the main diagonal, or any sub/super diagonal
ykuroda 0:13a5d365ba16 29 * of a square matrix. It is the return type of MatrixBase::diagonal() and MatrixBase::diagonal(Index) and most of the
ykuroda 0:13a5d365ba16 30 * time this is the only way it is used.
ykuroda 0:13a5d365ba16 31 *
ykuroda 0:13a5d365ba16 32 * \sa MatrixBase::diagonal(), MatrixBase::diagonal(Index)
ykuroda 0:13a5d365ba16 33 */
ykuroda 0:13a5d365ba16 34
ykuroda 0:13a5d365ba16 35 namespace internal {
ykuroda 0:13a5d365ba16 36 template<typename MatrixType, int DiagIndex>
ykuroda 0:13a5d365ba16 37 struct traits<Diagonal<MatrixType,DiagIndex> >
ykuroda 0:13a5d365ba16 38 : traits<MatrixType>
ykuroda 0:13a5d365ba16 39 {
ykuroda 0:13a5d365ba16 40 typedef typename nested<MatrixType>::type MatrixTypeNested;
ykuroda 0:13a5d365ba16 41 typedef typename remove_reference<MatrixTypeNested>::type _MatrixTypeNested;
ykuroda 0:13a5d365ba16 42 typedef typename MatrixType::StorageKind StorageKind;
ykuroda 0:13a5d365ba16 43 enum {
ykuroda 0:13a5d365ba16 44 RowsAtCompileTime = (int(DiagIndex) == DynamicIndex || int(MatrixType::SizeAtCompileTime) == Dynamic) ? Dynamic
ykuroda 0:13a5d365ba16 45 : (EIGEN_PLAIN_ENUM_MIN(MatrixType::RowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0),
ykuroda 0:13a5d365ba16 46 MatrixType::ColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))),
ykuroda 0:13a5d365ba16 47 ColsAtCompileTime = 1,
ykuroda 0:13a5d365ba16 48 MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic
ykuroda 0:13a5d365ba16 49 : DiagIndex == DynamicIndex ? EIGEN_SIZE_MIN_PREFER_FIXED(MatrixType::MaxRowsAtCompileTime,
ykuroda 0:13a5d365ba16 50 MatrixType::MaxColsAtCompileTime)
ykuroda 0:13a5d365ba16 51 : (EIGEN_PLAIN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0),
ykuroda 0:13a5d365ba16 52 MatrixType::MaxColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))),
ykuroda 0:13a5d365ba16 53 MaxColsAtCompileTime = 1,
ykuroda 0:13a5d365ba16 54 MaskLvalueBit = is_lvalue<MatrixType>::value ? LvalueBit : 0,
ykuroda 0:13a5d365ba16 55 Flags = (unsigned int)_MatrixTypeNested::Flags & (HereditaryBits | LinearAccessBit | MaskLvalueBit | DirectAccessBit) & ~RowMajorBit,
ykuroda 0:13a5d365ba16 56 CoeffReadCost = _MatrixTypeNested::CoeffReadCost,
ykuroda 0:13a5d365ba16 57 MatrixTypeOuterStride = outer_stride_at_compile_time<MatrixType>::ret,
ykuroda 0:13a5d365ba16 58 InnerStrideAtCompileTime = MatrixTypeOuterStride == Dynamic ? Dynamic : MatrixTypeOuterStride+1,
ykuroda 0:13a5d365ba16 59 OuterStrideAtCompileTime = 0
ykuroda 0:13a5d365ba16 60 };
ykuroda 0:13a5d365ba16 61 };
ykuroda 0:13a5d365ba16 62 }
ykuroda 0:13a5d365ba16 63
ykuroda 0:13a5d365ba16 64 template<typename MatrixType, int _DiagIndex> class Diagonal
ykuroda 0:13a5d365ba16 65 : public internal::dense_xpr_base< Diagonal<MatrixType,_DiagIndex> >::type
ykuroda 0:13a5d365ba16 66 {
ykuroda 0:13a5d365ba16 67 public:
ykuroda 0:13a5d365ba16 68
ykuroda 0:13a5d365ba16 69 enum { DiagIndex = _DiagIndex };
ykuroda 0:13a5d365ba16 70 typedef typename internal::dense_xpr_base<Diagonal>::type Base;
ykuroda 0:13a5d365ba16 71 EIGEN_DENSE_PUBLIC_INTERFACE(Diagonal)
ykuroda 0:13a5d365ba16 72
ykuroda 0:13a5d365ba16 73 inline Diagonal(MatrixType& matrix, Index a_index = DiagIndex) : m_matrix(matrix), m_index(a_index) {}
ykuroda 0:13a5d365ba16 74
ykuroda 0:13a5d365ba16 75 EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Diagonal)
ykuroda 0:13a5d365ba16 76
ykuroda 0:13a5d365ba16 77 inline Index rows() const
ykuroda 0:13a5d365ba16 78 { return m_index.value()<0 ? (std::min<Index>)(m_matrix.cols(),m_matrix.rows()+m_index.value()) : (std::min<Index>)(m_matrix.rows(),m_matrix.cols()-m_index.value()); }
ykuroda 0:13a5d365ba16 79
ykuroda 0:13a5d365ba16 80 inline Index cols() const { return 1; }
ykuroda 0:13a5d365ba16 81
ykuroda 0:13a5d365ba16 82 inline Index innerStride() const
ykuroda 0:13a5d365ba16 83 {
ykuroda 0:13a5d365ba16 84 return m_matrix.outerStride() + 1;
ykuroda 0:13a5d365ba16 85 }
ykuroda 0:13a5d365ba16 86
ykuroda 0:13a5d365ba16 87 inline Index outerStride() const
ykuroda 0:13a5d365ba16 88 {
ykuroda 0:13a5d365ba16 89 return 0;
ykuroda 0:13a5d365ba16 90 }
ykuroda 0:13a5d365ba16 91
ykuroda 0:13a5d365ba16 92 typedef typename internal::conditional<
ykuroda 0:13a5d365ba16 93 internal::is_lvalue<MatrixType>::value,
ykuroda 0:13a5d365ba16 94 Scalar,
ykuroda 0:13a5d365ba16 95 const Scalar
ykuroda 0:13a5d365ba16 96 >::type ScalarWithConstIfNotLvalue;
ykuroda 0:13a5d365ba16 97
ykuroda 0:13a5d365ba16 98 inline ScalarWithConstIfNotLvalue* data() { return &(m_matrix.const_cast_derived().coeffRef(rowOffset(), colOffset())); }
ykuroda 0:13a5d365ba16 99 inline const Scalar* data() const { return &(m_matrix.const_cast_derived().coeffRef(rowOffset(), colOffset())); }
ykuroda 0:13a5d365ba16 100
ykuroda 0:13a5d365ba16 101 inline Scalar& coeffRef(Index row, Index)
ykuroda 0:13a5d365ba16 102 {
ykuroda 0:13a5d365ba16 103 EIGEN_STATIC_ASSERT_LVALUE(MatrixType)
ykuroda 0:13a5d365ba16 104 return m_matrix.const_cast_derived().coeffRef(row+rowOffset(), row+colOffset());
ykuroda 0:13a5d365ba16 105 }
ykuroda 0:13a5d365ba16 106
ykuroda 0:13a5d365ba16 107 inline const Scalar& coeffRef(Index row, Index) const
ykuroda 0:13a5d365ba16 108 {
ykuroda 0:13a5d365ba16 109 return m_matrix.const_cast_derived().coeffRef(row+rowOffset(), row+colOffset());
ykuroda 0:13a5d365ba16 110 }
ykuroda 0:13a5d365ba16 111
ykuroda 0:13a5d365ba16 112 inline CoeffReturnType coeff(Index row, Index) const
ykuroda 0:13a5d365ba16 113 {
ykuroda 0:13a5d365ba16 114 return m_matrix.coeff(row+rowOffset(), row+colOffset());
ykuroda 0:13a5d365ba16 115 }
ykuroda 0:13a5d365ba16 116
ykuroda 0:13a5d365ba16 117 inline Scalar& coeffRef(Index idx)
ykuroda 0:13a5d365ba16 118 {
ykuroda 0:13a5d365ba16 119 EIGEN_STATIC_ASSERT_LVALUE(MatrixType)
ykuroda 0:13a5d365ba16 120 return m_matrix.const_cast_derived().coeffRef(idx+rowOffset(), idx+colOffset());
ykuroda 0:13a5d365ba16 121 }
ykuroda 0:13a5d365ba16 122
ykuroda 0:13a5d365ba16 123 inline const Scalar& coeffRef(Index idx) const
ykuroda 0:13a5d365ba16 124 {
ykuroda 0:13a5d365ba16 125 return m_matrix.const_cast_derived().coeffRef(idx+rowOffset(), idx+colOffset());
ykuroda 0:13a5d365ba16 126 }
ykuroda 0:13a5d365ba16 127
ykuroda 0:13a5d365ba16 128 inline CoeffReturnType coeff(Index idx) const
ykuroda 0:13a5d365ba16 129 {
ykuroda 0:13a5d365ba16 130 return m_matrix.coeff(idx+rowOffset(), idx+colOffset());
ykuroda 0:13a5d365ba16 131 }
ykuroda 0:13a5d365ba16 132
ykuroda 0:13a5d365ba16 133 const typename internal::remove_all<typename MatrixType::Nested>::type&
ykuroda 0:13a5d365ba16 134 nestedExpression() const
ykuroda 0:13a5d365ba16 135 {
ykuroda 0:13a5d365ba16 136 return m_matrix;
ykuroda 0:13a5d365ba16 137 }
ykuroda 0:13a5d365ba16 138
ykuroda 0:13a5d365ba16 139 int index() const
ykuroda 0:13a5d365ba16 140 {
ykuroda 0:13a5d365ba16 141 return m_index.value();
ykuroda 0:13a5d365ba16 142 }
ykuroda 0:13a5d365ba16 143
ykuroda 0:13a5d365ba16 144 protected:
ykuroda 0:13a5d365ba16 145 typename MatrixType::Nested m_matrix;
ykuroda 0:13a5d365ba16 146 const internal::variable_if_dynamicindex<Index, DiagIndex> m_index;
ykuroda 0:13a5d365ba16 147
ykuroda 0:13a5d365ba16 148 private:
ykuroda 0:13a5d365ba16 149 // some compilers may fail to optimize std::max etc in case of compile-time constants...
ykuroda 0:13a5d365ba16 150 EIGEN_STRONG_INLINE Index absDiagIndex() const { return m_index.value()>0 ? m_index.value() : -m_index.value(); }
ykuroda 0:13a5d365ba16 151 EIGEN_STRONG_INLINE Index rowOffset() const { return m_index.value()>0 ? 0 : -m_index.value(); }
ykuroda 0:13a5d365ba16 152 EIGEN_STRONG_INLINE Index colOffset() const { return m_index.value()>0 ? m_index.value() : 0; }
ykuroda 0:13a5d365ba16 153 // triger a compile time error is someone try to call packet
ykuroda 0:13a5d365ba16 154 template<int LoadMode> typename MatrixType::PacketReturnType packet(Index) const;
ykuroda 0:13a5d365ba16 155 template<int LoadMode> typename MatrixType::PacketReturnType packet(Index,Index) const;
ykuroda 0:13a5d365ba16 156 };
ykuroda 0:13a5d365ba16 157
ykuroda 0:13a5d365ba16 158 /** \returns an expression of the main diagonal of the matrix \c *this
ykuroda 0:13a5d365ba16 159 *
ykuroda 0:13a5d365ba16 160 * \c *this is not required to be square.
ykuroda 0:13a5d365ba16 161 *
ykuroda 0:13a5d365ba16 162 * Example: \include MatrixBase_diagonal.cpp
ykuroda 0:13a5d365ba16 163 * Output: \verbinclude MatrixBase_diagonal.out
ykuroda 0:13a5d365ba16 164 *
ykuroda 0:13a5d365ba16 165 * \sa class Diagonal */
ykuroda 0:13a5d365ba16 166 template<typename Derived>
ykuroda 0:13a5d365ba16 167 inline typename MatrixBase<Derived>::DiagonalReturnType
ykuroda 0:13a5d365ba16 168 MatrixBase<Derived>::diagonal()
ykuroda 0:13a5d365ba16 169 {
ykuroda 0:13a5d365ba16 170 return derived();
ykuroda 0:13a5d365ba16 171 }
ykuroda 0:13a5d365ba16 172
ykuroda 0:13a5d365ba16 173 /** This is the const version of diagonal(). */
ykuroda 0:13a5d365ba16 174 template<typename Derived>
ykuroda 0:13a5d365ba16 175 inline typename MatrixBase<Derived>::ConstDiagonalReturnType
ykuroda 0:13a5d365ba16 176 MatrixBase<Derived>::diagonal() const
ykuroda 0:13a5d365ba16 177 {
ykuroda 0:13a5d365ba16 178 return ConstDiagonalReturnType(derived());
ykuroda 0:13a5d365ba16 179 }
ykuroda 0:13a5d365ba16 180
ykuroda 0:13a5d365ba16 181 /** \returns an expression of the \a DiagIndex-th sub or super diagonal of the matrix \c *this
ykuroda 0:13a5d365ba16 182 *
ykuroda 0:13a5d365ba16 183 * \c *this is not required to be square.
ykuroda 0:13a5d365ba16 184 *
ykuroda 0:13a5d365ba16 185 * The template parameter \a DiagIndex represent a super diagonal if \a DiagIndex > 0
ykuroda 0:13a5d365ba16 186 * and a sub diagonal otherwise. \a DiagIndex == 0 is equivalent to the main diagonal.
ykuroda 0:13a5d365ba16 187 *
ykuroda 0:13a5d365ba16 188 * Example: \include MatrixBase_diagonal_int.cpp
ykuroda 0:13a5d365ba16 189 * Output: \verbinclude MatrixBase_diagonal_int.out
ykuroda 0:13a5d365ba16 190 *
ykuroda 0:13a5d365ba16 191 * \sa MatrixBase::diagonal(), class Diagonal */
ykuroda 0:13a5d365ba16 192 template<typename Derived>
ykuroda 0:13a5d365ba16 193 inline typename MatrixBase<Derived>::DiagonalDynamicIndexReturnType
ykuroda 0:13a5d365ba16 194 MatrixBase<Derived>::diagonal(Index index)
ykuroda 0:13a5d365ba16 195 {
ykuroda 0:13a5d365ba16 196 return DiagonalDynamicIndexReturnType(derived(), index);
ykuroda 0:13a5d365ba16 197 }
ykuroda 0:13a5d365ba16 198
ykuroda 0:13a5d365ba16 199 /** This is the const version of diagonal(Index). */
ykuroda 0:13a5d365ba16 200 template<typename Derived>
ykuroda 0:13a5d365ba16 201 inline typename MatrixBase<Derived>::ConstDiagonalDynamicIndexReturnType
ykuroda 0:13a5d365ba16 202 MatrixBase<Derived>::diagonal(Index index) const
ykuroda 0:13a5d365ba16 203 {
ykuroda 0:13a5d365ba16 204 return ConstDiagonalDynamicIndexReturnType(derived(), index);
ykuroda 0:13a5d365ba16 205 }
ykuroda 0:13a5d365ba16 206
ykuroda 0:13a5d365ba16 207 /** \returns an expression of the \a DiagIndex-th sub or super diagonal of the matrix \c *this
ykuroda 0:13a5d365ba16 208 *
ykuroda 0:13a5d365ba16 209 * \c *this is not required to be square.
ykuroda 0:13a5d365ba16 210 *
ykuroda 0:13a5d365ba16 211 * The template parameter \a DiagIndex represent a super diagonal if \a DiagIndex > 0
ykuroda 0:13a5d365ba16 212 * and a sub diagonal otherwise. \a DiagIndex == 0 is equivalent to the main diagonal.
ykuroda 0:13a5d365ba16 213 *
ykuroda 0:13a5d365ba16 214 * Example: \include MatrixBase_diagonal_template_int.cpp
ykuroda 0:13a5d365ba16 215 * Output: \verbinclude MatrixBase_diagonal_template_int.out
ykuroda 0:13a5d365ba16 216 *
ykuroda 0:13a5d365ba16 217 * \sa MatrixBase::diagonal(), class Diagonal */
ykuroda 0:13a5d365ba16 218 template<typename Derived>
ykuroda 0:13a5d365ba16 219 template<int Index>
ykuroda 0:13a5d365ba16 220 inline typename MatrixBase<Derived>::template DiagonalIndexReturnType<Index>::Type
ykuroda 0:13a5d365ba16 221 MatrixBase<Derived>::diagonal()
ykuroda 0:13a5d365ba16 222 {
ykuroda 0:13a5d365ba16 223 return derived();
ykuroda 0:13a5d365ba16 224 }
ykuroda 0:13a5d365ba16 225
ykuroda 0:13a5d365ba16 226 /** This is the const version of diagonal<int>(). */
ykuroda 0:13a5d365ba16 227 template<typename Derived>
ykuroda 0:13a5d365ba16 228 template<int Index>
ykuroda 0:13a5d365ba16 229 inline typename MatrixBase<Derived>::template ConstDiagonalIndexReturnType<Index>::Type
ykuroda 0:13a5d365ba16 230 MatrixBase<Derived>::diagonal() const
ykuroda 0:13a5d365ba16 231 {
ykuroda 0:13a5d365ba16 232 return derived();
ykuroda 0:13a5d365ba16 233 }
ykuroda 0:13a5d365ba16 234
ykuroda 0:13a5d365ba16 235 } // end namespace Eigen
ykuroda 0:13a5d365ba16 236
ykuroda 0:13a5d365ba16 237 #endif // EIGEN_DIAGONAL_H