Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::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 Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >:
Inheritance graph
[legend]

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 &aLhs, const Rhs &aRhs, const BinaryOp &func=BinaryOp())
 
const BinaryOp & functor () const
 
const _LhsNestedlhs () const
 
const _RhsNestedrhs () const
 
EIGEN_STRONG_INLINE 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

Definition at line 106 of file CwiseBinaryOp.h.

Member Typedef Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef internal::remove_reference<LhsNested>::type Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::_LhsNested

Definition at line 122 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef internal::remove_reference<RhsNested>::type Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::_RhsNested

Definition at line 123 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef CwiseBinaryOpImpl< BinaryOp, Lhs, Rhs, typename internal::promote_storage_type<typename internal::traits<Lhs>::StorageKind, typename internal::traits<Rhs>::StorageKind>::ret>::Base Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::Base

Definition at line 117 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef internal::nested<Lhs>::type Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::LhsNested

Definition at line 120 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef internal::nested<Rhs>::type Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::RhsNested

Definition at line 121 of file CwiseBinaryOp.h.

Constructor & Destructor Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::CwiseBinaryOp ( const Lhs &  aLhs,
const Rhs &  aRhs,
const BinaryOp &  func = BinaryOp() 
)
inline

Definition at line 125 of file CwiseBinaryOp.h.

Member Function Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE Index Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::cols ( ) const
inline

Definition at line 141 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
const BinaryOp& Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::functor ( ) const
inline
Returns
the functor representing the binary operation

Definition at line 154 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
const _LhsNested& Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::lhs ( ) const
inline
Returns
the left hand side nested expression

Definition at line 150 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
const _RhsNested& Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::rhs ( ) const
inline
Returns
the right hand side nested expression

Definition at line 152 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE Index Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::rows ( ) const
inline

Definition at line 134 of file CwiseBinaryOp.h.

Member Data Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
const BinaryOp Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_functor
protected

Definition at line 159 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
LhsNested Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_lhs
protected

Definition at line 157 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
RhsNested Eigen::CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_rhs
protected

Definition at line 158 of file CwiseBinaryOp.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:31