Eigen  3.3.0
 
Loading...
Searching...
No Matches
CwiseBinaryOp.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2014 Gael Guennebaud <gael.guennebaud@inria.fr>
5// Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
11#ifndef EIGEN_CWISE_BINARY_OP_H
12#define EIGEN_CWISE_BINARY_OP_H
13
14namespace Eigen {
15
16namespace internal {
17template<typename BinaryOp, typename Lhs, typename Rhs>
18struct traits<CwiseBinaryOp<BinaryOp, Lhs, Rhs> >
19{
20 // we must not inherit from traits<Lhs> since it has
21 // the potential to cause problems with MSVC
22 typedef typename remove_all<Lhs>::type Ancestor;
23 typedef typename traits<Ancestor>::XprKind XprKind;
24 enum {
25 RowsAtCompileTime = traits<Ancestor>::RowsAtCompileTime,
26 ColsAtCompileTime = traits<Ancestor>::ColsAtCompileTime,
27 MaxRowsAtCompileTime = traits<Ancestor>::MaxRowsAtCompileTime,
28 MaxColsAtCompileTime = traits<Ancestor>::MaxColsAtCompileTime
29 };
30
31 // even though we require Lhs and Rhs to have the same scalar type (see CwiseBinaryOp constructor),
32 // we still want to handle the case when the result type is different.
33 typedef typename result_of<
34 BinaryOp(
35 const typename Lhs::Scalar&,
36 const typename Rhs::Scalar&
37 )
38 >::type Scalar;
39 typedef typename cwise_promote_storage_type<typename traits<Lhs>::StorageKind,
40 typename traits<Rhs>::StorageKind,
41 BinaryOp>::ret StorageKind;
42 typedef typename promote_index_type<typename traits<Lhs>::StorageIndex,
43 typename traits<Rhs>::StorageIndex>::type StorageIndex;
44 typedef typename Lhs::Nested LhsNested;
45 typedef typename Rhs::Nested RhsNested;
46 typedef typename remove_reference<LhsNested>::type _LhsNested;
47 typedef typename remove_reference<RhsNested>::type _RhsNested;
48 enum {
49 Flags = _LhsNested::Flags & RowMajorBit
50 };
51};
52} // end namespace internal
53
54template<typename BinaryOp, typename Lhs, typename Rhs, typename StorageKind>
55class CwiseBinaryOpImpl;
56
76template<typename BinaryOp, typename LhsType, typename RhsType>
78 public CwiseBinaryOpImpl<
79 BinaryOp, LhsType, RhsType,
80 typename internal::cwise_promote_storage_type<typename internal::traits<LhsType>::StorageKind,
81 typename internal::traits<RhsType>::StorageKind,
82 BinaryOp>::ret>,
83 internal::no_assignment_operator
84{
85 public:
86
87 typedef typename internal::remove_all<LhsType>::type Lhs;
88 typedef typename internal::remove_all<RhsType>::type Rhs;
89
90 typedef typename CwiseBinaryOpImpl<
91 BinaryOp, LhsType, RhsType,
92 typename internal::cwise_promote_storage_type<typename internal::traits<LhsType>::StorageKind,
93 typename internal::traits<Rhs>::StorageKind,
94 BinaryOp>::ret>::Base Base;
95 EIGEN_GENERIC_PUBLIC_INTERFACE(CwiseBinaryOp)
96
97 typedef typename internal::ref_selector<LhsType>::type LhsNested;
98 typedef typename internal::ref_selector<RhsType>::type RhsNested;
99 typedef typename internal::remove_reference<LhsNested>::type _LhsNested;
100 typedef typename internal::remove_reference<RhsNested>::type _RhsNested;
101
102 EIGEN_DEVICE_FUNC
103 EIGEN_STRONG_INLINE CwiseBinaryOp(const Lhs& aLhs, const Rhs& aRhs, const BinaryOp& func = BinaryOp())
104 : m_lhs(aLhs), m_rhs(aRhs), m_functor(func)
105 {
106 EIGEN_CHECK_BINARY_COMPATIBILIY(BinaryOp,typename Lhs::Scalar,typename Rhs::Scalar);
107 // require the sizes to match
108 EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(Lhs, Rhs)
109 eigen_assert(aLhs.rows() == aRhs.rows() && aLhs.cols() == aRhs.cols());
110 }
111
112 EIGEN_DEVICE_FUNC
113 EIGEN_STRONG_INLINE Index rows() const {
114 // return the fixed size type if available to enable compile time optimizations
115 if (internal::traits<typename internal::remove_all<LhsNested>::type>::RowsAtCompileTime==Dynamic)
116 return m_rhs.rows();
117 else
118 return m_lhs.rows();
119 }
120 EIGEN_DEVICE_FUNC
121 EIGEN_STRONG_INLINE Index cols() const {
122 // return the fixed size type if available to enable compile time optimizations
123 if (internal::traits<typename internal::remove_all<LhsNested>::type>::ColsAtCompileTime==Dynamic)
124 return m_rhs.cols();
125 else
126 return m_lhs.cols();
127 }
128
130 EIGEN_DEVICE_FUNC
131 const _LhsNested& lhs() const { return m_lhs; }
133 EIGEN_DEVICE_FUNC
134 const _RhsNested& rhs() const { return m_rhs; }
136 EIGEN_DEVICE_FUNC
137 const BinaryOp& functor() const { return m_functor; }
138
139 protected:
140 LhsNested m_lhs;
141 RhsNested m_rhs;
142 const BinaryOp m_functor;
143};
144
145// Generic API dispatcher
146template<typename BinaryOp, typename Lhs, typename Rhs, typename StorageKind>
147class CwiseBinaryOpImpl
148 : public internal::generic_xpr_base<CwiseBinaryOp<BinaryOp, Lhs, Rhs> >::type
149{
150public:
151 typedef typename internal::generic_xpr_base<CwiseBinaryOp<BinaryOp, Lhs, Rhs> >::type Base;
152};
153
158template<typename Derived>
159template<typename OtherDerived>
160EIGEN_STRONG_INLINE Derived &
162{
163 call_assignment(derived(), other.derived(), internal::sub_assign_op<Scalar,typename OtherDerived::Scalar>());
164 return derived();
165}
166
171template<typename Derived>
172template<typename OtherDerived>
173EIGEN_STRONG_INLINE Derived &
175{
176 call_assignment(derived(), other.derived(), internal::add_assign_op<Scalar,typename OtherDerived::Scalar>());
177 return derived();
178}
179
180} // end namespace Eigen
181
182#endif // EIGEN_CWISE_BINARY_OP_H
183
Generic expression where a coefficient-wise binary operator is applied to two expressions.
Definition: CwiseBinaryOp.h:84
const _LhsNested & lhs() const
Definition: CwiseBinaryOp.h:131
const BinaryOp & functor() const
Definition: CwiseBinaryOp.h:137
const _RhsNested & rhs() const
Definition: CwiseBinaryOp.h:134
Derived & derived()
Definition: EigenBase.h:44
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:50
const unsigned int RowMajorBit
Definition: Constants.h:61
Namespace containing all symbols from the Eigen library.
Definition: Core:287
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:33
const int Dynamic
Definition: Constants.h:21