Michael Ernst Peter / Eigen

src/Core/NestByValue.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) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
ykuroda 0:13a5d365ba16 5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
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_NESTBYVALUE_H
ykuroda 0:13a5d365ba16 12 #define EIGEN_NESTBYVALUE_H
ykuroda 0:13a5d365ba16 13
ykuroda 0:13a5d365ba16 14 namespace Eigen {
ykuroda 0:13a5d365ba16 15
ykuroda 0:13a5d365ba16 16 /** \class NestByValue
ykuroda 0:13a5d365ba16 17 * \ingroup Core_Module
ykuroda 0:13a5d365ba16 18 *
ykuroda 0:13a5d365ba16 19 * \brief Expression which must be nested by value
ykuroda 0:13a5d365ba16 20 *
ykuroda 0:13a5d365ba16 21 * \param ExpressionType the type of the object of which we are requiring nesting-by-value
ykuroda 0:13a5d365ba16 22 *
ykuroda 0:13a5d365ba16 23 * This class is the return type of MatrixBase::nestByValue()
ykuroda 0:13a5d365ba16 24 * and most of the time this is the only way it is used.
ykuroda 0:13a5d365ba16 25 *
ykuroda 0:13a5d365ba16 26 * \sa MatrixBase::nestByValue()
ykuroda 0:13a5d365ba16 27 */
ykuroda 0:13a5d365ba16 28
ykuroda 0:13a5d365ba16 29 namespace internal {
ykuroda 0:13a5d365ba16 30 template<typename ExpressionType>
ykuroda 0:13a5d365ba16 31 struct traits<NestByValue<ExpressionType> > : public traits<ExpressionType>
ykuroda 0:13a5d365ba16 32 {};
ykuroda 0:13a5d365ba16 33 }
ykuroda 0:13a5d365ba16 34
ykuroda 0:13a5d365ba16 35 template<typename ExpressionType> class NestByValue
ykuroda 0:13a5d365ba16 36 : public internal::dense_xpr_base< NestByValue<ExpressionType> >::type
ykuroda 0:13a5d365ba16 37 {
ykuroda 0:13a5d365ba16 38 public:
ykuroda 0:13a5d365ba16 39
ykuroda 0:13a5d365ba16 40 typedef typename internal::dense_xpr_base<NestByValue>::type Base;
ykuroda 0:13a5d365ba16 41 EIGEN_DENSE_PUBLIC_INTERFACE(NestByValue)
ykuroda 0:13a5d365ba16 42
ykuroda 0:13a5d365ba16 43 inline NestByValue(const ExpressionType& matrix) : m_expression(matrix) {}
ykuroda 0:13a5d365ba16 44
ykuroda 0:13a5d365ba16 45 inline Index rows() const { return m_expression.rows(); }
ykuroda 0:13a5d365ba16 46 inline Index cols() const { return m_expression.cols(); }
ykuroda 0:13a5d365ba16 47 inline Index outerStride() const { return m_expression.outerStride(); }
ykuroda 0:13a5d365ba16 48 inline Index innerStride() const { return m_expression.innerStride(); }
ykuroda 0:13a5d365ba16 49
ykuroda 0:13a5d365ba16 50 inline const CoeffReturnType coeff(Index row, Index col) const
ykuroda 0:13a5d365ba16 51 {
ykuroda 0:13a5d365ba16 52 return m_expression.coeff(row, col);
ykuroda 0:13a5d365ba16 53 }
ykuroda 0:13a5d365ba16 54
ykuroda 0:13a5d365ba16 55 inline Scalar& coeffRef(Index row, Index col)
ykuroda 0:13a5d365ba16 56 {
ykuroda 0:13a5d365ba16 57 return m_expression.const_cast_derived().coeffRef(row, col);
ykuroda 0:13a5d365ba16 58 }
ykuroda 0:13a5d365ba16 59
ykuroda 0:13a5d365ba16 60 inline const CoeffReturnType coeff(Index index) const
ykuroda 0:13a5d365ba16 61 {
ykuroda 0:13a5d365ba16 62 return m_expression.coeff(index);
ykuroda 0:13a5d365ba16 63 }
ykuroda 0:13a5d365ba16 64
ykuroda 0:13a5d365ba16 65 inline Scalar& coeffRef(Index index)
ykuroda 0:13a5d365ba16 66 {
ykuroda 0:13a5d365ba16 67 return m_expression.const_cast_derived().coeffRef(index);
ykuroda 0:13a5d365ba16 68 }
ykuroda 0:13a5d365ba16 69
ykuroda 0:13a5d365ba16 70 template<int LoadMode>
ykuroda 0:13a5d365ba16 71 inline const PacketScalar packet(Index row, Index col) const
ykuroda 0:13a5d365ba16 72 {
ykuroda 0:13a5d365ba16 73 return m_expression.template packet<LoadMode>(row, col);
ykuroda 0:13a5d365ba16 74 }
ykuroda 0:13a5d365ba16 75
ykuroda 0:13a5d365ba16 76 template<int LoadMode>
ykuroda 0:13a5d365ba16 77 inline void writePacket(Index row, Index col, const PacketScalar& x)
ykuroda 0:13a5d365ba16 78 {
ykuroda 0:13a5d365ba16 79 m_expression.const_cast_derived().template writePacket<LoadMode>(row, col, x);
ykuroda 0:13a5d365ba16 80 }
ykuroda 0:13a5d365ba16 81
ykuroda 0:13a5d365ba16 82 template<int LoadMode>
ykuroda 0:13a5d365ba16 83 inline const PacketScalar packet(Index index) const
ykuroda 0:13a5d365ba16 84 {
ykuroda 0:13a5d365ba16 85 return m_expression.template packet<LoadMode>(index);
ykuroda 0:13a5d365ba16 86 }
ykuroda 0:13a5d365ba16 87
ykuroda 0:13a5d365ba16 88 template<int LoadMode>
ykuroda 0:13a5d365ba16 89 inline void writePacket(Index index, const PacketScalar& x)
ykuroda 0:13a5d365ba16 90 {
ykuroda 0:13a5d365ba16 91 m_expression.const_cast_derived().template writePacket<LoadMode>(index, x);
ykuroda 0:13a5d365ba16 92 }
ykuroda 0:13a5d365ba16 93
ykuroda 0:13a5d365ba16 94 operator const ExpressionType&() const { return m_expression; }
ykuroda 0:13a5d365ba16 95
ykuroda 0:13a5d365ba16 96 protected:
ykuroda 0:13a5d365ba16 97 const ExpressionType m_expression;
ykuroda 0:13a5d365ba16 98 };
ykuroda 0:13a5d365ba16 99
ykuroda 0:13a5d365ba16 100 /** \returns an expression of the temporary version of *this.
ykuroda 0:13a5d365ba16 101 */
ykuroda 0:13a5d365ba16 102 template<typename Derived>
ykuroda 0:13a5d365ba16 103 inline const NestByValue<Derived>
ykuroda 0:13a5d365ba16 104 DenseBase<Derived>::nestByValue() const
ykuroda 0:13a5d365ba16 105 {
ykuroda 0:13a5d365ba16 106 return NestByValue<Derived>(derived());
ykuroda 0:13a5d365ba16 107 }
ykuroda 0:13a5d365ba16 108
ykuroda 0:13a5d365ba16 109 } // end namespace Eigen
ykuroda 0:13a5d365ba16 110
ykuroda 0:13a5d365ba16 111 #endif // EIGEN_NESTBYVALUE_H