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

Public Types

typedef internal::remove_reference< LhsNested >::type _LhsNested
 
typedef internal::remove_reference< RhsNested >::type _RhsNested
 
typedef CwiseBinaryOpImpl< BinaryOp, LhsType, RhsType, typename internal::cwise_promote_storage_type< typename internal::traits< LhsType >::StorageKind, typename internal::traits< Rhs >::StorageKind, BinaryOp >::ret >::Base Base
 
typedef internal::remove_all< BinaryOp >::type Functor
 
typedef internal::remove_all< LhsType >::type Lhs
 
typedef internal::ref_selector< LhsType >::type LhsNested
 
typedef internal::remove_all< RhsType >::type Rhs
 
typedef internal::ref_selector< RhsType >::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 EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CwiseBinaryOp (const Lhs &aLhs, const Rhs &aRhs, const BinaryOp &func=BinaryOp())
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const BinaryOp & functor () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const _LhsNestedlhs () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const _RhsNestedrhs () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 

Protected Attributes

const BinaryOp m_functor
 
LhsNested m_lhs
 
RhsNested m_rhs
 

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
BinaryOptemplate functor implementing the operator
LhsTypethe type of the left-hand side
RhsTypethe 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 77 of file CwiseBinaryOp.h.

Member Typedef Documentation

◆ _LhsNested

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

Definition at line 100 of file CwiseBinaryOp.h.

◆ _RhsNested

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

Definition at line 101 of file CwiseBinaryOp.h.

◆ Base

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

Definition at line 95 of file CwiseBinaryOp.h.

◆ Functor

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

Definition at line 87 of file CwiseBinaryOp.h.

◆ Lhs

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

Definition at line 88 of file CwiseBinaryOp.h.

◆ LhsNested

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

Definition at line 98 of file CwiseBinaryOp.h.

◆ Rhs

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

Definition at line 89 of file CwiseBinaryOp.h.

◆ RhsNested

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

Definition at line 99 of file CwiseBinaryOp.h.

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

Definition at line 110 of file CwiseBinaryOp.h.

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 ( ) const
inline

Definition at line 125 of file CwiseBinaryOp.h.

◆ 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

Definition at line 138 of file CwiseBinaryOp.h.

◆ 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

Definition at line 132 of file CwiseBinaryOp.h.

◆ 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

Definition at line 135 of file CwiseBinaryOp.h.

◆ rows()

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

Definition at line 120 of file CwiseBinaryOp.h.

Member Data Documentation

◆ m_functor

template<typename BinaryOp, typename LhsType, typename RhsType>
const BinaryOp Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_functor
protected

Definition at line 143 of file CwiseBinaryOp.h.

◆ m_lhs

template<typename BinaryOp, typename LhsType, typename RhsType>
LhsNested Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_lhs
protected

Definition at line 141 of file CwiseBinaryOp.h.

◆ m_rhs

template<typename BinaryOp, typename LhsType, typename RhsType>
RhsNested Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_rhs
protected

Definition at line 142 of file CwiseBinaryOp.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:32