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

Collaboration diagram for Eigen::ArrayBase< Derived >:

List of all members.

Classes
struct	CastXpr
Public Types
typedef ArrayBase	StorageBaseType
typedef ArrayBase	Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl
typedef internal::traits < Derived >::StorageKind	StorageKind
typedef internal::traits < Derived >::Scalar	Scalar
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef DenseBase< Derived >	Base
typedef Base::CoeffReturnType	CoeffReturnType
typedef Base::PlainObject	PlainObject
	The plain matrix or array type corresponding to this expression.
typedef CwiseNullaryOp < internal::scalar_constant_op < Scalar >, PlainObject >	ConstantReturnType
typedef CwiseUnaryOp < internal::scalar_multiple_op < Scalar >, const Derived >	ScalarMultipleReturnType
typedef CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Derived >	ScalarComplexMultipleReturnType
typedef CwiseUnaryOp < internal::scalar_quotient1_op < Scalar >, const Derived >	ScalarQuotient1ReturnType
typedef internal::conditional < NumTraits< Scalar > ::IsComplex, const CwiseUnaryOp < internal::scalar_conjugate_op < Scalar >, const Derived > , const Derived & >::type	ConjugateReturnType
typedef internal::conditional < NumTraits< Scalar > ::IsComplex, const CwiseUnaryOp < internal::scalar_real_op < Scalar >, const Derived > , const Derived & >::type	RealReturnType
typedef internal::conditional < NumTraits< Scalar > ::IsComplex, CwiseUnaryView < internal::scalar_real_ref_op < Scalar >, Derived >, Derived & > ::type	NonConstRealReturnType
typedef CwiseUnaryOp < internal::scalar_imag_op < Scalar >, const Derived >	ImagReturnType
typedef CwiseUnaryView < internal::scalar_imag_ref_op < Scalar >, Derived >	NonConstImagReturnType
typedef CwiseUnaryOp < internal::scalar_opposite_op < Scalar >, const Derived >	NegativeReturnType
typedef CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Derived >	CwiseAbsReturnType
typedef CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Derived >	CwiseAbs2ReturnType
typedef CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Derived >	CwiseSqrtReturnType
typedef CwiseUnaryOp < internal::scalar_sign_op < Scalar >, const Derived >	CwiseSignReturnType
typedef CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Derived >	CwiseInverseReturnType
typedef CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Derived >	AbsReturnType
typedef CwiseUnaryOp < internal::scalar_arg_op < Scalar >, const Derived >	ArgReturnType
typedef CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Derived >	Abs2ReturnType
typedef CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Derived >	SqrtReturnType
typedef CwiseUnaryOp < internal::scalar_rsqrt_op < Scalar >, const Derived >	RsqrtReturnType
typedef CwiseUnaryOp < internal::scalar_sign_op < Scalar >, const Derived >	SignReturnType
typedef CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Derived >	InverseReturnType
typedef CwiseUnaryOp < internal::scalar_boolean_not_op < Scalar >, const Derived >	BooleanNotReturnType
typedef CwiseUnaryOp < internal::scalar_exp_op < Scalar >, const Derived >	ExpReturnType
typedef CwiseUnaryOp < internal::scalar_log_op < Scalar >, const Derived >	LogReturnType
typedef CwiseUnaryOp < internal::scalar_log10_op < Scalar >, const Derived >	Log10ReturnType
typedef CwiseUnaryOp < internal::scalar_cos_op < Scalar >, const Derived >	CosReturnType
typedef CwiseUnaryOp < internal::scalar_sin_op < Scalar >, const Derived >	SinReturnType
typedef CwiseUnaryOp < internal::scalar_tan_op < Scalar >, const Derived >	TanReturnType
typedef CwiseUnaryOp < internal::scalar_acos_op < Scalar >, const Derived >	AcosReturnType
typedef CwiseUnaryOp < internal::scalar_asin_op < Scalar >, const Derived >	AsinReturnType
typedef CwiseUnaryOp < internal::scalar_atan_op < Scalar >, const Derived >	AtanReturnType
typedef CwiseUnaryOp < internal::scalar_tanh_op < Scalar >, const Derived >	TanhReturnType
typedef CwiseUnaryOp < internal::scalar_sinh_op < Scalar >, const Derived >	SinhReturnType
typedef CwiseUnaryOp < internal::scalar_cosh_op < Scalar >, const Derived >	CoshReturnType
typedef CwiseUnaryOp < internal::scalar_lgamma_op < Scalar >, const Derived >	LgammaReturnType
typedef CwiseUnaryOp < internal::scalar_digamma_op < Scalar >, const Derived >	DigammaReturnType
typedef CwiseUnaryOp < internal::scalar_erf_op < Scalar >, const Derived >	ErfReturnType
typedef CwiseUnaryOp < internal::scalar_erfc_op < Scalar >, const Derived >	ErfcReturnType
typedef CwiseUnaryOp < internal::scalar_pow_op < Scalar >, const Derived >	PowReturnType
typedef CwiseUnaryOp < internal::scalar_square_op < Scalar >, const Derived >	SquareReturnType
typedef CwiseUnaryOp < internal::scalar_cube_op < Scalar >, const Derived >	CubeReturnType
typedef CwiseUnaryOp < internal::scalar_round_op < Scalar >, const Derived >	RoundReturnType
typedef CwiseUnaryOp < internal::scalar_floor_op < Scalar >, const Derived >	FloorReturnType
typedef CwiseUnaryOp < internal::scalar_ceil_op < Scalar >, const Derived >	CeilReturnType
typedef CwiseUnaryOp < internal::scalar_isnan_op < Scalar >, const Derived >	IsNaNReturnType
typedef CwiseUnaryOp < internal::scalar_isinf_op < Scalar >, const Derived >	IsInfReturnType
typedef CwiseUnaryOp < internal::scalar_isfinite_op < Scalar >, const Derived >	IsFiniteReturnType
typedef CwiseBinaryOp < internal::scalar_cmp_op < Scalar, internal::cmp_EQ > , const Derived, const ConstantReturnType >	CwiseScalarEqualReturnType
Public Member Functions
EIGEN_DEVICE_FUNC const NegativeReturnType	operator- () const
EIGEN_DEVICE_FUNC const ScalarMultipleReturnType	operator* (const Scalar &scalar) const
EIGEN_DEVICE_FUNC const ScalarQuotient1ReturnType	operator/ (const Scalar &scalar) const
EIGEN_DEVICE_FUNC const ScalarComplexMultipleReturnType	operator* (const std::complex< Scalar > &scalar) const
template<typename NewType >
EIGEN_DEVICE_FUNC CastXpr < NewType >::Type	cast () const
EIGEN_DEVICE_FUNC ConjugateReturnType	conjugate () const
EIGEN_DEVICE_FUNC RealReturnType	real () const
EIGEN_DEVICE_FUNC const ImagReturnType	imag () const
template<typename CustomUnaryOp >
EIGEN_DEVICE_FUNC const CwiseUnaryOp< CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise.
template<typename CustomViewOp >
EIGEN_DEVICE_FUNC const CwiseUnaryView< CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
EIGEN_DEVICE_FUNC NonConstRealReturnType	real ()
EIGEN_DEVICE_FUNC NonConstImagReturnType	imag ()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType	cwiseAbs () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType	cwiseAbs2 () const
EIGEN_DEVICE_FUNC const CwiseSqrtReturnType	cwiseSqrt () const
EIGEN_DEVICE_FUNC const CwiseSignReturnType	cwiseSign () const
EIGEN_DEVICE_FUNC const CwiseInverseReturnType	cwiseInverse () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const AbsReturnType	abs () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ArgReturnType	arg () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Abs2ReturnType	abs2 () const
EIGEN_DEVICE_FUNC const ExpReturnType	exp () const
EIGEN_DEVICE_FUNC const LogReturnType	log () const
EIGEN_DEVICE_FUNC const Log10ReturnType	log10 () const
EIGEN_DEVICE_FUNC const SqrtReturnType	sqrt () const
EIGEN_DEVICE_FUNC const RsqrtReturnType	rsqrt () const
EIGEN_DEVICE_FUNC const SignReturnType	sign () const
EIGEN_DEVICE_FUNC const CosReturnType	cos () const
EIGEN_DEVICE_FUNC const SinReturnType	sin () const
EIGEN_DEVICE_FUNC const TanReturnType	tan () const
const AtanReturnType	atan () const
EIGEN_DEVICE_FUNC const AcosReturnType	acos () const
EIGEN_DEVICE_FUNC const AsinReturnType	asin () const
const TanhReturnType	tanh () const
const SinhReturnType	sinh () const
const CoshReturnType	cosh () const
const LgammaReturnType	lgamma () const
const DigammaReturnType	digamma () const
const ErfReturnType	erf () const
const ErfcReturnType	erfc () const
EIGEN_DEVICE_FUNC const PowReturnType	pow (const Scalar &exponent) const
EIGEN_DEVICE_FUNC const InverseReturnType	inverse () const
EIGEN_DEVICE_FUNC const SquareReturnType	square () const
EIGEN_DEVICE_FUNC const CubeReturnType	cube () const
const RoundReturnType	round () const
const FloorReturnType	floor () const
const CeilReturnType	ceil () const
const IsNaNReturnType	isNaN () const
const IsInfReturnType	isInf () const
const IsFiniteReturnType	isFinite () const
EIGEN_DEVICE_FUNC const BooleanNotReturnType	operator! () 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 OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &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
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_min_op < 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 >, const Derived, const ConstantReturnType >	cwiseMin (const Scalar &other) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_max_op < 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 >, const Derived, const ConstantReturnType >	cwiseMax (const Scalar &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 CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const Derived, const OtherDerived >	operator/ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) 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 ExponentDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_binary_pow_op < Scalar, typename ExponentDerived::Scalar > , const Derived, const ExponentDerived >	pow (const ArrayBase< ExponentDerived > &exponents) const
EIGEN_DEVICE_FUNC const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator+ (const Scalar &scalar) const
EIGEN_DEVICE_FUNC const CwiseUnaryOp < internal::scalar_sub_op < Scalar >, const Derived >	operator- (const Scalar &scalar) 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 const CwiseBinaryOp < internal::scalar_boolean_or_op, const Derived, const OtherDerived >	operator|| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const ArrayBase &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const Scalar &value)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator+= (const Scalar &scalar)
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 Derived &	operator-= (const ArrayBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator*= (const ArrayBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator/= (const ArrayBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC ArrayBase < Derived > &	array ()
EIGEN_DEVICE_FUNC const ArrayBase< Derived > &	array () const
EIGEN_DEVICE_FUNC MatrixWrapper< Derived >	matrix ()
EIGEN_DEVICE_FUNC const MatrixWrapper< const Derived >	matrix () const
Protected Member Functions
EIGEN_DEVICE_FUNC	ArrayBase ()
template<typename OtherDerived >
Derived &	operator+= (const MatrixBase< OtherDerived > &)
template<typename OtherDerived >
Derived &	operator-= (const MatrixBase< OtherDerived > &)
Private Member Functions
	ArrayBase (Index)
	ArrayBase (Index, Index)
template<typename OtherDerived >
	ArrayBase (const ArrayBase< OtherDerived > &)
Friends
EIGEN_DEVICE_FUNC friend const ScalarMultipleReturnType	operator* (const Scalar &scalar, const StorageBaseType &matrix)
EIGEN_DEVICE_FUNC friend const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)
EIGEN_DEVICE_FUNC friend const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator+ (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)
EIGEN_DEVICE_FUNC friend const CwiseUnaryOp < internal::scalar_rsub_op < Scalar >, const Derived >	operator- (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)

---

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 TopicCustomizingEigen by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN.

See also:

class MatrixBase, TopicClassHierarchy

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 19 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 20 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 21 of file ArrayBase.h.

template<typename Derived>

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

Reimplemented from Eigen::DenseBase< Derived >.

Reimplemented in Eigen::ArrayWrapper< ExpressionType >.

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 34 of file ArrayBase.h.

template<typename Derived>

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

Reimplemented from Eigen::DenseBase< Derived >.

Definition at line 80 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

the return type of conjugate()

Definition at line 26 of file ArrayBase.h.

template<typename Derived>

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

Represents a matrix with all coefficients equal to one another

Reimplemented from Eigen::DenseBase< Derived >.

Definition at line 88 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 24 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 16 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 31 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 16 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 15 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 19 of file ArrayBase.h.

template<typename Derived>

typedef CwiseBinaryOp<internal::scalar_cmp_op<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 18 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 17 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 26 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 28 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 27 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 33 of file ArrayBase.h.

template<typename Derived>

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

the return type of imag() const

Definition at line 38 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 37 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 36 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 35 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 25 of file ArrayBase.h.

template<typename Derived>

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

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 42 of file ArrayBase.h.

template<typename Derived>

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

the return type of imag()

Definition at line 40 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

the return type of real()

Definition at line 36 of file ArrayBase.h.

template<typename Derived>

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

Reimplemented from Eigen::DenseBase< Derived >.

Definition at line 51 of file ArrayBase.h.

template<typename Derived>

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

The plain matrix or array type corresponding to this expression.

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

Reimplemented from Eigen::DenseBase< Derived >.

Definition at line 85 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_pow_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::PowReturnType

Definition at line 29 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

the return type of real() const

Definition at line 31 of file ArrayBase.h.

template<typename Derived>

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

Reimplemented from Eigen::DenseBase< Derived >.

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

The numeric type of the expression' coefficients, e.g. float, double, int or std::complex<float>, etc.

Reimplemented from Eigen::DenseBase< Derived >.

Definition at line 50 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> Eigen::ArrayBase< Derived >::ScalarComplexMultipleReturnType

Definition at line 18 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_multiple_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ScalarMultipleReturnType

Represents a scalar multiple of an expression

Definition at line 17 of file ArrayBase.h.

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::ScalarQuotient1ReturnType

Represents a quotient of an expression by a scalar

Definition at line 21 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 23 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 17 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 30 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

Reimplemented from Eigen::DenseBase< Derived >.

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 22 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 18 of file ArrayBase.h.

---

Constructor & Destructor Documentation

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::ArrayBase< Derived >::ArrayBase

(

)

[inline, protected]

Definition at line 157 of file ArrayBase.h.

: Base() {}

template<typename Derived>

Eigen::ArrayBase< Derived >::ArrayBase

(

Index

)

[explicit, private]

template<typename Derived>

Eigen::ArrayBase< Derived >::ArrayBase	(	Index	,
		Index
	)		[private]

template<typename Derived>

template<typename OtherDerived >

Eigen::ArrayBase< Derived >::ArrayBase

(

const ArrayBase< OtherDerived > &

)

[explicit, private]

---

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:

Output:

See also:

abs2()

Definition at line 48 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:

Output:

See also:

abs(), square()

Definition at line 76 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:

Output:

See also:

cos(), asin()

Definition at line 252 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:

Output:

See also:

abs()

Definition at line 62 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.

{ return *this; }

template<typename Derived>

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

(

)

const [inline]

Definition at line 143 of file ArrayBase.h.

{ return *this; }

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:

Output:

See also:

sin(), acos()

Definition at line 266 of file ArrayBase.h.

template<typename Derived>

const AtanReturnType Eigen::ArrayBase< Derived >::atan

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

tan(), asin(), acos()

Definition at line 238 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:

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 105 of file ArrayBase.h.

    {

template<typename Derived>

const CeilReturnType Eigen::ArrayBase< Derived >::ceil

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

floor(), round()

Definition at line 455 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:

adjoint()

Definition at line 115 of file ArrayBase.h.

    { Base::setConstant(value); return derived(); }

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:

Output:

See also:

sin(), acos()

Definition at line 193 of file ArrayBase.h.

{
  call_assignment(derived(), other.derived(), internal::add_assign_op<Scalar>());
  return derived();
}

template<typename Derived>

const CoshReturnType Eigen::ArrayBase< Derived >::cosh

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

tan(), sinh(), cosh()

Definition at line 305 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:

Output:

See also:

square(), pow()

Definition at line 416 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:

Output:

See also:

cwiseAbs2()

Definition at line 30 of file ArrayBase.h.

: public DenseBase<Derived>

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:

Output:

See also:

cwiseAbs()

Definition at line 41 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:

Output:

See also:

max()

Returns:

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

See also:

max()

Definition at line 45 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:

Output:

See also:

min()

Returns:

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

See also:

min()

Definition at line 71 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:

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.

                                                      { return MatrixWrapper<const Derived>(derived()); }

//     template<typename Dest>
//     inline void evalTo(Dest& dst) const { dst = matrix(); }

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:

Output:

See also:

cwiseProduct()

Definition at line 74 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<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:

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>, 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.

    { Base::setConstant(value); return derived(); }

    EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<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:

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>, 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:

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:

Output:

See also:

class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 132 of file ArrayBase.h.

        :
    EIGEN_DEVICE_FUNC

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:

Output:

Definition at line 62 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:

Output:

See also:

cwisePow(), cwiseSquare()

Definition at line 52 of file ArrayBase.h.

template<typename Derived>

const DigammaReturnType Eigen::ArrayBase< Derived >::digamma

(

)

const [inline]

Returns:

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

See also:

cos(), sin(), tan()

Definition at line 328 of file ArrayBase.h.

template<typename Derived>

template<typename OtherDerived >

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

                { 

template<typename Derived>

template<typename OtherDerived >

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

  : public DenseBase<Derived>

template<typename Derived>

const ErfReturnType Eigen::ArrayBase< Derived >::erf

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

cos(), sin(), tan()

Definition at line 342 of file ArrayBase.h.

template<typename Derived>

const ErfcReturnType Eigen::ArrayBase< Derived >::erfc

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

cos(), sin(), tan()

Definition at line 356 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:

Output:

See also:

pow(), log(), sin(), cos()

Definition at line 93 of file ArrayBase.h.

    {

template<typename Derived>

const FloorReturnType Eigen::ArrayBase< Derived >::floor

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

ceil(), round()

Definition at line 442 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 132 of file ArrayBase.h.

:
    EIGEN_DEVICE_FUNC

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 192 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:

Output:

See also:

operator/(), operator*()

Definition at line 388 of file ArrayBase.h.

template<typename Derived>

const IsFiniteReturnType Eigen::ArrayBase< Derived >::isFinite

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

isnan(), isinf()

Definition at line 494 of file ArrayBase.h.

template<typename Derived>

const IsInfReturnType Eigen::ArrayBase< Derived >::isInf

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

isnan(), isfinite()

Definition at line 481 of file ArrayBase.h.

template<typename Derived>

const IsNaNReturnType Eigen::ArrayBase< Derived >::isNaN

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

isfinite(), isinf()

Definition at line 468 of file ArrayBase.h.

template<typename Derived>

const LgammaReturnType Eigen::ArrayBase< Derived >::lgamma

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

cos(), sin(), tan()

Definition at line 318 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:

Output:

See also:

exp()

Definition at line 110 of file ArrayBase.h.

    { Base::setConstant(value); return derived(); }

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:

Output:

See also:

log()

Definition at line 126 of file ArrayBase.h.

        :
    EIGEN_DEVICE_FUNC

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.

{ return MatrixWrapper<Derived>(derived()); }

template<typename Derived>

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

(

)

const [inline]

Definition at line 150 of file ArrayBase.h.

{ return MatrixWrapper<const Derived>(derived()); }

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:

Output:

See also:

operator!=()

Definition at line 510 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 && operator of *this and other

Warning:

this operator is for expression of bool only.

Example:

Output:

See also:

operator||(), select()

Definition at line 258 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ScalarMultipleReturnType Eigen::ArrayBase< Derived >::operator*

(

const Scalar &

scalar

)

const [inline]

Returns:

an expression of *this scaled by the scalar factor scalar

Definition at line 57 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ScalarComplexMultipleReturnType Eigen::ArrayBase< Derived >::operator*

(

const std::complex< Scalar > &

scalar

)

const [inline]

Overloaded for efficient real matrix times complex scalar value

Definition at line 77 of file ArrayBase.h.

template<typename Derived >

template<typename OtherDerived >

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.

{
  call_assignment(derived(), other.derived(), internal::mul_assign_op<Scalar,typename OtherDerived::Scalar>());
  return derived();
}

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::operator+

(

const Scalar &

scalar

)

const [inline]

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 213 of file ArrayBase.h.

template<typename Derived >

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

(

const Scalar &

scalar

)

Definition at line 24 of file SelfCwiseBinaryOp.h.

{
  typedef typename Derived::PlainObject PlainObject;
  internal::call_assignment(this->derived(), PlainObject::Constant(rows(),cols(),other), internal::add_assign_op<Scalar>());
  return derived();
}

template<typename Derived >

template<typename OtherDerived >

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.

{
  call_assignment(derived(), other.derived(), internal::add_assign_op<Scalar>());
  return derived();
}

template<typename Derived>

template<typename OtherDerived >

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

(

const MatrixBase< OtherDerived > &

)

[inline, protected]

Definition at line 165 of file ArrayBase.h.

    {EIGEN_STATIC_ASSERT(std::ptrdiff_t(sizeof(typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES); return *this;}

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 51 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseUnaryOp<internal::scalar_sub_op<Scalar>, const Derived> Eigen::ArrayBase< Derived >::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 234 of file ArrayBase.h.

template<typename Derived >

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

(

const Scalar &

scalar

)

Definition at line 32 of file SelfCwiseBinaryOp.h.

{
  typedef typename Derived::PlainObject PlainObject;
  internal::call_assignment(this->derived(), PlainObject::Constant(rows(),cols(),other), internal::sub_assign_op<Scalar>());
  return derived();
}

template<typename Derived >

template<typename OtherDerived >

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.

{
  call_assignment(derived(), other.derived(), internal::sub_assign_op<Scalar>());
  return derived();
}

template<typename Derived>

template<typename OtherDerived >

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

(

const MatrixBase< OtherDerived > &

)

[inline, protected]

Definition at line 168 of file ArrayBase.h.

    {EIGEN_STATIC_ASSERT(std::ptrdiff_t(sizeof(typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES); return *this;}

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 >::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 21 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ScalarQuotient1ReturnType Eigen::ArrayBase< Derived >::operator/

(

const Scalar &

scalar

)

const [inline]

Returns:

an expression of *this divided by the scalar value scalar

Definition at line 69 of file ArrayBase.h.

template<typename Derived >

template<typename OtherDerived >

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.

{
  call_assignment(derived(), other.derived(), internal::div_assign_op<Scalar>());
  return derived();
}

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.

    {
      internal::call_assignment(derived(), other.derived());
      return derived();
    }

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.

    { Base::setConstant(value); return derived(); }

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 || operator of *this and other

Warning:

this operator is for expression of bool only.

Example:

Output:

See also:

operator&&(), select()

Definition at line 277 of file ArrayBase.h.

template<typename Derived>

template<typename ExponentDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_binary_pow_op<Scalar, typename ExponentDerived::Scalar>, const Derived, const ExponentDerived> Eigen::ArrayBase< Derived >::pow

(

const ArrayBase< ExponentDerived > &

exponents

)

const [inline]

Returns:

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

This function computes the coefficient-wise power.

Example:

Output:

Definition at line 88 of file ArrayBase.h.

    {

template<typename Derived>

EIGEN_DEVICE_FUNC const PowReturnType Eigen::ArrayBase< Derived >::pow

(

const Scalar &

exponent

)

const [inline]

Returns:

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

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

Example:

Output:

See also:

exp(), log()

Definition at line 373 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 125 of file ArrayBase.h.

:
    EIGEN_DEVICE_FUNC

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 185 of file ArrayBase.h.

template<typename Derived>

const RoundReturnType Eigen::ArrayBase< Derived >::round

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

ceil(), floor()

Definition at line 429 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:

Output:

See also:

pow(), square()

Definition at line 159 of file ArrayBase.h.

         :
    explicit ArrayBase(Index);
    ArrayBase(Index,Index);
    template<typename OtherDerived> explicit ArrayBase(const ArrayBase<OtherDerived>&);

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:

Output:

See also:

pow(), square()

Definition at line 175 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:

Output:

See also:

cos(), asin()

Definition at line 211 of file ArrayBase.h.

template<typename Derived>

const SinhReturnType Eigen::ArrayBase< Derived >::sinh

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

sin(), tanh(), cosh()

Definition at line 292 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:

Output:

See also:

pow(), square()

Definition at line 143 of file ArrayBase.h.

                                            { return *this; }

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:

Output:

See also:

operator/(), operator*(), abs2()

Definition at line 402 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:

Output:

See also:

cos(), sin()

Definition at line 225 of file ArrayBase.h.

template<typename Derived>

const TanhReturnType Eigen::ArrayBase< Derived >::tanh

(

)

const [inline]

Returns:

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

Example:

Output:

See also:

tan(), sinh(), cosh()

Definition at line 279 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:

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 156 of file ArrayBase.h.

                : Base() {}

  private:

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:

Output:

See also:

class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 175 of file ArrayBase.h.

---

Friends And Related Function Documentation

template<typename Derived>

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

Definition at line 84 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC friend 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 89 of file ArrayBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC friend 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 220 of file ArrayBase.h.

template<typename Derived>

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

Definition at line 241 of file ArrayBase.h.

---

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

• ArrayBase.h
• CommonCwiseUnaryOps.h
• MatrixCwiseUnaryOps.h
• ArrayCwiseUnaryOps.h
• MatrixCwiseBinaryOps.h
• CommonCwiseBinaryOps.h
• ArrayCwiseBinaryOps.h
• SelfCwiseBinaryOp.h