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

Detailed Description

template<typename BinaryOp, typename LhsType, typename RhsType>
class Eigen::CwiseBinaryOp< 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 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

Inherits Eigen::CwiseBinaryOpImpl< BinaryOp, LhsType, RhsType, internal::cwise_promote_storage_type< internal::traits< LhsType >::StorageKind, internal::traits< RhsType >::StorageKind, BinaryOp >::ret >, and Eigen::internal::no_assignment_operator.

Public Member Functions
const BinaryOp &	functor () const
const LhsNested_ &	lhs () const
const RhsNested_ &	rhs () const

Member Function Documentation

functor()

template<typename BinaryOp , typename LhsType , typename RhsType >

const BinaryOp & Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::functor ( ) const

inline

Returns

the functor representing the binary operation

lhs()

template<typename BinaryOp , typename LhsType , typename RhsType >

const LhsNested_ & Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::lhs ( ) const

inline

Returns

the left hand side nested expression

rhs()

template<typename BinaryOp , typename LhsType , typename RhsType >

const RhsNested_ & Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::rhs ( ) const

inline

Returns

the right hand side nested expression

---

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

• CwiseBinaryOp.h