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

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/CwiseBinaryOp.h>

Inheritance diagram for Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >:

Public Types
typedef internal::remove_all< BinaryOp >::type	Functor
typedef internal::remove_all< LhsType >::type	Lhs
typedef internal::remove_all< RhsType >::type	Rhs
typedef CwiseBinaryOpImpl< 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 Types inherited from Eigen::CwiseBinaryOpImpl< BinaryOp, LhsType, RhsType, internal::cwise_promote_storage_type< internal::traits< LhsType >::StorageKind, internal::traits< RhsType >::StorageKind, BinaryOp >::ret >
typedef internal::generic_xpr_base< CwiseBinaryOp< BinaryOp, LhsType, RhsType > >::type	Base

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	CwiseBinaryOp (const Lhs &aLhs, const Rhs &aRhs, const BinaryOp &func=BinaryOp())
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_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::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

Member Typedef Documentation

_LhsNested

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::remove_reference<LhsNested>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::_LhsNested

_RhsNested

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::remove_reference<RhsNested>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::_RhsNested

Base

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef CwiseBinaryOpImpl<BinaryOp,LhsType,RhsType,typenameinternal::cwise_promote_storage_type<typenameinternal::traits<LhsType>::StorageKind,typenameinternal::traits<Rhs>::StorageKind,BinaryOp>::ret>::Base Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::Base

Functor

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::remove_all<BinaryOp>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::Functor

Lhs

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::remove_all<LhsType>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::Lhs

LhsNested

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::ref_selector<LhsType>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::LhsNested

Rhs

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::remove_all<RhsType>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::Rhs

RhsNested

template<typename BinaryOp , typename LhsType , typename RhsType >

typedef internal::ref_selector<RhsType>::type Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::RhsNested

Constructor & Destructor Documentation

CwiseBinaryOp()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::CwiseBinaryOp ( const Lhs &  aLhs, const Rhs &  aRhs, const BinaryOp &  func = BinaryOp()  )

inline

Member Function Documentation

cols()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::cols ( void  ) const

inline

functor()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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 >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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 >

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

inline

Returns

the right hand side nested expression

rows()

template<typename BinaryOp , typename LhsType , typename RhsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::rows ( void  ) const

inline

Member Data Documentation

m_functor

template<typename BinaryOp , typename LhsType , typename RhsType >

const BinaryOp Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_functor

protected

m_lhs

template<typename BinaryOp , typename LhsType , typename RhsType >

LhsNested Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_lhs

protected

m_rhs

template<typename BinaryOp , typename LhsType , typename RhsType >

RhsNested Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_rhs

protected

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/ForwardDeclarations.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/CwiseBinaryOp.h