Eigen::CwiseUnaryView< ViewOp, MatrixType > Class Template Reference

Generic lvalue expression of a coefficient-wise unary operator of a matrix or a vector. More...

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

Inheritance diagram for Eigen::CwiseUnaryView< ViewOp, MatrixType >:

Collaboration diagram for Eigen::CwiseUnaryView< ViewOp, MatrixType >:

Public Types
typedef CwiseUnaryViewImpl< ViewOp, MatrixType, typenameinternal::traits< MatrixType >::StorageKind >::Base	Base
typedef internal::ref_selector< MatrixType >::non_const_type	MatrixTypeNested
typedef internal::remove_all< MatrixType >::type	NestedExpression

Public Member Functions
	CwiseUnaryView (MatrixType &mat, const ViewOp &func=ViewOp())
EIGEN_STRONG_INLINE Index	rows () const
EIGEN_STRONG_INLINE Index	cols () const
const ViewOp &	functor () const
const internal::remove_all< MatrixTypeNested >::type &	nestedExpression () const
internal::remove_reference< MatrixTypeNested >::type &	nestedExpression ()

Protected Attributes
MatrixTypeNested	m_matrix
ViewOp	m_functor

Detailed Description

template<typename ViewOp, typename MatrixType>
class Eigen::CwiseUnaryView< ViewOp, MatrixType >

Generic lvalue expression of a coefficient-wise unary operator of a matrix or a vector.

Template Parameters

ViewOp	template functor implementing the view
MatrixType	the type of the matrix we are applying the unary operator

This class represents a lvalue expression of a generic unary view operator of a matrix or a vector. It is the return type of real() and imag(), and most of the time this is the only way it is used.

See also

MatrixBase::unaryViewExpr(const CustomUnaryOp &) const, class CwiseUnaryOp

Member Typedef Documentation

Base

template<typename ViewOp , typename MatrixType >

typedef CwiseUnaryViewImpl<ViewOp,MatrixType,typenameinternal::traits<MatrixType>::StorageKind>::Base Eigen::CwiseUnaryView< ViewOp, MatrixType >::Base

MatrixTypeNested

template<typename ViewOp , typename MatrixType >

typedef internal::ref_selector<MatrixType>::non_const_type Eigen::CwiseUnaryView< ViewOp, MatrixType >::MatrixTypeNested

NestedExpression

template<typename ViewOp , typename MatrixType >

typedef internal::remove_all<MatrixType>::type Eigen::CwiseUnaryView< ViewOp, MatrixType >::NestedExpression

Constructor & Destructor Documentation

CwiseUnaryView()

template<typename ViewOp , typename MatrixType >

Eigen::CwiseUnaryView< ViewOp, MatrixType >::CwiseUnaryView ( MatrixType &  mat, const ViewOp &  func = ViewOp()  )

inlineexplicit

      : m_matrix(mat), m_functor(func) {}

Member Function Documentation

cols()

template<typename ViewOp , typename MatrixType >

EIGEN_STRONG_INLINE Index Eigen::CwiseUnaryView< ViewOp, MatrixType >::cols ( ) const

inline

{ return m_matrix.cols(); }

functor()

template<typename ViewOp , typename MatrixType >

const ViewOp & Eigen::CwiseUnaryView< ViewOp, MatrixType >::functor ( ) const

inline

Returns

the functor representing unary operation

{ return m_functor; }

nestedExpression() [1/2]

template<typename ViewOp , typename MatrixType >

internal::remove_reference< MatrixTypeNested >::type & Eigen::CwiseUnaryView< ViewOp, MatrixType >::nestedExpression ( )

inline

Returns

the nested expression

{ return m_matrix.const_cast_derived(); }

nestedExpression() [2/2]

template<typename ViewOp , typename MatrixType >

const internal::remove_all< MatrixTypeNested >::type & Eigen::CwiseUnaryView< ViewOp, MatrixType >::nestedExpression ( ) const

inline

Returns

the nested expression

{ return m_matrix; }

rows()

template<typename ViewOp , typename MatrixType >

EIGEN_STRONG_INLINE Index Eigen::CwiseUnaryView< ViewOp, MatrixType >::rows ( ) const

inline

{ return m_matrix.rows(); }

Member Data Documentation

m_functor

template<typename ViewOp , typename MatrixType >

ViewOp Eigen::CwiseUnaryView< ViewOp, MatrixType >::m_functor

protected

m_matrix

template<typename ViewOp , typename MatrixType >

MatrixTypeNested Eigen::CwiseUnaryView< ViewOp, MatrixType >::m_matrix

protected

---

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

• src/eigen/Eigen/src/Core/CwiseUnaryView.h