Logo Search packages:      
Sourcecode: eigen3 version File versions  Download package

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Friends | Related Functions

ArrayBase< Derived > Class Template Reference

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

#include <ArrayBase.h>

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

List of all members.

Public Types

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, CoeffReadCost = internal::traits<Derived>::CoeffReadCost, InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret,
  OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret
}
enum  { ThisConstantIsPrivateInPlainObjectBase }
typedef DenseBase< Derived > Base
typedef Base::CoeffReturnType CoeffReturnType
typedef Block< Derived,
internal::traits< Derived >
::RowsAtCompileTime, Dynamic,!IsRowMajor > 
ColsBlockXpr
typedef VectorwiseOp< Derived,
Vertical > 
ColwiseReturnType
typedef Block< Derived,
internal::traits< Derived >
::RowsAtCompileTime,
1,!IsRowMajor > 
ColXpr
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, const
CwiseUnaryOp
< internal::scalar_conjugate_op
< Scalar >, const Derived >
, const Derived & >::type 
ConjugateReturnType
typedef CwiseNullaryOp
< internal::scalar_constant_op
< Scalar >, Derived > 
ConstantReturnType
typedef const Block< const
Derived, internal::traits
< Derived >::RowsAtCompileTime,
Dynamic,!IsRowMajor > 
ConstColsBlockXpr
typedef const VectorwiseOp
< const Derived, Vertical > 
ConstColwiseReturnType
typedef const Block< const
Derived, internal::traits
< Derived >::RowsAtCompileTime,
1,!IsRowMajor > 
ConstColXpr
typedef const Reverse< const
Derived, BothDirections > 
ConstReverseReturnType
typedef const Block< const
Derived, Dynamic,
internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 
ConstRowsBlockXpr
typedef const VectorwiseOp
< const Derived, Horizontal > 
ConstRowwiseReturnType
typedef const Block< const
Derived, 1, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 
ConstRowXpr
typedef const VectorBlock
< const Derived > 
ConstSegmentReturnType
typedef const Transpose< const
Derived > 
ConstTransposeReturnType
typedef ArrayBase Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl
typedef Matrix< typename
NumTraits< typename
internal::traits< Derived >
::Scalar >::Real,
internal::traits< Derived >
::ColsAtCompileTime, 1 > 
EigenvaluesReturnType
typedef CwiseUnaryOp
< internal::scalar_imag_op
< Scalar >, const Derived > 
ImagReturnType
typedef internal::traits
< Derived >::Index 
Index
 The type of indices.
typedef CwiseUnaryView
< internal::scalar_imag_ref_op
< Scalar >, Derived > 
NonConstImagReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, CwiseUnaryView
< internal::scalar_real_ref_op
< Scalar >, Derived >, Derived & >
::type 
NonConstRealReturnType
typedef
internal::packet_traits
< Scalar >::type 
PacketScalar
typedef 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 > 
PlainObject
typedef CwiseNullaryOp
< internal::linspaced_op
< Scalar, true >, Derived > 
RandomAccessLinSpacedReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, const
CwiseUnaryOp
< internal::scalar_real_op
< Scalar >, const Derived >
, const Derived & >::type 
RealReturnType
typedef NumTraits< Scalar >::Real RealScalar
typedef Reverse< Derived,
BothDirections > 
ReverseReturnType
typedef Block< Derived,
Dynamic, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 
RowsBlockXpr
typedef VectorwiseOp< Derived,
Horizontal > 
RowwiseReturnType
typedef Block< Derived,
1, internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 
RowXpr
typedef internal::traits
< Derived >::Scalar 
Scalar
typedef CwiseUnaryOp
< internal::scalar_multiple_op
< Scalar >, const Derived > 
ScalarMultipleReturnType
typedef CwiseUnaryOp
< internal::scalar_quotient1_op
< Scalar >, const Derived > 
ScalarQuotient1ReturnType
typedef VectorBlock< Derived > SegmentReturnType
typedef CwiseNullaryOp
< internal::linspaced_op
< Scalar, false >, Derived > 
SequentialLinSpacedReturnType
typedef ArrayBase StorageBaseType
typedef internal::traits
< Derived >::StorageKind 
StorageKind

Public Member Functions

EIGEN_STRONG_INLINE const
CwiseUnaryOp
< internal::scalar_abs_op
< Scalar >, const Derived > 
abs () const
EIGEN_STRONG_INLINE const
CwiseUnaryOp
< internal::scalar_abs2_op
< Scalar >, const Derived > 
abs2 () const
const CwiseUnaryOp
< internal::scalar_acos_op
< Scalar >, const Derived > 
acos () const
bool all (void) const
bool any (void) const
ArrayBase< Derived > & array ()
const ArrayBase< Derived > & array () const
const CwiseUnaryOp
< internal::scalar_asin_op
< Scalar >, const Derived > 
asin () const
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp< CustomBinaryOp,
const Derived, const
OtherDerived > 
binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
Block< Derived > block (Index startRow, Index startCol, Index blockRows, Index blockCols)
const Block< const Derived > block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
template<int BlockRows, int BlockCols>
Block< Derived, BlockRows,
BlockCols > 
block (Index startRow, Index startCol)
template<int BlockRows, int BlockCols>
const Block< const Derived,
BlockRows, BlockCols > 
block (Index startRow, Index startCol) const
Block< Derived > bottomLeftCorner (Index cRows, Index cCols)
const Block< const Derived > bottomLeftCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomLeftCorner ()
template<int CRows, int CCols>
const Block< const Derived,
CRows, CCols > 
bottomLeftCorner () const
Block< Derived > bottomRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const Block< const Derived,
CRows, CCols > 
bottomRightCorner () const
const Block< const Derived > bottomRightCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomRightCorner ()
RowsBlockXpr bottomRows (Index n)
ConstRowsBlockXpr bottomRows (Index n) const
template<int N>
NRowsBlockXpr< N >::Type bottomRows ()
template<int N>
ConstNRowsBlockXpr< N >::Type bottomRows () const
template<typename NewType >
internal::cast_return_type
< Derived, const CwiseUnaryOp
< internal::scalar_cast_op
< typename internal::traits
< Derived >::Scalar, NewType >
, const Derived > >::type 
cast () const
ColXpr col (Index i)
ConstColXpr col (Index i) const
ConstColwiseReturnType colwise () const
ColwiseReturnType colwise ()
ConjugateReturnType conjugate () const
const CwiseUnaryOp
< internal::scalar_cos_op
< Scalar >, const Derived > 
cos () const
Index count () const
const CwiseUnaryOp
< internal::scalar_cube_op
< Scalar >, const Derived > 
cube () const
EIGEN_STRONG_INLINE const
CwiseUnaryOp
< internal::scalar_abs_op
< Scalar >, const Derived > 
cwiseAbs () const
EIGEN_STRONG_INLINE const
CwiseUnaryOp
< internal::scalar_abs2_op
< Scalar >, const Derived > 
cwiseAbs2 () const
template<typename OtherDerived >
const CwiseBinaryOp
< std::equal_to< Scalar >
, const Derived, const
OtherDerived > 
cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseUnaryOp
< std::binder1st
< std::equal_to< Scalar >
>, const Derived > 
cwiseEqual (const Scalar &s) const
const CwiseUnaryOp
< internal::scalar_inverse_op
< Scalar >, const Derived > 
cwiseInverse () const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_max_op
< Scalar >, const Derived,
const OtherDerived > 
cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_min_op
< Scalar >, const Derived,
const OtherDerived > 
cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
const CwiseBinaryOp
< std::not_equal_to< Scalar >
, const Derived, const
OtherDerived > 
cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar >, const Derived,
const OtherDerived > 
cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseUnaryOp
< internal::scalar_sqrt_op
< Scalar >, const Derived > 
cwiseSqrt () const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) operator*(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const
internal::eval< Derived >
::type 
eval () const
template<typename Dest >
void evalTo (Dest &) const
const CwiseUnaryOp
< internal::scalar_exp_op
< Scalar >, const Derived > 
exp () const
void fill (const Scalar &value)
template<unsigned int Added, unsigned int Removed>
const Flagged< Derived, Added,
Removed > 
flagged () const
const ForceAlignedAccess< Derived > forceAlignedAccess () const
ForceAlignedAccess< Derived > forceAlignedAccess ()
template<bool Enable>
const internal::conditional
< Enable, ForceAlignedAccess
< Derived >, Derived & >::type 
forceAlignedAccessIf () const
template<bool Enable>
internal::conditional< Enable,
ForceAlignedAccess< Derived >
, Derived & >::type 
forceAlignedAccessIf ()
const WithFormat< Derived > format (const IOFormat &fmt) const
DenseBase::ConstSegmentReturnType head (Index size) const
SegmentReturnType head (Index size)
template<int Size>
FixedSegmentReturnType< Size >
::Type 
head ()
template<int Size>
ConstFixedSegmentReturnType
< Size >::Type 
head () const
const ImagReturnType imag () const
NonConstImagReturnType imag ()
Index innerSize () const
const CwiseUnaryOp
< internal::scalar_inverse_op
< Scalar >, const Derived > 
inverse () const
template<typename OtherDerived >
bool isApprox (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isApproxToConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isMuchSmallerThan (const RealScalar &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
bool isMuchSmallerThan (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
template<typename Derived >
bool isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, RealScalar prec) const
bool isOnes (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isZero (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
Derived & lazyAssign (const DenseBase< OtherDerived > &other)
ColsBlockXpr leftCols (Index n)
ConstColsBlockXpr leftCols (Index n) const
template<int N>
NColsBlockXpr< N >::Type leftCols ()
template<int N>
ConstNColsBlockXpr< N >::Type leftCols () const
const CwiseUnaryOp
< internal::scalar_log_op
< Scalar >, const Derived > 
log () const
template<int p>
RealScalar lpNorm () const
MatrixWrapper< Derived > matrix ()
const MatrixWrapper< Derived > matrix () const
internal::traits< Derived >::Scalar maxCoeff () const
template<typename IndexType >
internal::traits< Derived >::Scalar maxCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
internal::traits< Derived >::Scalar maxCoeff (IndexType *index) const
Scalar mean () const
ColsBlockXpr middleCols (Index startCol, Index numCols)
ConstColsBlockXpr middleCols (Index startCol, Index numCols) const
template<int N>
NColsBlockXpr< N >::Type middleCols (Index startCol)
template<int N>
ConstNColsBlockXpr< N >::Type middleCols (Index startCol) const
ConstRowsBlockXpr middleRows (Index startRow, Index numRows) const
template<int N>
NRowsBlockXpr< N >::Type middleRows (Index startRow)
RowsBlockXpr middleRows (Index startRow, Index numRows)
template<int N>
ConstNRowsBlockXpr< N >::Type middleRows (Index startRow) const
template<typename IndexType >
internal::traits< Derived >::Scalar minCoeff (IndexType *index) const
internal::traits< Derived >::Scalar minCoeff () const
template<typename IndexType >
internal::traits< Derived >::Scalar minCoeff (IndexType *row, IndexType *col) const
const NestByValue< Derived > nestByValue () const
Index nonZeros () const
void operator* () const
const CwiseUnaryOp
< internal::scalar_multiple2_op
< Scalar, std::complex< Scalar >
>, const Derived > 
operator* (const std::complex< Scalar > &scalar) const
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
Derived & operator*= (const Scalar &other)
template<typename OtherDerived >
Derived & operator*= (const ArrayBase< OtherDerived > &other)
const CwiseUnaryOp
< internal::scalar_add_op
< Scalar >, const Derived > 
operator+ (const Scalar &scalar) const
template<typename OtherDerived >
Derived & operator+= (const ArrayBase< OtherDerived > &other)
Derived & operator+= (const Scalar &scalar)
template<typename OtherDerived >
Derived & operator+= (const EigenBase< OtherDerived > &other)
const CwiseUnaryOp
< internal::scalar_opposite_op
< typename internal::traits
< Derived >::Scalar >, const
Derived > 
operator- () const
const CwiseUnaryOp
< internal::scalar_add_op
< Scalar >, const Derived > 
operator- (const Scalar &scalar) const
Derived & operator-= (const Scalar &scalar)
template<typename OtherDerived >
Derived & operator-= (const ArrayBase< OtherDerived > &other)
template<typename OtherDerived >
Derived & operator-= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar >, const Derived,
const OtherDerived > 
operator/ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseUnaryOp
< internal::scalar_quotient1_op
< typename internal::traits
< Derived >::Scalar >, const
Derived > 
operator/ (const Scalar &scalar) const
Derived & operator/= (const Scalar &other)
template<typename OtherDerived >
Derived & operator/= (const ArrayBase< OtherDerived > &other)
CommaInitializer< Derived > operator<< (const Scalar &s)
template<typename OtherDerived >
CommaInitializer< Derived > operator<< (const DenseBase< OtherDerived > &other)
Derived & operator= (const ArrayBase &other)
Index outerSize () const
const CwiseUnaryOp
< internal::scalar_pow_op
< Scalar >, const Derived > 
pow (const Scalar &exponent) const
Scalar prod () const
NonConstRealReturnType real ()
RealReturnType real () const
template<int RowFactor, int ColFactor>
const Replicate< Derived,
RowFactor, ColFactor > 
replicate () const
const Replicate< Derived,
Dynamic, Dynamic > 
replicate (Index rowFacor, Index colFactor) const
void resize (Index size)
void resize (Index rows, Index cols)
ConstReverseReturnType reverse () const
ReverseReturnType reverse ()
void reverseInPlace ()
template<int N>
NColsBlockXpr< N >::Type rightCols ()
ConstColsBlockXpr rightCols (Index n) const
ColsBlockXpr rightCols (Index n)
template<int N>
ConstNColsBlockXpr< N >::Type rightCols () const
RowXpr row (Index i)
ConstRowXpr row (Index i) const
RowwiseReturnType rowwise ()
ConstRowwiseReturnType rowwise () const
DenseBase::ConstSegmentReturnType segment (Index start, Index size) const
template<int Size>
FixedSegmentReturnType< Size >
::Type 
segment (Index start)
SegmentReturnType segment (Index start, Index size)
template<int Size>
ConstFixedSegmentReturnType
< Size >::Type 
segment (Index start) const
template<typename ThenDerived , typename ElseDerived >
const Select< Derived,
ThenDerived, ElseDerived > 
select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
template<typename ElseDerived >
const Select< Derived,
typename
ElseDerived::ConstantReturnType,
ElseDerived > 
select (typename ElseDerived::Scalar thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
template<typename ThenDerived >
const Select< Derived,
ThenDerived, typename
ThenDerived::ConstantReturnType > 
select (const DenseBase< ThenDerived > &thenMatrix, typename ThenDerived::Scalar elseScalar) const
Derived & setConstant (const Scalar &value)
Derived & setLinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly space vector.
Derived & setLinSpaced (const Scalar &low, const Scalar &high)
Derived & setOnes ()
Derived & setRandom ()
Derived & setZero ()
const CwiseUnaryOp
< internal::scalar_sin_op
< Scalar >, const Derived > 
sin () const
const CwiseUnaryOp
< internal::scalar_sqrt_op
< Scalar >, const Derived > 
sqrt () const
const CwiseUnaryOp
< internal::scalar_square_op
< Scalar >, const Derived > 
square () const
Scalar sum () const
template<typename OtherDerived >
void swap (const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
template<typename OtherDerived >
void swap (PlainObjectBase< OtherDerived > &other)
template<int Size>
ConstFixedSegmentReturnType
< Size >::Type 
tail () const
SegmentReturnType tail (Index size)
template<int Size>
FixedSegmentReturnType< Size >
::Type 
tail ()
DenseBase::ConstSegmentReturnType tail (Index size) const
const CwiseUnaryOp
< internal::scalar_tan_op
< Scalar >, Derived > 
tan () const
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topLeftCorner ()
template<int CRows, int CCols>
const Block< const Derived,
CRows, CCols > 
topLeftCorner () const
const Block< const Derived > topLeftCorner (Index cRows, Index cCols) const
Block< Derived > topLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topRightCorner ()
const Block< const Derived > topRightCorner (Index cRows, Index cCols) const
Block< Derived > topRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const Block< const Derived,
CRows, CCols > 
topRightCorner () const
template<int N>
ConstNRowsBlockXpr< N >::Type topRows () const
RowsBlockXpr topRows (Index n)
template<int N>
NRowsBlockXpr< N >::Type topRows ()
ConstRowsBlockXpr topRows (Index n) const
Scalar trace () const
ConstTransposeReturnType transpose () const
Eigen::Transpose< Derived > transpose ()
void transposeInPlace ()
template<typename CustomUnaryOp >
const CwiseUnaryOp
< CustomUnaryOp, const Derived > 
unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise.
template<typename CustomViewOp >
const CwiseUnaryView
< CustomViewOp, const Derived > 
unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
CoeffReturnType value () const
template<typename Visitor >
void visit (Visitor &func) const

Static Public Member Functions

static const ConstantReturnType Constant (Index rows, Index cols, const Scalar &value)
static const ConstantReturnType Constant (Index size, const Scalar &value)
static const ConstantReturnType Constant (const Scalar &value)
static const
SequentialLinSpacedReturnType 
LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
 Sets a linearly space vector.
static const
RandomAccessLinSpacedReturnType 
LinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly space vector.
static const
SequentialLinSpacedReturnType 
LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
static const
RandomAccessLinSpacedReturnType 
LinSpaced (const Scalar &low, const Scalar &high)
template<typename CustomNullaryOp >
static const CwiseNullaryOp
< CustomNullaryOp, Derived > 
NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static const CwiseNullaryOp
< CustomNullaryOp, Derived > 
NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static const CwiseNullaryOp
< CustomNullaryOp, Derived > 
NullaryExpr (const CustomNullaryOp &func)
static const ConstantReturnType Ones ()
static const ConstantReturnType Ones (Index rows, Index cols)
static const ConstantReturnType Ones (Index size)
static const CwiseNullaryOp
< internal::scalar_random_op
< Scalar >, Derived > 
Random ()
static const CwiseNullaryOp
< internal::scalar_random_op
< Scalar >, Derived > 
Random (Index rows, Index cols)
static const CwiseNullaryOp
< internal::scalar_random_op
< Scalar >, Derived > 
Random (Index size)
static const ConstantReturnType Zero (Index size)
static const ConstantReturnType Zero (Index rows, Index cols)
static const ConstantReturnType Zero ()

Protected Member Functions

template<typename OtherDerived >
void checkTransposeAliasing (const OtherDerived &other) const
template<typename OtherDerived >
Derived & operator+= (const MatrixBase< OtherDerived > &)
template<typename OtherDerived >
Derived & operator-= (const MatrixBase< OtherDerived > &)

Private Member Functions

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

Friends

const ScalarMultipleReturnType operator* (const Scalar &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp
< internal::scalar_multiple2_op
< Scalar, std::complex< Scalar >
>, const Derived > 
operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp
< internal::scalar_add_op
< Scalar >, const Derived > 
operator+ (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)
const CwiseUnaryOp
< internal::scalar_add_op
< Scalar >, const CwiseUnaryOp
< internal::scalar_opposite_op
< Scalar >, const Derived > > 
operator- (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)

Related Functions

(Note that these are not member functions.)


template<typename Derived >
std::ostream & operator<< (std::ostream &s, const DenseBase< Derived > &m)

Detailed Description

template<typename Derived>
class 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 Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN.

See also:
class MatrixBase, The class hierarchy

Definition at line 52 of file ArrayBase.h.


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

Generated by  Doxygen 1.6.0   Back to index