Detailed Description

Base class for all 1D and 2D array, and related expressions.

An array is similar to a dense vector or matrix. While matrices are mathematical objects with well defined linear algebra operators, an array is just a collection of scalar values arranged in a one or two dimensionnal fashion. As the main consequence, all operations applied to an array are performed coefficient wise. Furthermore, arrays support scalar math functions of the c++ standard library (e.g., std::sin(x)), and convenient constructors allowing to easily write generic code working for both scalar values and arrays.

This class is the base that is inherited by all array expression types.

Template Parameters:

Derived is the derived type, e.g., an array or an expression type.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN.

See also:: class MatrixBase, TopicClassHierarchy

Definition at line 29 of file Core.

Inheritance diagram for Eigen::ArrayBase:

[legend]

List of all members.

Public Types
enum
enum
typedef internal::traits < Derived >::StorageKind	StorageKind
typedef internal::traits < Derived >::Index	Index
	The type of indices.
typedef internal::traits < Derived >::Scalar	Scalar
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef DenseCoeffsBase< Derived >	Base
typedef Base::CoeffReturnType	CoeffReturnType
typedef const Transpose< const Derived >	ConstTransposeReturnType
typedef VectorBlock< Derived >	SegmentReturnType
typedef const VectorBlock < const Derived >	ConstSegmentReturnType
typedef VectorwiseOp< Derived, Horizontal >	RowwiseReturnType
typedef const VectorwiseOp < const Derived, Horizontal >	ConstRowwiseReturnType
typedef VectorwiseOp< Derived, Vertical >	ColwiseReturnType
typedef const VectorwiseOp < const Derived, Vertical >	ConstColwiseReturnType
typedef Reverse< Derived, BothDirections >	ReverseReturnType
typedef const Reverse< const Derived, BothDirections >	ConstReverseReturnType
Public Member Functions
const CwiseUnaryOp < internal::scalar_opposite_op < typename internal::traits < Derived >::Scalar >, const Derived >	operator- () const
const ScalarMultipleReturnType	operator* (const Scalar &scalar) const
const ScalarMultipleReturnType	operator* (const RealScalar &scalar) const
const CwiseUnaryOp < internal::scalar_quotient1_op < typename internal::traits < Derived >::Scalar >, const Derived >	operator/ (const Scalar &scalar) const
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar) const
	Overloaded for efficient real matrix times complex scalar value.
template<typename NewType >
internal::cast_return_type < Derived, const CwiseUnaryOp < internal::scalar_cast_op < typename internal::traits < Derived >::Scalar, NewType > , const Derived > >::type	cast () const
ConjugateReturnType	conjugate () const
RealReturnType	real () const
const ImagReturnType	imag () const
template<typename CustomUnaryOp >
const CwiseUnaryOp < CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise.
template<typename CustomViewOp >
const CwiseUnaryView < CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
NonConstRealReturnType	real ()
NonConstImagReturnType	imag ()
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Derived >	cwiseAbs () const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Derived >	cwiseAbs2 () const
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Derived >	cwiseSqrt () const
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Derived >	cwiseInverse () const
const CwiseUnaryOp < std::binder1st < std::equal_to< Scalar > >, const Derived >	cwiseEqual (const Scalar &s) const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Derived >	abs () const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Derived >	abs2 () const
const CwiseUnaryOp < internal::scalar_exp_op < Scalar >, const Derived >	exp () const
const CwiseUnaryOp < internal::scalar_log_op < Scalar >, const Derived >	log () const
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Derived >	sqrt () const
const CwiseUnaryOp < internal::scalar_cos_op < Scalar >, const Derived >	cos () const
const CwiseUnaryOp < internal::scalar_sin_op < Scalar >, const Derived >	sin () const
const CwiseUnaryOp < internal::scalar_acos_op < Scalar >, const Derived >	acos () const
const CwiseUnaryOp < internal::scalar_asin_op < Scalar >, const Derived >	asin () const
const CwiseUnaryOp < internal::scalar_tan_op < Scalar >, Derived >	tan () const
const CwiseUnaryOp < internal::scalar_pow_op < Scalar >, const Derived >	pow (const Scalar &exponent) const
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Derived >	inverse () const
const CwiseUnaryOp < internal::scalar_square_op < Scalar >, const Derived >	square () const
const CwiseUnaryOp < internal::scalar_cube_op < Scalar >, const Derived >	cube () const
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
const CwiseBinaryOp < std::equal_to< Scalar > , const Derived, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
const CwiseBinaryOp < std::not_equal_to< Scalar > , const Derived, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const Derived, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const Derived, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const Derived, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) operator*(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const Derived, const OtherDerived >	operator/ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator+ (const Scalar &scalar) const
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator- (const Scalar &scalar) const
template<typename OtherDerived >
const CwiseBinaryOp < internal::scalar_boolean_and_op, const Derived, const OtherDerived >	operator&& (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
const CwiseBinaryOp < internal::scalar_boolean_or_op, const Derived, const OtherDerived >	operator\|\| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
Derived &	operator= (const ArrayBase &other)
	Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1)
Derived &	operator+= (const Scalar &scalar)
Derived &	operator-= (const Scalar &scalar)
template<typename OtherDerived >
Derived &	operator+= (const ArrayBase< OtherDerived > &other)
	replaces `this` by `this` + other.
template<typename OtherDerived >
Derived &	operator-= (const ArrayBase< OtherDerived > &other)
	replaces `this` by `this` - other.
template<typename OtherDerived >
Derived &	operator*= (const ArrayBase< OtherDerived > &other)
	replaces `this` by `this` * other coefficient wise.
template<typename OtherDerived >
Derived &	operator/= (const ArrayBase< OtherDerived > &other)
	replaces `this` by `this` / other coefficient wise.
ArrayBase< Derived > &	array ()
const ArrayBase< Derived > &	array () const
MatrixWrapper< Derived >	matrix ()
const MatrixWrapper< Derived >	matrix () const
Index	nonZeros () const
Index	outerSize () const
Index	innerSize () const
void	resize (Index size)
	Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize().
void	resize (Index rows, Index cols)
	Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize().
Derived &	operator+= (const EigenBase< OtherDerived > &other)
Derived &	operator-= (const EigenBase< OtherDerived > &other)
CommaInitializer< Derived >	operator<< (const Scalar &s)
CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)
const Flagged< Derived, Added, Removed >	flagged () const
Eigen::Transpose< Derived >	transpose ()
ConstTransposeReturnType	transpose () const
void	transposeInPlace ()
SegmentReturnType	segment (Index start, Index size)
DenseBase::ConstSegmentReturnType	segment (Index start, Index size) const
FixedSegmentReturnType< Size > ::Type	segment (Index start)
ConstFixedSegmentReturnType < Size >::Type	segment (Index start) const
SegmentReturnType	head (Index size)
DenseBase::ConstSegmentReturnType	head (Index size) const
FixedSegmentReturnType< Size > ::Type	head ()
ConstFixedSegmentReturnType < Size >::Type	head () const
SegmentReturnType	tail (Index size)
DenseBase::ConstSegmentReturnType	tail (Index size) const
FixedSegmentReturnType< Size > ::Type	tail ()
ConstFixedSegmentReturnType < Size >::Type	tail () const
void	fill (const Scalar &value)
Derived &	setConstant (const Scalar &value)
Derived &	setLinSpaced (Index size, const Scalar &low, const Scalar &high)
Derived &	setLinSpaced (const Scalar &low, const Scalar &high)
Derived &	setZero ()
Derived &	setOnes ()
Derived &	setRandom ()
bool	isApprox (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isMuchSmallerThan (const RealScalar &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isApproxToConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isZero (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isOnes (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
Derived &	operator*= (const Scalar &other)
Derived &	operator/= (const Scalar &other)
EIGEN_STRONG_INLINE const internal::eval< Derived > ::type	eval () const
void	swap (const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
	swaps this with the expression other*.
void	swap (PlainObjectBase< OtherDerived > &other)
	swaps this with the matrix or array other*.
const NestByValue< Derived >	nestByValue () const
const ForceAlignedAccess< Derived >	forceAlignedAccess () const
ForceAlignedAccess< Derived >	forceAlignedAccess ()
const internal::conditional < Enable, ForceAlignedAccess < Derived >, Derived & >::type	forceAlignedAccessIf () const
internal::conditional< Enable, ForceAlignedAccess< Derived > , Derived & >::type	forceAlignedAccessIf ()
Scalar	sum () const
Scalar	mean () const
Scalar	trace () const
Scalar	prod () const
internal::traits< Derived >::Scalar	minCoeff () const
internal::traits< Derived >::Scalar	minCoeff (IndexType row, IndexType col) const
internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const
internal::traits< Derived >::Scalar	maxCoeff () const
internal::traits< Derived >::Scalar	maxCoeff (IndexType row, IndexType col) const
internal::traits< Derived >::Scalar	maxCoeff (IndexType *index) const
internal::result_of< BinaryOp(typename internal::traits< Derived > ::Scalar)>::type	redux (const BinaryOp &func) const
void	visit (Visitor &func) const
const WithFormat< Derived >	format (const IOFormat &fmt) const
CoeffReturnType	value () const
bool	all (void) const
bool	any (void) const
Index	count () const
ConstRowwiseReturnType	rowwise () const
RowwiseReturnType	rowwise ()
ConstColwiseReturnType	colwise () const
ColwiseReturnType	colwise ()
const Select< Derived, ThenDerived, ElseDerived >	select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType >	select (const DenseBase< ThenDerived > &thenMatrix, typename ThenDerived::Scalar elseScalar) const
const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived >	select (typename ElseDerived::Scalar thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
RealScalar	lpNorm () const
const Replicate< Derived, RowFactor, ColFactor >	replicate () const
const Replicate< Derived, Dynamic, Dynamic >	replicate (Index rowFacor, Index colFactor) const
ReverseReturnType	reverse ()
ConstReverseReturnType	reverse () const
void	reverseInPlace ()
Block< Derived >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
const Block< const Derived >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index).
Block< Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol)
const Block< const Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index).
Block< Derived >	topRightCorner (Index cRows, Index cCols)
const Block< const Derived >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index).
Block< Derived, CRows, CCols >	topRightCorner ()
const Block< const Derived, CRows, CCols >	topRightCorner () const
	This is the const version of topRightCorner<int, int>().
Block< Derived >	topLeftCorner (Index cRows, Index cCols)
const Block< const Derived >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index).
Block< Derived, CRows, CCols >	topLeftCorner ()
const Block< const Derived, CRows, CCols >	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>().
Block< Derived >	bottomRightCorner (Index cRows, Index cCols)
const Block< const Derived >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index).
Block< Derived, CRows, CCols >	bottomRightCorner ()
const Block< const Derived, CRows, CCols >	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>().
Block< Derived >	bottomLeftCorner (Index cRows, Index cCols)
const Block< const Derived >	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index).
Block< Derived, CRows, CCols >	bottomLeftCorner ()
const Block< const Derived, CRows, CCols >	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>().
RowsBlockXpr	topRows (Index n)
ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index).
NRowsBlockXpr< N >::Type	topRows ()
ConstNRowsBlockXpr< N >::Type	topRows () const
	This is the const version of topRows<int>().
RowsBlockXpr	bottomRows (Index n)
ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index).
NRowsBlockXpr< N >::Type	bottomRows ()
ConstNRowsBlockXpr< N >::Type	bottomRows () const
	This is the const version of bottomRows<int>().
RowsBlockXpr	middleRows (Index startRow, Index numRows)
ConstRowsBlockXpr	middleRows (Index startRow, Index numRows) const
	This is the const version of middleRows(Index,Index).
NRowsBlockXpr< N >::Type	middleRows (Index startRow)
ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow) const
	This is the const version of middleRows<int>().
ColsBlockXpr	leftCols (Index n)
ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index).
NColsBlockXpr< N >::Type	leftCols ()
ConstNColsBlockXpr< N >::Type	leftCols () const
	This is the const version of leftCols<int>().
ColsBlockXpr	rightCols (Index n)
ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index).
NColsBlockXpr< N >::Type	rightCols ()
ConstNColsBlockXpr< N >::Type	rightCols () const
	This is the const version of rightCols<int>().
ColsBlockXpr	middleCols (Index startCol, Index numCols)
ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index).
NColsBlockXpr< N >::Type	middleCols (Index startCol)
ConstNColsBlockXpr< N >::Type	middleCols (Index startCol) const
	This is the const version of middleCols<int>().
ColXpr	col (Index i)
ConstColXpr	col (Index i) const
	This is the const version of col().
RowXpr	row (Index i)
ConstRowXpr	row (Index i) const
	This is the const version of row().
void	evalTo (Dest &) const
Static Public Member Functions
static const ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)
static const ConstantReturnType	Constant (Index size, const Scalar &value)
static const ConstantReturnType	Constant (const Scalar &value)
static const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
static const RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
static const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
static const RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
static const CwiseNullaryOp < CustomNullaryOp, Derived >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
static const CwiseNullaryOp < CustomNullaryOp, Derived >	NullaryExpr (Index size, const CustomNullaryOp &func)
static const CwiseNullaryOp < CustomNullaryOp, Derived >	NullaryExpr (const CustomNullaryOp &func)
static const ConstantReturnType	Zero (Index rows, Index cols)
static const ConstantReturnType	Zero (Index size)
static const ConstantReturnType	Zero ()
static const ConstantReturnType	Ones (Index rows, Index cols)
static const ConstantReturnType	Ones (Index size)
static const ConstantReturnType	Ones ()
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, Derived >	Random (Index rows, Index cols)
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, Derived >	Random (Index size)
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, Derived >	Random ()
Protected Member Functions
	ArrayBase ()
template<typename OtherDerived >
Derived &	operator+= (const MatrixBase< OtherDerived > &)
template<typename OtherDerived >
Derived &	operator-= (const MatrixBase< OtherDerived > &)
void	checkTransposeAliasing (const OtherDerived &other) const
Private Member Functions
	ArrayBase (Index)
	ArrayBase (Index, Index)
template<typename OtherDerived >
	ArrayBase (const ArrayBase< OtherDerived > &)
Friends
const ScalarMultipleReturnType	operator* (const Scalar &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator+ (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const CwiseUnaryOp < internal::scalar_opposite_op < Scalar >, const Derived > >	operator- (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)

Member Typedef Documentation

typedef DenseCoeffsBase<Derived> Eigen::DenseBase::Base [inherited]

Definition at line 71 of file Core.

typedef Base::CoeffReturnType Eigen::DenseBase::CoeffReturnType [inherited]

Definition at line 102 of file Core.

typedef VectorwiseOp<Derived, Vertical> Eigen::DenseBase::ColwiseReturnType [inherited]

Definition at line 462 of file Core.

typedef const VectorwiseOp<const Derived, Vertical> Eigen::DenseBase::ConstColwiseReturnType [inherited]

Definition at line 463 of file Core.

typedef const Reverse<const Derived, BothDirections> Eigen::DenseBase::ConstReverseReturnType [inherited]

Definition at line 494 of file Core.

typedef const VectorwiseOp<const Derived, Horizontal> Eigen::DenseBase::ConstRowwiseReturnType [inherited]

Definition at line 461 of file Core.

typedef const VectorBlock<const Derived> Eigen::DenseBase::ConstSegmentReturnType [inherited]

Definition at line 299 of file Core.

typedef const Transpose<const Derived> Eigen::DenseBase::ConstTransposeReturnType [inherited]

Definition at line 288 of file Core.

typedef internal::traits<Derived>::Index Eigen::DenseBase::Index [inherited]

The type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

See also:: TopicPreprocessorDirectives.

Definition at line 65 of file Core.

typedef internal::packet_traits<Scalar>::type Eigen::DenseBase::PacketScalar [inherited]

Definition at line 68 of file Core.

typedef NumTraits<Scalar>::Real Eigen::DenseBase::RealScalar [inherited]

Definition at line 69 of file Core.

typedef Reverse<Derived, BothDirections> Eigen::DenseBase::ReverseReturnType [inherited]

Definition at line 493 of file Core.

typedef VectorwiseOp<Derived, Horizontal> Eigen::DenseBase::RowwiseReturnType [inherited]

Definition at line 460 of file Core.

typedef internal::traits<Derived>::Scalar Eigen::DenseBase::Scalar [inherited]

Definition at line 67 of file Core.

typedef VectorBlock<Derived> Eigen::DenseBase::SegmentReturnType [inherited]

Definition at line 298 of file Core.

typedef internal::traits<Derived>::StorageKind Eigen::DenseBase::StorageKind [inherited]

Definition at line 57 of file Core.

Member Enumeration Documentation

anonymous enum [inherited]

Definition at line 104 of file Core.

anonymous enum [inherited]

Definition at line 185 of file Core.

Constructor & Destructor Documentation

Eigen::ArrayBase::ArrayBase ( ) [inline, protected]

Definition at line 168 of file Core.

Eigen::ArrayBase::ArrayBase ( Index ) [explicit, private]

Eigen::ArrayBase::ArrayBase	(	Index	,
		Index
	)		`[private]`

template<typename OtherDerived >

Eigen::ArrayBase::ArrayBase ( const ArrayBase< OtherDerived > & ) [explicit, private]

Member Function Documentation

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::ArrayBase::abs ( ) const [inline]

Returns:: an expression of the coefficient-wise absolute value of *this

Example:

Output:

See also:: abs2()

Definition at line 12 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::ArrayBase::abs2 ( ) const [inline]

Returns:: an expression of the coefficient-wise squared absolute value of *this

Example:

Output:

See also:: abs(), square()

Definition at line 25 of file Core.

const CwiseUnaryOp<internal::scalar_acos_op<Scalar>, const Derived> Eigen::ArrayBase::acos ( ) const [inline]

Returns:: an expression of the coefficient-wise arc cosine of *this.

Example:

Output:

See also:: cos(), asin()

Definition at line 104 of file Core.

bool Eigen::DenseBase::all ( void ) const [inherited]

Returns:: true if all coefficients are true

Example:

Output:

See also:: any(), Cwise::operator<()

bool Eigen::DenseBase::any ( void ) const [inherited]

Returns:: true if at least one coefficient is true

See also:: all()

ArrayBase<Derived>& Eigen::ArrayBase::array ( ) [inline]

Definition at line 156 of file Core.

const ArrayBase<Derived>& Eigen::ArrayBase::array ( ) const [inline]

Definition at line 157 of file Core.

const CwiseUnaryOp<internal::scalar_asin_op<Scalar>, const Derived> Eigen::ArrayBase::asin ( ) const [inline]

Returns:: an expression of the coefficient-wise arc sine of *this.

Example:

Output:

See also:: sin(), acos()

Definition at line 117 of file Core.

template<typename CustomBinaryOp , typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::ArrayBase::binaryExpr	(	const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &	other,
		const CustomBinaryOp &	func = `CustomBinaryOp()`
	)		const `[inline]`

Returns:: an expression of the difference of *this and other

Note:: If you want to substract a given scalar from all coefficients, see Cwise::operator-().

See also:: class CwiseBinaryOp, operator-=()

Returns:: an expression of the sum of *this and other

Note:: If you want to add a given scalar to all coefficients, see Cwise::operator+().

See also:: class CwiseBinaryOp, operator+=()

Returns:: an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

Output:

See also:: class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 58 of file Core.

Block<Derived> Eigen::DenseBase::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		`[inline, inherited]`

Returns:: a dynamic-size expression of a block in *this.

Parameters:

startRow	the first row in the block
startCol	the first column in the block
blockRows	the number of rows in the block
blockCols	the number of columns in the block

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size matrix, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, block(Index,Index)

Definition at line 70 of file Core.

const Block<const Derived> Eigen::DenseBase::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		const `[inline, inherited]`

This is the const version of block(Index,Index,Index,Index).

Definition at line 76 of file Core.

Block<Derived, BlockRows, BlockCols> Eigen::DenseBase::block	(	Index	startRow,
		Index	startCol
	)		`[inline, inherited]`

Returns:: a fixed-size expression of a block in *this.

The template parameters BlockRows and BlockCols are the number of rows and columns in the block.

Parameters:

startRow	the first row in the block
startCol	the first column in the block

Example:

Output:

Note:

since block is a templated member, the keyword template has to be used if the matrix type is also a template parameter:

 m.template block<3,3>(1,1);

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 550 of file Core.

const Block<const Derived, BlockRows, BlockCols> Eigen::DenseBase::block	(	Index	startRow,
		Index	startCol
	)		const `[inline, inherited]`

This is the const version of block<>(Index, Index).

Definition at line 557 of file Core.

Block<Derived> Eigen::DenseBase::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		`[inline, inherited]`

Returns:: a dynamic-size expression of a bottom-left corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 230 of file Core.

const Block<const Derived> Eigen::DenseBase::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline, inherited]`

This is the const version of bottomLeftCorner(Index, Index).

Definition at line 236 of file Core.

Block<Derived, CRows, CCols> Eigen::DenseBase::bottomLeftCorner ( ) [inline, inherited]

Returns:: an expression of a fixed-size bottom-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 251 of file Core.

const Block<const Derived, CRows, CCols> Eigen::DenseBase::bottomLeftCorner ( ) const [inline, inherited]

This is the const version of bottomLeftCorner<int, int>().

Definition at line 258 of file Core.

Block<Derived> Eigen::DenseBase::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		`[inline, inherited]`

Returns:: a dynamic-size expression of a bottom-right corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 185 of file Core.

const Block<const Derived> Eigen::DenseBase::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline, inherited]`

This is the const version of bottomRightCorner(Index, Index).

Definition at line 191 of file Core.

Block<Derived, CRows, CCols> Eigen::DenseBase::bottomRightCorner ( ) [inline, inherited]

Returns:: an expression of a fixed-size bottom-right corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 206 of file Core.

const Block<const Derived, CRows, CCols> Eigen::DenseBase::bottomRightCorner ( ) const [inline, inherited]

This is the const version of bottomRightCorner<int, int>().

Definition at line 213 of file Core.

RowsBlockXpr Eigen::DenseBase::bottomRows ( Index n ) [inline, inherited]

Returns:: a block consisting of the bottom rows of *this.

Parameters:

n	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 318 of file Core.

ConstRowsBlockXpr Eigen::DenseBase::bottomRows ( Index n ) const [inline, inherited]

This is the const version of bottomRows(Index).

Definition at line 324 of file Core.

NRowsBlockXpr<N>::Type Eigen::DenseBase::bottomRows ( ) [inline, inherited]

Returns:: a block consisting of the bottom rows of *this.

Template Parameters:

N	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 339 of file Core.

ConstNRowsBlockXpr<N>::Type Eigen::DenseBase::bottomRows ( ) const [inline, inherited]

This is the const version of bottomRows<int>().

Definition at line 346 of file Core.

template<typename NewType >

internal::cast_return_type<Derived,const CwiseUnaryOp<internal::scalar_cast_op<typename internal::traits<Derived>::Scalar, NewType>, const Derived> >::type Eigen::ArrayBase::cast ( ) const [inline]

Returns:: an expression of *this with the Scalar type casted to NewScalar.

The template parameter NewScalar is the type we are casting the scalars to.

See also:: class CwiseUnaryOp

Definition at line 108 of file Core.

void Eigen::DenseBase::checkTransposeAliasing ( const OtherDerived & other ) const [protected, inherited]

ColXpr Eigen::DenseBase::col ( Index i ) [inline, inherited]

Returns:: an expression of the i-th column of *this. Note that the numbering starts at 0.

Example:

Output:

See also:: row(), class Block

Definition at line 568 of file Core.

ConstColXpr Eigen::DenseBase::col ( Index i ) const [inline, inherited]

This is the const version of col().

Definition at line 574 of file Core.

ConstColwiseReturnType Eigen::DenseBase::colwise ( ) const [inherited]

Returns:: a VectorwiseOp wrapper of *this providing additional partial reduction operations

Example:

Output:

See also:: rowwise(), class VectorwiseOp

ColwiseReturnType Eigen::DenseBase::colwise ( ) [inherited]

Returns:: a writable VectorwiseOp wrapper of *this providing additional partial reduction operations

See also:: rowwise(), class VectorwiseOp

ConjugateReturnType Eigen::ArrayBase::conjugate ( ) const [inline]

Returns:: an expression of the complex conjugate of *this.

See also:: adjoint()

Definition at line 117 of file Core.

static const ConstantReturnType Eigen::DenseBase::Constant	(	Index	rows,
		Index	cols,
		const Scalar &	value
	)		`[static, inherited]`

Returns:: an expression of a constant matrix of value value

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this DenseBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

static const ConstantReturnType Eigen::DenseBase::Constant	(	Index	size,
		const Scalar &	value
	)		`[static, inherited]`

Returns:: an expression of a constant matrix of value value

The parameter size is the size of the returned vector. Must be compatible with this DenseBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

static const ConstantReturnType Eigen::DenseBase::Constant ( const Scalar & value ) [static, inherited]

Returns:: an expression of a constant matrix of value value

This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

const CwiseUnaryOp<internal::scalar_cos_op<Scalar>, const Derived> Eigen::ArrayBase::cos ( ) const [inline]

Returns:: an expression of the coefficient-wise cosine of *this.

Example:

Output:

See also:: sin(), acos()

Definition at line 77 of file Core.

Index Eigen::DenseBase::count ( void ) const [inherited]

Returns:: the number of coefficients which evaluate to true

See also:: all(), any()

const CwiseUnaryOp<internal::scalar_cube_op<Scalar>, const Derived> Eigen::ArrayBase::cube ( ) const [inline]

Returns:: an expression of the coefficient-wise cube of *this.

Example:

Output:

See also:: square(), pow()

Definition at line 185 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseAbs ( ) const [inline]

Returns:: an expression of the coefficient-wise absolute value of *this

Example:

Output:

See also:: cwiseAbs2()

Definition at line 37 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseAbs2 ( ) const [inline]

Returns:: an expression of the coefficient-wise squared absolute value of *this

Example:

Output:

See also:: cwiseAbs()

Definition at line 47 of file Core.

template<typename OtherDerived >

const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise == operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: cwiseNotEqual(), isApprox(), isMuchSmallerThan()

Definition at line 57 of file Core.

const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const Derived> Eigen::ArrayBase::cwiseEqual ( const Scalar & s ) const [inline]

Returns:: an expression of the coefficient-wise == operator of *this and a scalar s

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

See also:: cwiseEqual(const MatrixBase<OtherDerived> &) const

Definition at line 79 of file Core.

const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseInverse ( ) const [inline]

Returns:: an expression of the coefficient-wise inverse of *this.

Example:

Output:

See also:: cwiseProduct()

Definition at line 67 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseMax ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise max of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, min()

Definition at line 104 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseMin ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise min of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, max()

Definition at line 90 of file Core.

template<typename OtherDerived >

const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseNotEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise != operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: cwiseEqual(), isApprox(), isMuchSmallerThan()

Definition at line 76 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseQuotient ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise quotient of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 118 of file Core.

const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseSqrt ( ) const [inline]

Returns:: an expression of the coefficient-wise square root of *this.

Example:

Output:

See also:: cwisePow(), cwiseSquare()

Definition at line 57 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const Eigen::ArrayBase::EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	Derived	,
		OtherDerived
	)		const `[inline]`

Returns:: an expression of the coefficient wise product of *this and other

See also:: MatrixBase::cwiseProduct

Definition at line 7 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE const Eigen::ArrayBase::EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	Derived	,
		OtherDerived
	)		const `[inline]`

Returns:: an expression of the Schur product (coefficient wise product) of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, cwiseAbs2

Definition at line 37 of file Core.

EIGEN_STRONG_INLINE const internal::eval<Derived>::type Eigen::DenseBase::eval ( ) const [inline, inherited]

Returns:: the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

Definition at line 385 of file Core.

void Eigen::DenseBase::evalTo ( Dest & ) const [inline, inherited]

Definition at line 518 of file Core.

const CwiseUnaryOp<internal::scalar_exp_op<Scalar>, const Derived> Eigen::ArrayBase::exp ( ) const [inline]

Returns:: an expression of the coefficient-wise exponential of *this.

Example:

Output:

See also:: pow(), log(), sin(), cos()

Definition at line 38 of file Core.

void Eigen::DenseBase::fill ( const Scalar & value ) [inherited]

Alias for setConstant(): sets all coefficients in this expression to value.

See also:: setConstant(), Constant(), class CwiseNullaryOp

const Flagged<Derived, Added, Removed> Eigen::DenseBase::flagged ( ) const [inherited]

Returns:: an expression of *this with added and removed flags

This is mostly for internal use.

See also:: class Flagged

const ForceAlignedAccess<Derived> Eigen::DenseBase::forceAlignedAccess ( ) const [inline, inherited]

Reimplemented in Eigen::MatrixBase.

ForceAlignedAccess<Derived> Eigen::DenseBase::forceAlignedAccess ( ) [inline, inherited]

Reimplemented in Eigen::MatrixBase.

const internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type Eigen::DenseBase::forceAlignedAccessIf ( ) const [inline, inherited]

Reimplemented in Eigen::MatrixBase.

internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type Eigen::DenseBase::forceAlignedAccessIf ( ) [inline, inherited]

Reimplemented in Eigen::MatrixBase.

const WithFormat<Derived> Eigen::DenseBase::format ( const IOFormat & fmt ) const [inline, inherited]

Returns:: a WithFormat proxy object allowing to print a matrix the with given format fmt.

See class IOFormat for some examples.

See also:: class IOFormat, class WithFormat

SegmentReturnType Eigen::DenseBase::head ( Index size ) [inherited]

Returns:: a dynamic-size expression of the first coefficients of *this.

Parameters:

size	the number of coefficients in the block

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, block(Index,Index)

DenseBase::ConstSegmentReturnType Eigen::DenseBase::head ( Index size ) const [inherited]

This is the const version of head(Index).

FixedSegmentReturnType<Size>::Type Eigen::DenseBase::head ( ) [inherited]

Returns:: a fixed-size expression of the first coefficients of *this.

The template parameter Size is the number of coefficients in the block

Example:

Output:

See also:: class Block

ConstFixedSegmentReturnType<Size>::Type Eigen::DenseBase::head ( ) const [inherited]

This is the const version of head<int>().

const ImagReturnType Eigen::ArrayBase::imag ( ) const [inline]

Returns:: an read-only expression of the imaginary part of *this.

See also:: real()

Definition at line 132 of file Core.

NonConstImagReturnType Eigen::ArrayBase::imag ( ) [inline]

Returns:: a non const expression of the imaginary part of *this.

See also:: real()

Definition at line 188 of file Core.

Index Eigen::DenseBase::innerSize ( ) const [inline, inherited]

Returns:: the inner size.

Note:: For a vector, this is just the size. For a matrix (non-vector), this is the minor dimension with respect to the storage order, i.e., the number of rows for a column-major matrix, and the number of columns for a row-major matrix.

Definition at line 211 of file Core.

const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::ArrayBase::inverse ( ) const [inline]

Returns:: an expression of the coefficient-wise inverse of *this.

Example:

Output:

See also:: operator/(), operator*()

Definition at line 159 of file Core.

bool Eigen::DenseBase::isApprox	(	const DenseBase< OtherDerived > &	other,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inherited]`

Returns:: true if *this is approximately equal to other, within the precision determined by prec.

Note:: The fuzzy compares are done multiplicatively. Two vectors and are considered to be approximately equal within precision if
$\Vert v - w \Vert \leqslant p\,\min(\Vert v\Vert, \Vert w\Vert).$
For matrices, the comparison is done using the Hilbert-Schmidt norm (aka Frobenius norm L2 norm).; Because of the multiplicativeness of this comparison, one can't use this function to check whether *this is approximately equal to the zero matrix or vector. Indeed, isApprox(zero) returns false unless *this itself is exactly the zero matrix or vector. If you want to test whether *this is zero, use internal::isMuchSmallerThan(const RealScalar&, RealScalar) instead.

See also:: internal::isMuchSmallerThan(const RealScalar&, RealScalar) const

bool Eigen::DenseBase::isApproxToConstant	(	const Scalar &	value,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inherited]`

Returns:: true if all coefficients in this matrix are approximately equal to value, to within precision prec

bool Eigen::DenseBase::isConstant	(	const Scalar &	value,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inherited]`

This is just an alias for isApproxToConstant().

Returns:: true if all coefficients in this matrix are approximately equal to value, to within precision prec

bool Eigen::DenseBase::isMuchSmallerThan	(	const RealScalar &	other,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inherited]`

bool Eigen::DenseBase::isMuchSmallerThan	(	const DenseBase< OtherDerived > &	other,
		RealScalar	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const `[inherited]`

Returns:: true if the norm of *this is much smaller than the norm of other, within the precision determined by prec.

Note:: The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than a vector within precision if
$\Vert v \Vert \leqslant p\,\Vert w\Vert.$
For matrices, the comparison is done using the Hilbert-Schmidt norm.

See also:: isApprox(), isMuchSmallerThan(const RealScalar&, RealScalar) const

bool Eigen::DenseBase::isOnes ( RealScalar prec = NumTraits<Scalar>::dummy_precision() ) const [inherited]

Returns:: true if *this is approximately equal to the matrix where all coefficients are equal to 1, within the precision given by prec.

Example:

Output:

See also:: class CwiseNullaryOp, Ones()

bool Eigen::DenseBase::isZero ( RealScalar prec = NumTraits<Scalar>::dummy_precision() ) const [inherited]

Returns:: true if *this is approximately equal to the zero matrix, within the precision given by prec.

Example:

Output:

See also:: class CwiseNullaryOp, Zero()

ColsBlockXpr Eigen::DenseBase::leftCols ( Index n ) [inline, inherited]

Returns:: a block consisting of the left columns of *this.

Parameters:

n	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 408 of file Core.

ConstColsBlockXpr Eigen::DenseBase::leftCols ( Index n ) const [inline, inherited]

This is the const version of leftCols(Index).

Definition at line 414 of file Core.

NColsBlockXpr<N>::Type Eigen::DenseBase::leftCols ( ) [inline, inherited]

Returns:: a block consisting of the left columns of *this.

Template Parameters:

N	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 429 of file Core.

ConstNColsBlockXpr<N>::Type Eigen::DenseBase::leftCols ( ) const [inline, inherited]

This is the const version of leftCols<int>().

Definition at line 436 of file Core.

static const SequentialLinSpacedReturnType Eigen::DenseBase::LinSpaced	(	Sequential_t	,
		Index	size,
		const Scalar &	low,
		const Scalar &	high
	)		`[static, inherited]`

Sets a linearly space vector.

The function generates 'size' equally spaced values in the closed interval [low,high]. This particular version of LinSpaced() uses sequential access, i.e. vector access is assumed to be a(0), a(1), ..., a(size). This assumption allows for better vectorization and yields faster code than the random access version.

Example:

Output:

See also:: setLinSpaced(Index,const Scalar&,const Scalar&), LinSpaced(Index,Scalar,Scalar), CwiseNullaryOp

static const RandomAccessLinSpacedReturnType Eigen::DenseBase::LinSpaced	(	Index	size,
		const Scalar &	low,
		const Scalar &	high
	)		`[static, inherited]`

Sets a linearly space vector.

The function generates 'size' equally spaced values in the closed interval [low,high].

Example:

Output:

See also:: setLinSpaced(Index,const Scalar&,const Scalar&), LinSpaced(Sequential_t,Index,const Scalar&,const Scalar&,Index), CwiseNullaryOp

static const SequentialLinSpacedReturnType Eigen::DenseBase::LinSpaced	(	Sequential_t	,
		const Scalar &	low,
		const Scalar &	high
	)		`[static, inherited]`

Special version for fixed size types which does not require the size parameter.

static const RandomAccessLinSpacedReturnType Eigen::DenseBase::LinSpaced	(	const Scalar &	low,
		const Scalar &	high
	)		`[static, inherited]`

Special version for fixed size types which does not require the size parameter.

const CwiseUnaryOp<internal::scalar_log_op<Scalar>, const Derived> Eigen::ArrayBase::log ( ) const [inline]

Returns:: an expression of the coefficient-wise logarithm of *this.

Example:

Output:

See also:: exp()

Definition at line 51 of file Core.

RealScalar Eigen::DenseBase::lpNorm ( ) const [inherited]

Reimplemented in Eigen::MatrixBase.

MatrixWrapper<Derived> Eigen::ArrayBase::matrix ( ) [inline]

Returns:: an Matrix expression of this array

See also:: MatrixBase::array()

Definition at line 161 of file Core.

const MatrixWrapper<Derived> Eigen::ArrayBase::matrix ( ) const [inline]

Definition at line 162 of file Core.

internal::traits<Derived>::Scalar Eigen::DenseBase::maxCoeff ( ) const [inherited]

Returns:: the maximum of all coefficients of *this

internal::traits<Derived>::Scalar Eigen::DenseBase::maxCoeff	(	IndexType *	row,
		IndexType *	col
	)		const `[inherited]`

Returns:: the maximum of all coefficients of *this and puts in *row and *col its location.

See also:: DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::visitor(), DenseBase::maxCoeff()

internal::traits<Derived>::Scalar Eigen::DenseBase::maxCoeff ( IndexType * index ) const [inherited]

Returns:: the maximum of all coefficients of *this and puts in *index its location.

See also:: DenseBase::maxCoeff(IndexType*,IndexType*), DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::visitor(), DenseBase::maxCoeff()

Scalar Eigen::DenseBase::mean ( ) const [inherited]

Returns:: the mean of all coefficients of *this

See also:: trace(), prod(), sum()

Reimplemented in Eigen::MatrixBase.

ColsBlockXpr Eigen::DenseBase::middleCols	(	Index	startCol,
		Index	numCols
	)		`[inline, inherited]`

Returns:: a block consisting of a range of columns of *this.

Parameters:

startCol	the index of the first column in the block
numCols	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 497 of file Core.

ConstColsBlockXpr Eigen::DenseBase::middleCols	(	Index	startCol,
		Index	numCols
	)		const `[inline, inherited]`

This is the const version of middleCols(Index,Index).

Definition at line 503 of file Core.

NColsBlockXpr<N>::Type Eigen::DenseBase::middleCols ( Index startCol ) [inline, inherited]

Returns:: a block consisting of a range of columns of *this.

Template Parameters:

N	the number of columns in the block

Parameters:

startCol the index of the first column in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 519 of file Core.

ConstNColsBlockXpr<N>::Type Eigen::DenseBase::middleCols ( Index startCol ) const [inline, inherited]

This is the const version of middleCols<int>().

Definition at line 526 of file Core.

RowsBlockXpr Eigen::DenseBase::middleRows	(	Index	startRow,
		Index	numRows
	)		`[inline, inherited]`

Returns:: a block consisting of a range of rows of *this.

Parameters:

startRow	the index of the first row in the block
numRows	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 363 of file Core.

ConstRowsBlockXpr Eigen::DenseBase::middleRows	(	Index	startRow,
		Index	numRows
	)		const `[inline, inherited]`

This is the const version of middleRows(Index,Index).

Definition at line 369 of file Core.

NRowsBlockXpr<N>::Type Eigen::DenseBase::middleRows ( Index startRow ) [inline, inherited]

Returns:: a block consisting of a range of rows of *this.

Template Parameters:

N	the number of rows in the block

Parameters:

startRow the index of the first row in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 385 of file Core.

ConstNRowsBlockXpr<N>::Type Eigen::DenseBase::middleRows ( Index startRow ) const [inline, inherited]

This is the const version of middleRows<int>().

Definition at line 392 of file Core.

internal::traits<Derived>::Scalar Eigen::DenseBase::minCoeff ( ) const [inherited]

Returns:: the minimum of all coefficients of *this

internal::traits<Derived>::Scalar Eigen::DenseBase::minCoeff	(	IndexType *	row,
		IndexType *	col
	)		const `[inherited]`

Returns:: the minimum of all coefficients of *this and puts in *row and *col its location.

See also:: DenseBase::minCoeff(Index*), DenseBase::maxCoeff(Index*,Index*), DenseBase::visitor(), DenseBase::minCoeff()

internal::traits<Derived>::Scalar Eigen::DenseBase::minCoeff ( IndexType * index ) const [inherited]

Returns:: the minimum of all coefficients of *this and puts in *index its location.

See also:: DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::maxCoeff(IndexType*,IndexType*), DenseBase::visitor(), DenseBase::minCoeff()

const NestByValue<Derived> Eigen::DenseBase::nestByValue ( ) const [inline, inherited]

Returns:: an expression of the temporary version of *this.

Index Eigen::DenseBase::nonZeros ( ) const [inline, inherited]

Returns:: the number of nonzero coefficients which is in practice the number of stored coefficients.

Definition at line 189 of file Core.

static const CwiseNullaryOp<CustomNullaryOp, Derived> Eigen::DenseBase::NullaryExpr	(	Index	rows,
		Index	cols,
		const CustomNullaryOp &	func
	)		`[static, inherited]`

Returns:: an expression of a matrix defined by a custom functor func

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

static const CwiseNullaryOp<CustomNullaryOp, Derived> Eigen::DenseBase::NullaryExpr	(	Index	size,
		const CustomNullaryOp &	func
	)		`[static, inherited]`

Returns:: an expression of a matrix defined by a custom functor func

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

static const CwiseNullaryOp<CustomNullaryOp, Derived> Eigen::DenseBase::NullaryExpr ( const CustomNullaryOp & func ) [static, inherited]

Returns:: an expression of a matrix defined by a custom functor func

This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

static const ConstantReturnType Eigen::DenseBase::Ones	(	Index	rows,
		Index	cols
	)		`[static, inherited]`

Returns:: an expression of a matrix where all coefficients equal one.

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Ones() should be used instead.

Example:

Output:

See also:: Ones(), Ones(Index), isOnes(), class Ones

static const ConstantReturnType Eigen::DenseBase::Ones ( Index size ) [static, inherited]

Returns:: an expression of a vector where all coefficients equal one.

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Ones() should be used instead.

Example:

Output:

See also:: Ones(), Ones(Index,Index), isOnes(), class Ones

static const ConstantReturnType Eigen::DenseBase::Ones ( ) [static, inherited]

Returns:: an expression of a fixed-size matrix or vector where all coefficients equal one.

This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.

Example:

Output:

See also:: Ones(Index), Ones(Index,Index), isOnes(), class Ones

template<typename OtherDerived >

const CwiseBinaryOp<internal::scalar_boolean_and_op, const Derived, const OtherDerived> Eigen::ArrayBase::operator&& ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise && operator of *this and other

Warning:: this operator is for expression of bool only.

Example:

Output:

See also:: operator||(), select()

Definition at line 157 of file Core.

const ScalarMultipleReturnType Eigen::ArrayBase::operator* ( const Scalar & scalar ) const [inline]

Returns:: an expression of *this scaled by the scalar factor scalar

Definition at line 65 of file Core.

const ScalarMultipleReturnType Eigen::ArrayBase::operator* ( const RealScalar & scalar ) const

const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> Eigen::ArrayBase::operator* ( const std::complex< Scalar > & scalar ) const [inline]

Overloaded for efficient real matrix times complex scalar value.

Definition at line 85 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase::operator*= ( const ArrayBase< OtherDerived > & other )

replaces *this by *this * other coefficient wise.

Returns:: a reference to *this

Definition at line 218 of file Core.

Derived& Eigen::DenseBase::operator*= ( const Scalar & other ) [inline, inherited]

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> Eigen::ArrayBase::operator+ ( const Scalar & scalar ) const [inline]

Returns:: an expression of the coefficient-wise min of *this and other

Example:

Output:

See also:: max()

Returns:: an expression of the coefficient-wise max of *this and other

Example:

Output:

See also:: min()

Returns:: an expression of the coefficient-wise < operator of *this and other

Example:

Output:

See also:: all(), any(), operator>(), operator<=()

Returns:: an expression of the coefficient-wise <= operator of *this and other

Example:

Output:

See also:: all(), any(), operator>=(), operator<()

Returns:: an expression of the coefficient-wise > operator of *this and other

Example:

Output:

See also:: all(), any(), operator>=(), operator<()

Returns:: an expression of the coefficient-wise >= operator of *this and other

Example:

Output:

See also:: all(), any(), operator>(), operator<=()

Returns:: an expression of the coefficient-wise == operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: all(), any(), isApprox(), isMuchSmallerThan()

Returns:: an expression of the coefficient-wise != operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: all(), any(), isApprox(), isMuchSmallerThan()

Returns:: an expression of *this with each coeff incremented by the constant scalar

Example:

Output:

See also:: operator+=(), operator-()

Definition at line 116 of file Core.

Derived& Eigen::ArrayBase::operator+= ( const Scalar & scalar ) [inline]

Definition at line 139 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase::operator+= ( const ArrayBase< OtherDerived > & other )

replaces *this by *this + other.

Returns:: a reference to *this

Definition at line 204 of file Core.

template<typename OtherDerived >

Derived& Eigen::ArrayBase::operator+= ( const MatrixBase< OtherDerived > & ) [inline, protected]

Definition at line 176 of file Core.

Derived& Eigen::DenseBase::operator+= ( const EigenBase< OtherDerived > & other ) [inherited]

const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::ArrayBase::operator- ( ) const [inline]

Returns:: an expression of the opposite of *this

Definition at line 60 of file Core.

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> Eigen::ArrayBase::operator- ( const Scalar & scalar ) const [inline]

Returns:: an expression of *this with each coeff decremented by the constant scalar

Example:

Output:

See also:: operator+(), operator-=()

Definition at line 135 of file Core.

Derived& Eigen::ArrayBase::operator-= ( const Scalar & scalar ) [inline]

Definition at line 141 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase::operator-= ( const ArrayBase< OtherDerived > & other )

replaces *this by *this - other.

Returns:: a reference to *this

Definition at line 190 of file Core.

template<typename OtherDerived >

Derived& Eigen::ArrayBase::operator-= ( const MatrixBase< OtherDerived > & ) [inline, protected]

Definition at line 179 of file Core.

Derived& Eigen::DenseBase::operator-= ( const EigenBase< OtherDerived > & other ) [inherited]

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::operator/ ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient wise quotient of *this and other

See also:: MatrixBase::cwiseQuotient

Definition at line 19 of file Core.

const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::ArrayBase::operator/ ( const Scalar & scalar ) const [inline]

Returns:: an expression of *this divided by the scalar value scalar

Definition at line 77 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase::operator/= ( const ArrayBase< OtherDerived > & other )

replaces *this by *this / other coefficient wise.

Returns:: a reference to *this

Definition at line 232 of file Core.

Derived& Eigen::DenseBase::operator/= ( const Scalar & other ) [inline, inherited]

CommaInitializer<Derived> Eigen::DenseBase::operator<< ( const Scalar & s ) [inherited]

Convenient operator to set the coefficients of a matrix.

The coefficients must be provided in a row major order and exactly match the size of the matrix. Otherwise an assertion is raised.

Example:

Output:

See also:: CommaInitializer::finished(), class CommaInitializer

CommaInitializer<Derived> Eigen::DenseBase::operator<< ( const DenseBase< OtherDerived > & other ) [inherited]

See also:: operator<<(const Scalar&)

Derived& Eigen::ArrayBase::operator= ( const ArrayBase & other ) [inline]

Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1)

Definition at line 134 of file Core.

template<typename OtherDerived >

const CwiseBinaryOp<internal::scalar_boolean_or_op, const Derived, const OtherDerived> Eigen::ArrayBase::operator|| ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline]

Returns:: an expression of the coefficient-wise || operator of *this and other

Warning:: this operator is for expression of bool only.

Example:

Output:

See also:: operator&&(), select()

Definition at line 175 of file Core.

Index Eigen::DenseBase::outerSize ( ) const [inline, inherited]

Returns:

true if either the number of rows or the number of columns is equal to 1. In other words, this function returns

 rows()==1 || cols()==1

See also:: rows(), cols(), IsVectorAtCompileTime.

Returns:: the outer size.

Note:: For a vector, this returns just 1. For a matrix (non-vector), this is the major dimension with respect to the storage order, i.e., the number of columns for a column-major matrix, and the number of rows for a row-major matrix.

Definition at line 200 of file Core.

const CwiseUnaryOp<internal::scalar_pow_op<Scalar>, const Derived> Eigen::ArrayBase::pow ( const Scalar & exponent ) const [inline]

Returns:: an expression of the coefficient-wise power of *this to the given exponent.

Example:

Output:

See also:: exp(), log()

Definition at line 144 of file Core.

Scalar Eigen::DenseBase::prod ( ) const [inherited]

Returns:: the product of all coefficients of *this

Example:

Output:

See also:: sum(), mean(), trace()

static const CwiseNullaryOp<internal::scalar_random_op<Scalar>,Derived> Eigen::DenseBase::Random	(	Index	rows,
		Index	cols
	)		`[static, inherited]`

Returns:: a random matrix expression

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Random() should be used instead.

Example:

Output:

This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.

See also:: MatrixBase::setRandom(), MatrixBase::Random(Index), MatrixBase::Random()

static const CwiseNullaryOp<internal::scalar_random_op<Scalar>,Derived> Eigen::DenseBase::Random ( Index size ) [static, inherited]

Returns:: a random vector expression

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Random() should be used instead.

Example:

Output:

This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary vector whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.

See also:: MatrixBase::setRandom(), MatrixBase::Random(Index,Index), MatrixBase::Random()

static const CwiseNullaryOp<internal::scalar_random_op<Scalar>,Derived> Eigen::DenseBase::Random ( ) [static, inherited]

Returns:: a fixed-size random matrix or vector expression

This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.

Example:

Output:

This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.

See also:: MatrixBase::setRandom(), MatrixBase::Random(Index,Index), MatrixBase::Random(Index)

RealReturnType Eigen::ArrayBase::real ( ) const [inline]

Returns:: a read-only expression of the real part of *this.

See also:: imag()

Definition at line 126 of file Core.

NonConstRealReturnType Eigen::ArrayBase::real ( ) [inline]

Returns:: a non const expression of the real part of *this.

See also:: imag()

Definition at line 182 of file Core.

internal::result_of<BinaryOp(typename internal::traits<Derived>::Scalar)>::type Eigen::DenseBase::redux ( const BinaryOp & func ) const [inherited]

const Replicate<Derived,RowFactor,ColFactor> Eigen::DenseBase::replicate ( ) const [inherited]

Returns:: an expression of the replication of *this

Example:

Output:

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

const Replicate<Derived,Dynamic,Dynamic> Eigen::DenseBase::replicate	(	Index	rowFacor,
		Index	colFactor
	)		const `[inherited]`

Returns:: an expression of the replication of *this

Example:

Output:

See also:: VectorwiseOp::replicate(), DenseBase::replicate<int,int>(), class Replicate

void Eigen::DenseBase::resize ( Index size ) [inline, inherited]

Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize().

The present method only asserts that the new size equals the old size, and does nothing else.

Definition at line 221 of file Core.

void Eigen::DenseBase::resize	(	Index	rows,
		Index	cols
	)		`[inline, inherited]`

Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize().

The present method only asserts that the new size equals the old size, and does nothing else.

Definition at line 231 of file Core.

ReverseReturnType Eigen::DenseBase::reverse ( ) [inherited]

Returns:: an expression of the reverse of *this.

Example:

Output:

ConstReverseReturnType Eigen::DenseBase::reverse ( ) const [inherited]

This is the const version of reverse().

void Eigen::DenseBase::reverseInPlace ( ) [inherited]

This is the "in place" version of reverse: it reverses *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 features:

less error prone: doing the same operation with .reverse() requires special care:
```
 m = m.reverse().eval(); 
```
this API allows to avoid creating a temporary (the current implementation creates a temporary, but that could be avoided using swap)
it allows future optimizations (cache friendliness, etc.)

See also:: reverse()

ColsBlockXpr Eigen::DenseBase::rightCols ( Index n ) [inline, inherited]

Returns:: a block consisting of the right columns of *this.

Parameters:

n	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 452 of file Core.

ConstColsBlockXpr Eigen::DenseBase::rightCols ( Index n ) const [inline, inherited]

This is the const version of rightCols(Index).

Definition at line 458 of file Core.

NColsBlockXpr<N>::Type Eigen::DenseBase::rightCols ( ) [inline, inherited]

Returns:: a block consisting of the right columns of *this.

Template Parameters:

N	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 473 of file Core.

ConstNColsBlockXpr<N>::Type Eigen::DenseBase::rightCols ( ) const [inline, inherited]

This is the const version of rightCols<int>().

Definition at line 480 of file Core.

RowXpr Eigen::DenseBase::row ( Index i ) [inline, inherited]

Returns:: an expression of the i-th row of *this. Note that the numbering starts at 0.

Example:

Output:

See also:: col(), class Block

Definition at line 585 of file Core.

ConstRowXpr Eigen::DenseBase::row ( Index i ) const [inline, inherited]

This is the const version of row().

Definition at line 591 of file Core.

ConstRowwiseReturnType Eigen::DenseBase::rowwise ( ) const [inherited]

Returns:: a VectorwiseOp wrapper of *this providing additional partial reduction operations

Example:

Output:

See also:: colwise(), class VectorwiseOp

RowwiseReturnType Eigen::DenseBase::rowwise ( ) [inherited]

Returns:: a writable VectorwiseOp wrapper of *this providing additional partial reduction operations

See also:: colwise(), class VectorwiseOp

SegmentReturnType Eigen::DenseBase::segment	(	Index	start,
		Index	size
	)		`[inherited]`

Returns:: a dynamic-size expression of a segment (i.e. a vector block) in *this.

Parameters:

start	the first coefficient in the segment
size	the number of coefficients in the segment

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, segment(Index)

DenseBase::ConstSegmentReturnType Eigen::DenseBase::segment	(	Index	start,
		Index	size
	)		const `[inherited]`

This is the const version of segment(Index,Index).

FixedSegmentReturnType<Size>::Type Eigen::DenseBase::segment ( Index start ) [inherited]

Returns:: a fixed-size expression of a segment (i.e. a vector block) in *this

The template parameter Size is the number of coefficients in the block

Parameters:

start the index of the first element of the sub-vector

Example:

Output:

See also:: class Block

ConstFixedSegmentReturnType<Size>::Type Eigen::DenseBase::segment ( Index start ) const [inherited]

This is the const version of segment<int>(Index).

const Select<Derived,ThenDerived,ElseDerived> Eigen::DenseBase::select	(	const DenseBase< ThenDerived > &	thenMatrix,
		const DenseBase< ElseDerived > &	elseMatrix
	)		const `[inherited]`

Returns:: a matrix where each coefficient (i,j) is equal to thenMatrix(i,j) if *this(i,j), and elseMatrix(i,j) otherwise.

Example:

Output:

See also:: class Select

const Select<Derived,ThenDerived, typename ThenDerived::ConstantReturnType> Eigen::DenseBase::select	(	const DenseBase< ThenDerived > &	thenMatrix,
		typename ThenDerived::Scalar	elseScalar
	)		const `[inline, inherited]`

Version of DenseBase::select(const DenseBase&, const DenseBase&) with the else expression being a scalar value.

See also:: DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const, class Select

const Select<Derived, typename ElseDerived::ConstantReturnType, ElseDerived > Eigen::DenseBase::select	(	typename ElseDerived::Scalar	thenScalar,
		const DenseBase< ElseDerived > &	elseMatrix
	)		const `[inline, inherited]`

Version of DenseBase::select(const DenseBase&, const DenseBase&) with the then expression being a scalar value.

See also:: DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const, class Select

Derived& Eigen::DenseBase::setConstant ( const Scalar & value ) [inherited]

Sets all coefficients in this expression to value.

See also:: fill(), setConstant(Index,const Scalar&), setConstant(Index,Index,const Scalar&), setZero(), setOnes(), Constant(), class CwiseNullaryOp, setZero(), setOnes()

Derived& Eigen::DenseBase::setLinSpaced	(	Index	size,
		const Scalar &	low,
		const Scalar &	high
	)		`[inherited]`

Sets a linearly space vector.

The function generates 'size' equally spaced values in the closed interval [low,high].

Example:

Output:

See also:: CwiseNullaryOp

Derived& Eigen::DenseBase::setLinSpaced	(	const Scalar &	low,
		const Scalar &	high
	)		`[inherited]`

Derived& Eigen::DenseBase::setOnes ( ) [inherited]

Sets all coefficients in this expression to one.

Example:

Output:

See also:: class CwiseNullaryOp, Ones()

Derived& Eigen::DenseBase::setRandom ( ) [inherited]

Sets all coefficients in this expression to random values.

Example:

Output:

See also:: class CwiseNullaryOp, setRandom(Index), setRandom(Index,Index)

Derived& Eigen::DenseBase::setZero ( ) [inherited]

Sets all coefficients in this expression to zero.

Example:

Output:

See also:: class CwiseNullaryOp, Zero()

const CwiseUnaryOp<internal::scalar_sin_op<Scalar>, const Derived> Eigen::ArrayBase::sin ( ) const [inline]

Returns:: an expression of the coefficient-wise sine of *this.

Example:

Output:

See also:: cos(), asin()

Definition at line 91 of file Core.

const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::ArrayBase::sqrt ( ) const [inline]

Returns:: an expression of the coefficient-wise square root of *this.

Example:

Output:

See also:: pow(), square()

Definition at line 64 of file Core.

const CwiseUnaryOp<internal::scalar_square_op<Scalar>, const Derived> Eigen::ArrayBase::square ( ) const [inline]

Returns:: an expression of the coefficient-wise square of *this.

Example:

Output:

See also:: operator/(), operator*(), abs2()

Definition at line 172 of file Core.

Scalar Eigen::DenseBase::sum ( ) const [inherited]

Returns:: the sum of all coefficients of *this

See also:: trace(), prod(), mean()

void Eigen::DenseBase::swap	(	const DenseBase< OtherDerived > &	other,
		int	= `OtherDerived::ThisConstantIsPrivateInPlainObjectBase`
	)		`[inline, inherited]`

swaps *this with the expression other.

Definition at line 397 of file Core.

void Eigen::DenseBase::swap ( PlainObjectBase< OtherDerived > & other ) [inline, inherited]

swaps *this with the matrix or array other.

Definition at line 407 of file Core.

SegmentReturnType Eigen::DenseBase::tail ( Index size ) [inherited]

Returns:: a dynamic-size expression of the last coefficients of *this.

Parameters:

size	the number of coefficients in the block

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, block(Index,Index)

DenseBase::ConstSegmentReturnType Eigen::DenseBase::tail ( Index size ) const [inherited]

This is the const version of tail(Index).

FixedSegmentReturnType<Size>::Type Eigen::DenseBase::tail ( ) [inherited]

Returns:: a fixed-size expression of the last coefficients of *this.

The template parameter Size is the number of coefficients in the block

Example:

Output:

See also:: class Block

ConstFixedSegmentReturnType<Size>::Type Eigen::DenseBase::tail ( ) const [inherited]

This is the const version of tail<int>.

const CwiseUnaryOp<internal::scalar_tan_op<Scalar>, Derived> Eigen::ArrayBase::tan ( ) const [inline]

Returns:: an expression of the coefficient-wise tan of *this.

Example:

Output:

See also:: cos(), sin()

Definition at line 130 of file Core.

Block<Derived> Eigen::DenseBase::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		`[inline, inherited]`

Returns:: a dynamic-size expression of a top-left corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 140 of file Core.

const Block<const Derived> Eigen::DenseBase::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline, inherited]`

This is the const version of topLeftCorner(Index, Index).

Definition at line 146 of file Core.

Block<Derived, CRows, CCols> Eigen::DenseBase::topLeftCorner ( ) [inline, inherited]

Returns:: an expression of a fixed-size top-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 161 of file Core.

const Block<const Derived, CRows, CCols> Eigen::DenseBase::topLeftCorner ( ) const [inline, inherited]

This is the const version of topLeftCorner<int, int>().

Definition at line 168 of file Core.

Block<Derived> Eigen::DenseBase::topRightCorner	(	Index	cRows,
		Index	cCols
	)		`[inline, inherited]`

Returns:: a dynamic-size expression of a top-right corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 94 of file Core.

const Block<const Derived> Eigen::DenseBase::topRightCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline, inherited]`

This is the const version of topRightCorner(Index, Index).

Definition at line 100 of file Core.

Block<Derived, CRows, CCols> Eigen::DenseBase::topRightCorner ( ) [inline, inherited]

Returns:: an expression of a fixed-size top-right corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 115 of file Core.

const Block<const Derived, CRows, CCols> Eigen::DenseBase::topRightCorner ( ) const [inline, inherited]

This is the const version of topRightCorner<int, int>().

Definition at line 122 of file Core.

RowsBlockXpr Eigen::DenseBase::topRows ( Index n ) [inline, inherited]

Returns:: a block consisting of the top rows of *this.

Parameters:

n	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 274 of file Core.

ConstRowsBlockXpr Eigen::DenseBase::topRows ( Index n ) const [inline, inherited]

This is the const version of topRows(Index).

Definition at line 280 of file Core.

NRowsBlockXpr<N>::Type Eigen::DenseBase::topRows ( ) [inline, inherited]

Returns:: a block consisting of the top rows of *this.

Template Parameters:

N	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 295 of file Core.

ConstNRowsBlockXpr<N>::Type Eigen::DenseBase::topRows ( ) const [inline, inherited]

This is the const version of topRows<int>().

Definition at line 302 of file Core.

Scalar Eigen::DenseBase::trace ( ) const [inherited]

Reimplemented in Eigen::MatrixBase.

Eigen::Transpose<Derived> Eigen::DenseBase::transpose ( ) [inherited]

Returns:: an expression of the transpose of *this.

Example:

Output:

Warning:

If you want to replace a matrix by its own transpose, do NOT do this:

 m = m.transpose(); // bug!!! caused by aliasing effect

Instead, use the transposeInPlace() method:

 m.transposeInPlace();

which gives Eigen good opportunities for optimization, or alternatively you can also do:

 m = m.transpose().eval();

See also:: transposeInPlace(), adjoint()

ConstTransposeReturnType Eigen::DenseBase::transpose ( ) const [inherited]

This is the const version of transpose().

Make sure you read the warning for transpose() !

See also:: transposeInPlace(), adjoint()

void Eigen::DenseBase::transposeInPlace ( ) [inherited]

This is the "in place" version of transpose(): it replaces *this by its own transpose.

Thus, doing

 m.transposeInPlace();

has the same effect on m as doing

 m = m.transpose().eval();

and is faster and also safer because in the latter line of code, forgetting the eval() results in a bug caused by aliasing.

Notice however that this method is only useful if you want to replace a matrix by its own transpose. If you just need the transpose of a matrix, use transpose().

Note:: if the matrix is not square, then *this must be a resizable matrix.

See also:: transpose(), adjoint(), adjointInPlace()

template<typename CustomUnaryOp >

const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::ArrayBase::unaryExpr ( const CustomUnaryOp & func = CustomUnaryOp() ) const [inline]

Apply a unary operator coefficient-wise.

Parameters:

[in] func Functor implementing the unary operator

Template Parameters:

CustomUnaryOp Type of func

Returns:: An expression of a custom coefficient-wise unary operator func of *this

The function ptr_fun() from the C++ standard library can be used to make functors out of normal functions.

Example:

Output:

Genuine functors allow for more possibilities, for instance it may contain a state.

Example:

Output:

See also:: class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 155 of file Core.

template<typename CustomViewOp >

const CwiseUnaryView<CustomViewOp, const Derived> Eigen::ArrayBase::unaryViewExpr ( const CustomViewOp & func = CustomViewOp() ) const [inline]

Returns:: an expression of a custom coefficient-wise unary operator func of *this

The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.

Example:

Output:

See also:: class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 173 of file Core.

CoeffReturnType Eigen::DenseBase::value ( void ) const [inline, inherited]

Returns:: the unique coefficient of a 1x1 expression

Definition at line 447 of file Core.

void Eigen::DenseBase::visit ( Visitor & func ) const [inherited]

Applies the visitor visitor to the whole coefficients of the matrix or vector.

The template parameter Visitor is the type of the visitor and provides the following interface:

 struct MyVisitor {
   // called for the first coefficient
   void init(const Scalar& value, Index i, Index j);
   // called for all other coefficients
   void operator() (const Scalar& value, Index i, Index j);
 };

Note:: compared to one or two for loops, visitors offer automatic unrolling for small fixed size matrix.

See also:: minCoeff(Index*,Index*), maxCoeff(Index*,Index*), DenseBase::redux()

static const ConstantReturnType Eigen::DenseBase::Zero	(	Index	rows,
		Index	cols
	)		`[static, inherited]`

Returns:: an expression of a zero matrix.

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.

Example:

Output:

See also:: Zero(), Zero(Index)

static const ConstantReturnType Eigen::DenseBase::Zero ( Index size ) [static, inherited]

Returns:: an expression of a zero vector.

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.

Example:

Output:

See also:: Zero(), Zero(Index,Index)

static const ConstantReturnType Eigen::DenseBase::Zero ( ) [static, inherited]

Returns:: an expression of a fixed-size zero matrix or vector.

This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.

Example:

Output:

See also:: Zero(Index), Zero(Index,Index)

Friends And Related Function Documentation

const ScalarMultipleReturnType operator*	(	const Scalar &	scalar,
		const StorageBaseType &	matrix
	)		`[friend]`

Definition at line 92 of file Core.

const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> operator*	(	const std::complex< Scalar > &	scalar,
		const StorageBaseType &	matrix
	)		`[friend]`

Definition at line 96 of file Core.

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> operator+	(	const Scalar &	scalar,
		const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &	other
	)		`[friend]`

Definition at line 122 of file Core.

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const Derived> > operator-	(	const Scalar &	scalar,
		const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &	other
	)		`[friend]`

Definition at line 141 of file Core.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation