Generic expression where a coefficient-wise binary operator is applied to two expressions. More...
#include <CwiseBinaryOp.h>
Public Types | |
| typedef internal::remove_reference < LhsNested >::type | _LhsNested |
| typedef internal::remove_reference < RhsNested >::type | _RhsNested |
| typedef CwiseBinaryOpImpl < BinaryOp, Lhs, Rhs, typename internal::promote_storage_type < typename internal::traits < Lhs >::StorageKind, typename internal::traits< Rhs > ::StorageKind >::ret >::Base | Base |
| typedef internal::nested< Lhs > ::type | LhsNested |
| typedef internal::nested< Rhs > ::type | RhsNested |
Public Member Functions | |
| EIGEN_STRONG_INLINE Index | cols () const |
| EIGEN_STRONG_INLINE | CwiseBinaryOp (const Lhs &lhs, const Rhs &rhs, const BinaryOp &func=BinaryOp()) |
| const BinaryOp & | functor () const |
| const _LhsNested & | lhs () const |
| const _RhsNested & | rhs () const |
| EIGEN_STRONG_INLINE Index | rows () const |
Protected Attributes | |
| const BinaryOp | m_functor |
| const LhsNested | m_lhs |
| const RhsNested | m_rhs |
Detailed Description
template<typename BinaryOp, typename Lhs, typename Rhs>
class CwiseBinaryOp< BinaryOp, Lhs, Rhs >
Generic expression where a coefficient-wise binary operator is applied to two expressions.
- Parameters:
-
BinaryOp template functor implementing the operator Lhs the type of the left-hand side Rhs the type of the right-hand side
This class represents an expression where a coefficient-wise binary operator is applied to two expressions. It is the return type of binary operators, by which we mean only those binary operators where both the left-hand side and the right-hand side are Eigen expressions. For example, the return type of matrix1+matrix2 is a CwiseBinaryOp.
Most of the time, this is the only way that it is used, so you typically don't have to name CwiseBinaryOp types explicitly.
- See also:
- MatrixBase::binaryExpr(const MatrixBase<OtherDerived> &,const CustomBinaryOp &) const, class CwiseUnaryOp, class CwiseNullaryOp
Definition at line 119 of file CwiseBinaryOp.h.
Member Typedef Documentation
| typedef internal::remove_reference<LhsNested>::type CwiseBinaryOp< BinaryOp, Lhs, Rhs >::_LhsNested |
Definition at line 135 of file CwiseBinaryOp.h.
| typedef internal::remove_reference<RhsNested>::type CwiseBinaryOp< BinaryOp, Lhs, Rhs >::_RhsNested |
Definition at line 136 of file CwiseBinaryOp.h.
| typedef CwiseBinaryOpImpl< BinaryOp, Lhs, Rhs, typename internal::promote_storage_type<typename internal::traits<Lhs>::StorageKind, typename internal::traits<Rhs>::StorageKind>::ret>::Base CwiseBinaryOp< BinaryOp, Lhs, Rhs >::Base |
Definition at line 130 of file CwiseBinaryOp.h.
| typedef internal::nested<Lhs>::type CwiseBinaryOp< BinaryOp, Lhs, Rhs >::LhsNested |
Definition at line 133 of file CwiseBinaryOp.h.
| typedef internal::nested<Rhs>::type CwiseBinaryOp< BinaryOp, Lhs, Rhs >::RhsNested |
Definition at line 134 of file CwiseBinaryOp.h.
Constructor & Destructor Documentation
| EIGEN_STRONG_INLINE CwiseBinaryOp< BinaryOp, Lhs, Rhs >::CwiseBinaryOp | ( | const Lhs & | lhs, |
| const Rhs & | rhs, | ||
| const BinaryOp & | func = BinaryOp() |
||
| ) | [inline] |
Definition at line 138 of file CwiseBinaryOp.h.
Member Function Documentation
| EIGEN_STRONG_INLINE Index CwiseBinaryOp< BinaryOp, Lhs, Rhs >::cols | ( | ) | const [inline] |
Definition at line 154 of file CwiseBinaryOp.h.
| const BinaryOp& CwiseBinaryOp< BinaryOp, Lhs, Rhs >::functor | ( | ) | const [inline] |
- Returns:
- the functor representing the binary operation
Definition at line 167 of file CwiseBinaryOp.h.
| const _LhsNested& CwiseBinaryOp< BinaryOp, Lhs, Rhs >::lhs | ( | ) | const [inline] |
- Returns:
- the left hand side nested expression
Definition at line 163 of file CwiseBinaryOp.h.
| const _RhsNested& CwiseBinaryOp< BinaryOp, Lhs, Rhs >::rhs | ( | ) | const [inline] |
- Returns:
- the right hand side nested expression
Definition at line 165 of file CwiseBinaryOp.h.
| EIGEN_STRONG_INLINE Index CwiseBinaryOp< BinaryOp, Lhs, Rhs >::rows | ( | ) | const [inline] |
Definition at line 147 of file CwiseBinaryOp.h.
Member Data Documentation
const BinaryOp CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_functor [protected] |
Definition at line 172 of file CwiseBinaryOp.h.
const LhsNested CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_lhs [protected] |
Definition at line 170 of file CwiseBinaryOp.h.
const RhsNested CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_rhs [protected] |
Definition at line 171 of file CwiseBinaryOp.h.
The documentation for this class was generated from the following file: