PartialReduxExpr Class Template Reference

Inherits ei_no_assignment_operator, and MatrixBase< Eigen::PartialReduxExpr< MatrixType, MemberOp, Direction > >.

List of all members.


Detailed Description

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

Generic expression of a partially reduxed matrix.

This is defined in the Array module.

 #include <Eigen/Array> 

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 PartialRedux functions, and most of the time this is the only way it is used.

See also:
class PartialRedux

Public Types

typedef ei_traits
< PartialReduxExpr >
::_MatrixTypeNested 
_MatrixTypeNested
typedef ei_traits
< PartialReduxExpr >
::MatrixTypeNested 
MatrixTypeNested

Public Member Functions

const Scalar coeff (int i, int j) const
int cols () const
 PartialReduxExpr (const MatrixType &mat, const MemberOp &func=MemberOp())
int rows () const

Protected Attributes

const MemberOp m_functor
const MatrixTypeNested m_matrix

Member Function Documentation

const Scalar coeff ( int  row,
int  col 
) const [inline]

Short version: don't use this function, use operator()(int,int) const instead.

Long version: this function is similar to operator()(int,int) const , but without the assertion. Use this for limiting the performance cost of debugging code when doing repeated coefficient access. Only use this when it is guaranteed that the parameters row and col are in range.

If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator()(int,int) const .

See also:
operator()(int,int) const, coeffRef(int,int), coeff(int) const

Reimplemented from MatrixBase.

int cols (  )  const [inline]

Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from MatrixBase.

int rows (  )  const [inline]

Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from MatrixBase.


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

Generated on Thu Apr 9 10:10:02 2009 for Eigen by  doxygen 1.5.5