Eigen::CwiseUnaryOp< UnaryOp, XprType > Class Template Reference

Generic expression where a coefficient-wise unary operator is applied to an expression. More...

#include <CwiseUnaryOp.h>

Inheritance diagram for Eigen::CwiseUnaryOp< UnaryOp, XprType >:

Public Types
typedef CwiseUnaryOpImpl< UnaryOp, XprType, typenameinternal::traits< XprType >::StorageKind >::Base	Base
typedef internal::remove_all< XprType >::type	NestedExpression
Public Types inherited from Eigen::CwiseUnaryOpImpl< UnaryOp, XprType, internal::traits< XprType >::StorageKind >
typedef internal::generic_xpr_base< CwiseUnaryOp< UnaryOp, XprType > >::type	Base

Public Member Functions
EIGEN_DEVICE_FUNC	CwiseUnaryOp (const XprType &xpr, const UnaryOp &func=UnaryOp())
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rows () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	cols () const
EIGEN_DEVICE_FUNC const UnaryOp &	functor () const
EIGEN_DEVICE_FUNC const internal::remove_all< typenameXprType::Nested >::type &	nestedExpression () const
EIGEN_DEVICE_FUNC internal::remove_all< typenameXprType::Nested >::type &	nestedExpression ()

Protected Attributes
XprType::Nested	m_xpr
const UnaryOp	m_functor

Detailed Description

template<typename UnaryOp, typename XprType>
class Eigen::CwiseUnaryOp< UnaryOp, XprType >

Generic expression where a coefficient-wise unary operator is applied to an expression.

Parameters

UnaryOp	template functor implementing the operator
XprType	the type of the expression to which we are applying the unary operator

This class represents an expression where a unary operator is applied to an expression. It is the return type of all operations taking exactly 1 input expression, regardless of the presence of other inputs such as scalars. For example, the operator* in the expression 3*matrix is considered unary, because only the right-hand side is an expression, and its return type is a specialization of CwiseUnaryOp.

Most of the time, this is the only way that it is used, so you typically don't have to name CwiseUnaryOp types explicitly.

See also

MatrixBase::unaryExpr(const CustomUnaryOp &) const, class CwiseBinaryOp, class CwiseNullaryOp

Member Function Documentation

functor()

template<typename UnaryOp , typename XprType >

EIGEN_DEVICE_FUNC const UnaryOp & Eigen::CwiseUnaryOp< UnaryOp, XprType >::functor ( ) const

inline

Returns

the functor representing the unary operation

nestedExpression() [1/2]

template<typename UnaryOp , typename XprType >

EIGEN_DEVICE_FUNC internal::remove_all< typenameXprType::Nested >::type & Eigen::CwiseUnaryOp< UnaryOp, XprType >::nestedExpression ( )

inline

Returns

the nested expression

nestedExpression() [2/2]

template<typename UnaryOp , typename XprType >

EIGEN_DEVICE_FUNC const internal::remove_all< typenameXprType::Nested >::type & Eigen::CwiseUnaryOp< UnaryOp, XprType >::nestedExpression ( ) const

inline

Returns

the nested expression

---

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

• External/Eigen/src/Core/CwiseUnaryOp.h