Yoji KURODA / Eigen

Eigne Matrix Class Library

Dependents:   Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more

Embed: (wiki syntax)

« Back to documentation index

Flagged< ExpressionType, Added, Removed > Class Template Reference
Public Types | Public Member Functions

Flagged< ExpressionType, Added, Removed > Class Template Reference
[Core module]

Expression with modified flags. More...

#include <Flagged.h>

Inherits MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Public Types

typedef Matrix< Scalar,
EIGEN_SIZE_MAX(RowsAtCompileTime,
ColsAtCompileTime),
EIGEN_SIZE_MAX(RowsAtCompileTime,
ColsAtCompileTime)> 		SquareMatrixType
 type of the equivalent square matrix
typedef Matrix< typename
internal::traits< Flagged
< ExpressionType, Added,
Removed > >::Scalar,
internal::traits< Flagged
< ExpressionType, Added,
Removed > >::RowsAtCompileTime,
internal::traits< Flagged
< ExpressionType, Added,
Removed > >::ColsAtCompileTime,
AutoAlign|(internal::traits
< Flagged< ExpressionType,
Added, Removed > >::Flags
&RowMajorBit?RowMajor:ColMajor),
internal::traits< Flagged
< ExpressionType, Added,
Removed >
>::MaxRowsAtCompileTime,
internal::traits< Flagged
< ExpressionType, Added,
Removed >
>::MaxColsAtCompileTime > 		PlainObject
 The plain matrix type corresponding to this expression.

Public Member Functions

Index diagonalSize () const
Flagged< ExpressionType, Added,
Removed > & 		lazyAssign (const Flagged< OtherDerived, 0, EvalBeforeAssigningBit > &other)
bool operator== (const MatrixBase< OtherDerived > &other) const
bool operator!= (const MatrixBase< OtherDerived > &other) const
ArrayWrapper< Flagged
< ExpressionType, Added,
Removed > > 		array ()

Detailed Description

template<typename ExpressionType, unsigned int Added, unsigned int Removed>
class Eigen::Flagged< ExpressionType, Added, Removed >

Expression with modified flags.

Parameters:
ExpressionTypethe type of the object of which we are modifying the flags
Addedthe flags added to the expression
Removedthe flags removed from the expression (has priority over Added).

This class represents an expression whose flags have been modified. It is the return type of MatrixBase::flagged() and most of the time this is the only way it is used.

See also:
MatrixBase::flagged()

Definition at line 39 of file Flagged.h.

Member Typedef Documentation

typedef Matrix<typename internal::traits<Flagged< ExpressionType, Added, Removed > >::Scalar, internal::traits<Flagged< ExpressionType, Added, Removed > >::RowsAtCompileTime, internal::traits<Flagged< ExpressionType, Added, Removed > >::ColsAtCompileTime, AutoAlign | (internal::traits<Flagged< ExpressionType, Added, Removed > >::Flags&RowMajorBit ? RowMajor : ColMajor), internal::traits<Flagged< ExpressionType, Added, Removed > >::MaxRowsAtCompileTime, internal::traits<Flagged< ExpressionType, Added, Removed > >::MaxColsAtCompileTime > PlainObject [inherited]

The plain matrix type corresponding to this expression.

This is not necessarily exactly the return type of eval(). In the case of plain matrices, the return type of eval() is a const reference to a matrix, not a matrix! It is however guaranteed that the return type of eval() is either PlainObject or const PlainObject&.

Definition at line 115 of file MatrixBase.h.

typedef Matrix<Scalar,EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime)> SquareMatrixType [inherited]

type of the equivalent square matrix

Definition at line 96 of file MatrixBase.h.

Member Function Documentation

ArrayWrapper<Flagged< ExpressionType, Added, Removed > > array (  ) [inherited]
Returns:
an Array expression of this matrix
See also:
ArrayBase::matrix()

Definition at line 316 of file MatrixBase.h.

Index diagonalSize (  ) const [inherited]
Returns:
the size of the main diagonal, which is min(rows(),cols()).
See also:
rows(), cols(), SizeAtCompileTime.

Definition at line 101 of file MatrixBase.h.

Flagged< ExpressionType, Added, Removed > & lazyAssign ( const Flagged< OtherDerived, 0, EvalBeforeAssigningBit > &  other ) [inherited]

Definition at line 477 of file MatrixBase.h.

bool operator!= ( const MatrixBase< OtherDerived > &  other ) const [inherited]
Returns:
true if at least one pair of coefficients of *this and other are not exactly equal to each other.
Warning:
When using floating point scalar values you probably should rather use a fuzzy comparison such as isApprox()
See also:
isApprox(), operator==

Definition at line 295 of file MatrixBase.h.

bool operator== ( const MatrixBase< OtherDerived > &  other ) const [inherited]
Returns:
true if each coefficients of *this and other are all exactly equal.
Warning:
When using floating point scalar values you probably should rather use a fuzzy comparison such as isApprox()
See also:
isApprox(), operator!=

Definition at line 287 of file MatrixBase.h.

Generated on Tue Jul 12 2022 17:47:04 by  doxygen 1.7.2