1c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This file is part of Eigen, a lightweight C++ template library 2c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// for linear algebra. 3c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 4c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 2007-2009 Benoit Jacob <jacob.benoit.1@gmail.com> 5c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr> 6c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 7c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This Source Code Form is subject to the terms of the Mozilla 8c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Public License v. 2.0. If a copy of the MPL was not distributed 9c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// with this file, You can obtain one at http://mozilla.org/MPL/2.0/. 10c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 11c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#ifndef EIGEN_DIAGONAL_H 12c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#define EIGEN_DIAGONAL_H 13c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 14c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathnamespace Eigen { 15c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 16c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \class Diagonal 17c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \ingroup Core_Module 18c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 19c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \brief Expression of a diagonal/subdiagonal/superdiagonal in a matrix 20c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 21c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \param MatrixType the type of the object in which we are taking a sub/main/super diagonal 22c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \param DiagIndex the index of the sub/super diagonal. The default is 0 and it means the main diagonal. 23c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * A positive value means a superdiagonal, a negative value means a subdiagonal. 242b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * You can also use DynamicIndex so the index can be set at runtime. 25c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 26c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * The matrix is not required to be square. 27c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 28c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * This class represents an expression of the main diagonal, or any sub/super diagonal 29c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * of a square matrix. It is the return type of MatrixBase::diagonal() and MatrixBase::diagonal(Index) and most of the 30c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * time this is the only way it is used. 31c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 32c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa MatrixBase::diagonal(), MatrixBase::diagonal(Index) 33c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath */ 34c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 35c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathnamespace internal { 36c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename MatrixType, int DiagIndex> 37c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathstruct traits<Diagonal<MatrixType,DiagIndex> > 38c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath : traits<MatrixType> 39c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 402b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang typedef typename ref_selector<MatrixType>::type MatrixTypeNested; 41c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename remove_reference<MatrixTypeNested>::type _MatrixTypeNested; 42c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename MatrixType::StorageKind StorageKind; 43c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { 447faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez RowsAtCompileTime = (int(DiagIndex) == DynamicIndex || int(MatrixType::SizeAtCompileTime) == Dynamic) ? Dynamic 457faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez : (EIGEN_PLAIN_ENUM_MIN(MatrixType::RowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0), 467faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez MatrixType::ColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))), 47c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath ColsAtCompileTime = 1, 48c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic 497faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez : DiagIndex == DynamicIndex ? EIGEN_SIZE_MIN_PREFER_FIXED(MatrixType::MaxRowsAtCompileTime, 50c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath MatrixType::MaxColsAtCompileTime) 51c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath : (EIGEN_PLAIN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0), 52c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath MatrixType::MaxColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))), 53c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath MaxColsAtCompileTime = 1, 54c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath MaskLvalueBit = is_lvalue<MatrixType>::value ? LvalueBit : 0, 552b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang Flags = (unsigned int)_MatrixTypeNested::Flags & (RowMajorBit | MaskLvalueBit | DirectAccessBit) & ~RowMajorBit, // FIXME DirectAccessBit should not be handled by expressions 56c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath MatrixTypeOuterStride = outer_stride_at_compile_time<MatrixType>::ret, 57c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath InnerStrideAtCompileTime = MatrixTypeOuterStride == Dynamic ? Dynamic : MatrixTypeOuterStride+1, 58c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath OuterStrideAtCompileTime = 0 59c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath }; 60c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath}; 61c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 62c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 637faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandeztemplate<typename MatrixType, int _DiagIndex> class Diagonal 647faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez : public internal::dense_xpr_base< Diagonal<MatrixType,_DiagIndex> >::type 65c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 66c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath public: 67c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 687faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez enum { DiagIndex = _DiagIndex }; 69c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::dense_xpr_base<Diagonal>::type Base; 70c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_DENSE_PUBLIC_INTERFACE(Diagonal) 71c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 722b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 732b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang explicit inline Diagonal(MatrixType& matrix, Index a_index = DiagIndex) : m_matrix(matrix), m_index(a_index) {} 74c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 75c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Diagonal) 76c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 772b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 78c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline Index rows() const 792b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang { 802b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return m_index.value()<0 ? numext::mini<Index>(m_matrix.cols(),m_matrix.rows()+m_index.value()) 812b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang : numext::mini<Index>(m_matrix.rows(),m_matrix.cols()-m_index.value()); 822b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang } 83c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 842b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 85c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline Index cols() const { return 1; } 86c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 872b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 88c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline Index innerStride() const 89c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 90c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return m_matrix.outerStride() + 1; 91c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 92c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 932b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 94c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline Index outerStride() const 95c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 96c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return 0; 97c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 98c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 99c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::conditional< 100c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath internal::is_lvalue<MatrixType>::value, 101c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Scalar, 102c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath const Scalar 103c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath >::type ScalarWithConstIfNotLvalue; 104c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1052b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1062b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang inline ScalarWithConstIfNotLvalue* data() { return &(m_matrix.coeffRef(rowOffset(), colOffset())); } 1072b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1082b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang inline const Scalar* data() const { return &(m_matrix.coeffRef(rowOffset(), colOffset())); } 109c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1102b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 111c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline Scalar& coeffRef(Index row, Index) 112c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 113c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_LVALUE(MatrixType) 1142b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return m_matrix.coeffRef(row+rowOffset(), row+colOffset()); 115c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 116c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1172b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 118c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline const Scalar& coeffRef(Index row, Index) const 119c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1202b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return m_matrix.coeffRef(row+rowOffset(), row+colOffset()); 121c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 122c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1232b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 124c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline CoeffReturnType coeff(Index row, Index) const 125c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 126c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return m_matrix.coeff(row+rowOffset(), row+colOffset()); 127c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 128c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1292b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1307faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline Scalar& coeffRef(Index idx) 131c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 132c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_LVALUE(MatrixType) 1332b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return m_matrix.coeffRef(idx+rowOffset(), idx+colOffset()); 134c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 135c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1362b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1377faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline const Scalar& coeffRef(Index idx) const 138c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1392b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return m_matrix.coeffRef(idx+rowOffset(), idx+colOffset()); 140c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 141c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1422b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1437faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline CoeffReturnType coeff(Index idx) const 144c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1457faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez return m_matrix.coeff(idx+rowOffset(), idx+colOffset()); 146c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 147c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1482b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1492b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang inline const typename internal::remove_all<typename MatrixType::Nested>::type& 150c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath nestedExpression() const 151c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 152c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return m_matrix; 153c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 154c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1552b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1562b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang inline Index index() const 157c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 158c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return m_index.value(); 159c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 160c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 161c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath protected: 1622b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang typename internal::ref_selector<MatrixType>::non_const_type m_matrix; 1637faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez const internal::variable_if_dynamicindex<Index, DiagIndex> m_index; 164c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 165c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath private: 166c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath // some compilers may fail to optimize std::max etc in case of compile-time constants... 1672b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 168c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STRONG_INLINE Index absDiagIndex() const { return m_index.value()>0 ? m_index.value() : -m_index.value(); } 1692b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 170c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STRONG_INLINE Index rowOffset() const { return m_index.value()>0 ? 0 : -m_index.value(); } 1712b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 172c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STRONG_INLINE Index colOffset() const { return m_index.value()>0 ? m_index.value() : 0; } 1732b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang // trigger a compile-time error if someone try to call packet 174c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<int LoadMode> typename MatrixType::PacketReturnType packet(Index) const; 175c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<int LoadMode> typename MatrixType::PacketReturnType packet(Index,Index) const; 176c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath}; 177c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 178c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \returns an expression of the main diagonal of the matrix \c *this 179c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 180c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \c *this is not required to be square. 181c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 182c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Example: \include MatrixBase_diagonal.cpp 183c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Output: \verbinclude MatrixBase_diagonal.out 184c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 185c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa class Diagonal */ 186c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 187c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathinline typename MatrixBase<Derived>::DiagonalReturnType 188c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathMatrixBase<Derived>::diagonal() 189c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 1902b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return DiagonalReturnType(derived()); 191c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 192c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 193c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** This is the const version of diagonal(). */ 194c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 1957faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandezinline typename MatrixBase<Derived>::ConstDiagonalReturnType 196c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathMatrixBase<Derived>::diagonal() const 197c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 198c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return ConstDiagonalReturnType(derived()); 199c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 200c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 201c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \returns an expression of the \a DiagIndex-th sub or super diagonal of the matrix \c *this 202c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 203c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \c *this is not required to be square. 204c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 205c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * The template parameter \a DiagIndex represent a super diagonal if \a DiagIndex > 0 206c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * and a sub diagonal otherwise. \a DiagIndex == 0 is equivalent to the main diagonal. 207c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 208c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Example: \include MatrixBase_diagonal_int.cpp 209c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Output: \verbinclude MatrixBase_diagonal_int.out 210c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 211c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa MatrixBase::diagonal(), class Diagonal */ 212c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 213615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murrayinline typename MatrixBase<Derived>::DiagonalDynamicIndexReturnType 214c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathMatrixBase<Derived>::diagonal(Index index) 215c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 216615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray return DiagonalDynamicIndexReturnType(derived(), index); 217c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 218c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 219c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** This is the const version of diagonal(Index). */ 220c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 221615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murrayinline typename MatrixBase<Derived>::ConstDiagonalDynamicIndexReturnType 222c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathMatrixBase<Derived>::diagonal(Index index) const 223c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 224615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray return ConstDiagonalDynamicIndexReturnType(derived(), index); 225c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 226c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 227c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** \returns an expression of the \a DiagIndex-th sub or super diagonal of the matrix \c *this 228c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 229c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \c *this is not required to be square. 230c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 231c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * The template parameter \a DiagIndex represent a super diagonal if \a DiagIndex > 0 232c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * and a sub diagonal otherwise. \a DiagIndex == 0 is equivalent to the main diagonal. 233c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 234c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Example: \include MatrixBase_diagonal_template_int.cpp 235c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * Output: \verbinclude MatrixBase_diagonal_template_int.out 236c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 237c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa MatrixBase::diagonal(), class Diagonal */ 238c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 2392b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wangtemplate<int Index_> 2402b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wanginline typename MatrixBase<Derived>::template DiagonalIndexReturnType<Index_>::Type 241c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathMatrixBase<Derived>::diagonal() 242c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 2432b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return typename DiagonalIndexReturnType<Index_>::Type(derived()); 244c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 245c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 246c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath/** This is the const version of diagonal<int>(). */ 247c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> 2482b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wangtemplate<int Index_> 2492b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wanginline typename MatrixBase<Derived>::template ConstDiagonalIndexReturnType<Index_>::Type 250c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan KamathMatrixBase<Derived>::diagonal() const 251c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 2522b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang return typename ConstDiagonalIndexReturnType<Index_>::Type(derived()); 253c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} 254c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 255c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} // end namespace Eigen 256c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 257c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#endif // EIGEN_DIAGONAL_H 258