Pseudo expression providing partial reduction operations. More...

#include <VectorwiseOp.h>

Classes
struct	ExtendedType

struct	OppositeExtendedType

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)
	Copies the vector other to each subvector of `*this`.

template<typename OtherDerived >
ExpressionType &	operator+= (const DenseBase< OtherDerived > &other)
	Adds the vector other to each subvector of `*this`.

template<typename OtherDerived >
ExpressionType &	operator-= (const DenseBase< OtherDerived > &other)
	Substracts the vector other to each subvector of `*this`.

template<typename OtherDerived >
ExpressionType &	operator*= (const DenseBase< OtherDerived > &other)
	Multiples each subvector of `this` by the vector other*.

template<typename OtherDerived >
ExpressionType &	operator/= (const DenseBase< OtherDerived > &other)
	Divides each subvector of `this` by the vector 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
	Returns the expression of the sum of the vector other to each subvector of `*this`.

template<typename OtherDerived >
CwiseBinaryOp< internal::scalar_difference_op< Scalar >, const ExpressionTypeNestedCleaned, const typename ExtendedType< OtherDerived >::Type >	operator- (const DenseBase< OtherDerived > &other) const
	Returns the expression of the difference between each subvector of `this` and the vector other*.

template<typename OtherDerived >
EIGEN_STRONG_INLINE CwiseBinaryOp< internal::scalar_product_op< Scalar >, const ExpressionTypeNestedCleaned, const typename ExtendedType< OtherDerived >::Type >	operator* (const DenseBase< OtherDerived > &other) const
	Returns the expression where each subvector is the product of the vector other by the corresponding subvector of `*this`.

template<typename OtherDerived >
CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const ExpressionTypeNestedCleaned, const typename ExtendedType< OtherDerived >::Type >	operator/ (const DenseBase< OtherDerived > &other) const
	Returns the expression where each subvector is the quotient of the corresponding subvector of `this` by the vector other*.

CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const ExpressionTypeNestedCleaned, const typename OppositeExtendedType< typename ReturnType< internal::member_norm, RealScalar >::Type >::Type >	normalized () const

void	normalize ()
	Normalize in-place each row or columns of the referenced matrix. More...

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

template<typename OtherDerived >
OppositeExtendedType< OtherDerived >::Type	extendedToOpposite (const DenseBase< OtherDerived > &other) const

Protected Attributes
ExpressionTypeNested	m_matrix

Detailed Description

template<typename ExpressionType, int Direction>
class Eigen::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 Function Documentation

§ all()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_all>::Type Eigen::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()

§ any()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_any>::Type Eigen::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()

§ blueNorm()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_blueNorm,RealScalar>::Type Eigen::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()

§ count()

template<typename ExpressionType, int Direction>

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

§ cross()

template<typename ExpressionType , int Direction>

template<typename OtherDerived >

const VectorwiseOp< ExpressionType, Direction >::CrossReturnType Eigen::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()

§ hnormalized()

template<typename ExpressionType , int Direction>

const VectorwiseOp< ExpressionType, Direction >::HNormalizedReturnType Eigen::VectorwiseOp< ExpressionType, Direction >::hnormalized ( ) const

inline

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

Example:

Output:

See also: MatrixBase::hnormalized()

§ hypotNorm()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_hypotNorm,RealScalar>::Type Eigen::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()

§ maxCoeff()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_maxCoeff>::Type Eigen::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.

Warning: the result is undefined if *this contains NaN.

Example:

Output:

See also: DenseBase::maxCoeff()

§ mean()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_mean>::Type Eigen::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()

§ minCoeff()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_minCoeff>::Type Eigen::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.

Warning: the result is undefined if *this contains NaN.

Example:

Output:

See also: DenseBase::minCoeff()

§ norm()

template<typename ExpressionType, int Direction>

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

§ normalize()

template<typename ExpressionType, int Direction>

void Eigen::VectorwiseOp< ExpressionType, Direction >::normalize ( )

inline

Normalize in-place each row or columns of the referenced matrix.

See also: MatrixBase::normalize(), normalized()

§ normalized()

template<typename ExpressionType, int Direction>

CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const ExpressionTypeNestedCleaned, const typename OppositeExtendedType<typename ReturnType<internal::member_norm,RealScalar>::Type>::Type> Eigen::VectorwiseOp< ExpressionType, Direction >::normalized ( ) const

inline

Returns: an expression where each column of row of the referenced matrix are normalized. The referenced matrix is not modified.

See also: MatrixBase::normalized(), normalize()

§ prod()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_prod>::Type Eigen::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()

§ redux()

template<typename ExpressionType, int Direction>

template<typename BinaryOp >

const ReduxReturnType<BinaryOp>::Type Eigen::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()

§ replicate() [1/2]

template<typename ExpressionType , int Direction>

const VectorwiseOp< ExpressionType, Direction >::ReplicateReturnType Eigen::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

§ replicate() [2/2]

template<typename ExpressionType, int Direction>

template<int Factor>

const Replicate<ExpressionType,(IsVertical?Factor:1),(IsHorizontal?Factor:1)> Eigen::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

§ reverse()

template<typename ExpressionType, int Direction>

const Reverse<ExpressionType, Direction> Eigen::VectorwiseOp< ExpressionType, Direction >::reverse ( ) const

inline

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

Example:

Output:

See also: DenseBase::reverse()

§ squaredNorm()

template<typename ExpressionType, int Direction>

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

§ stableNorm()

template<typename ExpressionType, int Direction>

const ReturnType<internal::member_stableNorm,RealScalar>::Type Eigen::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()

§ sum()

template<typename ExpressionType, int Direction>

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

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

vendor/eigen/Eigen/src/Core/util/ForwardDeclarations.h
vendor/eigen/Eigen/src/Core/VectorwiseOp.h
vendor/eigen/Eigen/src/Core/Replicate.h
vendor/eigen/Eigen/src/Geometry/Homogeneous.h
vendor/eigen/Eigen/src/Geometry/OrthoMethods.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<typename ExpressionType, int Direction> class Eigen::VectorwiseOp< ExpressionType, Direction >

Member Function Documentation

§ all()

§ any()

§ blueNorm()

§ count()

§ cross()

§ hnormalized()

§ hypotNorm()

§ maxCoeff()

§ mean()

§ minCoeff()

§ norm()

§ normalize()

§ normalized()

§ prod()

§ redux()

§ replicate() [1/2]

§ replicate() [2/2]

§ reverse()

§ squaredNorm()

§ stableNorm()

§ sum()

template<typename ExpressionType, int Direction>
class Eigen::VectorwiseOp< ExpressionType, Direction >