![]() |
Eigen
3.3.4
|
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.
Derived | is the derived type, e.g., an array or an expression type. |
This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN
.
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 |
template<typename NewType > | |
CastXpr< NewType >::Type | cast () const |
const CeilReturnType | ceil () const |
ConjugateReturnType | conjugate () 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 FloorReturnType | floor () const |
const ImagReturnType | imag () const |
NonConstImagReturnType | imag () |
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 |
const NegativeReturnType | operator- () 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 |
RealReturnType | real () const |
NonConstRealReturnType | real () |
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 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 |
template<typename DerivedQ > | |
const CwiseBinaryOp < internal::scalar_zeta_op < Scalar >, const Derived, const DerivedQ > | zeta (const Eigen::ArrayBase< DerivedQ > &q) const |
![]() | |
bool | all () const |
bool | allFinite () const |
bool | any () const |
BlockXpr | block (Index startRow, Index startCol, Index blockRows, Index blockCols) |
const ConstBlockXpr | block (Index startRow, Index startCol, Index blockRows, Index blockCols) const |
This is the const version of block(Index,Index,Index,Index). */. | |
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). | |
BlockXpr | bottomLeftCorner (Index cRows, Index cCols) |
const ConstBlockXpr | bottomLeftCorner (Index cRows, Index cCols) const |
This is the const version of bottomLeftCorner(Index, Index). | |
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). | |
BlockXpr | bottomRightCorner (Index cRows, Index cCols) |
const ConstBlockXpr | bottomRightCorner (Index cRows, Index cCols) const |
This is the const version of bottomRightCorner(Index, Index). | |
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). | |
RowsBlockXpr | bottomRows (Index n) |
ConstRowsBlockXpr | bottomRows (Index n) const |
This is the const version of bottomRows(Index). | |
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>(). | |
ColXpr | col (Index i) |
ConstColXpr | col (Index i) const |
This is the const version of col(). | |
ConstColwiseReturnType | colwise () const |
ColwiseReturnType | colwise () |
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 |
SegmentReturnType | head (Index n) |
ConstSegmentReturnType | head (Index n) const |
This is the const version of head(Index). | |
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>(). | |
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 |
ColsBlockXpr | leftCols (Index n) |
ConstColsBlockXpr | leftCols (Index n) const |
This is the const version of leftCols(Index). | |
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 |
ColsBlockXpr | middleCols (Index startCol, Index numCols) |
ConstColsBlockXpr | middleCols (Index startCol, Index numCols) const |
This is the const version of middleCols(Index,Index). | |
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>(). | |
RowsBlockXpr | middleRows (Index startRow, Index n) |
ConstRowsBlockXpr | middleRows (Index startRow, Index n) const |
This is the const version of middleRows(Index,Index). | |
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) |
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 |
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 () |
ColsBlockXpr | rightCols (Index n) |
ConstColsBlockXpr | rightCols (Index n) const |
This is the const version of rightCols(Index). | |
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 () |
SegmentReturnType | segment (Index start, Index n) |
ConstSegmentReturnType | segment (Index start, Index n) const |
This is the const version of segment(Index,Index). | |
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) |
SegmentReturnType | tail (Index n) |
ConstSegmentReturnType | tail (Index 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>. | |
BlockXpr | topLeftCorner (Index cRows, Index cCols) |
const ConstBlockXpr | topLeftCorner (Index cRows, Index 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). | |
BlockXpr | topRightCorner (Index cRows, Index cCols) |
const ConstBlockXpr | topRightCorner (Index cRows, Index cCols) const |
This is the const version of topRightCorner(Index, Index). | |
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). | |
RowsBlockXpr | topRows (Index n) |
ConstRowsBlockXpr | topRows (Index n) const |
This is the const version of topRows(Index). | |
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 () |
CoeffReturnType | value () const |
template<typename Visitor > | |
void | visit (Visitor &func) const |
![]() | |
Index | colStride () const |
Index | innerStride () const |
Index | outerStride () const |
Index | rowStride () const |
![]() | |
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 () |
![]() | |
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 |
![]() | |
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) |
![]() | |
template<typename Derived > | |
std::ostream & | operator<< (std::ostream &s, const DenseBase< Derived > &m) |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
typedef Eigen::Index | Index |
The interface type of indices. More... | |
![]() | |
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 () |
![]() | |
DenseBase () | |
|
inline |
*this
Example:
Output:
1 2 3
|
inline |
*this
Example:
Output:
1 4 9
|
inline |
Example:
Output:
1.57 0.785 0
|
inline |
|
inline |
Example:
Output:
0 0.785 1.57
|
inline |
Example:
Output:
0 0.245 0.464 0.644 0.785
|
inline |
The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)
Here is an example illustrating the use of custom functors:
Output:
(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)
|
inline |
*this
with the Scalar type casted to NewScalar.The template parameter NewScalar is the type we are casting the scalars to.
|
inline |
Example:
Output:
-2 -1.33 -0.667 0 0.667 1.33 2 -2 -1 -0 0 1 2 2
|
inline |
*this
.
|
inline |
This function computes the coefficient-wise cosine. The function MatrixBase::cos() in the unsupported module MatrixFunctions computes the matrix cosine.
Example:
Output:
-1 6.12e-17 0.5
|
inline |
Example:
Output:
1 1.03 1.13 1.29 1.54
|
inline |
Example:
Output:
8 27 64
|
inline |
*this
Example:
Output:
2 4 6 5 1 0
|
inline |
*this
Example:
Output:
4 16 36 25 1 0
|
inline |
Example:
Output:
Comparing m with identity matrix: 1 1 0 1 Number of coefficients that are equal: 3
|
inline |
*this
and a scalar s
|
inline |
Example:
Output:
0.5 2 1 0.333 4 1
|
inline |
Example:
Output:
4 3 4
|
inline |
|
inline |
Example:
Output:
2 2 3
|
inline |
|
inline |
Example:
Output:
Comparing m with identity matrix: 0 0 1 0 Number of coefficients that are not equal: 1
|
inline |
Example:
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
|
inline |
Example:
Output:
0.5 1.5 1.33
|
inline |
Example:
Output:
1 -1 1 -1 1 0
|
inline |
Example:
Output:
1 1.41 2
|
inline |
This is defined in the unsupported SpecialFunctions module.
|
inline |
[c++11]
This is defined in the unsupported SpecialFunctions module.
Example:
Output:
-0.52 0.995 0 -1
|
inline |
[c++11]
This is defined in the unsupported SpecialFunctions module.
Example:
Output:
1.52 0.00468 1 2
|
inline |
This function computes the coefficient-wise exponential. The function MatrixBase::exp() in the unsupported module MatrixFunctions computes the matrix exponential.
Example:
Output:
2.72 7.39 20.1
|
inline |
Example:
Output:
-2 -1.33 -0.667 0 0.667 1.33 2 -2 -2 -1 0 0 1 2
|
inline |
*this
.
|
inline |
*this
.
|
inline |
Example:
Output:
0.5 0.333 0.25
|
inline |
|
inline |
Example:
Output:
1 nan inf 0 0 1
|
inline |
Example:
Output:
1 nan inf 0 1 0
|
inline |
[c++11]
This is defined in the unsupported SpecialFunctions module.
Example:
Output:
0.572 12.8 inf inf
|
inline |
This function computes the coefficient-wise logarithm. The function MatrixBase::log() in the unsupported module MatrixFunctions computes the matrix logarithm.
Example:
Output:
0 0.693 1.1
|
inline |
This function computes the coefficient-wise base-10 logarithm.
Example:
Output:
nan -inf 0 0.301
|
inline |
*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.
|
inline |
const CwiseBinaryOp< max <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::max | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const |
|
inline |
*this
and scalar other const CwiseBinaryOp< min <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::min | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const |
|
inline |
*this
and scalar other
|
inline |
Example:
Output:
1 nan inf 0 1 1
|
inline |
*this
and other Example:
Output:
0 0 0
|
inline |
*this
and other const CwiseBinaryOp<internal::scalar_product_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator* | ( | const T & | scalar | ) | const |
*this
scaled by the scalar factor scalar T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
|
inline |
replaces *this
by *this
* other coefficient wise.
*this
const CwiseBinaryOp< sum <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator+ | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const |
*this
and other const CwiseBinaryOp<internal::scalar_sum_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator+ | ( | const T & | scalar | ) | const |
Example:
Output:
1 0 0
Example:
Output:
1 1 0
Example:
Output:
0 0 1
Example:
Output:
0 1 1
Example:
Output:
0 1 0
Example:
Output:
1 0 1
*this
with each coeff incremented by the constant scalar T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
Example:
Output:
6 7 8
|
inline |
replaces *this
by *this
+ other.
*this
const CwiseBinaryOp< difference <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::operator- | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const |
*this
and other
|
inline |
*this
const CwiseBinaryOp<internal::scalar_difference_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator- | ( | const T & | scalar | ) | const |
*this
with each coeff decremented by the constant scalar T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
Example:
Output:
-4 -3 -2
|
inline |
replaces *this
by *this
- other.
*this
|
inline |
*this
and other const CwiseBinaryOp<internal::scalar_quotient_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::operator/ | ( | const T & | scalar | ) | const |
*this
divided by the scalar value scalar T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
|
inline |
replaces *this
by *this
/ other coefficient wise.
*this
|
inline |
Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1)
|
inline |
Set all the entries to value.
|
inline |
Example:
Output:
1 0 1
|
inline |
*this
and other Example:
Output:
1 0 1
const CwiseBinaryOp< pow <Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase< Derived >::pow | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const |
*this
to the given array of exponents.This function computes the coefficient-wise power.
Example:
Output:
[ 8 25 3]^[0.333 0.5 2] = 2 5 9 [ 8 25 3]^[0.333 0.5 2] = 2 5 9
const CwiseBinaryOp<internal::scalar_pow_op<Scalar,T>,Derived,Constant<T> > Eigen::ArrayBase< Derived >::pow | ( | const T & | exponent | ) | const |
*this
rasied to the constant power exponent T | is 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:
Output:
2 3 4
|
inline |
*this
.
|
inline |
*this
.
|
inline |
Example:
Output:
-2 -1.33 -0.667 0 0.667 1.33 2 -2 -1 -1 -0 1 1 2
|
inline |
|
inline |
|
inline |
This function computes the coefficient-wise sine. The function MatrixBase::sin() in the unsupported module MatrixFunctions computes the matrix sine.
Example:
Output:
1.22e-16 1 0.866
|
inline |
Example:
Output:
0 0.253 0.521 0.822 1.18
|
inline |
This function computes the coefficient-wise square root. The function MatrixBase::sqrt() in the unsupported module MatrixFunctions computes the matrix square root.
Example:
Output:
1 1.41 2
|
inline |
Example:
Output:
4 9 16
|
inline |
Example:
Output:
-1.22e-16 1.63e+16 1.73
|
inline |
Example:
Output:
0 0.245 0.462 0.635 0.762
|
inline |
Apply a unary operator coefficient-wise.
[in] | func | Functor implementing the unary operator |
CustomUnaryOp | Type of func |
The function ptr_fun()
from the C++ standard library can be used to make functors out of normal functions.
Example:
Output:
0.68 0.823 -0.444 -0.27 -0.211 -0.605 0.108 0.0268 0.566 -0.33 -0.0452 0.904 0.597 0.536 0.258 0.832 becomes: 0.68 0.823 0 0 0 0 0.108 0.0268 0.566 0 0 0.904 0.597 0.536 0.258 0.832
Genuine functors allow for more possibilities, for instance it may contain a state.
Example:
Output:
0.68 0.823 -0.444 -0.27 -0.211 -0.605 0.108 0.0268 0.566 -0.33 -0.0452 0.904 0.597 0.536 0.258 0.832 becomes: 0.5 0.5 -0.444 -0.27 -0.211 -0.5 0.108 0.0268 0.5 -0.33 -0.0452 0.5 0.5 0.5 0.258 0.5
|
inline |
The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.
Example:
Output:
0.68 0.823 -0.444 -0.27 -0.211 -0.605 0.108 0.0268 0.566 -0.33 -0.0452 0.904 0.597 0.536 0.258 0.832 becomes: 0.5 0.5 -0.444 -0.27 -0.211 -0.5 0.108 0.0268 0.5 -0.33 -0.0452 0.5 0.5 0.5 0.258 0.5
|
inline |
This is defined in the unsupported SpecialFunctions module.
It returns the Riemann zeta function of two arguments *this
and q:
*this | is the exposent, it must be > 1 |
q | is the shift, it must be > 0 |
This method is an alias for zeta(*this,q);
|
friend |
T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
|
friend |
T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
|
friend |
T | is the scalar type of scalar. It must be compatible with the scalar type of the given expression. |
|
friend |
Component-wise division of the scalar s by array elements of a.
Scalar | is the scalar type of x. It must be compatible with the scalar type of the given array expression (Derived::Scalar ). |
|
related |
ScalarExponent | is the scalar type of exponent. It must be compatible with the scalar type of the given expression (Derived::Scalar ). |
|
related |
This function computes the coefficient-wise power.
Example:
Output:
[ 8 25 3]^[0.333 0.5 2] = 2 5 9 [ 8 25 3]^[0.333 0.5 2] = 2 5 9
|
related |
This function computes the coefficient-wise power between a scalar and an array of exponents.
Scalar | is the scalar type of x. It must be compatible with the scalar type of the given array expression (Derived::Scalar ). |
Example:
Output:
10^[ 2 -3 0.333] = 100 0.001 2.15