Eigen  3.3.90 (mercurial changeset edbe6cfd4430)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::ArrayBase< Derived > Class Template Reference

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
+ Inheritance diagram for Eigen::ArrayBase< Derived >:

Public Member Functions

const AbsReturnType abs () const
 
const Abs2ReturnType abs2 () const
 
const AcosReturnType acos () const
 
const ArgReturnType arg () const
 
const AsinReturnType asin () const
 
const AtanReturnType atan () const
 
template<typename CustomBinaryOp , typename OtherDerived >
const CwiseBinaryOp
< CustomBinaryOp, const
Derived, const OtherDerived > 
binaryExpr (const Eigen::ArrayBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
const CeilReturnType ceil () const
 
const CosReturnType cos () const
 
const CoshReturnType cosh () const
 
const CubeReturnType cube () const
 
const CwiseAbsReturnType cwiseAbs () const
 
const CwiseAbs2ReturnType cwiseAbs2 () const
 
template<typename OtherDerived >
const CwiseBinaryOp
< std::equal_to< Scalar >
, const Derived, const
OtherDerived > 
cwiseEqual (const Eigen::ArrayBase< OtherDerived > &other) const
 
const CwiseScalarEqualReturnType cwiseEqual (const Scalar &s) const
 
const CwiseInverseReturnType cwiseInverse () const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_max_op
< Scalar, Scalar >, const
Derived, const OtherDerived > 
cwiseMax (const Eigen::ArrayBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_max_op
< Scalar, Scalar >, const
Derived, const
ConstantReturnType > 
cwiseMax (const Scalar &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_min_op
< Scalar, Scalar >, const
Derived, const OtherDerived > 
cwiseMin (const Eigen::ArrayBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_min_op
< Scalar, Scalar >, const
Derived, const
ConstantReturnType > 
cwiseMin (const Scalar &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp
< std::not_equal_to< Scalar >
, const Derived, const
OtherDerived > 
cwiseNotEqual (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_product_op
< Derived::Scalar,
OtherDerived::Scalar >, const
Derived, const OtherDerived > 
cwiseProduct (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar >, const Derived,
const OtherDerived > 
cwiseQuotient (const Eigen::ArrayBase< OtherDerived > &other) const
 
const CwiseSignReturnType cwiseSign () const
 
const CwiseSqrtReturnType cwiseSqrt () const
 
const DigammaReturnType digamma () const
 
const ErfReturnType erf () const
 
const ErfcReturnType erfc () const
 
const ExpReturnType exp () const
 
const Expm1ReturnType expm1 () const
 
const FloorReturnType floor () const
 
const InverseReturnType inverse () const
 
const IsFiniteReturnType isFinite () const
 
const IsInfReturnType isInf () const
 
const IsNaNReturnType isNaN () const
 
const LgammaReturnType lgamma () const
 
const LogReturnType log () const
 
const Log10ReturnType log10 () const
 
const Log1pReturnType log1p () const
 
MatrixWrapper< Derived > matrix ()
 
template<typename OtherDerived >
const CwiseBinaryOp< max
< Scalar >, const Derived,
const OtherDerived > 
max (const Eigen::ArrayBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_max_op
< Scalar, Scalar >, const
Derived, const CwiseNullaryOp
< internal::scalar_constant_op
< Scalar >, PlainObject > > 
max (const Scalar &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp< min
< Scalar >, const Derived,
const OtherDerived > 
min (const Eigen::ArrayBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_min_op
< Scalar, Scalar >, const
Derived, const CwiseNullaryOp
< internal::scalar_constant_op
< Scalar >, PlainObject > > 
min (const Scalar &other) const
 
const BooleanNotReturnType operator! () const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_boolean_and_op,
const Derived, const
OtherDerived > 
operator&& (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_product_op
< Derived::Scalar,
OtherDerived::Scalar >, const
Derived, const OtherDerived > 
operator* (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_product_op
< Scalar, T >, Derived,
Constant< T > > 
operator* (const T &scalar) const
 
template<typename OtherDerived >
Derived & operator*= (const ArrayBase< OtherDerived > &other)
 
template<typename OtherDerived >
const CwiseBinaryOp< sum
< Scalar >, const Derived,
const OtherDerived > 
operator+ (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_sum_op
< Scalar, T >, Derived,
Constant< T > > 
operator+ (const T &scalar) const
 
template<typename OtherDerived >
Derived & operator+= (const ArrayBase< OtherDerived > &other)
 
template<typename OtherDerived >
const CwiseBinaryOp
< difference< Scalar >, const
Derived, const OtherDerived > 
operator- (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_difference_op
< Scalar, T >, Derived,
Constant< T > > 
operator- (const T &scalar) const
 
template<typename OtherDerived >
Derived & operator-= (const ArrayBase< OtherDerived > &other)
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar, typename
OtherDerived::Scalar >, const
Derived, const OtherDerived > 
operator/ (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar, T >, Derived,
Constant< T > > 
operator/ (const T &scalar) const
 
template<typename OtherDerived >
Derived & operator/= (const ArrayBase< OtherDerived > &other)
 
Derived & operator= (const ArrayBase &other)
 
Derived & operator= (const Scalar &value)
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_boolean_xor_op,
const Derived, const
OtherDerived > 
operator^ (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp
< internal::scalar_boolean_or_op,
const Derived, const
OtherDerived > 
operator|| (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename OtherDerived >
const CwiseBinaryOp< pow
< Scalar >, const Derived,
const OtherDerived > 
pow (const Eigen::ArrayBase< OtherDerived > &other) const
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_pow_op
< Scalar, T >, Derived,
Constant< T > > 
pow (const T &exponent) const
 
const RoundReturnType round () const
 
const RsqrtReturnType rsqrt () const
 
const SignReturnType sign () const
 
const SinReturnType sin () const
 
const SinhReturnType sinh () const
 
const SqrtReturnType sqrt () const
 
const SquareReturnType square () const
 
const TanReturnType tan () const
 
const TanhReturnType tanh () const
 
template<typename DerivedQ >
const CwiseBinaryOp
< internal::scalar_zeta_op
< Scalar >, const Derived,
const DerivedQ > 
zeta (const Eigen::ArrayBase< DerivedQ > &q) const
 
- Public Member Functions inherited from Eigen::DenseBase< Derived >
bool all () const
 
bool allFinite () const
 
bool any () const
 
template<typename NRowsType , typename NColsType >
FixedBlockXpr<...,...>::Type block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)
 
template<typename NRowsType , typename NColsType >
const ConstFixedBlockXpr
<...,...>::Type 
block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) const
 This is the const version of block(Index,Index,NRowsType,NColsType)
 
template<int NRows, int NCols>
FixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol)
 
template<int NRows, int NCols>
const ConstFixedBlockXpr
< NRows, NCols >::Type 
block (Index startRow, Index startCol) const
 This is the const version of block<>(Index, Index). */.
 
template<int NRows, int NCols>
FixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
template<int NRows, int NCols>
const ConstFixedBlockXpr
< NRows, NCols >::Type 
block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 This is the const version of block<>(Index, Index, Index, Index).
 
template<typename NRowsType , typename NColsType >
FixedBlockXpr<...,...>::Type bottomLeftCorner (NRowsType cRows, NColsType cCols)
 
template<typename NRowsType , typename NColsType >
ConstFixedBlockXpr<...,...>::Type bottomLeftCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of bottomLeftCorner(NRowsType, NColsType).
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
bottomLeftCorner () const
 This is the const version of bottomLeftCorner<int, int>().
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
bottomLeftCorner (Index cRows, Index cCols) const
 This is the const version of bottomLeftCorner<int, int>(Index, Index).
 
template<typename NRowsType , typename NColsType >
FixedBlockXpr<...,...>::Type bottomRightCorner (NRowsType cRows, NColsType cCols)
 
template<typename NRowsType , typename NColsType >
const ConstFixedBlockXpr
<...,...>::Type 
bottomRightCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of bottomRightCorner(NRowsType, NColsType).
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type bottomRightCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
bottomRightCorner () const
 This is the const version of bottomRightCorner<int, int>().
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type bottomRightCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner<int, int>(Index, Index).
 
template<typename NRowsType >
NRowsBlockXpr<...>::Type bottomRows (NRowsType n)
 
template<typename NRowsType >
const ConstNRowsBlockXpr<...>::Type bottomRows (NRowsType n) const
 This is the const version of bottomRows(NRowsType).
 
template<int N>
NRowsBlockXpr< N >::Type bottomRows (Index n=N)
 
template<int N>
ConstNRowsBlockXpr< N >::Type bottomRows (Index n=N) const
 This is the const version of bottomRows<int>().
 
template<typename NewType >
CastXpr< NewType >::Type cast () const
 
ColXpr col (Index i)
 
ConstColXpr col (Index i) const
 This is the const version of col().
 
ConstColwiseReturnType colwise () const
 
ColwiseReturnType colwise ()
 
ConjugateReturnType conjugate () const
 
Index count () const
 
EvalReturnType eval () const
 
void fill (const Scalar &value)
 
template<unsigned int Added, unsigned int Removed>
EIGEN_DEPRECATED const Derived & flagged () const
 
const WithFormat< Derived > format (const IOFormat &fmt) const
 
bool hasNaN () const
 
template<typename NType >
FixedSegmentReturnType<...>::Type head (NType n)
 
template<typename NType >
const
ConstFixedSegmentReturnType
<...>::Type 
head (NType n) const
 This is the const version of head(NType).
 
template<int N>
FixedSegmentReturnType< N >::Type head (Index n=N)
 
template<int N>
ConstFixedSegmentReturnType< N >
::Type 
head (Index n=N) const
 This is the const version of head<int>().
 
const ImagReturnType imag () const
 
NonConstImagReturnType imag ()
 
Index innerSize () const
 
template<typename OtherDerived >
bool isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
template<typename Derived >
bool isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const
 
template<typename OtherDerived >
bool isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
template<typename NColsType >
NColsBlockXpr<...>::Type leftCols (NColsType n)
 
template<typename NColsType >
const ConstNColsBlockXpr<...>::Type leftCols (NColsType n) const
 This is the const version of leftCols(NColsType).
 
template<int N>
NColsBlockXpr< N >::Type leftCols (Index n=N)
 
template<int N>
ConstNColsBlockXpr< N >::Type leftCols (Index n=N) const
 This is the const version of leftCols<int>().
 
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
 
template<typename NColsType >
NColsBlockXpr<...>::Type middleCols (Index startCol, NColsType numCols)
 
template<typename NColsType >
const ConstNColsBlockXpr<...>::Type middleCols (Index startCol, NColsType numCols) const
 This is the const version of middleCols(Index,NColsType).
 
template<int N>
NColsBlockXpr< N >::Type middleCols (Index startCol, Index n=N)
 
template<int N>
ConstNColsBlockXpr< N >::Type middleCols (Index startCol, Index n=N) const
 This is the const version of middleCols<int>().
 
template<typename NRowsType >
NRowsBlockXpr<...>::Type middleRows (Index startRow, NRowsType n)
 
template<typename NRowsType >
const ConstNRowsBlockXpr<...>::Type middleRows (Index startRow, NRowsType n) const
 This is the const version of middleRows(Index,NRowsType).
 
template<int N>
NRowsBlockXpr< N >::Type middleRows (Index startRow, Index n=N)
 
template<int N>
ConstNRowsBlockXpr< N >::Type middleRows (Index startRow, Index n=N) const
 This is the const version of middleRows<int>().
 
internal::traits< Derived >::Scalar minCoeff () const
 
template<typename IndexType >
internal::traits< Derived >::Scalar minCoeff (IndexType *row, IndexType *col) const
 
template<typename IndexType >
internal::traits< Derived >::Scalar minCoeff (IndexType *index) const
 
const NestByValue< Derived > nestByValue () const
 
Index nonZeros () const
 
template<typename CustomNullaryOp >
const CwiseNullaryOp
< CustomNullaryOp, typename
DenseBase< Derived >
::PlainObject
NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
 
template<typename CustomNullaryOp >
const CwiseNullaryOp
< CustomNullaryOp, typename
DenseBase< Derived >
::PlainObject
NullaryExpr (Index size, const CustomNullaryOp &func)
 
template<typename CustomNullaryOp >
const CwiseNullaryOp
< CustomNullaryOp, typename
DenseBase< Derived >
::PlainObject
NullaryExpr (const CustomNullaryOp &func)
 
template<typename RowIndices , typename ColIndices >
IndexedView_or_Block operator() (const RowIndices &rowIndices, const ColIndices &colIndices)
 
template<typename Indices >
IndexedView_or_VectorBlock operator() (const Indices &indices)
 
const NegativeReturnType operator- () const
 
CommaInitializer< Derived > operator<< (const Scalar &s)
 
template<typename OtherDerived >
CommaInitializer< Derived > operator<< (const DenseBase< OtherDerived > &other)
 
template<typename OtherDerived >
Derived & operator= (const DenseBase< OtherDerived > &other)
 
Derived & operator= (const DenseBase &other)
 
template<typename OtherDerived >
Derived & operator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this. More...
 
Index outerSize () const
 
Scalar prod () const
 
RealReturnType real () const
 
NonConstRealReturnType real ()
 
template<typename Func >
internal::traits< Derived >::Scalar redux (const Func &func) const
 
template<int RowFactor, int ColFactor>
const Replicate< Derived,
RowFactor, ColFactor > 
replicate () const
 
const Replicate< Derived,
Dynamic, Dynamic
replicate (Index rowFactor, Index colFactor) const
 
void resize (Index newSize)
 
void resize (Index rows, Index cols)
 
ReverseReturnType reverse ()
 
ConstReverseReturnType reverse () const
 
void reverseInPlace ()
 
template<typename NColsType >
NColsBlockXpr<...>::Type rightCols (NColsType n)
 
template<typename NColsType >
const ConstNColsBlockXpr<...>::Type rightCols (NColsType n) const
 This is the const version of rightCols(NColsType).
 
template<int N>
NColsBlockXpr< N >::Type rightCols (Index n=N)
 
template<int N>
ConstNColsBlockXpr< N >::Type rightCols (Index n=N) const
 This is the const version of rightCols<int>().
 
RowXpr row (Index i)
 
ConstRowXpr row (Index i) const
 This is the const version of row(). */.
 
ConstRowwiseReturnType rowwise () const
 
RowwiseReturnType rowwise ()
 
template<typename NType >
FixedSegmentReturnType<...>::Type segment (Index start, NType n)
 
template<typename NType >
const
ConstFixedSegmentReturnType
<...>::Type 
segment (Index start, NType n) const
 This is the const version of segment(Index,NType).
 
template<int N>
FixedSegmentReturnType< N >::Type segment (Index start, Index n=N)
 
template<int N>
ConstFixedSegmentReturnType< N >
::Type 
segment (Index start, Index n=N) const
 This is the const version of segment<int>(Index).
 
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
 
Derived & setConstant (const Scalar &value)
 
Derived & setLinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
Derived & setLinSpaced (const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
Derived & setOnes ()
 
Derived & setRandom ()
 
Derived & setZero ()
 
Scalar sum () const
 
template<typename OtherDerived >
void swap (const DenseBase< OtherDerived > &other)
 
template<typename OtherDerived >
void swap (PlainObjectBase< OtherDerived > &other)
 
template<typename NType >
FixedSegmentReturnType<...>::Type tail (NType n)
 
template<typename NType >
const
ConstFixedSegmentReturnType
<...>::Type 
tail (NType n) const
 This is the const version of tail(Index).
 
template<int N>
FixedSegmentReturnType< N >::Type tail (Index n=N)
 
template<int N>
ConstFixedSegmentReturnType< N >
::Type 
tail (Index n=N) const
 This is the const version of tail<int>.
 
template<typename NRowsType , typename NColsType >
FixedBlockXpr<...,...>::Type topLeftCorner (NRowsType cRows, NColsType cCols)
 
template<typename NRowsType , typename NColsType >
const ConstFixedBlockXpr
<...,...>::Type 
topLeftCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of topLeftCorner(Index, Index).
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type topLeftCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
topLeftCorner () const
 This is the const version of topLeftCorner<int, int>().
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type topLeftCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner<int, int>(Index, Index).
 
template<typename NRowsType , typename NColsType >
FixedBlockXpr<...,...>::Type topRightCorner (NRowsType cRows, NColsType cCols)
 
template<typename NRowsType , typename NColsType >
const ConstFixedBlockXpr
<...,...>::Type 
topRightCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of topRightCorner(NRowsType, NColsType).
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type topRightCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
topRightCorner () const
 This is the const version of topRightCorner<int, int>().
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type topRightCorner (Index cRows, Index cCols)
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner<int, int>(Index, Index).
 
template<typename NRowsType >
NRowsBlockXpr<...>::Type topRows (NRowsType n)
 
template<typename NRowsType >
const ConstNRowsBlockXpr<...>::Type topRows (NRowsType n) const
 This is the const version of topRows(NRowsType).
 
template<int N>
NRowsBlockXpr< N >::Type topRows (Index n=N)
 
template<int N>
ConstNRowsBlockXpr< N >::Type topRows (Index n=N) const
 This is the const version of topRows<int>().
 
TransposeReturnType transpose ()
 
ConstTransposeReturnType transpose () const
 
void transposeInPlace ()
 
template<typename CustomUnaryOp >
const CwiseUnaryOp
< CustomUnaryOp, const Derived > 
unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
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
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >
Index colStride () const
 
Index innerStride () const
 
Index outerStride () const
 
Index rowStride () const
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
Scalar & coeffRef (Index row, Index col)
 
Scalar & coeffRef (Index index)
 
Scalar & operator() (Index row, Index col)
 
Scalar & operator() (Index index)
 
Scalar & operator[] (Index index)
 
Scalar & w ()
 
Scalar & x ()
 
Scalar & y ()
 
Scalar & z ()
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
CoeffReturnType coeff (Index row, Index col) const
 
CoeffReturnType coeff (Index index) const
 
CoeffReturnType operator() (Index row, Index col) const
 
CoeffReturnType operator() (Index index) const
 
CoeffReturnType operator[] (Index index) const
 
CoeffReturnType w () const
 
CoeffReturnType x () const
 
CoeffReturnType y () const
 
CoeffReturnType z () const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
Index cols () const
 
Derived & derived ()
 
const Derived & derived () const
 
Index rows () const
 
Index size () const
 

Friends

template<typename T >
const CwiseBinaryOp
< internal::scalar_product_op
< T, Scalar >, Constant< T >
, Derived > 
operator* (const T &scalar, const StorageBaseType &expr)
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_sum_op< T,
Scalar >, Constant< T >
, Derived > 
operator+ (const T &scalar, const StorageBaseType &expr)
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_difference_op
< T, Scalar >, Constant< T >
, Derived > 
operator- (const T &scalar, const StorageBaseType &expr)
 
template<typename T >
const CwiseBinaryOp
< internal::scalar_quotient_op
< T, Scalar >, Constant< T >
, Derived > 
operator/ (const T &s, const StorageBaseType &a)
 Component-wise division of the scalar s by array elements of a. More...
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from Eigen::DenseBase< Derived >
enum  {
  RowsAtCompileTime,
  ColsAtCompileTime,
  SizeAtCompileTime,
  MaxRowsAtCompileTime,
  MaxColsAtCompileTime,
  MaxSizeAtCompileTime,
  IsVectorAtCompileTime,
  Flags,
  IsRowMajor
}
 
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 internal::traits
< Derived >::Scalar 
Scalar
 
typedef internal::traits
< Derived >::StorageIndex 
StorageIndex
 The type used to store indices. More...
 
typedef Scalar value_type
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
- Static Public Member Functions inherited from Eigen::DenseBase< Derived >
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)
 
static const
RandomAccessLinSpacedReturnType 
LinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
static const
SequentialLinSpacedReturnType 
LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
 
static const
RandomAccessLinSpacedReturnType 
LinSpaced (const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
static const ConstantReturnType Ones (Index rows, Index cols)
 
static const ConstantReturnType Ones (Index size)
 
static const ConstantReturnType Ones ()
 
static const RandomReturnType Random (Index rows, Index cols)
 
static const RandomReturnType Random (Index size)
 
static const RandomReturnType Random ()
 
static const ConstantReturnType Zero (Index rows, Index cols)
 
static const ConstantReturnType Zero (Index size)
 
static const ConstantReturnType Zero ()
 
- Protected Member Functions inherited from Eigen::DenseBase< Derived >
 DenseBase ()
 

Member Function Documentation

template<typename Derived>
const AbsReturnType Eigen::ArrayBase< Derived >::abs ( ) const
inline
Returns
an expression of the coefficient-wise absolute value of *this

Example:

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

Output:

1
2
3
See Also
Math functions, abs2()
template<typename Derived>
const Abs2ReturnType Eigen::ArrayBase< Derived >::abs2 ( ) const
inline
Returns
an expression of the coefficient-wise squared absolute value of *this

Example:

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

Output:

1
4
9
See Also
Math functions, abs(), square()
template<typename Derived>
const AcosReturnType Eigen::ArrayBase< Derived >::acos ( ) const
inline
Returns
an expression of the coefficient-wise arc cosine of *this.

Example:

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

Output:

 1.57
0.785
    0
See Also
Math functions, cos(), asin()
template<typename Derived>
const ArgReturnType Eigen::ArrayBase< Derived >::arg ( ) const
inline
Returns
an expression of the coefficient-wise phase angle of *this

Example:

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

Output:

 (-0.211,0.68)
 (0.597,0.566)
(-0.605,0.823)

 1.87
0.759
  2.2
See Also
abs()
template<typename Derived>
const AsinReturnType Eigen::ArrayBase< Derived >::asin ( ) const
inline
Returns
an expression of the coefficient-wise arc sine of *this.

Example:

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

Output:

    0
0.785
 1.57
See Also
Math functions, sin(), acos()
template<typename Derived>
const AtanReturnType Eigen::ArrayBase< Derived >::atan ( ) const
inline
Returns
an expression of the coefficient-wise arc tan of *this.

Example:

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

Output:

    0
0.245
0.464
0.644
0.785
See Also
Math functions, tan(), asin(), acos()
template<typename Derived>
template<typename CustomBinaryOp , typename OtherDerived >
const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::binaryExpr ( const Eigen::ArrayBase< OtherDerived > &  other,
const CustomBinaryOp &  func = CustomBinaryOp() 
) const
inline
Returns
an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;
// define a custom template binary functor
template<typename Scalar> struct MakeComplexOp {
EIGEN_EMPTY_STRUCT_CTOR(MakeComplexOp)
typedef complex<Scalar> result_type;
complex<Scalar> operator()(const Scalar& a, const Scalar& b) const { return complex<Scalar>(a,b); }
};
int main(int, char**)
{
cout << m1.binaryExpr(m2, MakeComplexOp<double>()) << endl;
return 0;
}

Output:

   (0.68,0.271)  (0.823,-0.967) (-0.444,-0.687)   (-0.27,0.998)
 (-0.211,0.435) (-0.605,-0.514)  (0.108,-0.198) (0.0268,-0.563)
 (0.566,-0.717)  (-0.33,-0.726) (-0.0452,-0.74)  (0.904,0.0259)
  (0.597,0.214)   (0.536,0.608)  (0.258,-0.782)   (0.832,0.678)
See Also
class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()
template<typename Derived>
const CeilReturnType Eigen::ArrayBase< Derived >::ceil ( ) const
inline
Returns
an expression of the coefficient-wise ceil of *this.

Example:

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

Output:

    -2
 -1.33
-0.667
     0
 0.667
  1.33
     2

-2
-1
-0
 0
 1
 2
 2
See Also
Math functions, floor(), round()
template<typename Derived>
const CosReturnType Eigen::ArrayBase< Derived >::cos ( ) const
inline
Returns
an expression of the coefficient-wise cosine of *this.

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

Example:

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

Output:

      -1
6.12e-17
     0.5
See Also
Math functions, sin(), acos()
template<typename Derived>
const CoshReturnType Eigen::ArrayBase< Derived >::cosh ( ) const
inline
Returns
an expression of the coefficient-wise hyperbolic cos of *this.

Example:

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

Output:

   1
1.03
1.13
1.29
1.54
See Also
Math functions, tan(), sinh(), cosh()
template<typename Derived>
const CubeReturnType Eigen::ArrayBase< Derived >::cube ( ) const
inline
Returns
an expression of the coefficient-wise cube of *this.

Example:

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

Output:

 8
27
64
See Also
Math functions, square(), pow()
template<typename Derived>
const CwiseAbsReturnType Eigen::ArrayBase< Derived >::cwiseAbs ( ) const
inline
Returns
an expression of the coefficient-wise absolute value of *this

Example:

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

Output:

2 4 6
5 1 0
See Also
cwiseAbs2()
template<typename Derived>
const CwiseAbs2ReturnType Eigen::ArrayBase< Derived >::cwiseAbs2 ( ) const
inline
Returns
an expression of the coefficient-wise squared absolute value of *this

Example:

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

Output:

 4 16 36
25  1  0
See Also
cwiseAbs()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::cwiseEqual ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise == operator of *this and other
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

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

Output:

Comparing m with identity matrix:
1 1
0 1
Number of coefficients that are equal: 3
See Also
cwiseNotEqual(), isApprox(), isMuchSmallerThan()
template<typename Derived>
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
template<typename Derived>
const CwiseInverseReturnType Eigen::ArrayBase< Derived >::cwiseInverse ( ) const
inline
Returns
an expression of the coefficient-wise inverse of *this.

Example:

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

Output:

  0.5     2     1
0.333     4     1
See Also
cwiseProduct()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_max_op<Scalar,Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::cwiseMax ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise max of *this and other

Example:

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

Output:

4
3
4
See Also
class CwiseBinaryOp, min()
template<typename Derived>
const CwiseBinaryOp<internal::scalar_max_op<Scalar,Scalar>, const Derived, const ConstantReturnType> Eigen::ArrayBase< Derived >::cwiseMax ( const Scalar other) const
inline
Returns
an expression of the coefficient-wise max of *this and scalar other
See Also
class CwiseBinaryOp, min()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_min_op<Scalar,Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::cwiseMin ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise min of *this and other

Example:

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

Output:

2
2
3
See Also
class CwiseBinaryOp, max()
template<typename Derived>
const CwiseBinaryOp<internal::scalar_min_op<Scalar,Scalar>, const Derived, const ConstantReturnType> Eigen::ArrayBase< Derived >::cwiseMin ( const Scalar other) const
inline
Returns
an expression of the coefficient-wise min of *this and scalar other
See Also
class CwiseBinaryOp, min()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::cwiseNotEqual ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise != operator of *this and other
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

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

Output:

Comparing m with identity matrix:
0 0
1 0
Number of coefficients that are not equal: 1
See Also
cwiseEqual(), isApprox(), isMuchSmallerThan()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_product_op < Derived ::Scalar, OtherDerived ::Scalar>, const Derived , const OtherDerived > Eigen::ArrayBase< Derived >::cwiseProduct ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the Schur product (coefficient wise product) of *this and other

Example:

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

Output:

a:
 7  6 -3
-2  9  6
 6 -6 -5
b:
 1 -3  9
 0  0  3
 3  9  5
c:
  7 -18 -27
  0   0  18
 18 -54 -25
See Also
class CwiseBinaryOp, cwiseAbs2
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::cwiseQuotient ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise quotient of *this and other

Example:

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

Output:

 0.5
 1.5
1.33
See Also
class CwiseBinaryOp, cwiseProduct(), cwiseInverse()
template<typename Derived>
const CwiseSignReturnType Eigen::ArrayBase< Derived >::cwiseSign ( ) const
inline
Returns
an expression of the coefficient-wise signum of *this.

Example:

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

Output:

 1 -1  1
-1  1  0
template<typename Derived>
const CwiseSqrtReturnType Eigen::ArrayBase< Derived >::cwiseSqrt ( ) const
inline
Returns
an expression of the coefficient-wise square root of *this.

Example:

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

Output:

   1
1.41
   2
See Also
cwisePow(), cwiseSquare()
template<typename Derived>
const DigammaReturnType Eigen::ArrayBase< Derived >::digamma ( ) const
inline
Returns
an expression of the coefficient-wise digamma (psi, derivative of lgamma).

This is defined in the unsupported SpecialFunctions module.

#include <Eigen/SpecialFunctions>
Note
This function supports only float and double scalar types. To support other scalar types, the user has to provide implementations of digamma(T) for any scalar type T to be supported.
See Also
Math functions, Eigen::digamma(), Eigen::polygamma(), lgamma()
template<typename Derived>
const ErfReturnType Eigen::ArrayBase< Derived >::erf ( ) const
inline

[c++11]

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

This is defined in the unsupported SpecialFunctions module.

#include <Eigen/SpecialFunctions>

Example:

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

Output:

-0.52
0.995
    0
   -1
Note
This function supports only float and double scalar types in c++11 mode. To support other scalar types, or float/double in non c++11 mode, the user has to provide implementations of erf(T) for any scalar type T to be supported.
See Also
Math functions, erfc()
template<typename Derived>
const ErfcReturnType Eigen::ArrayBase< Derived >::erfc ( ) const
inline

[c++11]

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

This is defined in the unsupported SpecialFunctions module.

#include <Eigen/SpecialFunctions>

Example:

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

Output:

   1.52
0.00468
      1
      2
Note
This function supports only float and double scalar types in c++11 mode. To support other scalar types, or float/double in non c++11 mode, the user has to provide implementations of erfc(T) for any scalar type T to be supported.
See Also
Math functions, erf()
template<typename Derived>
const ExpReturnType Eigen::ArrayBase< Derived >::exp ( ) const
inline
Returns
an expression of the coefficient-wise exponential of *this.

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

Example:

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

Output:

2.72
7.39
20.1
See Also
Math functions, pow(), log(), sin(), cos()
template<typename Derived>
const Expm1ReturnType Eigen::ArrayBase< Derived >::expm1 ( ) const
inline
Returns
an expression of the coefficient-wise exponential of *this minus 1.

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

See Also
Math functions, exp()
template<typename Derived>
const FloorReturnType Eigen::ArrayBase< Derived >::floor ( ) const
inline
Returns
an expression of the coefficient-wise floor of *this.

Example:

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

Output:

    -2
 -1.33
-0.667
     0
 0.667
  1.33
     2

-2
-2
-1
 0
 0
 1
 2
See Also
Math functions, ceil(), round()
template<typename Derived>
const InverseReturnType Eigen::ArrayBase< Derived >::inverse ( ) const
inline
Returns
an expression of the coefficient-wise inverse of *this.

Example:

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

Output:

  0.5
0.333
 0.25
See Also
operator/(), operator*()
template<typename Derived>
const IsFiniteReturnType Eigen::ArrayBase< Derived >::isFinite ( ) const
inline
Returns
an expression of the coefficient-wise isfinite of *this.

Example:

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

Output:

   1
-nan
 inf

1
0
0
See Also
isnan(), isinf()
template<typename Derived>
const IsInfReturnType Eigen::ArrayBase< Derived >::isInf ( ) const
inline
Returns
an expression of the coefficient-wise isinf of *this.

Example:

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

Output:

   1
-nan
 inf

0
0
1
See Also
isnan(), isfinite()
template<typename Derived>
const IsNaNReturnType Eigen::ArrayBase< Derived >::isNaN ( ) const
inline
Returns
an expression of the coefficient-wise isnan of *this.

Example:

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

Output:

   1
-nan
 inf

0
1
0
See Also
isfinite(), isinf()
template<typename Derived>
const LgammaReturnType Eigen::ArrayBase< Derived >::lgamma ( ) const
inline

[c++11]

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

This is defined in the unsupported SpecialFunctions module.

#include <Eigen/SpecialFunctions>

Example:

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

Output:

0.572
 12.8
  inf
  inf
Note
This function supports only float and double scalar types in c++11 mode. To support other scalar types, or float/double in non c++11 mode, the user has to provide implementations of lgamma(T) for any scalar type T to be supported.
See Also
Math functions, digamma()
template<typename Derived>
const LogReturnType Eigen::ArrayBase< Derived >::log ( ) const
inline
Returns
an expression of the coefficient-wise logarithm of *this.

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

Example:

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

Output:

    0
0.693
  1.1
See Also
Math functions, log()
template<typename Derived>
const Log10ReturnType Eigen::ArrayBase< Derived >::log10 ( ) const
inline
Returns
an expression of the coefficient-wise base-10 logarithm of *this.

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

Example:

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

Output:

  nan
 -inf
    0
0.301
See Also
Math functions, log()
template<typename Derived>
const Log1pReturnType Eigen::ArrayBase< Derived >::log1p ( ) const
inline
Returns
an expression of the coefficient-wise logarithm of 1 plus *this.

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

See Also
Math functions, log()
template<typename Derived>
MatrixWrapper<Derived> Eigen::ArrayBase< Derived >::matrix ( )
inline
Returns
an Matrix expression of this array
See Also
MatrixBase::array()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< max <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::max ( const Eigen::ArrayBase< OtherDerived > &  other) const
Returns
an expression of the coefficient-wise max of *this and other

Example:

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

Output:

4
3
4
See Also
min()
template<typename Derived>
const CwiseBinaryOp<internal::scalar_max_op<Scalar,Scalar>, const Derived, const CwiseNullaryOp<internal::scalar_constant_op<Scalar>, PlainObject> > Eigen::ArrayBase< Derived >::max ( const Scalar other) const
inline
Returns
an expression of the coefficient-wise max of *this and scalar other
See Also
min()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< min <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::min ( const Eigen::ArrayBase< OtherDerived > &  other) const
Returns
an expression of the coefficient-wise min of *this and other

Example:

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

Output:

2
2
3
See Also
max()
template<typename Derived>
const CwiseBinaryOp<internal::scalar_min_op<Scalar,Scalar>, const Derived, const CwiseNullaryOp<internal::scalar_constant_op<Scalar>, PlainObject> > Eigen::ArrayBase< Derived >::min ( const Scalar other) const
inline
Returns
an expression of the coefficient-wise min of *this and scalar other
See Also
max()
template<typename Derived>
const BooleanNotReturnType Eigen::ArrayBase< Derived >::operator! ( ) const
inline
Returns
an expression of the coefficient-wise ! operator of *this
Warning
this operator is for expression of bool only.

Example:

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

Output:

   1
-nan
 inf

0
1
1
See Also
operator!=()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_boolean_and_op, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator&& ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise boolean and operator of *this and other
Warning
this operator is for expression of bool only.

Example:

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

Output:

0
0
0
See Also
operator||(), select()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_product_op < Derived ::Scalar, OtherDerived ::Scalar>, const Derived , const OtherDerived > Eigen::ArrayBase< Derived >::operator* ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient wise product of *this and other
See Also
MatrixBase::cwiseProduct
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_product_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator* ( const T &  scalar) const
Returns
an expression of *this scaled by the scalar factor scalar
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.
template<typename Derived >
template<typename OtherDerived >
Derived & Eigen::ArrayBase< Derived >::operator*= ( const ArrayBase< OtherDerived > &  other)
inline

replaces *this by *this * other coefficient wise.

Returns
a reference to *this
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< sum <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator+ ( const Eigen::ArrayBase< OtherDerived > &  other) const
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+=()
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_sum_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator+ ( const T &  scalar) const
Returns
an expression of the coefficient-wise < operator of *this and other

Example:

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

Output:

1
0
0
See Also
all(), any(), operator>(), operator<=()
Returns
an expression of the coefficient-wise <= operator of *this and other

Example:

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

Output:

1
1
0
See Also
all(), any(), operator>=(), operator<()
Returns
an expression of the coefficient-wise > operator of *this and other

Example:

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

Output:

0
0
1
See Also
all(), any(), operator>=(), operator<()
Returns
an expression of the coefficient-wise >= operator of *this and other

Example:

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

Output:

0
1
1
See Also
all(), any(), operator>(), operator<=()
Returns
an expression of the coefficient-wise == operator of *this and other
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

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

Output:

0
1
0
See Also
all(), any(), isApprox(), isMuchSmallerThan()
Returns
an expression of the coefficient-wise != operator of *this and other
Warning
this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

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

Output:

1
0
1
See Also
all(), any(), isApprox(), isMuchSmallerThan()
Returns
an expression of *this with each coeff incremented by the constant scalar
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.

Example:

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

Output:

6
7
8
See Also
operator+=(), operator-()
template<typename Derived >
template<typename OtherDerived >
Derived & Eigen::ArrayBase< Derived >::operator+= ( const ArrayBase< OtherDerived > &  other)
inline

replaces *this by *this + other.

Returns
a reference to *this
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< difference <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator- ( const Eigen::ArrayBase< OtherDerived > &  other) const
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-=()
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_difference_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator- ( const T &  scalar) const
Returns
an expression of *this with each coeff decremented by the constant scalar
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.

Example:

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

Output:

-4
-3
-2
See Also
operator+=(), operator-()
template<typename Derived >
template<typename OtherDerived >
Derived & Eigen::ArrayBase< Derived >::operator-= ( const ArrayBase< OtherDerived > &  other)
inline

replaces *this by *this - other.

Returns
a reference to *this
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_quotient_op<Scalar,typename OtherDerived::Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator/ ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient wise quotient of *this and other
See Also
MatrixBase::cwiseQuotient
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_quotient_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator/ ( const T &  scalar) const
Returns
an expression of *this divided by the scalar value scalar
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.
template<typename Derived >
template<typename OtherDerived >
Derived & Eigen::ArrayBase< Derived >::operator/= ( const ArrayBase< OtherDerived > &  other)
inline

replaces *this by *this / other coefficient wise.

Returns
a reference to *this
template<typename Derived>
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)

template<typename Derived>
Derived& Eigen::ArrayBase< Derived >::operator= ( const Scalar value)
inline

Set all the entries to value.

See Also
DenseBase::setConstant(), DenseBase::fill()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_boolean_xor_op, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator^ ( const Eigen::ArrayBase< 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:

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

Output:

1
0
1
See Also
operator&&(), select()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp<internal::scalar_boolean_or_op, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator|| ( const Eigen::ArrayBase< OtherDerived > &  other) const
inline
Returns
an expression of the coefficient-wise boolean or operator of *this and other
Warning
this operator is for expression of bool only.

Example:

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

Output:

1
0
1
See Also
operator&&(), select()
template<typename Derived>
template<typename OtherDerived >
const CwiseBinaryOp< pow <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::pow ( const Eigen::ArrayBase< OtherDerived > &  other) const
Returns
an expression of the coefficient-wise power of *this 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:

[ 8 25  3]^[0.333   0.5     2] = 2 5 9
[ 8 25  3]^[0.333   0.5     2] = 2 5 9
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_pow_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::pow ( const T &  exponent) const
Returns
an expression of the coefficients of *this rasied to the constant power exponent
Template Parameters
Tis the scalar type of exponent. It must be compatible with the scalar type of the given expression.

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

Example:

Array3d v(8,27,64);
cout << v.pow(0.333333) << endl;

Output:

2
3
4
See Also
ArrayBase::pow(ArrayBase), square(), cube(), exp(), log()
template<typename Derived>
const RoundReturnType Eigen::ArrayBase< Derived >::round ( ) const
inline
Returns
an expression of the coefficient-wise round of *this.

Example:

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

Output:

    -2
 -1.33
-0.667
     0
 0.667
  1.33
     2

-2
-1
-1
-0
 1
 1
 2
See Also
Math functions, ceil(), floor()
template<typename Derived>
const RsqrtReturnType Eigen::ArrayBase< Derived >::rsqrt ( ) const
inline
Returns
an expression of the coefficient-wise inverse square root of *this.

This function computes the coefficient-wise inverse square root.

Example:

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

Output:

   1
1.41
   2
See Also
pow(), square()
template<typename Derived>
const SignReturnType Eigen::ArrayBase< Derived >::sign ( ) const
inline
Returns
an expression of the coefficient-wise signum of *this.

This function computes the coefficient-wise signum.

Example:

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

Output:

-1
 1
 0
See Also
pow(), square()
template<typename Derived>
const SinReturnType Eigen::ArrayBase< Derived >::sin ( ) const
inline
Returns
an expression of the coefficient-wise sine of *this.

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

Example:

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

Output:

1.22e-16
       1
   0.866
See Also
Math functions, cos(), asin()
template<typename Derived>
const SinhReturnType Eigen::ArrayBase< Derived >::sinh ( ) const
inline
Returns
an expression of the coefficient-wise hyperbolic sin of *this.

Example:

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

Output:

    0
0.253
0.521
0.822
 1.18
See Also
Math functions, sin(), tanh(), cosh()
template<typename Derived>
const SqrtReturnType Eigen::ArrayBase< Derived >::sqrt ( ) const
inline
Returns
an expression of the coefficient-wise square root of *this.

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

Example:

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

Output:

   1
1.41
   2
See Also
Math functions, pow(), square()
template<typename Derived>
const SquareReturnType Eigen::ArrayBase< Derived >::square ( ) const
inline
Returns
an expression of the coefficient-wise square of *this.

Example:

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

Output:

 4
 9
16
See Also
Math functions, abs2(), cube(), pow()
template<typename Derived>
const TanReturnType Eigen::ArrayBase< Derived >::tan ( ) const
inline
Returns
an expression of the coefficient-wise tan of *this.

Example:

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

Output:

-1.22e-16
 1.63e+16
     1.73
See Also
Math functions, cos(), sin()
template<typename Derived>
const TanhReturnType Eigen::ArrayBase< Derived >::tanh ( ) const
inline
Returns
an expression of the coefficient-wise hyperbolic tan of *this.

Example:

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

Output:

    0
0.245
0.462
0.635
0.762
See Also
Math functions, tan(), sinh(), cosh()
template<typename Derived>
template<typename DerivedQ >
const CwiseBinaryOp<internal::scalar_zeta_op<Scalar>, const Derived, const DerivedQ> Eigen::ArrayBase< Derived >::zeta ( const Eigen::ArrayBase< DerivedQ > &  q) const
inline
Returns
an expression of the coefficient-wise zeta function.

This is defined in the unsupported SpecialFunctions module.

#include <Eigen/SpecialFunctions>

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

Parameters
*thisis the exposent, it must be > 1
qis the shift, it must be > 0
Note
This function supports only float and double scalar types. To support other scalar types, the user has to provide implementations of zeta(T,T) for any scalar type T to be supported.

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

See Also
Eigen::zeta()

Friends And Related Function Documentation

template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_product_op<T,Scalar>,Constant<T>,Derived> operator* ( const T &  scalar,
const StorageBaseType &  expr 
)
friend
Returns
an expression of expr scaled by the scalar factor scalar
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_sum_op<T,Scalar>,Constant<T>,Derived> operator+ ( const T &  scalar,
const StorageBaseType &  expr 
)
friend
Returns
an expression of expr with each coeff incremented by the constant scalar
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_difference_op<T,Scalar>,Constant<T>,Derived> operator- ( const T &  scalar,
const StorageBaseType &  expr 
)
friend
Returns
an expression of the constant matrix of value scalar decremented by the coefficients of expr
Template Parameters
Tis the scalar type of scalar. It must be compatible with the scalar type of the given expression.
template<typename Derived>
template<typename T >
const CwiseBinaryOp<internal::scalar_quotient_op<T,Scalar>,Constant<T>,Derived> operator/ ( const T &  s,
const StorageBaseType &  a 
)
friend

Component-wise division of the scalar s by array elements of a.

Template Parameters
Scalaris the scalar type of x. It must be compatible with the scalar type of the given array expression (Derived::Scalar).
template<typename Derived , typename ScalarExponent >
const CwiseBinaryOp< internal::scalar_pow_op< Derived::Scalar, ScalarExponent >, Derived, Constant< ScalarExponent > > pow ( const Eigen::ArrayBase< Derived > &  x,
const ScalarExponent &  exponent 
)
related
Returns
an expression of the coefficient-wise power of x to the given constant exponent.
Template Parameters
ScalarExponentis the scalar type of exponent. It must be compatible with the scalar type of the given expression (Derived::Scalar).
See Also
ArrayBase::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:

[ 8 25  3]^[0.333   0.5     2] = 2 5 9
[ 8 25  3]^[0.333   0.5     2] = 2 5 9
See Also
ArrayBase::pow()
template<typename Scalar , typename Derived >
const CwiseBinaryOp< internal::scalar_pow_op< Scalar, Derived::Scalar >, Constant< Scalar >, Derived > pow ( const Scalar x,
const Eigen::ArrayBase< Derived > &  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:

10^[    2    -3 0.333] =   100 0.001  2.15
See Also
ArrayBase::pow()

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