Product.h
Go to the documentation of this file.
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008-2011 Gael Guennebaud <gael.guennebaud@inria.fr>
5 //
6 // This Source Code Form is subject to the terms of the Mozilla
7 // Public License v. 2.0. If a copy of the MPL was not distributed
8 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 
10 #ifndef EIGEN_PRODUCT_H
11 #define EIGEN_PRODUCT_H
12 
13 namespace Eigen {
14 
15 template<typename Lhs, typename Rhs, int Option, typename StorageKind> class ProductImpl;
16 
17 namespace internal {
18 
19 template<typename Lhs, typename Rhs, int Option>
20 struct traits<Product<Lhs, Rhs, Option> >
21 {
26 
27  typedef MatrixXpr XprKind;
28 
30  typedef typename product_promote_storage_type<typename LhsTraits::StorageKind,
31  typename RhsTraits::StorageKind,
33  typedef typename promote_index_type<typename LhsTraits::StorageIndex,
34  typename RhsTraits::StorageIndex>::type StorageIndex;
35 
36  enum {
37  RowsAtCompileTime = LhsTraits::RowsAtCompileTime,
38  ColsAtCompileTime = RhsTraits::ColsAtCompileTime,
39  MaxRowsAtCompileTime = LhsTraits::MaxRowsAtCompileTime,
40  MaxColsAtCompileTime = RhsTraits::MaxColsAtCompileTime,
41 
42  // FIXME: only needed by GeneralMatrixMatrixTriangular
43  InnerSize = EIGEN_SIZE_MIN_PREFER_FIXED(LhsTraits::ColsAtCompileTime, RhsTraits::RowsAtCompileTime),
44 
45  // The storage order is somewhat arbitrary here. The correct one will be determined through the evaluator.
46  Flags = (MaxRowsAtCompileTime==1 && MaxColsAtCompileTime!=1) ? RowMajorBit
47  : (MaxColsAtCompileTime==1 && MaxRowsAtCompileTime!=1) ? 0
48  : ( ((LhsTraits::Flags&NoPreferredStorageOrderBit) && (RhsTraits::Flags&RowMajorBit))
49  || ((RhsTraits::Flags&NoPreferredStorageOrderBit) && (LhsTraits::Flags&RowMajorBit)) ) ? RowMajorBit
50  : NoPreferredStorageOrderBit
51  };
52 };
53 
54 } // end namespace internal
55 
70 template<typename _Lhs, typename _Rhs, int Option>
71 class Product : public ProductImpl<_Lhs,_Rhs,Option,
72  typename internal::product_promote_storage_type<typename internal::traits<_Lhs>::StorageKind,
73  typename internal::traits<_Rhs>::StorageKind,
74  internal::product_type<_Lhs,_Rhs>::ret>::ret>
75 {
76  public:
77 
78  typedef _Lhs Lhs;
79  typedef _Rhs Rhs;
80 
81  typedef typename ProductImpl<
82  Lhs, Rhs, Option,
87 
88  typedef typename internal::ref_selector<Lhs>::type LhsNested;
89  typedef typename internal::ref_selector<Rhs>::type RhsNested;
90  typedef typename internal::remove_all<LhsNested>::type LhsNestedCleaned;
91  typedef typename internal::remove_all<RhsNested>::type RhsNestedCleaned;
92 
93  EIGEN_DEVICE_FUNC Product(const Lhs& lhs, const Rhs& rhs) : m_lhs(lhs), m_rhs(rhs)
94  {
95  eigen_assert(lhs.cols() == rhs.rows()
96  && "invalid matrix product"
97  && "if you wanted a coeff-wise or a dot product use the respective explicit functions");
98  }
99 
100  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index rows() const { return m_lhs.rows(); }
101  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index cols() const { return m_rhs.cols(); }
102 
103  EIGEN_DEVICE_FUNC const LhsNestedCleaned& lhs() const { return m_lhs; }
104  EIGEN_DEVICE_FUNC const RhsNestedCleaned& rhs() const { return m_rhs; }
105 
106  protected:
107 
110 };
111 
112 namespace internal {
113 
116  : public internal::dense_xpr_base<Product<Lhs,Rhs,Option> >::type
117 {};
118 
120 template<typename Lhs, typename Rhs, int Option>
122  : public internal::dense_xpr_base<Product<Lhs,Rhs,Option> >::type
123 {
126 public:
127  using Base::derived;
128  typedef typename Base::Scalar Scalar;
129 
130  EIGEN_STRONG_INLINE operator const Scalar() const
131  {
132  return internal::evaluator<ProductXpr>(derived()).coeff(0,0);
133  }
134 };
135 
136 } // namespace internal
137 
138 // Generic API dispatcher
139 template<typename Lhs, typename Rhs, int Option, typename StorageKind>
140 class ProductImpl : public internal::generic_xpr_base<Product<Lhs,Rhs,Option>, MatrixXpr, StorageKind>::type
141 {
142  public:
144 };
145 
146 template<typename Lhs, typename Rhs, int Option>
147 class ProductImpl<Lhs,Rhs,Option,Dense>
148  : public internal::dense_product_base<Lhs,Rhs,Option>
149 {
151 
152  public:
153 
156  protected:
157  enum {
158  IsOneByOne = (RowsAtCompileTime == 1 || RowsAtCompileTime == Dynamic) &&
159  (ColsAtCompileTime == 1 || ColsAtCompileTime == Dynamic),
160  EnableCoeff = IsOneByOne || Option==LazyProduct
161  };
162 
163  public:
164 
165  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar coeff(Index row, Index col) const
166  {
167  EIGEN_STATIC_ASSERT(EnableCoeff, THIS_METHOD_IS_ONLY_FOR_INNER_OR_LAZY_PRODUCTS);
168  eigen_assert( (Option==LazyProduct) || (this->rows() == 1 && this->cols() == 1) );
169 
170  return internal::evaluator<Derived>(derived()).coeff(row,col);
171  }
172 
173  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar coeff(Index i) const
174  {
175  EIGEN_STATIC_ASSERT(EnableCoeff, THIS_METHOD_IS_ONLY_FOR_INNER_OR_LAZY_PRODUCTS);
176  eigen_assert( (Option==LazyProduct) || (this->rows() == 1 && this->cols() == 1) );
177 
178  return internal::evaluator<Derived>(derived()).coeff(i);
179  }
180 
181 
182 };
183 
184 } // end namespace Eigen
185 
186 #endif // EIGEN_PRODUCT_H
SCALAR Scalar
Definition: bench_gemm.cpp:33
#define EIGEN_GENERIC_PUBLIC_INTERFACE(Derived)
Definition: Macros.h:852
#define EIGEN_STRONG_INLINE
Definition: Macros.h:494
Expression of the product of two arbitrary matrices or vectors.
Definition: Product.h:71
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index cols() const
Definition: Product.h:101
promote_index_type< typename LhsTraits::StorageIndex, typename RhsTraits::StorageIndex >::type StorageIndex
Definition: Product.h:34
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index rows() const
Definition: Product.h:100
Product< Lhs, Rhs, Option > Derived
Definition: Product.h:150
Namespace containing all symbols from the Eigen library.
Definition: jet.h:637
#define EIGEN_STATIC_ASSERT(CONDITION, MSG)
Definition: StaticAssert.h:124
LhsNested m_lhs
Definition: Product.h:108
const unsigned int RowMajorBit
Definition: Constants.h:61
#define EIGEN_SIZE_MIN_PREFER_FIXED(a, b)
Definition: Macros.h:889
EIGEN_DEVICE_FUNC const LhsNestedCleaned & lhs() const
Definition: Product.h:103
m row(1)
ScalarBinaryOpTraits< typename traits< LhsCleaned >::Scalar, typename traits< RhsCleaned >::Scalar >::ReturnType Scalar
Definition: Product.h:29
internal::generic_xpr_base< Product< Lhs, Rhs, Option >, MatrixXpr, StorageKind >::type Base
Definition: Product.h:143
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:33
#define eigen_assert(x)
Definition: Macros.h:579
internal::dense_xpr_base< ProductXpr >::type Base
Definition: Product.h:125
RhsNested m_rhs
Definition: Product.h:109
ProductImpl< Lhs, Rhs, Option, typename internal::product_promote_storage_type< typename internal::traits< Lhs >::StorageKind, typename internal::traits< Rhs >::StorageKind, internal::product_type< Lhs, Rhs >::ret >::ret >::Base Base
Definition: Product.h:85
DenseIndex ret
Definition: level1_impl.h:59
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar coeff(Index i) const
Definition: Product.h:173
#define EIGEN_DENSE_PUBLIC_INTERFACE(Derived)
Definition: Macros.h:870
m col(1)
Determines whether the given binary operation of two numeric types is allowed and what the scalar ret...
Definition: XprHelper.h:766
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar coeff(Index row, Index col) const
Definition: Product.h:165
const int Dynamic
Definition: Constants.h:21
internal::dense_product_base< Lhs, Rhs, Option > Base
Definition: Product.h:154
EIGEN_DEVICE_FUNC const RhsNestedCleaned & rhs() const
Definition: Product.h:104
Definition: pytypes.h:897
const unsigned int NoPreferredStorageOrderBit
Definition: Constants.h:173
product_promote_storage_type< typename LhsTraits::StorageKind, typename RhsTraits::StorageKind, internal::product_type< Lhs, Rhs >::ret >::ret StorageKind
Definition: Product.h:32


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:43:33