PartialRedux< ExpressionType, Direction > Class Template Reference

Pseudo expression providing partial reduction operations. More...

#include <PartialRedux.h>

List of all members.

Classes
struct	ReduxReturnType
struct	ReturnType
Public Types
typedef ExpressionType::PlainMatrixType	CrossReturnType
typedef ei_meta_if < ei_must_nest_by_value < ExpressionType >::ret, ExpressionType, const ExpressionType & >::ret	ExpressionTypeNested
typedef NumTraits< Scalar >::Real	RealScalar
typedef ei_traits < ExpressionType >::Scalar	Scalar
Public Member Functions
const ExpressionType &	_expression () const
const ReturnType < ei_member_all >::Type	all () const
const ReturnType < ei_member_any >::Type	any () const
const PartialReduxExpr < ExpressionType, ei_member_count< int > , Direction >	count () const
template<typename OtherDerived >
const CrossReturnType	cross (const MatrixBase< OtherDerived > &other) const
const ReturnType < ei_member_maxCoeff >::Type	maxCoeff () const
const ReturnType < ei_member_minCoeff >::Type	minCoeff () const
const ReturnType < ei_member_norm, RealScalar > ::Type	norm () const
	PartialRedux (const ExpressionType &matrix)
template<typename BinaryOp >
const ReduxReturnType < BinaryOp >::Type	redux (const BinaryOp &func=BinaryOp()) const
const ReturnType < ei_member_squaredNorm, RealScalar >::Type	squaredNorm () const
const ReturnType < ei_member_sum >::Type	sum () const
Protected Attributes
ExpressionTypeNested	m_matrix
Private Member Functions
PartialRedux &	operator= (const PartialRedux &)

---

Detailed Description

template<typename ExpressionType, int Direction>
class PartialRedux< ExpressionType, Direction >

Pseudo expression providing partial reduction operations.

Parameters:

	ExpressionType	the type of the object on which to do partial reductions
	Direction	indicates the direction of the redux (Vertical or Horizontal)

This class represents a pseudo expression with partial reduction features. It is the return type of MatrixBase::colwise() and MatrixBase::rowwise() and most of the time this is the only way it is used.

Example:

Output:

See also:

MatrixBase::colwise(), MatrixBase::rowwise(), class PartialReduxExpr

Definition at line 158 of file PartialRedux.h.

---

Member Typedef Documentation

template<typename ExpressionType, int Direction>

typedef ExpressionType::PlainMatrixType PartialRedux< ExpressionType, Direction >::CrossReturnType

Definition at line 184 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

typedef ei_meta_if<ei_must_nest_by_value<ExpressionType>::ret, ExpressionType, const ExpressionType&>::ret PartialRedux< ExpressionType, Direction >::ExpressionTypeNested

Definition at line 165 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

typedef NumTraits<Scalar>::Real PartialRedux< ExpressionType, Direction >::RealScalar

Definition at line 163 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

typedef ei_traits<ExpressionType>::Scalar PartialRedux< ExpressionType, Direction >::Scalar

Definition at line 162 of file PartialRedux.h.

---

Constructor & Destructor Documentation

template<typename ExpressionType, int Direction>

PartialRedux< ExpressionType, Direction >::PartialRedux

(

const ExpressionType &

matrix

)

[inline]

Definition at line 186 of file PartialRedux.h.

---

Member Function Documentation

template<typename ExpressionType, int Direction>

const ExpressionType& PartialRedux< ExpressionType, Direction >::_expression

(

)

const [inline]

Definition at line 189 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_all>::Type PartialRedux< ExpressionType, Direction >::all

(

)

const [inline]

Returns:

a row (or column) vector expression representing whether all coefficients of each respective column (or row) are true.

See also:

MatrixBase::all()

Definition at line 249 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_any>::Type PartialRedux< ExpressionType, Direction >::any

(

)

const [inline]

Returns:

a row (or column) vector expression representing whether at least one coefficient of each respective column (or row) is true.

See also:

MatrixBase::any()

Definition at line 256 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const PartialReduxExpr<ExpressionType, ei_member_count<int>, Direction> PartialRedux< ExpressionType, Direction >::count

(

)

const [inline]

Returns:

a row (or column) vector expression representing the number of true coefficients of each respective column (or row).

Example:

Output:

See also:

MatrixBase::count()

Definition at line 266 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

template<typename OtherDerived >

const CrossReturnType PartialRedux< ExpressionType, Direction >::cross

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Returns:

a 3x3 matrix expression of the cross product of each column or row of the referenced expression with the other vector.

See also:

MatrixBase::cross()

Definition at line 276 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_maxCoeff>::Type PartialRedux< ExpressionType, Direction >::maxCoeff

(

)

const [inline]

Returns:

a row (or column) vector expression of the largest coefficient of each column (or row) of the referenced expression.

Example:

Output:

See also:

MatrixBase::maxCoeff()

Definition at line 212 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_minCoeff>::Type PartialRedux< ExpressionType, Direction >::minCoeff

(

)

const [inline]

Returns:

a row (or column) vector expression of the smallest coefficient of each column (or row) of the referenced expression.

Example:

Output:

See also:

MatrixBase::minCoeff()

Definition at line 202 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_norm,RealScalar>::Type PartialRedux< ExpressionType, Direction >::norm

(

)

const [inline]

Returns:

a row (or column) vector expression of the norm of each column (or row) of the referenced expression.

Example:

Output:

See also:

MatrixBase::norm()

Definition at line 232 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

PartialRedux& PartialRedux< ExpressionType, Direction >::operator=

(

const PartialRedux< ExpressionType, Direction > &

)

[private]

template<typename ExpressionType , int Direction>

template<typename BinaryOp >

const PartialRedux< ExpressionType, Direction >::template ReduxReturnType< BinaryOp >::Type PartialRedux< ExpressionType, Direction >::redux

(

const BinaryOp &

func = BinaryOp()

)

const [inline]

Returns:

a row or column vector expression of *this reduxed by func

The template parameter BinaryOp is the type of the functor of the custom redux operator. Note that func must be an associative operator.

See also:

class PartialRedux, MatrixBase::colwise(), MatrixBase::rowwise()

Definition at line 344 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_squaredNorm,RealScalar>::Type PartialRedux< ExpressionType, Direction >::squaredNorm

(

)

const [inline]

Returns:

a row (or column) vector expression of the squared norm of each column (or row) of the referenced expression.

Example:

Output:

See also:

MatrixBase::squaredNorm()

Definition at line 222 of file PartialRedux.h.

template<typename ExpressionType, int Direction>

const ReturnType<ei_member_sum>::Type PartialRedux< ExpressionType, Direction >::sum

(

)

const [inline]

Returns:

a row (or column) vector expression of the sum of each column (or row) of the referenced expression.

Example:

Output:

See also:

MatrixBase::sum()

Definition at line 242 of file PartialRedux.h.

---

Member Data Documentation

template<typename ExpressionType, int Direction>

ExpressionTypeNested PartialRedux< ExpressionType, Direction >::m_matrix [protected]

Definition at line 296 of file PartialRedux.h.

---

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

• PartialRedux.h