Public Types | Public Member Functions | Protected Attributes
CwiseBinaryOp< BinaryOp, Lhs, Rhs > Class Template Reference

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

#include <CwiseBinaryOp.h>

+ Inheritance diagram for CwiseBinaryOp< BinaryOp, Lhs, Rhs >:

List of all members.

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

Index cols () const
 CwiseBinaryOp (const Lhs &lhs, const Rhs &rhs, const BinaryOp &func=BinaryOp())
const BinaryOp & functor () const
const _LhsNestedlhs () const
const _RhsNestedrhs () const
Index rows () const

Protected Attributes

const BinaryOp m_functor
LhsNested m_lhs
RhsNested m_rhs

Detailed Description

template<typename BinaryOp, typename Lhs, typename Rhs>
class Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >

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

Parameters:
BinaryOptemplate functor implementing the operator
Lhsthe type of the left-hand side
Rhsthe 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

Member Typedef Documentation

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

Constructor & Destructor Documentation

CwiseBinaryOp ( const Lhs &  lhs,
const Rhs &  rhs,
const BinaryOp &  func = BinaryOp() 
) [inline]

Member Function Documentation

Index cols ( ) const [inline]

References Eigen::Dynamic.

const BinaryOp& functor ( ) const [inline]
Returns:
the functor representing the binary operation
const _LhsNested& lhs ( ) const [inline]
Returns:
the left hand side nested expression
const _RhsNested& rhs ( ) const [inline]
Returns:
the right hand side nested expression
Index rows ( ) const [inline]

References Eigen::Dynamic.


Member Data Documentation

const BinaryOp m_functor [protected]
LhsNested m_lhs [protected]
RhsNested m_rhs [protected]

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