WPILibC++ 2023.4.3
Eigen::CwiseUnaryView< ViewOp, MatrixType > Class Template Reference

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/CwiseUnaryView.h>

Inheritance diagram for Eigen::CwiseUnaryView< ViewOp, MatrixType >:
Eigen::CwiseUnaryViewImpl< ViewOp, MatrixType, internal::traits< MatrixType >::StorageKind >

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 Types inherited from Eigen::CwiseUnaryViewImpl< ViewOp, MatrixType, internal::traits< MatrixType >::StorageKind >
typedef internal::generic_xpr_base< CwiseUnaryView< ViewOp, MatrixType > >::type Base
 

Public Member Functions

EIGEN_DEVICE_FUNC CwiseUnaryView (MatrixType &mat, const ViewOp &func=ViewOp())
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC const ViewOp & functor () const
 
EIGEN_DEVICE_FUNC const internal::remove_all< MatrixTypeNested >::typenestedExpression () const
 
EIGEN_DEVICE_FUNC internal::remove_reference< MatrixTypeNested >::typenestedExpression ()
 

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
ViewOptemplate functor implementing the view
MatrixTypethe 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_DEVICE_FUNC Eigen::CwiseUnaryView< ViewOp, MatrixType >::CwiseUnaryView ( MatrixType &  mat,
const ViewOp &  func = ViewOp() 
)
inlineexplicit

Member Function Documentation

◆ cols()

template<typename ViewOp , typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::CwiseUnaryView< ViewOp, MatrixType >::cols ( void  ) const
inline

◆ functor()

template<typename ViewOp , typename MatrixType >
EIGEN_DEVICE_FUNC const ViewOp & Eigen::CwiseUnaryView< ViewOp, MatrixType >::functor ( ) const
inline
Returns
the functor representing unary operation

◆ nestedExpression() [1/2]

template<typename ViewOp , typename MatrixType >
EIGEN_DEVICE_FUNC internal::remove_reference< MatrixTypeNested >::type & Eigen::CwiseUnaryView< ViewOp, MatrixType >::nestedExpression ( )
inline
Returns
the nested expression

◆ nestedExpression() [2/2]

template<typename ViewOp , typename MatrixType >
EIGEN_DEVICE_FUNC const internal::remove_all< MatrixTypeNested >::type & Eigen::CwiseUnaryView< ViewOp, MatrixType >::nestedExpression ( ) const
inline
Returns
the nested expression

◆ rows()

template<typename ViewOp , typename MatrixType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::CwiseUnaryView< ViewOp, MatrixType >::rows ( void  ) const
inline

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 files: