Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Related Functions | List of all members
Eigen::ArrayBase< Derived > Class Template Reference
Dense matrix and array manipulation » Reference » Core_Module

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

#include <ArrayBase.h>

Inheritance diagram for Eigen::ArrayBase< Derived >:
Inheritance graph
[legend]

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, NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0 : bool(IsVectorAtCompileTime) ? 1 : 2,
  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, internal::accessors_level< Derived >::value > Base
 
typedef Base::CoeffReturnType CoeffReturnType
 
typedef VectorwiseOp< Derived, Vertical > ColwiseReturnType
 
typedef internal::conditional< IsVectorAtCompileTime, const_iterator_type, void >::type const_iterator
 
typedef internal::conditional<(Flags &DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator< const Derived >, internal::generic_randaccess_stl_iterator< const Derived > >::type const_iterator_type
 
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::conditional< IsVectorAtCompileTime, iterator_type, void >::type iterator
 
typedef internal::conditional<(Flags &DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator< Derived >, internal::generic_randaccess_stl_iterator< Derived > >::type iterator_type
 
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 >, 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 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_DEPRECATED EIGEN_DEVICE_FUNC Derived & lazyAssign (const DenseBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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)
 
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
 
iterator begin ()
 
const_iterator begin () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
EIGEN_DEVICE_FUNC ColwiseReturnType colwise ()
 
EIGEN_DEVICE_FUNC ConstColwiseReturnType colwise () const
 
EIGEN_DEVICE_FUNC Index count () const
 
iterator end ()
 
const_iterator end () 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 EIGEN_CONSTEXPR Index innerSize () 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 >
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 >
EIGEN_DEVICE_FUNC 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_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & lazyAssign (const DenseBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived & lazyAssign (const DenseBase< OtherDerived > &other)
 
template<int p>
RealScalar lpNorm () const
 
template<int NaNPropagation>
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar maxCoeff () const
 
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar maxCoeff () const
 
template<int NaNPropagation, 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 *index) const
 
template<int NaNPropagation, typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar maxCoeff (IndexType *row, IndexType *col) const
 
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar maxCoeff (IndexType *row, IndexType *col) const
 
EIGEN_DEVICE_FUNC Scalar mean () const
 
template<int NaNPropagation>
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar minCoeff () const
 
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar minCoeff () const
 
template<int NaNPropagation, 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 *index) const
 
template<int NaNPropagation, typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar minCoeff (IndexType *row, IndexType *col) const
 
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar minCoeff (IndexType *row, IndexType *col) const
 
const EIGEN_DEVICE_FUNC NestByValue< Derived > nestByValue () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR 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 >
EIGEN_DEVICE_FUNC 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 >
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)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR 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_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar redux (const Func &func) 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 EIGEN_DEVICE_FUNC Select< Derived, ThenDerived, ElseDerived > select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
 
template<typename ThenDerived >
const EIGEN_DEVICE_FUNC Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType > select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const
 
template<typename ElseDerived >
const EIGEN_DEVICE_FUNC 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 EIGEN_STRONG_INLINE void swap (const DenseBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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

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 ScalarExponent >
#define EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(X)   X
 
template<typename Scalar , typename Derived >
#define EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(X)   X
 
template<typename Derived , typename ExponentDerived >
const Eigen::CwiseBinaryOp< Eigen::internal::scalar_pow_op< typename Derived::Scalar, typename ExponentDerived::Scalar >, const Derived, const ExponentDerived > pow (const Eigen::ArrayBase< Derived > &x, const Eigen::ArrayBase< ExponentDerived > &exponents)
 
- Related 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...
 
EIGEN_DEPRECATED static const EIGEN_DEVICE_FUNC RandomAccessLinSpacedReturnType LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
 
EIGEN_DEPRECATED static const EIGEN_DEVICE_FUNC RandomAccessLinSpacedReturnType 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
 
EIGEN_DEPRECATED typedef CwiseNullaryOp< internal::linspaced_op< Scalar >, PlainObject > SequentialLinSpacedReturnType
 

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
Derivedis the derived type, e.g., an array or an expression type.

This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN.

See also
class MatrixBase, The class hierarchy

Definition at line 39 of file ArrayBase.h.

Member Typedef Documentation

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

◆ ConstantReturnType

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

Definition at line 87 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 84 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/3]

template<typename Derived >
Eigen::ArrayBase< Derived >::ArrayBase ( Index  )
explicitprivate

◆ ArrayBase() [2/3]

template<typename Derived >
Eigen::ArrayBase< Derived >::ArrayBase ( Index  ,
Index   
)
private

◆ ArrayBase() [3/3]

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_DEVICE_FUNC 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_DEPRECATED EIGEN_DEVICE_FUNC Derived& Eigen::DenseBase< Derived >::lazyAssign ( typename OtherDerived  )
Deprecated:

◆ 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 143 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 152 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/6]

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/6]

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/6]

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/6]

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 134 of file EigenBase.h.

◆ operator=() [5/6]

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

Definition at line 84 of file ReturnByValue.h.

◆ operator=() [6/6]

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

◆ EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE [1/2]

template<typename Derived , typename ScalarExponent >
#define EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE (   const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPEDerived, typename internal::promote_scalar_arg< typename Derived::Scalar EIGEN_COMMA ScalarExponent EIGEN_COMMA EIGEN_SCALAR_BINARY_SUPPORTED(pow, typename Derived::Scalar, ScalarExponent)>::type, pow) const   X
related
Returns
an expression of the coefficient-wise power of x to the given constant exponent.
Template Parameters
ScalarExponentis 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 117 of file GlobalFunctions.h.

◆ EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE [2/2]

template<typename Scalar , typename Derived >
#define EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE (   const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPEtypename internal::promote_scalar_arg< typename Derived::Scalar EIGEN_COMMA Scalar EIGEN_COMMA EIGEN_SCALAR_BINARY_SUPPORTED(pow, Scalar, typename Derived::Scalar)>::type, Derived, pow) const &   X
related
Returns
an expression of the coefficient-wise power of the scalar x to the given array of exponents.

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

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

Example:

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

Output: 

See also
ArrayBase::pow() 








◆ pow()








template<typename Derived , typename ExponentDerived > 



  

  
      

        

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

        

          
          
          const Eigen::ArrayBase< ExponentDerived > & 
          exponents 
        

        

          
          )
          
        

      

  		
  
related  
  






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


This function computes the coefficient-wise power.


Example: 
Array<double,1,3> x(8,25,3),


                  e(1./3.,0.5,2.);


cout << "[" << x << "]^[" << e << "] = " << x.pow(e) << endl; // using ArrayBase::pow


cout << "[" << x << "]^[" << e << "] = " << pow(x,e) << endl; // using Eigen::pow


 Output: 
See also
ArrayBase::pow() 



Definition at line 143 of file GlobalFunctions.h.







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



e
Array< double, 1, 3 > e(1./3., 0.5, 2.)


x
set noclip points set clip one set noclip two set bar set border lt lw set xdata set ydata set zdata set x2data set y2data set boxwidth set dummy x
Definition: gnuplot_common_settings.hh:12


Eigen::ArrayBase::pow
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)
Definition: GlobalFunctions.h:143






gtsam

Author(s): 

autogenerated on Wed May 28 2025 03:09:32