Eigen::CwiseHeteroBinaryOp< BinaryOp, LhsType, RhsType > Class Template Reference

Generic expression where a coefficient-wise binary operator is applied to two expressions. More...

#include <CwiseHeteroBinaryOp.h>

Inherits Eigen::CwiseHeteroBinaryOpImpl< BinaryOp, Lhs, Rhs, StorageKind >, and internal::no_assignment_operator.

Public Types
typedef internal::remove_all< BinaryOp >::type	Functor
typedef internal::remove_all< LhsType >::type	Lhs
typedef internal::remove_all< RhsType >::type	Rhs
typedef CwiseHeteroBinaryOpImpl< BinaryOp, LhsType, RhsType, typenameinternal::cwise_promote_storage_type< typenameinternal::traits< LhsType >::StorageKind, typenameinternal::traits< Rhs >::StorageKind, BinaryOp >::ret >::Base	Base
typedef internal::ref_selector< LhsType >::type	LhsNested
typedef internal::ref_selector< RhsType >::type	RhsNested
typedef internal::remove_reference< LhsNested >::type	_LhsNested
typedef internal::remove_reference< RhsNested >::type	_RhsNested

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	CwiseHeteroBinaryOp (const Lhs &aLhs, const Rhs &aRhs, const BinaryOp &func=BinaryOp())
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE constexpr Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE constexpr Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const _LhsNested &	lhs () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const _RhsNested &	rhs () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const BinaryOp &	functor () const

Protected Attributes
LhsNested	m_lhs
RhsNested	m_rhs
const BinaryOp	m_functor

Detailed Description

template<typename BinaryOp, typename LhsType, typename RhsType>
class Eigen::CwiseHeteroBinaryOp< BinaryOp, LhsType, RhsType >

Generic expression where a coefficient-wise binary operator is applied to two expressions.

Template Parameters

BinaryOp	template functor implementing the operator
LhsType	the type of the left-hand side
RhsType	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 CwiseHeteroBinaryOp.

Most of the time, this is the only way that it is used, so you typically don't have to name CwiseHeteroBinaryOp types explicitly.

See also

MatrixBase::binaryExpr(const MatrixBase<OtherDerived> &,const CustomBinaryOp &) const, class CwiseUnaryOp, class CwiseNullaryOp

Member Function Documentation

functor()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const BinaryOp & Eigen::CwiseHeteroBinaryOp< BinaryOp, LhsType, RhsType >::functor ( ) const

inline

Returns

the functor representing the binary operation

lhs()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const _LhsNested & Eigen::CwiseHeteroBinaryOp< BinaryOp, LhsType, RhsType >::lhs ( ) const

inline

Returns

the left hand side nested expression

rhs()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const _RhsNested & Eigen::CwiseHeteroBinaryOp< BinaryOp, LhsType, RhsType >::rhs ( ) const

inline

Returns

the right hand side nested expression

---

The documentation for this class was generated from the following file:

• CwiseHeteroBinaryOp.h