CwiseBinaryOp< BinaryOp, Lhs, Rhs > Class Template Reference

Generic expression of a coefficient-wise operator between two matrices or vectors. More...

#include <CwiseBinaryOp.h>

Inheritance diagram for CwiseBinaryOp< BinaryOp, Lhs, Rhs >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef ei_traits
< CwiseBinaryOp >::LhsNested 
LhsNested
typedef ei_traits
< CwiseBinaryOp >::RhsNested 
RhsNested

Public Member Functions

EIGEN_STRONG_INLINE const Scalar coeff (int index) const
EIGEN_STRONG_INLINE const Scalar coeff (int row, int col) const
EIGEN_STRONG_INLINE int cols () const
EIGEN_STRONG_INLINE CwiseBinaryOp (const Lhs &lhs, const Rhs &rhs, const BinaryOp &func=BinaryOp())
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (int index) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (int row, int col) const
EIGEN_STRONG_INLINE int rows () const

Protected Attributes

const BinaryOp m_functor
const LhsNested m_lhs
const RhsNested m_rhs

Detailed Description

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

Generic expression of a coefficient-wise operator between two matrices or vectors.

Parameters:
BinaryOp template functor implementing the operator
Lhs the type of the left-hand side
Rhs the type of the right-hand side

This class represents an expression of a generic binary operator of two matrices or vectors. It is the return type of the operator+, operator-, and the Cwise methods, and most of the time this is the only way it is used.

However, if you want to write a function returning such an expression, you will need to use this class.

See also:
MatrixBase::binaryExpr(const MatrixBase<OtherDerived> &,const CustomBinaryOp &) const, class CwiseUnaryOp, class CwiseNullaryOp

Definition at line 80 of file CwiseBinaryOp.h.


Member Typedef Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef ei_traits<CwiseBinaryOp>::LhsNested CwiseBinaryOp< BinaryOp, Lhs, Rhs >::LhsNested

Definition at line 86 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
typedef ei_traits<CwiseBinaryOp>::RhsNested CwiseBinaryOp< BinaryOp, Lhs, Rhs >::RhsNested

Definition at line 87 of file CwiseBinaryOp.h.


Constructor & Destructor Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE CwiseBinaryOp< BinaryOp, Lhs, Rhs >::CwiseBinaryOp ( const Lhs &  lhs,
const Rhs &  rhs,
const BinaryOp &  func = BinaryOp() 
) [inline]

Definition at line 89 of file CwiseBinaryOp.h.


Member Function Documentation

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE const Scalar CwiseBinaryOp< BinaryOp, Lhs, Rhs >::coeff ( int  index  )  const [inline]

Reimplemented from MatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.

Definition at line 122 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE const Scalar CwiseBinaryOp< BinaryOp, Lhs, Rhs >::coeff ( int  row,
int  col 
) const [inline]

Reimplemented from MatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.

Definition at line 111 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE int CwiseBinaryOp< BinaryOp, Lhs, Rhs >::cols (  )  const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from MatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.

Definition at line 109 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar CwiseBinaryOp< BinaryOp, Lhs, Rhs >::packet ( int  index  )  const [inline]

Reimplemented from MatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.

Definition at line 128 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar CwiseBinaryOp< BinaryOp, Lhs, Rhs >::packet ( int  row,
int  col 
) const [inline]

Reimplemented from MatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.

Definition at line 117 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
EIGEN_STRONG_INLINE int CwiseBinaryOp< BinaryOp, Lhs, Rhs >::rows (  )  const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from MatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >.

Definition at line 108 of file CwiseBinaryOp.h.


Member Data Documentation

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

Definition at line 136 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
const LhsNested CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_lhs [protected]

Definition at line 134 of file CwiseBinaryOp.h.

template<typename BinaryOp, typename Lhs, typename Rhs>
const RhsNested CwiseBinaryOp< BinaryOp, Lhs, Rhs >::m_rhs [protected]

Definition at line 135 of file CwiseBinaryOp.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


vcglib
Author(s): Christian Bersch
autogenerated on Fri Jan 11 09:21:59 2013