![]() |
Eigen
3.4.0
|
General-purpose arrays with easy API for coefficient-wise operations.
The Array class is very similar to the Matrix class. It provides general-purpose one- and two-dimensional arrays. The difference between the Array and the Matrix class is primarily in the API: the API for the Array class provides easy access to coefficient-wise operations, while the API for the Matrix class provides easy access to linear-algebra operations.
See documentation of class Matrix for detailed information on the template parameters storage layout.
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_ARRAY_PLUGIN
.
Public Member Functions | |
Array () | |
template<typename... ArgTypes> | |
Array (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args) | |
Construct a row of column vector with fixed size from an arbitrary number of coefficients. [c++11] More... | |
Array (const std::initializer_list< std::initializer_list< Scalar >> &list) | |
Constructs an array and initializes it from the coefficients given as initializer-lists grouped by row. [c++11] More... | |
Array (const Scalar *data) | |
Constructs a fixed-sized array initialized with coefficients starting at data. | |
Array (Index dim) | |
Array (const Scalar &value) | |
Array (Index rows, Index cols) | |
Array (const Scalar &val0, const Scalar &val1) | |
Array (const Scalar &val0, const Scalar &val1, const Scalar &val2) | |
Array (const Scalar &val0, const Scalar &val1, const Scalar &val2, const Scalar &val3) | |
Array (const Array &other) | |
template<typename OtherDerived > | |
Array (const EigenBase< OtherDerived > &other, typename internal::enable_if< internal::is_convertible< typename OtherDerived::Scalar, Scalar >::value, PrivateType >::type=PrivateType()) | |
template<typename OtherDerived > | |
Array & | operator= (const EigenBase< OtherDerived > &other) |
Array & | operator= (const Scalar &value) |
template<typename OtherDerived > | |
Array & | operator= (const DenseBase< OtherDerived > &other) |
Array & | operator= (const Array &other) |
![]() | |
const Scalar & | coeff (Index rowId, Index colId) const |
const Scalar & | coeff (Index index) const |
Scalar & | coeffRef (Index rowId, Index colId) |
Scalar & | coeffRef (Index index) |
const Scalar & | coeffRef (Index rowId, Index colId) const |
const Scalar & | coeffRef (Index index) const |
void | conservativeResize (Index rows, Index cols) |
void | conservativeResize (Index rows, NoChange_t) |
void | conservativeResize (NoChange_t, Index cols) |
void | conservativeResize (Index size) |
void | conservativeResizeLike (const DenseBase< OtherDerived > &other) |
const Scalar * | data () const |
Scalar * | data () |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | lazyAssign (const DenseBase< OtherDerived > &other) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | operator= (const PlainObjectBase &other) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. More... | |
void | resize (Index rows, Index cols) |
void | resize (Index size) |
void | resize (NoChange_t, Index cols) |
void | resize (Index rows, NoChange_t) |
void | resizeLike (const EigenBase< OtherDerived > &_other) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setConstant (Index size, const Scalar &val) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setConstant (Index rows, Index cols, const Scalar &val) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setConstant (NoChange_t, Index cols, const Scalar &val) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setConstant (Index rows, NoChange_t, const Scalar &val) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setOnes (Index size) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setOnes (Index rows, Index cols) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setOnes (NoChange_t, Index cols) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setOnes (Index rows, NoChange_t) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setRandom (Index size) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setRandom (Index rows, Index cols) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setRandom (NoChange_t, Index cols) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setRandom (Index rows, NoChange_t) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setZero (Index size) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setZero (Index rows, Index cols) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setZero (NoChange_t, Index cols) |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setZero (Index rows, NoChange_t) |
![]() | |
const AbsReturnType | abs () const |
const Abs2ReturnType | abs2 () const |
template<typename OtherDerived > | |
const CwiseBinaryOp< absolute_difference< Scalar >, const Derived, const OtherDerived > | absolute_difference (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseBinaryOp< internal::scalar_absolute_difference_op< Scalar, Scalar >, const Derived, const CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject > > | absolute_difference (const Scalar &other) const |
const AcosReturnType | acos () const |
const AcoshReturnType | acosh () const |
const ArgReturnType | arg () const |
const AsinReturnType | asin () const |
const AsinhReturnType | asinh () const |
const AtanReturnType | atan () const |
const AtanhReturnType | atanh () 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 |
const CwiseArgReturnType | cwiseArg () const |
template<typename OtherDerived > | |
const CwiseBinaryOp< numext::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< numext::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 |
const Log2ReturnType | log2 () const |
const LogisticReturnType | logistic () 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 NdtriReturnType | ndtri () const |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_boolean_and_op, const Derived, const OtherDerived > | operator && (const Eigen::ArrayBase< OtherDerived > &other) const |
const BooleanNotReturnType | operator! () 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 RintReturnType | rint () const |
const RoundReturnType | round () const |
const RsqrtReturnType | rsqrt () const |
template<int N> | |
ShiftLeftXpr< N >::Type | shiftLeft () const |
template<int N> | |
ShiftRightXpr< N >::Type | shiftRight () 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 |
![]() | |
bool | all () const |
bool | allFinite () const |
bool | any () const |
iterator | begin () |
const_iterator | begin () 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 |
const_iterator | cbegin () const |
const_iterator | cend () 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 |
template<bool Cond> | |
internal::conditional< Cond, ConjugateReturnType, const Derived & >::type | conjugateIf () const |
Index | count () const |
iterator | end () |
const_iterator | end () 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 () |
EIGEN_CONSTEXPR Index | innerSize () const |
InnerVectorReturnType | innerVector (Index outer) |
const ConstInnerVectorReturnType | innerVector (Index outer) const |
InnerVectorsReturnType | innerVectors (Index outerStart, Index outerSize) |
const ConstInnerVectorsReturnType | innerVectors (Index outerStart, Index outerSize) 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 OtherDerived > | |
EIGEN_DEPRECATED Derived & | lazyAssign (const DenseBase< OtherDerived > &other) |
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>(). | |
template<int NaNPropagation> | |
internal::traits< Derived >::Scalar | maxCoeff () const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *row, IndexType *col) const |
template<int NaNPropagation, 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>(). | |
template<int NaNPropagation> | |
internal::traits< Derived >::Scalar | minCoeff () const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *row, IndexType *col) const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *index) const |
const NestByValue< Derived > | nestByValue () const |
EIGEN_CONSTEXPR Index | nonZeros () const |
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... | |
EIGEN_CONSTEXPR 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 |
template<int Order = ColMajor, typename NRowsType , typename NColsType > | |
Reshaped< Derived,... > | reshaped (NRowsType nRows, NColsType nCols) |
template<int Order = ColMajor, typename NRowsType , typename NColsType > | |
const Reshaped< const Derived,... > | reshaped (NRowsType nRows, NColsType nCols) const |
This is the const version of reshaped(NRowsType,NColsType). | |
template<int Order = ColMajor> | |
Reshaped< Derived,... > | reshaped () |
template<int Order = ColMajor> | |
const Reshaped< const Derived,... > | reshaped () const |
This is the const version of reshaped(). | |
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 () |
template<DirectionType Direction> | |
internal::conditional< Direction==Vertical, ColXpr, RowXpr >::type | subVector (Index i) |
template<DirectionType Direction> | |
internal::conditional< Direction==Vertical, ConstColXpr, ConstRowXpr >::type | subVector (Index i) const |
template<DirectionType Direction> | |
EIGEN_CONSTEXPR Index | subVectors () const |
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 |
![]() | |
EIGEN_CONSTEXPR Index | colStride () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | innerStride () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | outerStride () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | rowStride () const EIGEN_NOEXCEPT |
![]() | |
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 |
![]() | |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
Derived & | derived () |
const Derived & | derived () const |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
Additional Inherited Members | |
![]() | |
enum | { RowsAtCompileTime, ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime, MaxColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime, NumDimensions, Flags, IsRowMajor } |
typedef random_access_iterator_type | const_iterator |
typedef random_access_iterator_type | iterator |
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 ConstMapType | Map (const Scalar *data) |
static MapType | Map (Scalar *data) |
static ConstMapType | Map (const Scalar *data, Index size) |
static MapType | Map (Scalar *data, Index size) |
static ConstMapType | Map (const Scalar *data, Index rows, Index cols) |
static MapType | Map (Scalar *data, Index rows, Index cols) |
static StridedConstMapType< Stride< Outer, Inner > >::type | Map (const Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedMapType< Stride< Outer, Inner > >::type | Map (Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedConstMapType< Stride< Outer, Inner > >::type | Map (const Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedMapType< Stride< Outer, Inner > >::type | Map (Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedConstMapType< Stride< Outer, Inner > >::type | Map (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
static StridedMapType< Stride< Outer, Inner > >::type | Map (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
static ConstAlignedMapType | MapAligned (const Scalar *data) |
static AlignedMapType | MapAligned (Scalar *data) |
static ConstAlignedMapType | MapAligned (const Scalar *data, Index size) |
static AlignedMapType | MapAligned (Scalar *data, Index size) |
static ConstAlignedMapType | MapAligned (const Scalar *data, Index rows, Index cols) |
static AlignedMapType | MapAligned (Scalar *data, Index rows, Index cols) |
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (const Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (const Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
static StridedAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
![]() | |
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 EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType | LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high) |
static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType | LinSpaced (Sequential_t, 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 RandomAccessLinSpacedReturnType | LinSpaced (const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
template<typename CustomNullaryOp > | |
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func) |
template<typename CustomNullaryOp > | |
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (Index size, const CustomNullaryOp &func) |
template<typename CustomNullaryOp > | |
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (const CustomNullaryOp &func) |
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 () |
![]() | |
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | _set (const DenseBase< OtherDerived > &other) |
Copies the value of the expression other into *this with automatic resizing. More... | |
PlainObjectBase (const PlainObjectBase &other) | |
PlainObjectBase (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args) | |
Construct a row of column vector with fixed size from an arbitrary number of coefficients. [c++11] More... | |
PlainObjectBase (const std::initializer_list< std::initializer_list< Scalar >> &list) | |
Constructs a Matrix or Array and initializes it by elements given by an initializer list of initializer lists [c++11] | |
PlainObjectBase (const DenseBase< OtherDerived > &other) | |
PlainObjectBase (const EigenBase< OtherDerived > &other) | |
PlainObjectBase (const ReturnByValue< OtherDerived > &other) | |
Copy constructor with in-place evaluation. | |
![]() | |
DenseBase () | |
![]() | |
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) |
|
inline |
Default constructor.
For fixed-size matrices, does nothing.
For dynamic-size matrices, creates an empty matrix of size 0. Does not allocate any array. Such a matrix is called a null matrix. This constructor is the unique way to create null matrices: resizing a matrix to 0 is not supported.
|
inline |
Construct a row of column vector with fixed size from an arbitrary number of coefficients. [c++11]
This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.
This constructor is for 1D array or vectors with more than 4 coefficients. There exists C++98 analogue constructors for fixed-size array/vector having 1, 2, 3, or 4 coefficients.
*this
.Example:
Output:
1 2 3 4 5 6 1 2 3
|
inline |
Constructs an array and initializes it from the coefficients given as initializer-lists grouped by row. [c++11]
In the general case, the constructor takes a list of rows, each row being represented as a list of coefficients:
Example:
Output:
1 2 3 3 4 5
Each of the inner initializer lists must contain the exact same number of elements, otherwise an assertion is triggered.
In the case of a compile-time column 1D array, implicit transposition from a single row is allowed. Therefore Array<int,Dynamic,1>{{1,2,3,4,5}}
is legal and the more verbose syntax Array<int,Dynamic,1>{{1},{2},{3},{4},{5}}
can be avoided:
Example:
Output:
1 2 3 4 5
In the case of fixed-sized arrays, the initializer list sizes must exactly match the array sizes, and implicit transposition is allowed for compile-time 1D arrays only.
|
inlineexplicit |
Constructs a vector or row-vector with given dimension. This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.
Note that this is only useful for dynamic-size vectors. For fixed-size vectors, it is redundant to pass the dimension here, so it makes more sense to use the default constructor Array() instead.
Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array | ( | const Scalar & | value | ) |
constructs an initialized 1x1 Array with the given coefficient
Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array | ( | Index | rows, |
Index | cols | ||
) |
constructs an uninitialized array with rows rows and cols columns.
This is useful for dynamic-size arrays. For fixed-size arrays, it is redundant to pass these parameters, so one should use the default constructor Array() instead.
Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array | ( | const Scalar & | val0, |
const Scalar & | val1 | ||
) |
constructs an initialized 2D vector with given coefficients
|
inline |
constructs an initialized 3D vector with given coefficients
|
inline |
constructs an initialized 4D vector with given coefficients
|
inline |
Copy constructor
|
inline |
|
inline |
The usage of using Base::operator=; fails on MSVC. Since the code below is working with GCC and MSVC, we skipped the usage of 'using'. This should be done only for operator=.
|
inline |
Set all the entries to value.
|
inline |
Copies the value of the expression other into *this
with automatic resizing.
*this might be resized to match the dimensions of other. If *this was a null matrix (not already initialized), it will be initialized.
Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.
|
inline |
This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.