mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-04-23 18:19:34 +08:00
f2f48b6560
* replaced the Flags template parameter of Matrix by StorageOrder and move it back to the 4th position such that we don't have to worry about the two Max* template parameters * extended EIGEN_USING_MATRIX_TYPEDEFS with the ei_* math functions
125 lines
4.1 KiB
C++
125 lines
4.1 KiB
C++
// This file is part of Eigen, a lightweight C++ template library
|
|
// for linear algebra. Eigen itself is part of the KDE project.
|
|
//
|
|
// Copyright (C) 2006-2008 Benoit Jacob <jacob@math.jussieu.fr>
|
|
//
|
|
// Eigen is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 3 of the License, or (at your option) any later version.
|
|
//
|
|
// Alternatively, you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License as
|
|
// published by the Free Software Foundation; either version 2 of
|
|
// the License, or (at your option) any later version.
|
|
//
|
|
// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License and a copy of the GNU General Public License along with
|
|
// Eigen. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
#ifndef EIGEN_DIAGONALCOEFFS_H
|
|
#define EIGEN_DIAGONALCOEFFS_H
|
|
|
|
/** \class DiagonalCoeffs
|
|
*
|
|
* \brief Expression of the main diagonal of a matrix
|
|
*
|
|
* \param MatrixType the type of the object in which we are taking the main diagonal
|
|
*
|
|
* The matrix is not required to be square.
|
|
*
|
|
* This class represents an expression of the main diagonal of a square matrix.
|
|
* It is the return type of MatrixBase::diagonal() and most of the time this is
|
|
* the only way it is used.
|
|
*
|
|
* \sa MatrixBase::diagonal()
|
|
*/
|
|
template<typename MatrixType>
|
|
struct ei_traits<DiagonalCoeffs<MatrixType> >
|
|
{
|
|
typedef typename MatrixType::Scalar Scalar;
|
|
typedef typename ei_nested<MatrixType>::type MatrixTypeNested;
|
|
typedef typename ei_unref<MatrixTypeNested>::type _MatrixTypeNested;
|
|
enum {
|
|
RowsAtCompileTime = int(MatrixType::SizeAtCompileTime) == Dynamic ? Dynamic
|
|
: EIGEN_ENUM_MIN(MatrixType::RowsAtCompileTime,
|
|
MatrixType::ColsAtCompileTime),
|
|
ColsAtCompileTime = 1,
|
|
MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic
|
|
: EIGEN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime,
|
|
MatrixType::MaxColsAtCompileTime),
|
|
MaxColsAtCompileTime = 1,
|
|
Flags = (unsigned int)_MatrixTypeNested::Flags & (HereditaryBits | LinearAccessBit),
|
|
CoeffReadCost = _MatrixTypeNested::CoeffReadCost
|
|
};
|
|
};
|
|
|
|
template<typename MatrixType> class DiagonalCoeffs
|
|
: public MatrixBase<DiagonalCoeffs<MatrixType> >
|
|
{
|
|
public:
|
|
|
|
EIGEN_GENERIC_PUBLIC_INTERFACE(DiagonalCoeffs)
|
|
|
|
inline DiagonalCoeffs(const MatrixType& matrix) : m_matrix(matrix) {}
|
|
|
|
EIGEN_INHERIT_ASSIGNMENT_OPERATORS(DiagonalCoeffs)
|
|
|
|
inline int rows() const { return std::min(m_matrix.rows(), m_matrix.cols()); }
|
|
inline int cols() const { return 1; }
|
|
|
|
inline Scalar& coeffRef(int row, int)
|
|
{
|
|
return m_matrix.const_cast_derived().coeffRef(row, row);
|
|
}
|
|
|
|
inline const Scalar coeff(int row, int) const
|
|
{
|
|
return m_matrix.coeff(row, row);
|
|
}
|
|
|
|
inline Scalar& coeffRef(int index)
|
|
{
|
|
return m_matrix.const_cast_derived().coeffRef(index, index);
|
|
}
|
|
|
|
inline const Scalar coeff(int index) const
|
|
{
|
|
return m_matrix.coeff(index, index);
|
|
}
|
|
|
|
protected:
|
|
|
|
const typename MatrixType::Nested m_matrix;
|
|
};
|
|
|
|
/** \returns an expression of the main diagonal of the matrix \c *this
|
|
*
|
|
* \c *this is not required to be square.
|
|
*
|
|
* Example: \include MatrixBase_diagonal.cpp
|
|
* Output: \verbinclude MatrixBase_diagonal.out
|
|
*
|
|
* \sa class DiagonalCoeffs */
|
|
template<typename Derived>
|
|
inline DiagonalCoeffs<Derived>
|
|
MatrixBase<Derived>::diagonal()
|
|
{
|
|
return DiagonalCoeffs<Derived>(derived());
|
|
}
|
|
|
|
/** This is the const version of diagonal(). */
|
|
template<typename Derived>
|
|
inline const DiagonalCoeffs<Derived>
|
|
MatrixBase<Derived>::diagonal() const
|
|
{
|
|
return DiagonalCoeffs<Derived>(derived());
|
|
}
|
|
|
|
#endif // EIGEN_DIAGONALCOEFFS_H
|