Eigen::ArrayBase< Derived > Class Template Reference

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

#include <ArrayBase.h>

Inheritance diagram for Eigen::ArrayBase< Derived >:

Classes
struct	CastXpr

Public Types
typedef CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const Derived >	Abs2ReturnType
typedef CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const Derived >	AbsReturnType
typedef CwiseUnaryOp< internal::scalar_acos_op< Scalar >, const Derived >	AcosReturnType
typedef CwiseUnaryOp< internal::scalar_arg_op< Scalar >, const Derived >	ArgReturnType
typedef CwiseUnaryOp< internal::scalar_asin_op< Scalar >, const Derived >	AsinReturnType
typedef CwiseUnaryOp< internal::scalar_atan_op< Scalar >, const Derived >	AtanReturnType
typedef DenseBase< Derived >	Base
typedef CwiseUnaryOp< internal::scalar_boolean_not_op< Scalar >, const Derived >	BooleanNotReturnType
typedef CwiseUnaryOp< internal::scalar_ceil_op< Scalar >, const Derived >	CeilReturnType
typedef Base::CoeffReturnType	CoeffReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const Derived >, const Derived & >::type	ConjugateReturnType
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject >	ConstantReturnType
typedef CwiseUnaryOp< internal::scalar_cosh_op< Scalar >, const Derived >	CoshReturnType
typedef CwiseUnaryOp< internal::scalar_cos_op< Scalar >, const Derived >	CosReturnType
typedef CwiseUnaryOp< internal::scalar_cube_op< Scalar >, const Derived >	CubeReturnType
typedef CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const Derived >	CwiseAbs2ReturnType
typedef CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const Derived >	CwiseAbsReturnType
typedef CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const Derived >	CwiseInverseReturnType
typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, Scalar, internal::cmp_EQ >, const Derived, const ConstantReturnType >	CwiseScalarEqualReturnType
typedef CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const Derived >	CwiseSignReturnType
typedef CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const Derived >	CwiseSqrtReturnType
typedef CwiseUnaryOp< internal::scalar_digamma_op< Scalar >, const Derived >	DigammaReturnType
typedef ArrayBase	Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl
typedef CwiseUnaryOp< internal::scalar_erfc_op< Scalar >, const Derived >	ErfcReturnType
typedef CwiseUnaryOp< internal::scalar_erf_op< Scalar >, const Derived >	ErfReturnType
typedef CwiseUnaryOp< internal::scalar_exp_op< Scalar >, const Derived >	ExpReturnType
typedef CwiseUnaryOp< internal::scalar_floor_op< Scalar >, const Derived >	FloorReturnType
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const Derived >	ImagReturnType
typedef CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const Derived >	InverseReturnType
typedef CwiseUnaryOp< internal::scalar_isfinite_op< Scalar >, const Derived >	IsFiniteReturnType
typedef CwiseUnaryOp< internal::scalar_isinf_op< Scalar >, const Derived >	IsInfReturnType
typedef CwiseUnaryOp< internal::scalar_isnan_op< Scalar >, const Derived >	IsNaNReturnType
typedef CwiseUnaryOp< internal::scalar_lgamma_op< Scalar >, const Derived >	LgammaReturnType
typedef CwiseUnaryOp< internal::scalar_log10_op< Scalar >, const Derived >	Log10ReturnType
typedef CwiseUnaryOp< internal::scalar_log1p_op< Scalar >, const Derived >	Log1pReturnType
typedef CwiseUnaryOp< internal::scalar_log_op< Scalar >, const Derived >	LogReturnType
typedef CwiseUnaryOp< internal::scalar_opposite_op< Scalar >, const Derived >	NegativeReturnType
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, Derived >	NonConstImagReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, Derived >, Derived & >::type	NonConstRealReturnType
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef Base::PlainObject	PlainObject
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const Derived >, const Derived & >::type	RealReturnType
typedef NumTraits< Scalar >::Real	RealScalar
typedef CwiseUnaryOp< internal::scalar_round_op< Scalar >, const Derived >	RoundReturnType
typedef CwiseUnaryOp< internal::scalar_rsqrt_op< Scalar >, const Derived >	RsqrtReturnType
typedef internal::traits< Derived >::Scalar	Scalar
typedef CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const Derived >	SignReturnType
typedef CwiseUnaryOp< internal::scalar_sinh_op< Scalar >, const Derived >	SinhReturnType
typedef CwiseUnaryOp< internal::scalar_sin_op< Scalar >, const Derived >	SinReturnType
typedef CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const Derived >	SqrtReturnType
typedef CwiseUnaryOp< internal::scalar_square_op< Scalar >, const Derived >	SquareReturnType
typedef ArrayBase	StorageBaseType
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef CwiseUnaryOp< internal::scalar_tanh_op< Scalar >, const Derived >	TanhReturnType
typedef CwiseUnaryOp< internal::scalar_tan_op< Scalar >, const Derived >	TanReturnType
Public Types inherited from Eigen::DenseBase< Derived >
enum	{   RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime,   MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime, Flags = internal::traits<Derived>::Flags,   IsRowMajor = int(Flags) & RowMajorBit, InnerSizeAtCompileTime, InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret, OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret }
enum	{ IsPlainObjectBase = 0 }
typedef DenseCoeffsBase< Derived >	Base
typedef Block< Derived >	BlockXpr
typedef Base::CoeffReturnType	CoeffReturnType
typedef Block< Derived, internal::traits< Derived >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ColsBlockXpr
typedef VectorwiseOp< Derived, Vertical >	ColwiseReturnType
typedef Block< Derived, internal::traits< Derived >::RowsAtCompileTime, 1,!IsRowMajor >	ColXpr
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject >	ConstantReturnType
typedef const Block< const Derived >	ConstBlockXpr
typedef const Block< const Derived, internal::traits< Derived >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ConstColsBlockXpr
typedef const VectorwiseOp< const Derived, Vertical >	ConstColwiseReturnType
typedef const Block< const Derived, internal::traits< Derived >::RowsAtCompileTime, 1,!IsRowMajor >	ConstColXpr
typedef const Reverse< const Derived, BothDirections >	ConstReverseReturnType
typedef const Block< const Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr
typedef const VectorwiseOp< const Derived, Horizontal >	ConstRowwiseReturnType
typedef const Block< const Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr
typedef const VectorBlock< const Derived >	ConstSegmentReturnType
typedef internal::add_const< Transpose< const Derived > >::type	ConstTransposeReturnType
typedef Matrix< typename NumTraits< typename internal::traits< Derived >::Scalar >::Real, internal::traits< Derived >::ColsAtCompileTime, 1 >	EigenvaluesReturnType
typedef internal::add_const_on_value_type< typename internal::eval< Derived >::type >::type	EvalReturnType
typedef Eigen::InnerIterator< Derived >	InnerIterator
typedef internal::find_best_packet< Scalar, SizeAtCompileTime >::type	PacketScalar
typedef Array< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime >	PlainArray
typedef Matrix< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime >	PlainMatrix
typedef internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type	PlainObject
	The plain matrix or array type corresponding to this expression. More...
typedef CwiseNullaryOp< internal::linspaced_op< Scalar, PacketScalar >, PlainObject >	RandomAccessLinSpacedReturnType
typedef CwiseNullaryOp< internal::scalar_random_op< Scalar >, PlainObject >	RandomReturnType
typedef NumTraits< Scalar >::Real	RealScalar
typedef Reverse< Derived, BothDirections >	ReverseReturnType
typedef Block< Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr
typedef VectorwiseOp< Derived, Horizontal >	RowwiseReturnType
typedef Block< Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	RowXpr
typedef internal::traits< Derived >::Scalar	Scalar
typedef VectorBlock< Derived >	SegmentReturnType
typedef CwiseNullaryOp< internal::linspaced_op< Scalar, PacketScalar >, PlainObject >	SequentialLinSpacedReturnType
typedef internal::traits< Derived >::StorageIndex	StorageIndex
	The type used to store indices. More...
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef Transpose< Derived >	TransposeReturnType
typedef Scalar	value_type

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const AbsReturnType	abs () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Abs2ReturnType	abs2 () const
EIGEN_DEVICE_FUNC const AcosReturnType	acos () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ArgReturnType	arg () const
EIGEN_DEVICE_FUNC ArrayBase< Derived > &	array ()
EIGEN_DEVICE_FUNC const ArrayBase< Derived > &	array () const
EIGEN_DEVICE_FUNC const AsinReturnType	asin () const
EIGEN_DEVICE_FUNC const AtanReturnType	atan () const
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_DEVICE_FUNC 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 NewType >
EIGEN_DEVICE_FUNC CastXpr< NewType >::Type	cast () const
EIGEN_DEVICE_FUNC const CeilReturnType	ceil () const
EIGEN_DEVICE_FUNC ConjugateReturnType	conjugate () const
EIGEN_DEVICE_FUNC const CosReturnType	cos () const
EIGEN_DEVICE_FUNC const CoshReturnType	cosh () const
EIGEN_DEVICE_FUNC const CubeReturnType	cube () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType	cwiseAbs () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType	cwiseAbs2 () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	CwiseBinaryOp (min)(const Scalar &other) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	CwiseBinaryOp (max)(const Scalar &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< std::equal_to< Scalar >, const Derived, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const
EIGEN_DEVICE_FUNC const CwiseInverseReturnType	cwiseInverse () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const ConstantReturnType >	cwiseMax (const Scalar &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const ConstantReturnType >	cwiseMin (const Scalar &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const Derived, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC const CwiseSignReturnType	cwiseSign () const
EIGEN_DEVICE_FUNC const CwiseSqrtReturnType	cwiseSqrt () const
EIGEN_DEVICE_FUNC const DigammaReturnType	digamma () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	EIGEN_CWISE_BINARY_RETURN_TYPE (Derived, OtherDerived, product) operator*(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	EIGEN_CWISE_BINARY_RETURN_TYPE (Derived, OtherDerived, product) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC const ErfReturnType	erf () const
EIGEN_DEVICE_FUNC const ErfcReturnType	erfc () const
EIGEN_DEVICE_FUNC const ExpReturnType	exp () const
EIGEN_DEVICE_FUNC const FloorReturnType	floor () const
EIGEN_DEVICE_FUNC const ImagReturnType	imag () const
EIGEN_DEVICE_FUNC NonConstImagReturnType	imag ()
EIGEN_DEVICE_FUNC const InverseReturnType	inverse () const
EIGEN_DEVICE_FUNC const IsFiniteReturnType	isFinite () const
EIGEN_DEVICE_FUNC const IsInfReturnType	isInf () const
EIGEN_DEVICE_FUNC const IsNaNReturnType	isNaN () const
EIGEN_DEVICE_FUNC const LgammaReturnType	lgamma () const
EIGEN_DEVICE_FUNC const LogReturnType	log () const
EIGEN_DEVICE_FUNC const Log10ReturnType	log10 () const
EIGEN_DEVICE_FUNC const Log1pReturnType	log1p () const
EIGEN_DEVICE_FUNC MatrixWrapper< Derived >	matrix ()
EIGEN_DEVICE_FUNC const MatrixWrapper< const Derived >	matrix () const
EIGEN_DEVICE_FUNC const BooleanNotReturnType	operator! () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_and_op, const Derived, const OtherDerived >	operator&& (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator*= (const ArrayBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator+= (const Scalar &scalar)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator+= (const ArrayBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC const NegativeReturnType	operator- () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator-= (const Scalar &scalar)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator-= (const ArrayBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, typename OtherDerived::Scalar >, const Derived, const OtherDerived >	operator/ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator/= (const ArrayBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const ArrayBase &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const Scalar &value)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_xor_op, const Derived, const OtherDerived >	operator^ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_or_op, const Derived, const OtherDerived >	operator|| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC RealReturnType	real () const
EIGEN_DEVICE_FUNC NonConstRealReturnType	real ()
EIGEN_DEVICE_FUNC const RoundReturnType	round () const
EIGEN_DEVICE_FUNC const RsqrtReturnType	rsqrt () const
EIGEN_DEVICE_FUNC const SignReturnType	sign () const
EIGEN_DEVICE_FUNC const SinReturnType	sin () const
EIGEN_DEVICE_FUNC const SinhReturnType	sinh () const
EIGEN_DEVICE_FUNC const SqrtReturnType	sqrt () const
EIGEN_DEVICE_FUNC const SquareReturnType	square () const
EIGEN_DEVICE_FUNC const TanReturnType	tan () const
EIGEN_DEVICE_FUNC const TanhReturnType	tanh () const
template<typename CustomUnaryOp >
EIGEN_DEVICE_FUNC const CwiseUnaryOp< CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...
template<typename CustomViewOp >
EIGEN_DEVICE_FUNC const CwiseUnaryView< CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
template<typename DerivedQ >
const CwiseBinaryOp< internal::scalar_zeta_op< Scalar >, const Derived, const DerivedQ >	zeta (const EIGEN_CURRENT_STORAGE_BASE_CLASS< DerivedQ > &q) const
Public Member Functions inherited from Eigen::DenseBase< Derived >
EIGEN_DEVICE_FUNC bool	all () const
bool	allFinite () const
EIGEN_DEVICE_FUNC bool	any () const
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). */. More...
template<int NRows, int NCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol)
template<int NRows, int NCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). */. More...
template<int NRows, int NCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
template<int NRows, int NCols>
const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index). More...
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	bottomLeftCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index). More...
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	bottomRightCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index). More...
EIGEN_DEVICE_FUNC RowsBlockXpr	bottomRows (Index n)
EIGEN_DEVICE_FUNC ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index). More...
template<int N>
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	bottomRows (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>(). More...
EIGEN_DEVICE_FUNC ColXpr	col (Index i)
EIGEN_DEVICE_FUNC ConstColXpr	col (Index i) const
	This is the const version of col(). More...
EIGEN_DEVICE_FUNC ConstColwiseReturnType	colwise () const
EIGEN_DEVICE_FUNC ColwiseReturnType	colwise ()
EIGEN_DEVICE_FUNC Index	count () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType	eval () const
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &) const
EIGEN_DEVICE_FUNC void	fill (const Scalar &value)
template<unsigned int Added, unsigned int Removed>
EIGEN_DEPRECATED const Derived &	flagged () const
EIGEN_DEVICE_FUNC const ForceAlignedAccess< Derived >	forceAlignedAccess () const
EIGEN_DEVICE_FUNC ForceAlignedAccess< Derived >	forceAlignedAccess ()
template<bool Enable>
EIGEN_DEVICE_FUNC const internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type	forceAlignedAccessIf () const
template<bool Enable>
EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type	forceAlignedAccessIf ()
const WithFormat< Derived >	format (const IOFormat &fmt) const
bool	hasNaN () const
EIGEN_DEVICE_FUNC SegmentReturnType	head (Index n)
EIGEN_DEVICE_FUNC ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index). More...
template<int N>
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type	head (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>(). More...
EIGEN_DEVICE_FUNC Index	innerSize () const
template<typename OtherDerived >
bool	isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC bool	isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename Derived >
bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const
template<typename OtherDerived >
bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec) const
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC ColsBlockXpr	leftCols (Index n)
EIGEN_DEVICE_FUNC ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index). More...
template<int N>
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	leftCols (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>(). More...
template<int p>
RealScalar	lpNorm () const
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff () const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType *index) const
EIGEN_DEVICE_FUNC Scalar	mean () const
EIGEN_DEVICE_FUNC ColsBlockXpr	middleCols (Index startCol, Index numCols)
EIGEN_DEVICE_FUNC ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index). More...
template<int N>
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>(). More...
EIGEN_DEVICE_FUNC RowsBlockXpr	middleRows (Index startRow, Index n)
EIGEN_DEVICE_FUNC ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
	This is the const version of middleRows(Index,Index). More...
template<int N>
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>(). More...
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff () const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const
EIGEN_DEVICE_FUNC const NestByValue< Derived >	nestByValue () const
EIGEN_DEVICE_FUNC Index	nonZeros () const
template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (const CustomNullaryOp &func)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator*= (const Scalar &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator+= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator-= (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator/= (const Scalar &other)
template<typename OtherDerived >
CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const Scalar &s)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator= (const ReturnByValue< OtherDerived > &func)
EIGEN_DEVICE_FUNC Index	outerSize () const
EIGEN_DEVICE_FUNC Scalar	prod () const
template<typename Func >
EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar	redux (const Func &func) const
template<typename BinaryOp >
EIGEN_DEVICE_FUNC Scalar	redux (const BinaryOp &func) const
template<int RowFactor, int ColFactor>
const Replicate< Derived, RowFactor, ColFactor >	replicate () const
template<int RowFactor, int ColFactor>
EIGEN_DEVICE_FUNC const Replicate< Derived, RowFactor, ColFactor >	replicate () const
EIGEN_DEVICE_FUNC const Replicate< Derived, Dynamic, Dynamic >	replicate (Index rowFactor, Index colFactor) const
EIGEN_DEVICE_FUNC void	resize (Index newSize)
EIGEN_DEVICE_FUNC void	resize (Index rows, Index cols)
EIGEN_DEVICE_FUNC ReverseReturnType	reverse ()
EIGEN_DEVICE_FUNC ConstReverseReturnType	reverse () const
EIGEN_DEVICE_FUNC void	reverseInPlace ()
EIGEN_DEVICE_FUNC ColsBlockXpr	rightCols (Index n)
EIGEN_DEVICE_FUNC ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index). More...
template<int N>
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	rightCols (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>(). More...
EIGEN_DEVICE_FUNC RowXpr	row (Index i)
EIGEN_DEVICE_FUNC ConstRowXpr	row (Index i) const
	This is the const version of row(). */. More...
EIGEN_DEVICE_FUNC ConstRowwiseReturnType	rowwise () const
EIGEN_DEVICE_FUNC RowwiseReturnType	rowwise ()
EIGEN_DEVICE_FUNC SegmentReturnType	segment (Index start, Index n)
EIGEN_DEVICE_FUNC ConstSegmentReturnType	segment (Index start, Index n) const
	This is the const version of segment(Index,Index). More...
template<int N>
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index). More...
template<typename ThenDerived , typename ElseDerived >
const Select< Derived, ThenDerived, ElseDerived >	select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
template<typename ThenDerived >
const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType >	select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const
template<typename ElseDerived >
const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived >	select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
EIGEN_DEVICE_FUNC Derived &	setConstant (const Scalar &value)
EIGEN_DEVICE_FUNC Derived &	setLinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
EIGEN_DEVICE_FUNC Derived &	setLinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
EIGEN_DEVICE_FUNC Derived &	setOnes ()
EIGEN_DEVICE_FUNC Derived &	setRandom ()
EIGEN_DEVICE_FUNC Derived &	setZero ()
EIGEN_DEVICE_FUNC Scalar	sum () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC void	swap (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC void	swap (PlainObjectBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC SegmentReturnType	tail (Index n)
EIGEN_DEVICE_FUNC ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index). More...
template<int N>
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type	tail (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>. More...
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	topLeftCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index). More...
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr	topRightCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index). More...
EIGEN_DEVICE_FUNC RowsBlockXpr	topRows (Index n)
EIGEN_DEVICE_FUNC ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index). More...
template<int N>
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	topRows (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>(). More...
EIGEN_DEVICE_FUNC Scalar	trace () const
EIGEN_DEVICE_FUNC TransposeReturnType	transpose ()
EIGEN_DEVICE_FUNC ConstTransposeReturnType	transpose () const
EIGEN_DEVICE_FUNC void	transposeInPlace ()
EIGEN_DEVICE_FUNC CoeffReturnType	value () const
template<typename Visitor >
EIGEN_DEVICE_FUNC void	visit (Visitor &func) const

Protected Member Functions
EIGEN_DEVICE_FUNC	ArrayBase ()
template<typename OtherDerived >
Derived &	operator+= (const MatrixBase< OtherDerived > &)
template<typename OtherDerived >
Derived &	operator-= (const MatrixBase< OtherDerived > &)
Protected Member Functions inherited from Eigen::DenseBase< Derived >
EIGEN_DEVICE_FUNC	DenseBase ()

Private Member Functions
	ArrayBase (Index)
	ArrayBase (Index, Index)
template<typename OtherDerived >
	ArrayBase (const ArrayBase< OtherDerived > &)

Related Functions
(Note that these are not member functions.)
template<typename Derived , typename ScalarExponent >
internal::enable_if< !(internal::is_same< typename Derived::Scalar, ScalarExponent >::value)&&EIGEN_SCALAR_BINARY_SUPPORTED(pow, typename Derived::Scalar, ScalarExponent), const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(Derived, ScalarExponent, pow) >::type	pow (const Eigen::ArrayBase< Derived > &x, const ScalarExponent &exponent)
template<typename Derived , typename ExponentDerived >
const Eigen::CwiseBinaryOp< Eigen::internal::scalar_pow_op< typename Derived::Scalar, typename ExponentDerived::Scalar >, const Derived, const ExponentDerived >	pow (const Eigen::ArrayBase< Derived > &x, const Eigen::ArrayBase< ExponentDerived > &exponents)
template<typename Scalar , typename Derived >
internal::enable_if< !(internal::is_same< typename Derived::Scalar, Scalar >::value)&&EIGEN_SCALAR_BINARY_SUPPORTED(pow, Scalar, typename Derived::Scalar), const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(Scalar, Derived, pow) >::type	pow (const Scalar &x, const Eigen::ArrayBase< Derived > &exponents)
Related Functions inherited from Eigen::DenseBase< Derived >
template<typename Derived >
std::ostream &	operator<< (std::ostream &s, const DenseBase< Derived > &m)

Additional Inherited Members
Static Public Member Functions inherited from Eigen::DenseBase< Derived >
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (Index size, const Scalar &value)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (const Scalar &value)
static EIGEN_DEVICE_FUNC const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
static EIGEN_DEVICE_FUNC const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (const CustomNullaryOp &func)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones (Index rows, Index cols)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones (Index size)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones ()
static const RandomReturnType	Random (Index rows, Index cols)
static const RandomReturnType	Random (Index size)
static const RandomReturnType	Random ()
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero (Index rows, Index cols)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero (Index size)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero ()

Detailed Description

template<typename Derived>
class Eigen::ArrayBase< Derived >

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 Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN.

See also

class MatrixBase, The class hierarchy

Definition at line 39 of file ArrayBase.h.

Member Typedef Documentation

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::Abs2ReturnType

Definition at line 6 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::AbsReturnType

Definition at line 4 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_acos_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::AcosReturnType

Definition at line 20 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_arg_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ArgReturnType

Definition at line 5 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_asin_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::AsinReturnType

Definition at line 21 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_atan_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::AtanReturnType

Definition at line 22 of file ArrayBase.h.

template<typename Derived>

typedef DenseBase<Derived> Eigen::ArrayBase< Derived >::Base

Definition at line 54 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_boolean_not_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::BooleanNotReturnType

Definition at line 11 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_ceil_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CeilReturnType

Definition at line 30 of file ArrayBase.h.

template<typename Derived>

typedef Base::CoeffReturnType Eigen::ArrayBase< Derived >::CoeffReturnType

Definition at line 78 of file ArrayBase.h.

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived& >::type Eigen::ArrayBase< Derived >::ConjugateReturnType

Definition at line 20 of file ArrayBase.h.

template<typename Derived>

typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,PlainObject> Eigen::ArrayBase< Derived >::ConstantReturnType

Definition at line 86 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_cosh_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CoshReturnType

Definition at line 25 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_cos_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CosReturnType

Definition at line 17 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_cube_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CubeReturnType

Definition at line 27 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CwiseAbs2ReturnType

Definition at line 17 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CwiseAbsReturnType

Definition at line 16 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CwiseInverseReturnType

Definition at line 20 of file ArrayBase.h.

template<typename Derived>

typedef CwiseBinaryOp<internal::scalar_cmp_op<Scalar,Scalar,internal::cmp_EQ>, const Derived, const ConstantReturnType> Eigen::ArrayBase< Derived >::CwiseScalarEqualReturnType

Definition at line 137 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sign_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CwiseSignReturnType

Definition at line 19 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::CwiseSqrtReturnType

Definition at line 18 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_digamma_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::DigammaReturnType

Definition at line 472 of file ArrayBase.h.

template<typename Derived>

typedef ArrayBase Eigen::ArrayBase< Derived >::Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl

Definition at line 47 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_erfc_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ErfcReturnType

Definition at line 474 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_erf_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ErfReturnType

Definition at line 473 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_exp_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ExpReturnType

Definition at line 13 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_floor_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::FloorReturnType

Definition at line 29 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ImagReturnType

Definition at line 32 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::InverseReturnType

Definition at line 10 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_isfinite_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::IsFiniteReturnType

Definition at line 33 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_isinf_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::IsInfReturnType

Definition at line 32 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_isnan_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::IsNaNReturnType

Definition at line 31 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_lgamma_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::LgammaReturnType

Definition at line 471 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_log10_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::Log10ReturnType

Definition at line 16 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_log1p_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::Log1pReturnType

Definition at line 15 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_log_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::LogReturnType

Definition at line 14 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::NegativeReturnType

Definition at line 36 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> Eigen::ArrayBase< Derived >::NonConstImagReturnType

Definition at line 34 of file ArrayBase.h.

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>, Derived& >::type Eigen::ArrayBase< Derived >::NonConstRealReturnType

Definition at line 30 of file ArrayBase.h.

template<typename Derived>

typedef internal::packet_traits<Scalar>::type Eigen::ArrayBase< Derived >::PacketScalar

Definition at line 51 of file ArrayBase.h.

template<typename Derived>

typedef Base::PlainObject Eigen::ArrayBase< Derived >::PlainObject

Definition at line 83 of file ArrayBase.h.

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived& >::type Eigen::ArrayBase< Derived >::RealReturnType

Definition at line 25 of file ArrayBase.h.

template<typename Derived>

typedef NumTraits<Scalar>::Real Eigen::ArrayBase< Derived >::RealScalar

Definition at line 52 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_round_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::RoundReturnType

Definition at line 28 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_rsqrt_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::RsqrtReturnType

Definition at line 8 of file ArrayBase.h.

template<typename Derived>

typedef internal::traits<Derived>::Scalar Eigen::ArrayBase< Derived >::Scalar

Definition at line 50 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sign_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::SignReturnType

Definition at line 9 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sinh_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::SinhReturnType

Definition at line 24 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sin_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::SinReturnType

Definition at line 18 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::SqrtReturnType

Definition at line 7 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_square_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::SquareReturnType

Definition at line 26 of file ArrayBase.h.

template<typename Derived>

typedef ArrayBase Eigen::ArrayBase< Derived >::StorageBaseType

The base class for a given storage type.

Definition at line 45 of file ArrayBase.h.

template<typename Derived>

typedef internal::traits<Derived>::StorageKind Eigen::ArrayBase< Derived >::StorageKind

Definition at line 49 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_tanh_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::TanhReturnType

Definition at line 23 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_tan_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::TanReturnType

Definition at line 19 of file ArrayBase.h.

Constructor & Destructor Documentation

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::ArrayBase< Derived >::ArrayBase ( )

inlineprotected

Definition at line 157 of file ArrayBase.h.

template<typename Derived>

Eigen::ArrayBase< Derived >::ArrayBase ( Index  )

explicitprivate

template<typename Derived>

Eigen::ArrayBase< Derived >::ArrayBase ( Index  , Index    )

private

template<typename Derived>

template<typename OtherDerived >

Eigen::ArrayBase< Derived >::ArrayBase ( const ArrayBase< OtherDerived > &  )

explicitprivate

Member Function Documentation

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const AbsReturnType Eigen::ArrayBase< Derived >::abs ( ) const

inline

Returns

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

Example:

Array3d v(1,-2,-3);
cout << v.abs() << endl;

Output:

See also

Math functions, abs2()

Definition at line 44 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Abs2ReturnType Eigen::ArrayBase< Derived >::abs2 ( ) const

inline

Returns

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

Example:

Array3d v(1,-2,-3);
cout << v.abs2() << endl;

Output:

See also

Math functions, abs(), square()

Definition at line 72 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const AcosReturnType Eigen::ArrayBase< Derived >::acos ( ) const

inline

Returns

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

Example:

Array3d v(0, sqrt(2.)/2, 1);
cout << v.acos() << endl;

Output:

See also

Math functions, cos(), asin()

Definition at line 263 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ArgReturnType Eigen::ArrayBase< Derived >::arg ( ) const

inline

Returns

an expression of the coefficient-wise phase angle of *this

Example:

ArrayXcf v = ArrayXcf::Random(3);
cout << v << endl << endl;
cout << arg(v) << endl;

Output:

See also

abs()

Definition at line 58 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ArrayBase<Derived>& Eigen::ArrayBase< Derived >::array ( )

inline

Definition at line 141 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ArrayBase<Derived>& Eigen::ArrayBase< Derived >::array ( ) const

inline

Definition at line 143 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const AsinReturnType Eigen::ArrayBase< Derived >::asin ( ) const

inline

Returns

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

Example:

Array3d v(0, sqrt(2.)/2, 1);
cout << v.asin() << endl;

Output:

See also

Math functions, sin(), acos()

Definition at line 277 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const AtanReturnType Eigen::ArrayBase< Derived >::atan ( ) const

inline

Returns

an expression of the coefficient-wise arc tan of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(5,0,1);
cout << v.atan() << endl;

Output:

See also

Math functions, tan(), asin(), acos()

Definition at line 249 of file ArrayBase.h.

template<typename Derived>

template<typename CustomBinaryOp , typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::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:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define a custom template binary functor
template<typename Scalar> struct MakeComplexOp {
  EIGEN_EMPTY_STRUCT_CTOR(MakeComplexOp)
  typedef complex<Scalar> result_type;
  complex<Scalar> operator()(const Scalar& a, const Scalar& b) const { return complex<Scalar>(a,b); }
};

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random(), m2 = Matrix4d::Random();
  cout << m1.binaryExpr(m2, MakeComplexOp<double>()) << endl;
  return 0;
}

Output:

See also

class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 44 of file ArrayBase.h.

template<typename Derived>

template<typename NewType >

EIGEN_DEVICE_FUNC CastXpr<NewType>::Type Eigen::ArrayBase< Derived >::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 63 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CeilReturnType Eigen::ArrayBase< Derived >::ceil ( ) const

inline

Returns

an expression of the coefficient-wise ceil of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(7,-2,2);
cout << v << endl << endl;
cout << ceil(v) << endl;

Output:

See also

Math functions, floor(), round()

Definition at line 403 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConjugateReturnType Eigen::ArrayBase< Derived >::conjugate ( ) const

inline

Returns

an expression of the complex conjugate of *this.

See also

Math functions, MatrixBase::adjoint()

Definition at line 75 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CosReturnType Eigen::ArrayBase< Derived >::cos ( ) const

inline

Returns

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

This function computes the coefficient-wise cosine. The function MatrixBase::cos() in the unsupported module MatrixFunctions computes the matrix cosine.

Example:

Array3d v(M_PI, M_PI/2, M_PI/3);
cout << v.cos() << endl;

Output:

See also

Math functions, sin(), acos()

Definition at line 203 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CoshReturnType Eigen::ArrayBase< Derived >::cosh ( ) const

inline

Returns

an expression of the coefficient-wise hyperbolic cos of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(5,0,1);
cout << cosh(v) << endl;

Output:

See also

Math functions, tan(), sinh(), cosh()

Definition at line 319 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CubeReturnType Eigen::ArrayBase< Derived >::cube ( ) const

inline

Returns

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

Example:

Array3d v(2,3,4);
cout << v.cube() << endl;

Output:

See also

Math functions, square(), pow()

Definition at line 361 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType Eigen::ArrayBase< Derived >::cwiseAbs ( ) const

inline

Returns

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

Example:

MatrixXd m(2,3);
m << 2, -4, 6,   
     -5, 1, 0;
cout << m.cwiseAbs() << endl;

Output:

See also

cwiseAbs2()

Definition at line 33 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType Eigen::ArrayBase< Derived >::cwiseAbs2 ( ) const

inline

Returns

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

Example:

MatrixXd m(2,3);
m << 2, -4, 6,   
     -5, 1, 0;
cout << m.cwiseAbs2() << endl;

Output:

See also

cwiseAbs()

Definition at line 46 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Eigen::ArrayBase< Derived >::CwiseBinaryOp ( min  ) const

inline

Returns

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

Example:

Array3d v(2,3,4), w(4,2,3);
cout << v.min(w) << endl;

Output:

See also

max()

Returns

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

See also

max()

Definition at line 46 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Eigen::ArrayBase< Derived >::CwiseBinaryOp ( max  ) const

inline

Returns

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

Example:

Array3d v(2,3,4), w(4,2,3);
cout << v.max(w) << endl;

Output:

See also

min()

Returns

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

See also

min()

Definition at line 72 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::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:

MatrixXi m(2,2);
m << 1, 0,
     1, 1;
cout << "Comparing m with identity matrix:" << endl;
cout << m.cwiseEqual(MatrixXi::Identity(2,2)) << endl;
Index count = m.cwiseEqual(MatrixXi::Identity(2,2)).count();
cout << "Number of coefficients that are equal: " << count << endl;

Output:

See also

cwiseNotEqual(), isApprox(), isMuchSmallerThan()

Definition at line 44 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType Eigen::ArrayBase< Derived >::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 150 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseInverseReturnType Eigen::ArrayBase< Derived >::cwiseInverse ( ) const

inline

Returns

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

Example:

MatrixXd m(2,3);
m << 2, 0.5, 1,   
     3, 0.25, 1;
cout << m.cwiseInverse() << endl;

Output:

See also

cwiseProduct()

Definition at line 84 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inline

Returns

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

Example:

Vector3d v(2,3,4), w(4,2,3);
cout << v.cwiseMax(w) << endl;

Output:

See also

class CwiseBinaryOp, min()

Definition at line 105 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar,Scalar>, const Derived, const ConstantReturnType> Eigen::ArrayBase< Derived >::cwiseMax ( const Scalar &  other ) const

inline

Returns

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

See also

class CwiseBinaryOp, min()

Definition at line 116 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inline

Returns

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

Example:

Vector3d v(2,3,4), w(4,2,3);
cout << v.cwiseMin(w) << endl;

Output:

See also

class CwiseBinaryOp, max()

Definition at line 79 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar,Scalar>, const Derived, const ConstantReturnType> Eigen::ArrayBase< Derived >::cwiseMin ( const Scalar &  other ) const

inline

Returns

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

See also

class CwiseBinaryOp, min()

Definition at line 90 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::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:

MatrixXi m(2,2);
m << 1, 0,
     1, 1;
cout << "Comparing m with identity matrix:" << endl;
cout << m.cwiseNotEqual(MatrixXi::Identity(2,2)) << endl;
Index count = m.cwiseNotEqual(MatrixXi::Identity(2,2)).count();
cout << "Number of coefficients that are not equal: " << count << endl;

Output:

See also

cwiseEqual(), isApprox(), isMuchSmallerThan()

Definition at line 64 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inline

Returns

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

Example:

Vector3d v(2,3,4), w(4,2,3);
cout << v.cwiseQuotient(w) << endl;

Output:

See also

class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 132 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseSignReturnType Eigen::ArrayBase< Derived >::cwiseSign ( ) const

inline

Returns

an expression of the coefficient-wise signum of *this.

Example:

MatrixXd m(2,3);
m <<  2, -4, 6,
     -5,  1, 0;
cout << m.cwiseSign() << endl;

Output:

Definition at line 70 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseSqrtReturnType Eigen::ArrayBase< Derived >::cwiseSqrt ( ) const

inline

Returns

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

Example:

Vector3d v(1,2,4);
cout << v.cwiseSqrt() << endl;

Output:

See also

cwisePow(), cwiseSquare()

Definition at line 59 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const DigammaReturnType Eigen::ArrayBase< Derived >::digamma ( ) const

inline

Returns

an expression of the coefficient-wise digamma (psi, derivative of lgamma).

Note

This function supports only float and double scalar types. To support other scalar types, the user has to provide implementations of digamma(T) for any scalar type T to be supported.

See also

Math functions, Eigen::digamma(), Eigen::polygamma(), lgamma()

Definition at line 508 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Eigen::ArrayBase< Derived >::EIGEN_CWISE_BINARY_RETURN_TYPE ( Derived  , OtherDerived  , product    ) const

inline

Returns

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

See also

MatrixBase::cwiseProduct

Definition at line 9 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Eigen::ArrayBase< Derived >::EIGEN_CWISE_BINARY_RETURN_TYPE ( Derived  , OtherDerived  , product    ) const

inline

Returns

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

Example:

Matrix3i a = Matrix3i::Random(), b = Matrix3i::Random();
Matrix3i c = a.cwiseProduct(b);
cout << "a:\n" << a << "\nb:\n" << b << "\nc:\n" << c << endl;

Output:

See also

class CwiseBinaryOp, cwiseAbs2

Definition at line 23 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ErfReturnType Eigen::ArrayBase< Derived >::erf ( ) const

inline

Returns

an expression of the coefficient-wise Gauss error function of *this.

Example:

#include <Eigen/Core>
#include <unsupported/Eigen/SpecialFunctions>
#include <iostream>
using namespace Eigen;
int main()
{
  Array4d v(-0.5,2,0,-7);
  std::cout << v.erf() << std::endl;
}

Output:

Note

This function supports only float and double scalar types in c++11 mode. To support other scalar types, or float/double in non c++11 mode, the user has to provide implementations of erf(T) for any scalar type T to be supported.

See also

Math functions, erfc()

Definition at line 529 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ErfcReturnType Eigen::ArrayBase< Derived >::erfc ( ) const

inline

Returns

an expression of the coefficient-wise Complementary error function of *this.

Example:

#include <Eigen/Core>
#include <unsupported/Eigen/SpecialFunctions>
#include <iostream>
using namespace Eigen;
int main()
{
  Array4d v(-0.5,2,0,-7);
  std::cout << v.erfc() << std::endl;
}

Output:

Note

This function supports only float and double scalar types in c++11 mode. To support other scalar types, or float/double in non c++11 mode, the user has to provide implementations of erfc(T) for any scalar type T to be supported.

See also

Math functions, erf()

Definition at line 550 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ExpReturnType Eigen::ArrayBase< Derived >::exp ( ) const

inline

Returns

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

This function computes the coefficient-wise exponential. The function MatrixBase::exp() in the unsupported module MatrixFunctions computes the matrix exponential.

Example:

Array3d v(1,2,3);
cout << v.exp() << endl;

Output:

See also

Math functions, pow(), log(), sin(), cos()

Definition at line 89 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const FloorReturnType Eigen::ArrayBase< Derived >::floor ( ) const

inline

Returns

an expression of the coefficient-wise floor of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(7,-2,2);
cout << v << endl << endl;
cout << floor(v) << endl;

Output:

See also

Math functions, ceil(), round()

Definition at line 389 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ImagReturnType Eigen::ArrayBase< Derived >::imag ( ) const

inline

Returns

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

See also

real()

Definition at line 96 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC NonConstImagReturnType Eigen::ArrayBase< Derived >::imag ( )

inline

Returns

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

See also

real()

Definition at line 164 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const InverseReturnType Eigen::ArrayBase< Derived >::inverse ( ) const

inline

Returns

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

Example:

Array3d v(2,3,4);
cout << v.inverse() << endl;

Output:

See also

operator/(), operator*()

Definition at line 333 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const IsFiniteReturnType Eigen::ArrayBase< Derived >::isFinite ( ) const

inline

Returns

an expression of the coefficient-wise isfinite of *this.

Example:

Array3d v(1,2,3);
v(1) *= 0.0/0.0;
v(2) /= 0.0;
cout << v << endl << endl;
cout << isfinite(v) << endl;

Output:

See also

isnan(), isinf()

Definition at line 445 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const IsInfReturnType Eigen::ArrayBase< Derived >::isInf ( ) const

inline

Returns

an expression of the coefficient-wise isinf of *this.

Example:

Array3d v(1,2,3);
v(1) *= 0.0/0.0;
v(2) /= 0.0;
cout << v << endl << endl;
cout << isinf(v) << endl;

Output:

See also

isnan(), isfinite()

Definition at line 431 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const IsNaNReturnType Eigen::ArrayBase< Derived >::isNaN ( ) const

inline

Returns

an expression of the coefficient-wise isnan of *this.

Example:

Array3d v(1,2,3);
v(1) *= 0.0/0.0;
v(2) /= 0.0;
cout << v << endl << endl;
cout << isnan(v) << endl;

Output:

See also

isfinite(), isinf()

Definition at line 417 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const LgammaReturnType Eigen::ArrayBase< Derived >::lgamma ( ) const

inline

Returns

an expression of the coefficient-wise ln(|gamma(*this)|).

Example:

#include <Eigen/Core>
#include <unsupported/Eigen/SpecialFunctions>
#include <iostream>
using namespace Eigen;
int main()
{
  Array4d v(0.5,10,0,-1);
  std::cout << v.lgamma() << std::endl;
}

Output:

Note

This function supports only float and double scalar types in c++11 mode. To support other scalar types, or float/double in non c++11 mode, the user has to provide implementations of lgamma(T) for any scalar type T to be supported.

See also

Math functions, digamma()

Definition at line 491 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const LogReturnType Eigen::ArrayBase< Derived >::log ( ) const

inline

Returns

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

This function computes the coefficient-wise logarithm. The function MatrixBase::log() in the unsupported module MatrixFunctions computes the matrix logarithm.

Example:

Array3d v(1,2,3);
cout << v.log() << endl;

Output:

See also

Math functions, exp()

Definition at line 106 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const Log10ReturnType Eigen::ArrayBase< Derived >::log10 ( ) const

inline

Returns

an expression of the coefficient-wise base-10 logarithm of *this.

This function computes the coefficient-wise base-10 logarithm.

Example:

Array4d v(-1,0,1,2);
cout << log10(v) << endl;

Output:

See also

Math functions, log()

Definition at line 136 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const Log1pReturnType Eigen::ArrayBase< Derived >::log1p ( ) const

inline

Returns

an expression of the coefficient-wise logarithm of 1 plus *this.

In exact arithmetic, x.log() is equivalent to (x+1).log(), however, with finite precision, this function is much more accurate when x is close to zero.

See also

Math functions, log()

Definition at line 120 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC MatrixWrapper<Derived> Eigen::ArrayBase< Derived >::matrix ( )

inline

Returns

an Matrix expression of this array

See also

MatrixBase::array()

Definition at line 148 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const MatrixWrapper<const Derived> Eigen::ArrayBase< Derived >::matrix ( ) const

inline

Definition at line 150 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const BooleanNotReturnType Eigen::ArrayBase< Derived >::operator! ( ) const

inline

Returns

an expression of the coefficient-wise ! operator of *this

Warning

this operator is for expression of bool only.

Example:

Array3d v(1,2,3);
v(1) *= 0.0/0.0;
v(2) /= 0.0;
cout << v << endl << endl;
cout << !isfinite(v) << endl;

Output:

See also

operator!=()

Definition at line 461 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inline

Returns

an expression of the coefficient-wise boolean and operator of *this and other

Warning

this operator is for expression of bool only.

Example:

Array3d v(-1,2,1), w(-3,2,3);
cout << ((v<w) && (v<0)) << endl;

Output:

See also

operator||(), select()

Definition at line 92 of file ArrayBase.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase< Derived >::operator*=

(

const ArrayBase< OtherDerived > &

other

)

replaces *this by *this * other coefficient wise.

Returns

a reference to *this

Definition at line 205 of file ArrayBase.h.

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase< Derived >::operator+=

(

const Scalar &

scalar

)

Definition at line 25 of file SelfCwiseBinaryOp.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase< Derived >::operator+=

(

const ArrayBase< OtherDerived > &

other

)

replaces *this by *this + other.

Returns

a reference to *this

Definition at line 192 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inlineprotected

Definition at line 165 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const NegativeReturnType Eigen::ArrayBase< Derived >::operator- ( ) const

inline

Returns

an expression of the opposite of *this

Definition at line 46 of file ArrayBase.h.

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase< Derived >::operator-=

(

const Scalar &

scalar

)

Definition at line 32 of file SelfCwiseBinaryOp.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase< Derived >::operator-=

(

const ArrayBase< OtherDerived > &

other

)

replaces *this by *this - other.

Returns

a reference to *this

Definition at line 179 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inlineprotected

Definition at line 168 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar,typename OtherDerived::Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::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 22 of file ArrayBase.h.

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::ArrayBase< Derived >::operator/=

(

const ArrayBase< OtherDerived > &

other

)

replaces *this by *this / other coefficient wise.

Returns

a reference to *this

Definition at line 218 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::ArrayBase< Derived >::operator= ( const ArrayBase< Derived > &  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 107 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::ArrayBase< Derived >::operator= ( const Scalar &  value )

inline

Set all the entries to value.

See also

DenseBase::setConstant(), DenseBase::fill()

Definition at line 116 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<internal::scalar_boolean_xor_op, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator^ ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &  other ) const

inline

Returns

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

Example:

Array3d v(1,2,3), w(3,2,1);
cout << (v<w) << endl;

Output:

See also

all(), any(), operator>(), operator<=()

Returns

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

Example:

Array3d v(1,2,3), w(3,2,1);
cout << (v<=w) << endl;

Output:

See also

all(), any(), operator>=(), operator<()

Returns

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

Example:

Array3d v(1,2,3), w(3,2,1);
cout << (v>w) << endl;

Output:

See also

all(), any(), operator>=(), operator<()

Returns

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

Example:

Array3d v(1,2,3), w(3,2,1);
cout << (v>=w) << endl;

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:

Array3d v(1,2,3), w(3,2,1);
cout << (v==w) << endl;

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:

Array3d v(1,2,3), w(3,2,1);
cout << (v!=w) << endl;

Output:

See also

all(), any(), isApprox(), isMuchSmallerThan()

Returns

an expression of the coefficient-wise ^ operator of *this and other

Warning

this operator is for expression of bool only.

Example:

Array3d v(-1,2,1), w(-3,2,3);
cout << ((v<w) ^ (v<0)) << endl;

Output:

See also

operator&&(), select()

Definition at line 285 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

inline

Returns

an expression of the coefficient-wise boolean or operator of *this and other

Warning

this operator is for expression of bool only.

Example:

Array3d v(-1,2,1), w(-3,2,3);
cout << ((v<w) || (v<0)) << endl;

Output:

See also

operator&&(), select()

Definition at line 111 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC RealReturnType Eigen::ArrayBase< Derived >::real ( ) const

inline

Returns

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

See also

imag()

Definition at line 87 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC NonConstRealReturnType Eigen::ArrayBase< Derived >::real ( )

inline

Returns

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

See also

imag()

Definition at line 155 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const RoundReturnType Eigen::ArrayBase< Derived >::round ( ) const

inline

Returns

an expression of the coefficient-wise round of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(7,-2,2);
cout << v << endl << endl;
cout << round(v) << endl;

Output:

See also

Math functions, ceil(), floor()

Definition at line 375 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const RsqrtReturnType Eigen::ArrayBase< Derived >::rsqrt ( ) const

inline

Returns

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

This function computes the coefficient-wise inverse square root.

Example:

Array3d v(1,2,4);
cout << v.sqrt() << endl;

Output:

See also

pow(), square()

Definition at line 169 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const SignReturnType Eigen::ArrayBase< Derived >::sign ( ) const

inline

Returns

an expression of the coefficient-wise signum of *this.

This function computes the coefficient-wise signum.

Example:

Array3d v(-3,5,0);
cout << v.sign() << endl;

Output:

See also

pow(), square()

Definition at line 185 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const SinReturnType Eigen::ArrayBase< Derived >::sin ( ) const

inline

Returns

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

This function computes the coefficient-wise sine. The function MatrixBase::sin() in the unsupported module MatrixFunctions computes the matrix sine.

Example:

Array3d v(M_PI, M_PI/2, M_PI/3);
cout << v.sin() << endl;

Output:

See also

Math functions, cos(), asin()

Definition at line 221 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const SinhReturnType Eigen::ArrayBase< Derived >::sinh ( ) const

inline

Returns

an expression of the coefficient-wise hyperbolic sin of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(5,0,1);
cout << sinh(v) << endl;

Output:

See also

Math functions, sin(), tanh(), cosh()

Definition at line 305 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const SqrtReturnType Eigen::ArrayBase< Derived >::sqrt ( ) const

inline

Returns

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

This function computes the coefficient-wise square root. The function MatrixBase::sqrt() in the unsupported module MatrixFunctions computes the matrix square root.

Example:

Array3d v(1,2,4);
cout << v.sqrt() << endl;

Output:

See also

Math functions, pow(), square()

Definition at line 153 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const SquareReturnType Eigen::ArrayBase< Derived >::square ( ) const

inline

Returns

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

Example:

Array3d v(2,3,4);
cout << v.square() << endl;

Output:

See also

Math functions, abs2(), cube(), pow()

Definition at line 347 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const TanReturnType Eigen::ArrayBase< Derived >::tan ( ) const

inline

Returns

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

Example:

Array3d v(M_PI, M_PI/2, M_PI/3);
cout << v.tan() << endl;

Output:

See also

Math functions, cos(), sin()

Definition at line 235 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const TanhReturnType Eigen::ArrayBase< Derived >::tanh ( ) const

inline

Returns

an expression of the coefficient-wise hyperbolic tan of *this.

Example:

ArrayXd v = ArrayXd::LinSpaced(5,0,1);
cout << tanh(v) << endl;

Output:

See also

Math functions, tan(), sinh(), cosh()

Definition at line 291 of file ArrayBase.h.

template<typename Derived>

template<typename CustomUnaryOp >

EIGEN_DEVICE_FUNC const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::ArrayBase< Derived >::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:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define function to be applied coefficient-wise
double ramp(double x)
{
  if (x > 0)
    return x;
  else 
    return 0;
}

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random();
  cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(ptr_fun(ramp)) << endl;
  return 0;
}

Output:

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

Example:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define a custom template unary functor
template<typename Scalar>
struct CwiseClampOp {
  CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {}
  const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); }
  Scalar m_inf, m_sup;
};

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random();
  cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(CwiseClampOp<double>(-0.5,0.5)) << endl;
  return 0;
}

Output:

See also

unaryViewExpr, binaryExpr, class CwiseUnaryOp

Definition at line 122 of file ArrayBase.h.

template<typename Derived>

template<typename CustomViewOp >

EIGEN_DEVICE_FUNC const CwiseUnaryView<CustomViewOp, const Derived> Eigen::ArrayBase< Derived >::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:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define a custom template unary functor
template<typename Scalar>
struct CwiseClampOp {
  CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {}
  const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); }
  Scalar m_inf, m_sup;
};

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random();
  cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(CwiseClampOp<double>(-0.5,0.5)) << endl;
  return 0;
}

Output:

See also

unaryExpr, binaryExpr class CwiseUnaryOp

Definition at line 143 of file ArrayBase.h.

template<typename Derived>

template<typename DerivedQ >

const CwiseBinaryOp<internal::scalar_zeta_op<Scalar>, const Derived, const DerivedQ> Eigen::ArrayBase< Derived >::zeta ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< DerivedQ > &  q ) const

inline

Returns

an expression of the coefficient-wise zeta function.

It returns the Riemann zeta function of two arguments *this and q:

Parameters

*this	is the exposent, it must be > 1
q	is the shift, it must be > 0

Note

This function supports only float and double scalar types. To support other scalar types, the user has to provide implementations of zeta(T,T) for any scalar type T to be supported.

This method is an alias for zeta(*this,q);

See also

Eigen::zeta()

Definition at line 330 of file ArrayBase.h.

Friends And Related Function Documentation

template<typename Derived , typename ScalarExponent >

internal::enable_if< !(internal::is_same< typename Derived::Scalar, ScalarExponent >::value)&&EIGEN_SCALAR_BINARY_SUPPORTED(pow, typename Derived::Scalar, ScalarExponent), const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(Derived, ScalarExponent, pow) >::type pow ( const Eigen::ArrayBase< Derived > &  x, const ScalarExponent &  exponent  )

related

Returns

an expression of the coefficient-wise power of x to the given constant exponent.

Template Parameters

ScalarExponent

is the scalar type of exponent. It must be compatible with the scalar type of the given expression (Derived::Scalar).

See also

ArrayBase::pow()

Definition at line 108 of file GlobalFunctions.h.

template<typename Derived , typename ExponentDerived >

const Eigen::CwiseBinaryOp< Eigen::internal::scalar_pow_op< typename Derived::Scalar, typename ExponentDerived::Scalar >, const Derived, const ExponentDerived > pow ( const Eigen::ArrayBase< Derived > &  x, const Eigen::ArrayBase< ExponentDerived > &  exponents  )

related

Returns

an expression of the coefficient-wise power of x to the given array of exponents.

This function computes the coefficient-wise power.

Example:

Array<double,1,3> x(8,25,3),
                  e(1./3.,0.5,2.);
cout << "[" << x << "]^[" << e << "] = " << x.pow(e) << endl; // using ArrayBase::pow
cout << "[" << x << "]^[" << e << "] = " << pow(x,e) << endl; // using Eigen::pow

Output:

See also

ArrayBase::pow()

Definition at line 132 of file GlobalFunctions.h.

template<typename Scalar , typename Derived >

internal::enable_if< !(internal::is_same< typename Derived::Scalar, Scalar >::value)&&EIGEN_SCALAR_BINARY_SUPPORTED(pow, Scalar, typename Derived::Scalar), const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(Scalar, Derived, pow) >::type pow ( const Scalar &  x, const Eigen::ArrayBase< Derived > &  exponents  )

related

Returns

an expression of the coefficient-wise power of the scalar x to the given array of exponents.

This function computes the coefficient-wise power between a scalar and an array of exponents.

Template Parameters

Scalar

is the scalar type of x. It must be compatible with the scalar type of the given array expression (Derived::Scalar).

Example:

Array<double,1,3> e(2,-3,1./3.);
cout << "10^[" << e << "] = " << pow(10,e) << endl;

Output:

See also

ArrayBase::pow()

Definition at line 161 of file GlobalFunctions.h.

---

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

• ArrayBase.h
• GlobalFunctions.h
• SelfCwiseBinaryOp.h