Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction > Class Template Reference

Generic expression of a partially reduxed matrix. More...

Inherits internal::dense_xpr_base::type, and Eigen::internal::no_assignment_operator.

Public Types
typedef internal::dense_xpr_base< PartialReduxExpr >::type	Base

Public Member Functions
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
const MemberOp &	functor () const
MatrixType::Nested	nestedExpression () const
	PartialReduxExpr (const MatrixType &mat, const MemberOp &func=MemberOp())
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

Protected Attributes
const MemberOp	m_functor
MatrixType::Nested	m_matrix

Detailed Description

template<typename MatrixType, typename MemberOp, int Direction>
class Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >

Generic expression of a partially reduxed matrix.

Template Parameters

MatrixType	the type of the matrix we are applying the redux operation
MemberOp	type of the member functor
Direction	indicates the direction of the redux (Vertical or Horizontal)

This class represents an expression of a partial redux operator of a matrix. It is the return type of some VectorwiseOp functions, and most of the time this is the only way it is used.

See also

class VectorwiseOp

Definition at line 58 of file VectorwiseOp.h.

Member Typedef Documentation

Base

template<typename MatrixType , typename MemberOp , int Direction>

typedef internal::dense_xpr_base<PartialReduxExpr>::type Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::Base

Definition at line 63 of file VectorwiseOp.h.

Constructor & Destructor Documentation

PartialReduxExpr()

template<typename MatrixType , typename MemberOp , int Direction>

Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::PartialReduxExpr ( const MatrixType &  mat, const MemberOp &  func = MemberOp()  )

inlineexplicit

Definition at line 67 of file VectorwiseOp.h.

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

Member Function Documentation

cols()

template<typename MatrixType , typename MemberOp , int Direction>

EIGEN_CONSTEXPR Index Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::cols ( void  ) const

inline

Definition at line 73 of file VectorwiseOp.h.

{ return (Direction==Horizontal ? 1 : m_matrix.cols()); }

functor()

template<typename MatrixType , typename MemberOp , int Direction>

const MemberOp& Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::functor ( ) const

inline

Definition at line 79 of file VectorwiseOp.h.

{ return m_functor; }

nestedExpression()

template<typename MatrixType , typename MemberOp , int Direction>

MatrixType::Nested Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::nestedExpression ( ) const

inline

Definition at line 76 of file VectorwiseOp.h.

{ return m_matrix; }

rows()

template<typename MatrixType , typename MemberOp , int Direction>

EIGEN_CONSTEXPR Index Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::rows ( void  ) const

inline

Definition at line 71 of file VectorwiseOp.h.

{ return (Direction==Vertical   ? 1 : m_matrix.rows()); }

Member Data Documentation

m_functor

template<typename MatrixType , typename MemberOp , int Direction>

const MemberOp Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::m_functor

protected

Definition at line 83 of file VectorwiseOp.h.

m_matrix

template<typename MatrixType , typename MemberOp , int Direction>

MatrixType::Nested Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::m_matrix

protected

Definition at line 82 of file VectorwiseOp.h.

---

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

• ForwardDeclarations.h
• VectorwiseOp.h