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

#include <src/eigen/Eigen/src/Core/CwiseBinaryOp.h>

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

Collaboration 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 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 Index	rows () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	cols () const

EIGEN_DEVICE_FUNC const _LhsNested &	lhs () const

EIGEN_DEVICE_FUNC const _RhsNested &	rhs () const

EIGEN_DEVICE_FUNC 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

      : m_lhs(aLhs), m_rhs(aRhs), m_functor(func)
    {
      EIGEN_CHECK_BINARY_COMPATIBILIY(BinaryOp,typename Lhs::Scalar,typename Rhs::Scalar);
      // require the sizes to match
      EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(Lhs, Rhs)
      eigen_assert(aLhs.rows() == aRhs.rows() && aLhs.cols() == aRhs.cols());
    }

References eigen_assert, EIGEN_CHECK_BINARY_COMPATIBILIY, and EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE.

Member Function Documentation

◆ cols()

template<typename BinaryOp , typename LhsType , typename RhsType >

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

inline

                                           {
      // return the fixed size type if available to enable compile time optimizations
      if (internal::traits<typename internal::remove_all<LhsNested>::type>::ColsAtCompileTime==Dynamic)
        return m_rhs.cols();
      else
        return m_lhs.cols();
    }

References Eigen::Dynamic, Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_lhs, and Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_rhs.

◆ functor()

template<typename BinaryOp , typename LhsType , typename RhsType >

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

inline

Returns: the functor representing the binary operation

138{ return m_functor; }

References Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_functor.

◆ lhs()

template<typename BinaryOp , typename LhsType , typename RhsType >

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

inline

Returns: the left hand side nested expression

132{ return m_lhs; }

References Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_lhs.

Referenced by Eigen::internal::check_transpose_aliasing_run_time_selector< Scalar, DestIsTransposed, CwiseBinaryOp< BinOp, DerivedA, DerivedB > >::run(), and Eigen::internal::Assignment< DstXprType, CwiseBinaryOp< internal::scalar_product_op< ScalarBis, Scalar >, const CwiseNullaryOp< internal::scalar_constant_op< ScalarBis >, Plain >, const Product< Lhs, Rhs, DefaultProduct > >, AssignFunc, Dense2Dense >::run().

Here is the caller graph for this function:

◆ rhs()

template<typename BinaryOp , typename LhsType , typename RhsType >

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

inline

Returns: the right hand side nested expression

135{ return m_rhs; }

References Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_rhs.

Referenced by Eigen::internal::check_transpose_aliasing_run_time_selector< Scalar, DestIsTransposed, CwiseBinaryOp< BinOp, DerivedA, DerivedB > >::run(), and Eigen::internal::Assignment< DstXprType, CwiseBinaryOp< internal::scalar_product_op< ScalarBis, Scalar >, const CwiseNullaryOp< internal::scalar_constant_op< ScalarBis >, Plain >, const Product< Lhs, Rhs, DefaultProduct > >, AssignFunc, Dense2Dense >::run().

Here is the caller graph for this function:

◆ rows()

template<typename BinaryOp , typename LhsType , typename RhsType >

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

inline

                                           {
      // return the fixed size type if available to enable compile time optimizations
      if (internal::traits<typename internal::remove_all<LhsNested>::type>::RowsAtCompileTime==Dynamic)
        return m_rhs.rows();
      else
        return m_lhs.rows();
    }

References Eigen::Dynamic, Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_lhs, and Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::m_rhs.

Member Data Documentation

◆ m_functor

template<typename BinaryOp , typename LhsType , typename RhsType >

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

protected

Referenced by Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::functor().

◆ m_lhs

template<typename BinaryOp , typename LhsType , typename RhsType >

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

protected

Referenced by Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::cols(), Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::lhs(), and Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::rows().

◆ m_rhs

template<typename BinaryOp , typename LhsType , typename RhsType >

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

protected

Referenced by Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::cols(), Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::rhs(), and Eigen::CwiseBinaryOp< BinaryOp, LhsType, RhsType >::rows().

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

src/eigen/Eigen/src/Core/CwiseBinaryOp.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ _LhsNested

◆ _RhsNested

◆ Base

◆ Functor

◆ Lhs

◆ LhsNested

◆ Rhs

◆ RhsNested

Constructor & Destructor Documentation

◆ CwiseBinaryOp()

Member Function Documentation

◆ cols()

◆ functor()

◆ lhs()

◆ rhs()

◆ rows()

Member Data Documentation

◆ m_functor

◆ m_lhs

◆ m_rhs