11 #ifndef EIGEN_GENERAL_PRODUCT_H 12 #define EIGEN_GENERAL_PRODUCT_H 23 template<
int Rows,
int Cols,
int Depth>
struct product_type_selector;
25 template<
int Size,
int MaxSize>
struct product_size_category
27 enum { is_large = MaxSize ==
Dynamic ||
28 Size >= EIGEN_CACHEFRIENDLY_PRODUCT_THRESHOLD ||
29 (Size==
Dynamic && MaxSize>=EIGEN_CACHEFRIENDLY_PRODUCT_THRESHOLD),
30 value = is_large ? Large
36 template<
typename Lhs,
typename Rhs>
struct product_type
38 typedef typename remove_all<Lhs>::type _Lhs;
39 typedef typename remove_all<Rhs>::type _Rhs;
41 MaxRows = traits<_Lhs>::MaxRowsAtCompileTime,
42 Rows = traits<_Lhs>::RowsAtCompileTime,
43 MaxCols = traits<_Rhs>::MaxColsAtCompileTime,
44 Cols = traits<_Rhs>::ColsAtCompileTime,
45 MaxDepth = EIGEN_SIZE_MIN_PREFER_FIXED(traits<_Lhs>::MaxColsAtCompileTime,
46 traits<_Rhs>::MaxRowsAtCompileTime),
47 Depth = EIGEN_SIZE_MIN_PREFER_FIXED(traits<_Lhs>::ColsAtCompileTime,
48 traits<_Rhs>::RowsAtCompileTime)
55 rows_select = product_size_category<Rows,MaxRows>::value,
56 cols_select = product_size_category<Cols,MaxCols>::value,
57 depth_select = product_size_category<Depth,MaxDepth>::value
59 typedef product_type_selector<rows_select, cols_select, depth_select> selector;
63 value = selector::ret,
66 #ifdef EIGEN_DEBUG_PRODUCT 69 EIGEN_DEBUG_VAR(Rows);
70 EIGEN_DEBUG_VAR(Cols);
71 EIGEN_DEBUG_VAR(Depth);
72 EIGEN_DEBUG_VAR(rows_select);
73 EIGEN_DEBUG_VAR(cols_select);
74 EIGEN_DEBUG_VAR(depth_select);
75 EIGEN_DEBUG_VAR(value);
84 template<
int M,
int N>
struct product_type_selector<M,N,1> {
enum { ret = OuterProduct }; };
85 template<
int M>
struct product_type_selector<M, 1, 1> {
enum { ret = LazyCoeffBasedProductMode }; };
86 template<
int N>
struct product_type_selector<1, N, 1> {
enum { ret = LazyCoeffBasedProductMode }; };
87 template<
int Depth>
struct product_type_selector<1, 1, Depth> {
enum { ret = InnerProduct }; };
88 template<>
struct product_type_selector<1, 1, 1> {
enum { ret = InnerProduct }; };
89 template<>
struct product_type_selector<Small,1, Small> {
enum { ret = CoeffBasedProductMode }; };
90 template<>
struct product_type_selector<1, Small,Small> {
enum { ret = CoeffBasedProductMode }; };
91 template<>
struct product_type_selector<Small,Small,Small> {
enum { ret = CoeffBasedProductMode }; };
92 template<>
struct product_type_selector<Small, Small, 1> {
enum { ret = LazyCoeffBasedProductMode }; };
93 template<>
struct product_type_selector<Small, Large, 1> {
enum { ret = LazyCoeffBasedProductMode }; };
94 template<>
struct product_type_selector<Large, Small, 1> {
enum { ret = LazyCoeffBasedProductMode }; };
95 template<>
struct product_type_selector<1, Large,Small> {
enum { ret = CoeffBasedProductMode }; };
96 template<>
struct product_type_selector<1, Large,Large> {
enum { ret = GemvProduct }; };
97 template<>
struct product_type_selector<1, Small,Large> {
enum { ret = CoeffBasedProductMode }; };
98 template<>
struct product_type_selector<Large,1, Small> {
enum { ret = CoeffBasedProductMode }; };
99 template<>
struct product_type_selector<Large,1, Large> {
enum { ret = GemvProduct }; };
100 template<>
struct product_type_selector<Small,1, Large> {
enum { ret = CoeffBasedProductMode }; };
101 template<>
struct product_type_selector<Small,Small,Large> {
enum { ret = GemmProduct }; };
102 template<>
struct product_type_selector<Large,Small,Large> {
enum { ret = GemmProduct }; };
103 template<>
struct product_type_selector<Small,Large,Large> {
enum { ret = GemmProduct }; };
104 template<>
struct product_type_selector<Large,Large,Large> {
enum { ret = GemmProduct }; };
105 template<>
struct product_type_selector<Large,Small,Small> {
enum { ret = CoeffBasedProductMode }; };
106 template<>
struct product_type_selector<Small,Large,Small> {
enum { ret = CoeffBasedProductMode }; };
107 template<>
struct product_type_selector<Large,Large,Small> {
enum { ret = GemmProduct }; };
139 template<
int S
ide,
int StorageOrder,
bool BlasCompatible>
140 struct gemv_dense_selector;
146 template<
typename Scalar,
int Size,
int MaxSize,
bool Cond>
struct gemv_static_vector_if;
148 template<
typename Scalar,
int Size,
int MaxSize>
149 struct gemv_static_vector_if<Scalar,Size,MaxSize,false>
151 EIGEN_STRONG_INLINE Scalar* data() { eigen_internal_assert(
false &&
"should never be called");
return 0; }
154 template<
typename Scalar,
int Size>
155 struct gemv_static_vector_if<Scalar,Size,
Dynamic,true>
157 EIGEN_STRONG_INLINE Scalar* data() {
return 0; }
160 template<
typename Scalar,
int Size,
int MaxSize>
161 struct gemv_static_vector_if<Scalar,Size,MaxSize,true>
164 ForceAlignment = internal::packet_traits<Scalar>::Vectorizable,
165 PacketSize = internal::packet_traits<Scalar>::size
167 #if EIGEN_MAX_STATIC_ALIGN_BYTES!=0 168 internal::plain_array<Scalar,EIGEN_SIZE_MIN_PREFER_FIXED(Size,MaxSize),0,EIGEN_PLAIN_ENUM_MIN(AlignedMax,PacketSize)> m_data;
169 EIGEN_STRONG_INLINE Scalar* data() {
return m_data.array; }
173 internal::plain_array<Scalar,EIGEN_SIZE_MIN_PREFER_FIXED(Size,MaxSize)+(ForceAlignment?EIGEN_MAX_ALIGN_BYTES:0),0> m_data;
174 EIGEN_STRONG_INLINE Scalar* data() {
175 return ForceAlignment
176 ?
reinterpret_cast<Scalar*
>((internal::UIntPtr(m_data.array) & ~(std::size_t(EIGEN_MAX_ALIGN_BYTES-1))) + EIGEN_MAX_ALIGN_BYTES)
183 template<
int StorageOrder,
bool BlasCompatible>
184 struct gemv_dense_selector<
OnTheLeft,StorageOrder,BlasCompatible>
186 template<
typename Lhs,
typename Rhs,
typename Dest>
187 static void run(
const Lhs &lhs,
const Rhs &rhs, Dest& dest,
const typename Dest::Scalar& alpha)
189 Transpose<Dest> destT(dest);
191 gemv_dense_selector<OnTheRight,OtherStorageOrder,BlasCompatible>
192 ::run(rhs.transpose(), lhs.transpose(), destT, alpha);
198 template<
typename Lhs,
typename Rhs,
typename Dest>
199 static inline void run(
const Lhs &lhs,
const Rhs &rhs, Dest& dest,
const typename Dest::Scalar& alpha)
201 typedef typename Lhs::Scalar LhsScalar;
202 typedef typename Rhs::Scalar RhsScalar;
203 typedef typename Dest::Scalar ResScalar;
204 typedef typename Dest::RealScalar RealScalar;
206 typedef internal::blas_traits<Lhs> LhsBlasTraits;
207 typedef typename LhsBlasTraits::DirectLinearAccessType ActualLhsType;
208 typedef internal::blas_traits<Rhs> RhsBlasTraits;
209 typedef typename RhsBlasTraits::DirectLinearAccessType ActualRhsType;
211 typedef Map<Matrix<ResScalar,Dynamic,1>, EIGEN_PLAIN_ENUM_MIN(AlignedMax,internal::packet_traits<ResScalar>::size)> MappedDest;
213 ActualLhsType actualLhs = LhsBlasTraits::extract(lhs);
214 ActualRhsType actualRhs = RhsBlasTraits::extract(rhs);
216 ResScalar actualAlpha = alpha * LhsBlasTraits::extractScalarFactor(lhs)
217 * RhsBlasTraits::extractScalarFactor(rhs);
220 typedef typename conditional<Dest::IsVectorAtCompileTime, Dest, typename Dest::ColXpr>::type ActualDest;
225 EvalToDestAtCompileTime = (ActualDest::InnerStrideAtCompileTime==1),
226 ComplexByReal = (NumTraits<LhsScalar>::IsComplex) && (!NumTraits<RhsScalar>::IsComplex),
227 MightCannotUseDest = (!EvalToDestAtCompileTime) || ComplexByReal
230 typedef const_blas_data_mapper<LhsScalar,Index,ColMajor> LhsMapper;
231 typedef const_blas_data_mapper<RhsScalar,Index,RowMajor> RhsMapper;
232 RhsScalar compatibleAlpha = get_factor<ResScalar,RhsScalar>::run(actualAlpha);
234 if(!MightCannotUseDest)
238 general_matrix_vector_product
239 <
Index,LhsScalar,LhsMapper,
ColMajor,LhsBlasTraits::NeedToConjugate,RhsScalar,RhsMapper,RhsBlasTraits::NeedToConjugate>::run(
240 actualLhs.rows(), actualLhs.cols(),
241 LhsMapper(actualLhs.data(), actualLhs.outerStride()),
242 RhsMapper(actualRhs.data(), actualRhs.innerStride()),
248 gemv_static_vector_if<ResScalar,ActualDest::SizeAtCompileTime,ActualDest::MaxSizeAtCompileTime,MightCannotUseDest> static_dest;
250 const bool alphaIsCompatible = (!ComplexByReal) || (numext::imag(actualAlpha)==RealScalar(0));
251 const bool evalToDest = EvalToDestAtCompileTime && alphaIsCompatible;
253 ei_declare_aligned_stack_constructed_variable(ResScalar,actualDestPtr,dest.size(),
254 evalToDest ? dest.data() : static_dest.data());
258 #ifdef EIGEN_DENSE_STORAGE_CTOR_PLUGIN 259 Index size = dest.size();
260 EIGEN_DENSE_STORAGE_CTOR_PLUGIN
262 if(!alphaIsCompatible)
264 MappedDest(actualDestPtr, dest.size()).setZero();
265 compatibleAlpha = RhsScalar(1);
268 MappedDest(actualDestPtr, dest.size()) = dest;
271 general_matrix_vector_product
272 <
Index,LhsScalar,LhsMapper,
ColMajor,LhsBlasTraits::NeedToConjugate,RhsScalar,RhsMapper,RhsBlasTraits::NeedToConjugate>::run(
273 actualLhs.rows(), actualLhs.cols(),
274 LhsMapper(actualLhs.data(), actualLhs.outerStride()),
275 RhsMapper(actualRhs.data(), actualRhs.innerStride()),
281 if(!alphaIsCompatible)
282 dest.matrix() += actualAlpha * MappedDest(actualDestPtr, dest.size());
284 dest = MappedDest(actualDestPtr, dest.size());
292 template<
typename Lhs,
typename Rhs,
typename Dest>
293 static void run(
const Lhs &lhs,
const Rhs &rhs, Dest& dest,
const typename Dest::Scalar& alpha)
295 typedef typename Lhs::Scalar LhsScalar;
296 typedef typename Rhs::Scalar RhsScalar;
297 typedef typename Dest::Scalar ResScalar;
299 typedef internal::blas_traits<Lhs> LhsBlasTraits;
300 typedef typename LhsBlasTraits::DirectLinearAccessType ActualLhsType;
301 typedef internal::blas_traits<Rhs> RhsBlasTraits;
302 typedef typename RhsBlasTraits::DirectLinearAccessType ActualRhsType;
303 typedef typename internal::remove_all<ActualRhsType>::type ActualRhsTypeCleaned;
305 typename add_const<ActualLhsType>::type actualLhs = LhsBlasTraits::extract(lhs);
306 typename add_const<ActualRhsType>::type actualRhs = RhsBlasTraits::extract(rhs);
308 ResScalar actualAlpha = alpha * LhsBlasTraits::extractScalarFactor(lhs)
309 * RhsBlasTraits::extractScalarFactor(rhs);
314 DirectlyUseRhs = ActualRhsTypeCleaned::InnerStrideAtCompileTime==1
317 gemv_static_vector_if<RhsScalar,ActualRhsTypeCleaned::SizeAtCompileTime,ActualRhsTypeCleaned::MaxSizeAtCompileTime,!DirectlyUseRhs> static_rhs;
319 ei_declare_aligned_stack_constructed_variable(RhsScalar,actualRhsPtr,actualRhs.size(),
320 DirectlyUseRhs ?
const_cast<RhsScalar*
>(actualRhs.data()) : static_rhs.data());
324 #ifdef EIGEN_DENSE_STORAGE_CTOR_PLUGIN 325 Index size = actualRhs.size();
326 EIGEN_DENSE_STORAGE_CTOR_PLUGIN
328 Map<typename ActualRhsTypeCleaned::PlainObject>(actualRhsPtr, actualRhs.size()) = actualRhs;
331 typedef const_blas_data_mapper<LhsScalar,Index,RowMajor> LhsMapper;
332 typedef const_blas_data_mapper<RhsScalar,Index,ColMajor> RhsMapper;
333 general_matrix_vector_product
334 <
Index,LhsScalar,LhsMapper,
RowMajor,LhsBlasTraits::NeedToConjugate,RhsScalar,RhsMapper,RhsBlasTraits::NeedToConjugate>::run(
335 actualLhs.rows(), actualLhs.cols(),
336 LhsMapper(actualLhs.data(), actualLhs.outerStride()),
337 RhsMapper(actualRhsPtr, 1),
338 dest.data(), dest.col(0).innerStride(),
343 template<>
struct gemv_dense_selector<
OnTheRight,ColMajor,false>
345 template<
typename Lhs,
typename Rhs,
typename Dest>
346 static void run(
const Lhs &lhs,
const Rhs &rhs, Dest& dest,
const typename Dest::Scalar& alpha)
348 EIGEN_STATIC_ASSERT((!nested_eval<Lhs,1>::Evaluate),EIGEN_INTERNAL_COMPILATION_ERROR_OR_YOU_MADE_A_PROGRAMMING_MISTAKE);
350 typename nested_eval<Rhs,1>::type actual_rhs(rhs);
351 const Index size = rhs.rows();
352 for(Index k=0; k<size; ++k)
353 dest += (alpha*actual_rhs.coeff(k)) * lhs.col(k);
357 template<>
struct gemv_dense_selector<
OnTheRight,RowMajor,false>
359 template<
typename Lhs,
typename Rhs,
typename Dest>
360 static void run(
const Lhs &lhs,
const Rhs &rhs, Dest& dest,
const typename Dest::Scalar& alpha)
362 EIGEN_STATIC_ASSERT((!nested_eval<Lhs,1>::Evaluate),EIGEN_INTERNAL_COMPILATION_ERROR_OR_YOU_MADE_A_PROGRAMMING_MISTAKE);
363 typename nested_eval<Rhs,Lhs::RowsAtCompileTime>::type actual_rhs(rhs);
364 const Index rows = dest.rows();
365 for(Index i=0; i<rows; ++i)
366 dest.coeffRef(i) += alpha * (lhs.row(i).cwiseProduct(actual_rhs.transpose())).sum();
384 template<
typename Derived>
385 template<
typename OtherDerived>
386 inline const Product<Derived, OtherDerived>
394 ProductIsValid = Derived::ColsAtCompileTime==
Dynamic 395 || OtherDerived::RowsAtCompileTime==
Dynamic 396 || int(Derived::ColsAtCompileTime)==int(OtherDerived::RowsAtCompileTime),
397 AreVectors = Derived::IsVectorAtCompileTime && OtherDerived::IsVectorAtCompileTime,
398 SameSizes = EIGEN_PREDICATE_SAME_MATRIX_SIZE(Derived,OtherDerived)
403 EIGEN_STATIC_ASSERT(ProductIsValid || !(AreVectors && SameSizes),
404 INVALID_VECTOR_VECTOR_PRODUCT__IF_YOU_WANTED_A_DOT_OR_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTIONS)
405 EIGEN_STATIC_ASSERT(ProductIsValid || !(SameSizes && !AreVectors),
406 INVALID_MATRIX_PRODUCT__IF_YOU_WANTED_A_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTION)
407 EIGEN_STATIC_ASSERT(ProductIsValid || SameSizes, INVALID_MATRIX_PRODUCT)
408 #ifdef EIGEN_DEBUG_PRODUCT 409 internal::product_type<Derived,OtherDerived>::debug();
428 template<
typename Derived>
429 template<
typename OtherDerived>
434 ProductIsValid = Derived::ColsAtCompileTime==
Dynamic 435 || OtherDerived::RowsAtCompileTime==
Dynamic 436 || int(Derived::ColsAtCompileTime)==int(OtherDerived::RowsAtCompileTime),
437 AreVectors = Derived::IsVectorAtCompileTime && OtherDerived::IsVectorAtCompileTime,
438 SameSizes = EIGEN_PREDICATE_SAME_MATRIX_SIZE(Derived,OtherDerived)
443 EIGEN_STATIC_ASSERT(ProductIsValid || !(AreVectors && SameSizes),
444 INVALID_VECTOR_VECTOR_PRODUCT__IF_YOU_WANTED_A_DOT_OR_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTIONS)
445 EIGEN_STATIC_ASSERT(ProductIsValid || !(SameSizes && !AreVectors),
446 INVALID_MATRIX_PRODUCT__IF_YOU_WANTED_A_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTION)
447 EIGEN_STATIC_ASSERT(ProductIsValid || SameSizes, INVALID_MATRIX_PRODUCT)
454 #endif // EIGEN_PRODUCT_H Definition: Constants.h:320
Expression of the product of two arbitrary matrices or vectors.
Definition: Product.h:71
Definition: Constants.h:335
Namespace containing all symbols from the Eigen library.
Definition: Core:287
Derived & derived()
Definition: EigenBase.h:45
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:33
Definition: Constants.h:333
Definition: Eigen_Colamd.h:50
Definition: Constants.h:322
const int Dynamic
Definition: Constants.h:21
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:48
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, Derived, Constant< T > > operator*(const T &scalar) const
const Product< Derived, OtherDerived, LazyProduct > lazyProduct(const MatrixBase< OtherDerived > &other) const
Definition: GeneralProduct.h:431