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

#include <ArrayBase.h>

Inheritance diagram for Eigen::ArrayBase< Derived >:

Public Types
typedef DenseBase< Derived >	Base

typedef Base::CoeffReturnType	CoeffReturnType

typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject >	ConstantReturnType

typedef ArrayBase	Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef Base::PlainObject	PlainObject

typedef NumTraits< Scalar >::Real	RealScalar

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

typedef ArrayBase	StorageBaseType

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

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

typedef VectorwiseOp< Derived, Vertical >	ColwiseReturnType

typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject >	ConstantReturnType

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 VectorwiseOp< Derived, Horizontal >	RowwiseReturnType

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

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 ArrayBase< Derived > &	array ()

const EIGEN_DEVICE_FUNC ArrayBase< Derived > &	array () const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	lazyAssign (const DenseBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived &	lazyAssign (const DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC MatrixWrapper< Derived >	matrix ()

const EIGEN_DEVICE_FUNC MatrixWrapper< const Derived >	matrix () 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 &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator+= (const ArrayBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator+= (const EigenBase< 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)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator-= (const EigenBase< 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 EIGEN_STRONG_INLINE Derived &	operator/= (const Scalar &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const ArrayBase &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase< OtherDerived > &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)

template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const Scalar &value)

Public Member Functions inherited from Eigen::DenseBase< Derived >
EIGEN_DEVICE_FUNC bool	all () const

bool	allFinite () const

EIGEN_DEVICE_FUNC bool	any () const

EIGEN_DEVICE_FUNC ColwiseReturnType	colwise ()

EIGEN_DEVICE_FUNC ConstColwiseReturnType	colwise () const

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>
const EIGEN_DEPRECATED Derived &	flagged () const

EIGEN_DEVICE_FUNC ForceAlignedAccess< Derived >	forceAlignedAccess ()

const EIGEN_DEVICE_FUNC ForceAlignedAccess< Derived >	forceAlignedAccess () const

template<bool Enable>
EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type	forceAlignedAccessIf ()

template<bool Enable>
const EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type	forceAlignedAccessIf () const

const WithFormat< Derived >	format (const IOFormat &fmt) const

bool	hasNaN () const

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 OtherDerived >
bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec) 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	isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

template<typename Derived >
bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) 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)

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 *index) const

template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType row, IndexType col) const

EIGEN_DEVICE_FUNC Scalar	mean () const

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff () const

template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const

template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType row, IndexType col) const

const EIGEN_DEVICE_FUNC NestByValue< Derived >	nestByValue () const

EIGEN_DEVICE_FUNC Index	nonZeros () const

template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (const CustomNullaryOp &func)

template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)

template<typename CustomNullaryOp >
const EIGEN_STRONG_INLINE CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (Index size, 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)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const Scalar &s)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase< OtherDerived > &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)

template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)

EIGEN_DEVICE_FUNC Index	outerSize () const

EIGEN_DEVICE_FUNC Scalar	prod () const

template<typename BinaryOp >
EIGEN_DEVICE_FUNC Scalar	redux (const BinaryOp &func) const

template<typename Func >
EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar	redux (const Func &func) const

template<int RowFactor, int ColFactor>
const Replicate< Derived, RowFactor, ColFactor >	replicate () const

template<int RowFactor, int ColFactor>
const EIGEN_DEVICE_FUNC Replicate< Derived, RowFactor, ColFactor >	replicate () const

const EIGEN_DEVICE_FUNC 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 RowwiseReturnType	rowwise ()

EIGEN_DEVICE_FUNC ConstRowwiseReturnType	rowwise () const

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 (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

EIGEN_DEVICE_FUNC Derived &	setLinSpaced (Index size, 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 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
template<typename OtherDerived >
	ArrayBase (const ArrayBase< OtherDerived > &)

	ArrayBase (Index)

	ArrayBase (Index, Index)

Related Functions
(Note that these are not member functions.)
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 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 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 const EIGEN_DEVICE_FUNC ConstantReturnType	Constant (const Scalar &value)

static const EIGEN_DEVICE_FUNC ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)

static const EIGEN_DEVICE_FUNC ConstantReturnType	Constant (Index size, const Scalar &value)

static const EIGEN_DEVICE_FUNC RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

static const EIGEN_DEVICE_FUNC RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

static const EIGEN_DEVICE_FUNC SequentialLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)

static const EIGEN_DEVICE_FUNC SequentialLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)

template<typename CustomNullaryOp >
static const EIGEN_DEVICE_FUNC CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (const CustomNullaryOp &func)

template<typename CustomNullaryOp >
static const EIGEN_DEVICE_FUNC CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)

template<typename CustomNullaryOp >
static const EIGEN_DEVICE_FUNC CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)

static const EIGEN_DEVICE_FUNC ConstantReturnType	Ones ()

static const EIGEN_DEVICE_FUNC ConstantReturnType	Ones (Index rows, Index cols)

static const EIGEN_DEVICE_FUNC ConstantReturnType	Ones (Index size)

static const RandomReturnType	Random ()

static const RandomReturnType	Random (Index rows, Index cols)

static const RandomReturnType	Random (Index size)

static const EIGEN_DEVICE_FUNC ConstantReturnType	Zero ()

static const EIGEN_DEVICE_FUNC ConstantReturnType	Zero (Index rows, Index cols)

static const EIGEN_DEVICE_FUNC ConstantReturnType	Zero (Index size)

Public Attributes inherited from Eigen::DenseBase< Derived >
const typedef VectorwiseOp< const Derived, Vertical >	ConstColwiseReturnType

const typedef Reverse< const Derived, BothDirections >	ConstReverseReturnType

const typedef VectorwiseOp< const Derived, Horizontal >	ConstRowwiseReturnType

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

See also: class MatrixBase, TopicClassHierarchy

Definition at line 39 of file ArrayBase.h.

Member Typedef Documentation

◆ Base

template<typename Derived >

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

Definition at line 54 of file ArrayBase.h.

◆ CoeffReturnType

template<typename Derived >

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

Definition at line 78 of file ArrayBase.h.

◆ ConstantReturnType

template<typename Derived >

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

Definition at line 86 of file ArrayBase.h.

◆ Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl

template<typename Derived >

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

Definition at line 47 of file ArrayBase.h.

◆ PacketScalar

template<typename Derived >

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

Definition at line 51 of file ArrayBase.h.

◆ PlainObject

template<typename Derived >

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

Definition at line 83 of file ArrayBase.h.

◆ RealScalar

template<typename Derived >

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

Definition at line 52 of file ArrayBase.h.

◆ Scalar

template<typename Derived >

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

Definition at line 50 of file ArrayBase.h.

◆ StorageBaseType

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.

◆ StorageKind

template<typename Derived >

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

Definition at line 49 of file ArrayBase.h.

Constructor & Destructor Documentation

◆ ArrayBase() [1/4]

template<typename Derived >

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

inlineprotected

Definition at line 157 of file ArrayBase.h.

◆ ArrayBase() [2/4]

template<typename Derived >

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

explicitprivate

◆ ArrayBase() [3/4]

template<typename Derived >

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

private

◆ ArrayBase() [4/4]

template<typename Derived >

template<typename OtherDerived >

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

explicitprivate

Member Function Documentation

◆ array() [1/2]

template<typename Derived >

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

inline

Definition at line 141 of file ArrayBase.h.

◆ array() [2/2]

template<typename Derived >

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

inline

Definition at line 143 of file ArrayBase.h.

◆ lazyAssign() [1/2]

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived& Eigen::DenseBase< Derived >::lazyAssign ( typename OtherDerived )

Definition at line 20 of file Assign.h.

◆ lazyAssign() [2/2]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived& Eigen::DenseBase< Derived >::lazyAssign ( typename OtherDerived )

◆ matrix() [1/2]

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.

◆ matrix() [2/2]

template<typename Derived >

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

inline

Definition at line 150 of file ArrayBase.h.

◆ operator*=() [1/2]

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.

◆ operator*=() [2/2]

template<typename Derived >

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

Definition at line 18 of file SelfCwiseBinaryOp.h.

◆ operator+=() [1/4]

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.

◆ operator+=() [2/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator+= ( typename OtherDerived )

Definition at line 142 of file EigenBase.h.

◆ operator+=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

inlineprotected

Definition at line 165 of file ArrayBase.h.

◆ operator+=() [4/4]

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.

◆ operator-=() [1/4]

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.

◆ operator-=() [2/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator-= ( typename OtherDerived )

Definition at line 151 of file EigenBase.h.

◆ operator-=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

inlineprotected

Definition at line 168 of file ArrayBase.h.

◆ operator-=() [4/4]

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.

◆ operator/=() [1/2]

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.

◆ operator/=() [2/2]

template<typename Derived >

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

Definition at line 39 of file SelfCwiseBinaryOp.h.

◆ operator=() [1/7]

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.

◆ operator=() [2/7]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator=

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 47 of file Assign.h.

◆ operator=() [3/7]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator= ( typename OtherDerived )

Copies other into *this.

Returns: a reference to *this.

Definition at line 39 of file Assign.h.

◆ operator=() [4/7]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator= ( typename OtherDerived )

Copies the generic expression other into *this.

The expression must provide a (templated) evalTo(Derived& dst) const function which does the actual job. In practice, this allows any user to write its own special matrix without having to modify MatrixBase

Returns: a reference to *this.

Definition at line 133 of file EigenBase.h.

◆ operator=() [5/7]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived& Eigen::DenseBase< Derived >::operator= ( typename OtherDerived )

◆ operator=() [6/7]

template<typename Derived >

template<typename OtherDerived >

Derived& Eigen::DenseBase< Derived >::operator= ( typename OtherDerived )

Definition at line 82 of file ReturnByValue.h.

◆ operator=() [7/7]

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.

Friends And Related Function Documentation

◆ pow() [1/3]

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
	)

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

This function computes the coefficient-wise power.

Example:

Output:

See also: ArrayBase::pow()

Definition at line 132 of file GlobalFunctions.h.

◆ pow() [2/3]

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
	)

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.

◆ pow() [3/3]

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
	)

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:

Output:

See also: ArrayBase::pow()

Definition at line 161 of file GlobalFunctions.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Related Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ CoeffReturnType

◆ ConstantReturnType

◆ Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl

◆ PacketScalar

◆ PlainObject

◆ RealScalar

◆ Scalar

◆ StorageBaseType

◆ StorageKind

Constructor & Destructor Documentation

◆ ArrayBase() [1/4]

◆ ArrayBase() [2/4]

◆ ArrayBase() [3/4]

◆ ArrayBase() [4/4]

Member Function Documentation

◆ array() [1/2]

◆ array() [2/2]

◆ lazyAssign() [1/2]

◆ lazyAssign() [2/2]

◆ matrix() [1/2]

◆ matrix() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/4]

◆ operator+=() [2/4]

◆ operator+=() [3/4]

◆ operator+=() [4/4]

◆ operator-=() [1/4]

◆ operator-=() [2/4]

◆ operator-=() [3/4]

◆ operator-=() [4/4]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/7]

◆ operator=() [2/7]

◆ operator=() [3/7]

◆ operator=() [4/7]

◆ operator=() [5/7]

◆ operator=() [6/7]

◆ operator=() [7/7]

Friends And Related Function Documentation

◆ pow() [1/3]

◆ pow() [2/3]

◆ pow() [3/3]

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