WPILibC++ 2023.4.3-108-ge5452e3
Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction > Class Template Reference

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

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

Inheritance diagram for Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >:
Eigen::internal::no_assignment_operator

Public Types

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

Public Member Functions

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

Protected Attributes

MatrixType::Nested m_matrix
 
const MemberOp m_functor
 

Detailed Description

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

Generic expression of a partially reduxed matrix.

Template Parameters
MatrixTypethe type of the matrix we are applying the redux operation
MemberOptype of the member functor
Directionindicates 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

Member Typedef Documentation

◆ Base

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

Constructor & Destructor Documentation

◆ PartialReduxExpr()

template<typename MatrixType , typename MemberOp , int Direction>
EIGEN_DEVICE_FUNC Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::PartialReduxExpr ( const MatrixType &  mat,
const MemberOp &  func = MemberOp() 
)
inlineexplicit

Member Function Documentation

◆ cols()

template<typename MatrixType , typename MemberOp , int Direction>
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::cols ( void  ) const
inline

◆ functor()

template<typename MatrixType , typename MemberOp , int Direction>
EIGEN_DEVICE_FUNC const MemberOp & Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::functor ( ) const
inline

◆ nestedExpression()

template<typename MatrixType , typename MemberOp , int Direction>
EIGEN_DEVICE_FUNC MatrixType::Nested Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::nestedExpression ( ) const
inline

◆ rows()

template<typename MatrixType , typename MemberOp , int Direction>
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::rows ( void  ) const
inline

Member Data Documentation

◆ m_functor

template<typename MatrixType , typename MemberOp , int Direction>
const MemberOp Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::m_functor
protected

◆ m_matrix

template<typename MatrixType , typename MemberOp , int Direction>
MatrixType::Nested Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction >::m_matrix
protected

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