Pseudo expression providing partial reduction operations. More...

#include <VectorwiseOp.h>

Classes
struct	ExtendedType

struct	LpNormReturnType

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 Eigen::Index	Index

typedef internal::ref_selector< ExpressionType >::non_const_type	ExpressionTypeNested

typedef internal::remove_all< ExpressionTypeNested >::type	ExpressionTypeNestedCleaned

typedef ReturnType< internal::member_minCoeff >::Type	MinCoeffReturnType

typedef ReturnType< internal::member_maxCoeff >::Type	MaxCoeffReturnType

typedef ReturnType< internal::member_squaredNorm, RealScalar >::Type	SquaredNormReturnType

typedef ReturnType< internal::member_norm, RealScalar >::Type	NormReturnType

typedef ReturnType< internal::member_blueNorm, RealScalar >::Type	BlueNormReturnType

typedef ReturnType< internal::member_stableNorm, RealScalar >::Type	StableNormReturnType

typedef ReturnType< internal::member_hypotNorm, RealScalar >::Type	HypotNormReturnType

typedef ReturnType< internal::member_sum >::Type	SumReturnType

typedef ReturnType< internal::member_mean >::Type	MeanReturnType

typedef ReturnType< internal::member_all >::Type	AllReturnType

typedef ReturnType< internal::member_any >::Type	AnyReturnType

typedef PartialReduxExpr< ExpressionType, internal::member_count< Index >, Direction >	CountReturnType

typedef ReturnType< internal::member_prod >::Type	ProdReturnType

typedef Reverse< const ExpressionType, Direction >	ConstReverseReturnType

typedef Reverse< ExpressionType, Direction >	ReverseReturnType

typedef Replicate< ExpressionType,(isVertical?Dynamic:1),(isHorizontal?Dynamic:1)>	ReplicateReturnType

typedef Homogeneous< ExpressionType, Direction >	HomogeneousReturnType

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
EIGEN_DEVICE_FUNC	VectorwiseOp (ExpressionType &matrix)

EIGEN_DEVICE_FUNC const ExpressionType &	_expression () const

template<typename BinaryOp >
EIGEN_DEVICE_FUNC const ReduxReturnType< BinaryOp >::Type	redux (const BinaryOp &func=BinaryOp()) const

EIGEN_DEVICE_FUNC const MinCoeffReturnType	minCoeff () const

EIGEN_DEVICE_FUNC const MaxCoeffReturnType	maxCoeff () const

EIGEN_DEVICE_FUNC const SquaredNormReturnType	squaredNorm () const

EIGEN_DEVICE_FUNC const NormReturnType	norm () const

template<int p>
EIGEN_DEVICE_FUNC const LpNormReturnType< p >::Type	lpNorm () const

EIGEN_DEVICE_FUNC const BlueNormReturnType	blueNorm () const

EIGEN_DEVICE_FUNC const StableNormReturnType	stableNorm () const

EIGEN_DEVICE_FUNC const HypotNormReturnType	hypotNorm () const

EIGEN_DEVICE_FUNC const SumReturnType	sum () const

EIGEN_DEVICE_FUNC const MeanReturnType	mean () const

EIGEN_DEVICE_FUNC const AllReturnType	all () const

EIGEN_DEVICE_FUNC const AnyReturnType	any () const

EIGEN_DEVICE_FUNC const CountReturnType	count () const

EIGEN_DEVICE_FUNC const ProdReturnType	prod () const

EIGEN_DEVICE_FUNC const ConstReverseReturnType	reverse () const

EIGEN_DEVICE_FUNC ReverseReturnType	reverse ()

EIGEN_DEVICE_FUNC const ReplicateReturnType	replicate (Index factor) const

template<int Factor>
const Replicate< ExpressionType, isVertical Factor+isHorizontal, isHorizontal Factor+isVertical > EIGEN_DEVICE_FUNC	replicate (Index factor=Factor) const

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

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

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

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

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

template<typename OtherDerived >
EIGEN_STRONG_INLINE EIGEN_DEVICE_FUNC CwiseBinaryOp< internal::scalar_sum_op< Scalar, typename OtherDerived::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 >
EIGEN_DEVICE_FUNC CwiseBinaryOp< internal::scalar_difference_op< Scalar, typename OtherDerived::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 EIGEN_DEVICE_FUNC CwiseBinaryOp< internal::scalar_product_op< Scalar >, const ExpressionTypeNestedCleaned, const typename ExtendedType< OtherDerived >::Type > EIGEN_DEVICE_FUNC	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 >
EIGEN_DEVICE_FUNC 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*.

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

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

EIGEN_DEVICE_FUNC void	reverseInPlace ()
	This is the "in place" version of VectorwiseOp::reverse: it reverses each column or row of `*this`. More...

EIGEN_DEVICE_FUNC HomogeneousReturnType	homogeneous () const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CrossReturnType	cross (const MatrixBase< OtherDerived > &other) const

EIGEN_DEVICE_FUNC const HNormalizedReturnType	hnormalized () const

Protected Types
typedef internal::conditional< isVertical, typename ExpressionType::ColXpr, typename ExpressionType::RowXpr >::type	SubVector

Protected Member Functions
EIGEN_DEVICE_FUNC SubVector	subVector (Index i)

EIGEN_DEVICE_FUNC Index	subVectors () const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC ExtendedType< OtherDerived >::Type	extendedTo (const DenseBase< OtherDerived > &other) const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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.

Template 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

§ Index

template<typename ExpressionType, int Direction>

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

Deprecated:: since Eigen 3.3

Member Function Documentation

§ all()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const AllReturnType Eigen::VectorwiseOp< ExpressionType, Direction >::all ( ) const

inline

Returns: a row (or column) vector expression representing whether all coefficients of each respective column (or row) are true. This expression can be assigned to a vector with entries of type bool.

See also: DenseBase::all()

§ any()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const AnyReturnType Eigen::VectorwiseOp< 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. This expression can be assigned to a vector with entries of type bool.

See also: DenseBase::any()

§ blueNorm()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const BlueNormReturnType 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. This is a vector with real entries, even if the original matrix has complex entries.

See also: DenseBase::blueNorm()

§ count()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const CountReturnType 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). This expression can be assigned to a vector whose entries have the same type as is used to index entries of the original matrix; for dense matrices, this is std::ptrdiff_t .

Example:

Output:

See also: DenseBase::count()

§ hypotNorm()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const HypotNormReturnType 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. This is a vector with real entries, even if the original matrix has complex entries.

See also: DenseBase::hypotNorm()

§ lpNorm()

template<typename ExpressionType, int Direction>

template<int p>

EIGEN_DEVICE_FUNC const LpNormReturnType<p>::Type Eigen::VectorwiseOp< ExpressionType, Direction >::lpNorm ( ) const

inline

Returns: a row (or column) vector expression of the norm of each column (or row) of the referenced expression. This is a vector with real entries, even if the original matrix has complex entries.

Example:

Output:

See also: DenseBase::norm()

§ maxCoeff()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const MaxCoeffReturnType 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>

EIGEN_DEVICE_FUNC const MeanReturnType 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>

EIGEN_DEVICE_FUNC const MinCoeffReturnType 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>

EIGEN_DEVICE_FUNC const NormReturnType 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. This is a vector with real entries, even if the original matrix has complex entries.

Example:

Output:

See also: DenseBase::norm()

§ normalize()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC 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>

EIGEN_DEVICE_FUNC 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 (or row) of the referenced matrix are normalized. The referenced matrix is not modified.

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

§ prod()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const ProdReturnType 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 >

EIGEN_DEVICE_FUNC 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+isHorizontal,isHorizontal*Factor+isVertical> EIGEN_DEVICE_FUNC 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() [1/2]

template<typename ExpressionType, int Direction>

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

inline

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

Example:

Output:

See also: DenseBase::reverse()

§ reverse() [2/2]

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC ReverseReturnType Eigen::VectorwiseOp< ExpressionType, Direction >::reverse ( )

inline

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

See also: reverse() const

§ reverseInPlace()

template<typename ExpressionType , int Direction>

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

inline

This is the "in place" version of VectorwiseOp::reverse: it reverses each column or row of *this.

In most cases it is probably better to simply use the reversed expression of a matrix. However, when reversing the matrix data itself is really needed, then this "in-place" version is probably the right choice because it provides the following additional benefits:

less error prone: doing the same operation with .reverse() requires special care:
m = m.reverse().eval();
this API enables reverse operations without the need for a temporary

See also: DenseBase::reverseInPlace(), reverse()

§ squaredNorm()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const SquaredNormReturnType 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. This is a vector with real entries, even if the original matrix has complex entries.

Example:

Output:

See also: DenseBase::squaredNorm()

§ stableNorm()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const StableNormReturnType 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. This is a vector with real entries, even if the original matrix has complex entries.

See also: DenseBase::stableNorm()

§ sum()

template<typename ExpressionType, int Direction>

EIGEN_DEVICE_FUNC const SumReturnType 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:

third-party-libs/eigen3/Eigen/src/Core/util/ForwardDeclarations.h
third-party-libs/eigen3/Eigen/src/Core/VectorwiseOp.h
third-party-libs/eigen3/Eigen/src/Core/Replicate.h
third-party-libs/eigen3/Eigen/src/Core/Reverse.h
third-party-libs/eigen3/Eigen/src/Geometry/Homogeneous.h
third-party-libs/eigen3/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 Typedef Documentation

§ Index

Member Function Documentation

§ all()

§ any()

§ blueNorm()

§ count()

§ hypotNorm()

§ lpNorm()

§ maxCoeff()

§ mean()

§ minCoeff()

§ norm()

§ normalize()

§ normalized()

§ prod()

§ redux()

§ replicate() [1/2]

§ replicate() [2/2]

§ reverse() [1/2]

§ reverse() [2/2]

§ reverseInPlace()

§ squaredNorm()

§ stableNorm()

§ sum()

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