Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes

VectorwiseOp< ExpressionType, Direction > Class Template Reference

Pseudo expression providing partial reduction operations. More...

#include <VectorwiseOp.h>

List of all members.

Classes

struct  ExtendedType
struct  ReduxReturnType
struct  ReturnType

Public Types

enum  { IsVertical = (Direction==Vertical) ? 1 : 0, IsHorizontal = (Direction==Horizontal) ? 1 : 0 }
enum  { HNormalized_Size, HNormalized_SizeMinusOne = HNormalized_Size==Dynamic ? Dynamic : HNormalized_Size-1 }
typedef ExpressionType::Scalar Scalar
typedef ExpressionType::RealScalar RealScalar
typedef ExpressionType::Index Index
typedef internal::conditional
< internal::must_nest_by_value
< ExpressionType >::ret,
ExpressionType, ExpressionType & >
::type 		ExpressionTypeNested
typedef internal::remove_all
< ExpressionTypeNested >::type 		ExpressionTypeNestedCleaned
typedef Replicate
< ExpressionType, Direction==Vertical?Dynamic:1,
Direction==Horizontal?Dynamic:1 > 		ReplicateReturnType
typedef ExpressionType::PlainObject CrossReturnType
typedef Block< const
ExpressionType, Direction==Vertical?int(HNormalized_SizeMinusOne):int(internal::traits
< ExpressionType >
::RowsAtCompileTime),
Direction==Horizontal?int(HNormalized_SizeMinusOne):int(internal::traits
< ExpressionType >
::ColsAtCompileTime)> 		HNormalized_Block
typedef Block< const
ExpressionType, Direction==Vertical?1:int(internal::traits
< ExpressionType >
::RowsAtCompileTime),
Direction==Horizontal?1:int(internal::traits
< ExpressionType >
::ColsAtCompileTime)> 		HNormalized_Factors
typedef CwiseBinaryOp
< internal::scalar_quotient_op
< typename internal::traits
< ExpressionType >::Scalar >
, const HNormalized_Block,
const Replicate
< HNormalized_Factors,
Direction==Vertical?HNormalized_SizeMinusOne:1,
Direction==Horizontal?HNormalized_SizeMinusOne:1 > > 		HNormalizedReturnType

Public Member Functions

 VectorwiseOp (ExpressionType &matrix)
const ExpressionType & _expression () const
template<typename BinaryOp >
const ReduxReturnType
< BinaryOp >::Type 		redux (const BinaryOp &func=BinaryOp()) const
const ReturnType
< internal::member_minCoeff >
::Type 		minCoeff () const
const ReturnType
< internal::member_maxCoeff >
::Type 		maxCoeff () const
const ReturnType
< internal::member_squaredNorm,
RealScalar >::Type 		squaredNorm () const
const ReturnType
< internal::member_norm,
RealScalar >::Type 		norm () const
const ReturnType
< internal::member_blueNorm,
RealScalar >::Type 		blueNorm () const
const ReturnType
< internal::member_stableNorm,
RealScalar >::Type 		stableNorm () const
const ReturnType
< internal::member_hypotNorm,
RealScalar >::Type 		hypotNorm () const
const ReturnType
< internal::member_sum >::Type 		sum () const
const ReturnType
< internal::member_mean >
::Type 		mean () const
const ReturnType
< internal::member_all >::Type 		all () const
const ReturnType
< internal::member_any >::Type 		any () const
const PartialReduxExpr
< ExpressionType,
internal::member_count< Index >
, Direction > 		count () const
const ReturnType
< internal::member_prod >
::Type 		prod () const
const Reverse< ExpressionType,
Direction > 		reverse () const
const ReplicateReturnType replicate (Index factor) const
template<int Factor>
const Replicate
< ExpressionType,(IsVertical?Factor:1),(IsHorizontal?Factor:1)> 		replicate (Index factor=Factor) const
template<typename OtherDerived >
ExpressionType & operator= (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
ExpressionType & operator+= (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
ExpressionType & operator-= (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE
CwiseBinaryOp
< internal::scalar_sum_op
< Scalar >, const
ExpressionTypeNestedCleaned,
const typename ExtendedType
< OtherDerived >::Type > 		operator+ (const DenseBase< OtherDerived > &other) const
template<typename OtherDerived >
CwiseBinaryOp
< internal::scalar_difference_op
< Scalar >, const
ExpressionTypeNestedCleaned,
const typename ExtendedType
< OtherDerived >::Type > 		operator- (const DenseBase< OtherDerived > &other) const
template<typename OtherDerived >
const CrossReturnType cross (const MatrixBase< OtherDerived > &other) const
const HNormalizedReturnType hnormalized () const

Protected Types

typedef internal::conditional
< Direction==Vertical,
typename
ExpressionType::ColXpr,
typename
ExpressionType::RowXpr >::type 		SubVector

Protected Member Functions

SubVector subVector (Index i)
Index subVectors () const
template<typename OtherDerived >
ExtendedType< OtherDerived >::Type extendedTo (const DenseBase< OtherDerived > &other) const

Protected Attributes

ExpressionTypeNested m_matrix

Detailed Description

template<typename ExpressionType, int Direction>
class VectorwiseOp< 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 DenseBase::colwise() and DenseBase::rowwise() and most of the time this is the only way it is used.

Example: 

 Output: 


See also:
DenseBase::colwise(), DenseBase::rowwise(), class PartialReduxExpr 


Member Typedef Documentation








template<typename ExpressionType, int Direction> 

      

        

          typedef ExpressionType::PlainObject VectorwiseOp< ExpressionType, Direction >::CrossReturnType
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef internal::conditional<internal::must_nest_by_value<ExpressionType>::ret, ExpressionType, ExpressionType&>::type VectorwiseOp< ExpressionType, Direction >::ExpressionTypeNested
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef internal::remove_all<ExpressionTypeNested>::type VectorwiseOp< ExpressionType, Direction >::ExpressionTypeNestedCleaned
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef Block<const ExpressionType, Direction==Vertical ? int(HNormalized_SizeMinusOne) : int(internal::traits<ExpressionType>::RowsAtCompileTime), Direction==Horizontal ? int(HNormalized_SizeMinusOne) : int(internal::traits<ExpressionType>::ColsAtCompileTime)> VectorwiseOp< ExpressionType, Direction >::HNormalized_Block
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef Block<const ExpressionType, Direction==Vertical ? 1 : int(internal::traits<ExpressionType>::RowsAtCompileTime), Direction==Horizontal ? 1 : int(internal::traits<ExpressionType>::ColsAtCompileTime)> VectorwiseOp< ExpressionType, Direction >::HNormalized_Factors
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef CwiseBinaryOp<internal::scalar_quotient_op<typename internal::traits<ExpressionType>::Scalar>, const HNormalized_Block, const Replicate<HNormalized_Factors, Direction==Vertical ? HNormalized_SizeMinusOne : 1, Direction==Horizontal ? HNormalized_SizeMinusOne : 1> > VectorwiseOp< ExpressionType, Direction >::HNormalizedReturnType
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef ExpressionType::Index VectorwiseOp< ExpressionType, Direction >::Index
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef ExpressionType::RealScalar VectorwiseOp< ExpressionType, Direction >::RealScalar
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef Replicate<ExpressionType,Direction==Vertical?Dynamic:1,Direction==Horizontal?Dynamic:1> VectorwiseOp< ExpressionType, Direction >::ReplicateReturnType
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef ExpressionType::Scalar VectorwiseOp< ExpressionType, Direction >::Scalar
        

      

















template<typename ExpressionType, int Direction> 

      

        

          typedef internal::conditional<Direction==Vertical, typename ExpressionType::ColXpr, typename ExpressionType::RowXpr>::type VectorwiseOp< ExpressionType, Direction >::SubVector [protected]
        

      











Member Enumeration Documentation








template<typename ExpressionType, int Direction> 

      

        

          anonymous enum
        

      






Enumerator: 


IsVertical 



IsHorizontal 




















template<typename ExpressionType, int Direction> 

      

        

          anonymous enum
        

      






Enumerator: 


HNormalized_Size 



HNormalized_SizeMinusOne 














Constructor & Destructor Documentation








template<typename ExpressionType, int Direction> 

      

        

          VectorwiseOp< ExpressionType, Direction >::VectorwiseOp 
          (
          ExpressionType & 
           matrix
           ) 
           [inline]
        

      











Member Function Documentation








template<typename ExpressionType, int Direction> 

      

        

          const ExpressionType& VectorwiseOp< ExpressionType, Direction >::_expression 
          (
          
           ) 
           const [inline]
        

      

















template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_all>::Type VectorwiseOp< ExpressionType, Direction >::all 
          (
          void 
          
           ) 
           const [inline]
        

      






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


See also:
DenseBase::all() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_any>::Type VectorwiseOp< ExpressionType, Direction >::any 
          (
          void 
          
           ) 
           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:
DenseBase::any() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_blueNorm,RealScalar>::Type VectorwiseOp< ExpressionType, Direction >::blueNorm 
          (
          
           ) 
           const [inline]
        

      






Returns:
a row (or column) vector expression of the norm of each column (or row) of the referenced expression, using blue's algorithm.


See also:
DenseBase::blueNorm() 













template<typename ExpressionType, int Direction> 

      

        

          const PartialReduxExpr<ExpressionType, internal::member_count<Index>, Direction> VectorwiseOp< 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:
DenseBase::count() 













template<typename ExpressionType , int Direction> 



template<typename OtherDerived > 

      

        

          const VectorwiseOp< ExpressionType, Direction >::CrossReturnType VectorwiseOp< ExpressionType, Direction >::cross 
          (
          const MatrixBase< OtherDerived > & 
           other
           ) 
           const
        

      






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


The referenced matrix must have one dimension equal to 3. The result matrix has the same dimensions than the referenced one.


See also:
MatrixBase::cross() 













template<typename ExpressionType, int Direction> 



template<typename OtherDerived > 

      

        

          ExtendedType<OtherDerived>::Type VectorwiseOp< ExpressionType, Direction >::extendedTo 
          (
          const DenseBase< OtherDerived > & 
           other
           ) 
           const [inline, protected]
        

      

















template<typename ExpressionType , int Direction> 

      

        

          const VectorwiseOp< ExpressionType, Direction >::HNormalizedReturnType VectorwiseOp< ExpressionType, Direction >::hnormalized 
          (
          
           ) 
           const [inline]
        

      






Returns:
an expression of the homogeneous normalized vector of *this 


Example: 


 Output: 


See also:
MatrixBase::hnormalized() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_hypotNorm,RealScalar>::Type VectorwiseOp< ExpressionType, Direction >::hypotNorm 
          (
          
           ) 
           const [inline]
        

      






Returns:
a row (or column) vector expression of the norm of each column (or row) of the referenced expression, avoiding underflow and overflow using a concatenation of hypot() calls.


See also:
DenseBase::hypotNorm() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_maxCoeff>::Type VectorwiseOp< 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:
DenseBase::maxCoeff() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_mean>::Type VectorwiseOp< ExpressionType, Direction >::mean 
          (
          
           ) 
           const [inline]
        

      






Returns:
a row (or column) vector expression of the mean of each column (or row) of the referenced expression.


See also:
DenseBase::mean() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_minCoeff>::Type VectorwiseOp< 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:
DenseBase::minCoeff() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_norm,RealScalar>::Type VectorwiseOp< 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:
DenseBase::norm() 













template<typename ExpressionType, int Direction> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const ExpressionTypeNestedCleaned, const typename ExtendedType<OtherDerived>::Type> VectorwiseOp< ExpressionType, Direction >::operator+ 
          (
          const DenseBase< OtherDerived > & 
           other
           ) 
           const [inline]
        

      






Returns the expression of the sum of the vector other to each subvector of *this 













template<typename ExpressionType, int Direction> 



template<typename OtherDerived > 

      

        

          ExpressionType& VectorwiseOp< ExpressionType, Direction >::operator+= 
          (
          const DenseBase< OtherDerived > & 
           other
           ) 
           [inline]
        

      






Adds the vector other to each subvector of *this 













template<typename ExpressionType, int Direction> 



template<typename OtherDerived > 

      

        

          CwiseBinaryOp<internal::scalar_difference_op<Scalar>, const ExpressionTypeNestedCleaned, const typename ExtendedType<OtherDerived>::Type> VectorwiseOp< ExpressionType, Direction >::operator- 
          (
          const DenseBase< OtherDerived > & 
           other
           ) 
           const [inline]
        

      






Returns the expression of the difference between each subvector of *this and the vector other 













template<typename ExpressionType, int Direction> 



template<typename OtherDerived > 

      

        

          ExpressionType& VectorwiseOp< ExpressionType, Direction >::operator-= 
          (
          const DenseBase< OtherDerived > & 
           other
           ) 
           [inline]
        

      






Substracts the vector other to each subvector of *this 













template<typename ExpressionType, int Direction> 



template<typename OtherDerived > 

      

        

          ExpressionType& VectorwiseOp< ExpressionType, Direction >::operator= 
          (
          const DenseBase< OtherDerived > & 
           other
           ) 
           [inline]
        

      






Copies the vector other to each subvector of *this 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_prod>::Type VectorwiseOp< ExpressionType, Direction >::prod 
          (
          
           ) 
           const [inline]
        

      






Returns:
a row (or column) vector expression of the product of each column (or row) of the referenced expression.


Example: 


 Output: 


See also:
DenseBase::prod() 













template<typename ExpressionType, int Direction> 



template<typename BinaryOp > 

      

        

          const ReduxReturnType<BinaryOp>::Type VectorwiseOp< 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 VectorwiseOp, DenseBase::colwise(), DenseBase::rowwise() 













template<typename ExpressionType, int Direction> 



template<int Factor> 

      

        

          const Replicate<ExpressionType,(IsVertical?Factor:1),(IsHorizontal?Factor:1)> VectorwiseOp< ExpressionType, Direction >::replicate 
          (
          Index 
           factor = Factor
           ) 
           const [inline]
        

      






Returns:
an expression of the replication of each column (or row) of *this 


Example: 


 Output: 


See also:
VectorwiseOp::replicate(Index), DenseBase::replicate(), class Replicate 













template<typename ExpressionType , int Direction> 

      

        

          const VectorwiseOp< ExpressionType, Direction >::ReplicateReturnType VectorwiseOp< ExpressionType, Direction >::replicate 
          (
          Index 
           factor
           ) 
           const
        

      






Returns:
an expression of the replication of each column (or row) of *this 


Example: 


 Output: 


See also:
VectorwiseOp::replicate(), DenseBase::replicate(), class Replicate 













template<typename ExpressionType, int Direction> 

      

        

          const Reverse<ExpressionType, Direction> VectorwiseOp< ExpressionType, Direction >::reverse 
          (
          
           ) 
           const [inline]
        

      






Returns:
a matrix expression where each column (or row) are reversed.


Example: 


 Output: 


See also:
DenseBase::reverse() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_squaredNorm,RealScalar>::Type VectorwiseOp< 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:
DenseBase::squaredNorm() 













template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_stableNorm,RealScalar>::Type VectorwiseOp< ExpressionType, Direction >::stableNorm 
          (
          
           ) 
           const [inline]
        

      






Returns:
a row (or column) vector expression of the norm of each column (or row) of the referenced expression, avoiding underflow and overflow.


See also:
DenseBase::stableNorm() 













template<typename ExpressionType, int Direction> 

      

        

          SubVector VectorwiseOp< ExpressionType, Direction >::subVector 
          (
          Index 
           i
           ) 
           [inline, protected]
        

      

















template<typename ExpressionType, int Direction> 

      

        

          Index VectorwiseOp< ExpressionType, Direction >::subVectors 
          (
          
           ) 
           const [inline, protected]
        

      

















template<typename ExpressionType, int Direction> 

      

        

          const ReturnType<internal::member_sum>::Type VectorwiseOp< 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:
DenseBase::sum() 







Member Data Documentation








template<typename ExpressionType, int Direction> 

      

        

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

      











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



Generated on Thu Dec 1 2011 12:54:53 for HUMIM Tracker by 

doxygen 1.7.1