Expression of a mathematical vector or matrix as an array object. More...
#include <ArrayWrapper.h>
Public Types | |
enum | |
enum | |
typedef ArrayBase< ArrayWrapper > | Base |
typedef Base::CoeffReturnType | CoeffReturnType |
typedef VectorwiseOp < ArrayWrapper< ExpressionType > , Vertical > | ColwiseReturnType |
typedef const VectorwiseOp < const ArrayWrapper < ExpressionType >, Vertical > | ConstColwiseReturnType |
typedef const Reverse< const ArrayWrapper< ExpressionType > , BothDirections > | ConstReverseReturnType |
typedef const VectorwiseOp < const ArrayWrapper < ExpressionType >, Horizontal > | ConstRowwiseReturnType |
typedef const VectorBlock < const ArrayWrapper < ExpressionType > > | ConstSegmentReturnType |
typedef const Transpose< const ArrayWrapper< ExpressionType > > | ConstTransposeReturnType |
typedef internal::add_const_on_value_type < typename internal::eval < ArrayWrapper< ExpressionType > >::type >::type | EvalReturnType |
typedef internal::traits < ArrayWrapper< ExpressionType > >::Index | Index |
The type of indices. | |
typedef internal::nested < ExpressionType >::type | NestedExpressionType |
typedef internal::packet_traits < Scalar >::type | PacketScalar |
typedef NumTraits< Scalar >::Real | RealScalar |
typedef Reverse< ArrayWrapper < ExpressionType > , BothDirections > | ReverseReturnType |
typedef VectorwiseOp < ArrayWrapper< ExpressionType > , Horizontal > | RowwiseReturnType |
typedef internal::traits < ArrayWrapper< ExpressionType > >::Scalar | Scalar |
typedef internal::conditional < internal::is_lvalue < ExpressionType >::value, Scalar, const Scalar >::type | ScalarWithConstIfNotLvalue |
typedef VectorBlock < ArrayWrapper< ExpressionType > > | SegmentReturnType |
typedef internal::traits < ArrayWrapper< ExpressionType > >::StorageKind | StorageKind |
Public Member Functions | |
const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const ArrayWrapper < ExpressionType > > | abs () const |
const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const ArrayWrapper < ExpressionType > > | abs2 () const |
const CwiseUnaryOp < internal::scalar_acos_op < Scalar >, const ArrayWrapper < ExpressionType > > | acos () const |
bool | all (void) const |
bool | any (void) const |
ArrayBase< ArrayWrapper < ExpressionType > > & | array () |
const ArrayBase< ArrayWrapper < ExpressionType > > & | array () const |
ArrayWrapper (ExpressionType &matrix) | |
const CwiseUnaryOp < internal::scalar_asin_op < Scalar >, const ArrayWrapper < ExpressionType > > | asin () const |
const CwiseBinaryOp < CustomBinaryOp, const ArrayWrapper< ExpressionType > , const OtherDerived > | binaryExpr (const Eigen::ArrayBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const |
Block< ArrayWrapper < ExpressionType > > | block (Index startRow, Index startCol, Index blockRows, Index blockCols) |
const Block< const ArrayWrapper< ExpressionType > > | block (Index startRow, Index startCol, Index blockRows, Index blockCols) const |
Block< ArrayWrapper < ExpressionType >, BlockRows, BlockCols > | block (Index startRow, Index startCol) |
const Block< const ArrayWrapper< ExpressionType > , BlockRows, BlockCols > | block (Index startRow, Index startCol) const |
Block< ArrayWrapper < ExpressionType > > | bottomLeftCorner (Index cRows, Index cCols) |
const Block< const ArrayWrapper< ExpressionType > > | bottomLeftCorner (Index cRows, Index cCols) const |
Block< ArrayWrapper < ExpressionType >, CRows, CCols > | bottomLeftCorner () |
const Block< const ArrayWrapper< ExpressionType > , CRows, CCols > | bottomLeftCorner () const |
Block< ArrayWrapper < ExpressionType > > | bottomRightCorner (Index cRows, Index cCols) |
const Block< const ArrayWrapper< ExpressionType > > | bottomRightCorner (Index cRows, Index cCols) const |
Block< ArrayWrapper < ExpressionType >, CRows, CCols > | bottomRightCorner () |
const Block< const ArrayWrapper< ExpressionType > , CRows, CCols > | bottomRightCorner () const |
RowsBlockXpr | bottomRows (Index n) |
ConstRowsBlockXpr | bottomRows (Index n) const |
NRowsBlockXpr< N >::Type | bottomRows () |
ConstNRowsBlockXpr< N >::Type | bottomRows () const |
internal::cast_return_type < ArrayWrapper< ExpressionType > , const CwiseUnaryOp < internal::scalar_cast_op < typename internal::traits < ArrayWrapper< ExpressionType > >::Scalar, NewType >, const ArrayWrapper< ExpressionType > > >::type | cast () const |
CoeffReturnType | coeff (Index row, Index col) const |
CoeffReturnType | coeff (Index index) const |
Scalar & | coeffRef (Index row, Index col) |
const Scalar & | coeffRef (Index row, Index col) const |
Scalar & | coeffRef (Index index) |
const Scalar & | coeffRef (Index index) const |
ColXpr | col (Index i) |
ConstColXpr | col (Index i) const |
Index | cols () const |
ConstColwiseReturnType | colwise () const |
ColwiseReturnType | colwise () |
ConjugateReturnType | conjugate () const |
const CwiseUnaryOp < internal::scalar_cos_op < Scalar >, const ArrayWrapper < ExpressionType > > | cos () const |
Index | count () const |
const CwiseUnaryOp < internal::scalar_cube_op < Scalar >, const ArrayWrapper < ExpressionType > > | cube () const |
const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const ArrayWrapper < ExpressionType > > | cwiseAbs () const |
const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const ArrayWrapper < ExpressionType > > | cwiseAbs2 () const |
const | CwiseBinaryOp (min)(const Scalar &other) const |
const | CwiseBinaryOp (max)(const Scalar &other) const |
const CwiseBinaryOp < std::equal_to< Scalar > , const ArrayWrapper < ExpressionType >, const OtherDerived > | cwiseEqual (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseUnaryOp < std::binder1st < std::equal_to< Scalar > >, const ArrayWrapper < ExpressionType > > | cwiseEqual (const Scalar &s) const |
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const ArrayWrapper < ExpressionType > > | cwiseInverse () const |
const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const ArrayWrapper < ExpressionType >, const OtherDerived > | cwiseMax (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const ArrayWrapper < ExpressionType >, const ConstantReturnType > | cwiseMax (const Scalar &other) const |
const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const ArrayWrapper < ExpressionType >, const OtherDerived > | cwiseMin (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const ArrayWrapper < ExpressionType >, const ConstantReturnType > | cwiseMin (const Scalar &other) const |
const CwiseBinaryOp < std::not_equal_to< Scalar > , const ArrayWrapper < ExpressionType >, const OtherDerived > | cwiseNotEqual (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const ArrayWrapper < ExpressionType >, const OtherDerived > | cwiseQuotient (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const ArrayWrapper < ExpressionType > > | cwiseSqrt () const |
ScalarWithConstIfNotLvalue * | data () |
const Scalar * | data () const |
const | EIGEN_CWISE_PRODUCT_RETURN_TYPE (ArrayWrapper< ExpressionType >, OtherDerived) operator*(const Eigen |
const | EIGEN_CWISE_PRODUCT_RETURN_TYPE (ArrayWrapper< ExpressionType >, OtherDerived) cwiseProduct(const Eigen |
EvalReturnType | eval () const |
template<typename Dest > | |
void | evalTo (Dest &dst) const |
const CwiseUnaryOp < internal::scalar_exp_op < Scalar >, const ArrayWrapper < ExpressionType > > | exp () const |
void | fill (const Scalar &value) |
const Flagged< ArrayWrapper < ExpressionType >, Added, Removed > | flagged () const |
const ForceAlignedAccess < ArrayWrapper< ExpressionType > > | forceAlignedAccess () const |
ForceAlignedAccess < ArrayWrapper< ExpressionType > > | forceAlignedAccess () |
const internal::conditional < Enable, ForceAlignedAccess < ArrayWrapper< ExpressionType > >, ArrayWrapper < ExpressionType > & >::type | forceAlignedAccessIf () const |
internal::conditional< Enable, ForceAlignedAccess < ArrayWrapper< ExpressionType > >, ArrayWrapper < ExpressionType > & >::type | forceAlignedAccessIf () |
const WithFormat< ArrayWrapper < ExpressionType > > | format (const IOFormat &fmt) const |
SegmentReturnType | head (Index size) |
DenseBase::ConstSegmentReturnType | head (Index size) const |
FixedSegmentReturnType< Size > ::Type | head () |
ConstFixedSegmentReturnType < Size >::Type | head () const |
const ImagReturnType | imag () const |
NonConstImagReturnType | imag () |
Index | innerSize () const |
Index | innerStride () const |
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const ArrayWrapper < ExpressionType > > | inverse () const |
bool | isApprox (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isApproxToConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isMuchSmallerThan (const RealScalar &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isMuchSmallerThan (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isOnes (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isZero (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const |
ColsBlockXpr | leftCols (Index n) |
ConstColsBlockXpr | leftCols (Index n) const |
NColsBlockXpr< N >::Type | leftCols () |
ConstNColsBlockXpr< N >::Type | leftCols () const |
const CwiseUnaryOp < internal::scalar_log_op < Scalar >, const ArrayWrapper < ExpressionType > > | log () const |
RealScalar | lpNorm () const |
MatrixWrapper< ArrayWrapper < ExpressionType > > | matrix () |
const MatrixWrapper< const ArrayWrapper< ExpressionType > > | matrix () const |
internal::traits< ArrayWrapper < ExpressionType > >::Scalar | maxCoeff () const |
internal::traits< ArrayWrapper < ExpressionType > >::Scalar | maxCoeff (IndexType *row, IndexType *col) const |
internal::traits< ArrayWrapper < ExpressionType > >::Scalar | maxCoeff (IndexType *index) const |
Scalar | mean () const |
ColsBlockXpr | middleCols (Index startCol, Index numCols) |
ConstColsBlockXpr | middleCols (Index startCol, Index numCols) const |
NColsBlockXpr< N >::Type | middleCols (Index startCol) |
ConstNColsBlockXpr< N >::Type | middleCols (Index startCol) const |
RowsBlockXpr | middleRows (Index startRow, Index numRows) |
ConstRowsBlockXpr | middleRows (Index startRow, Index numRows) const |
NRowsBlockXpr< N >::Type | middleRows (Index startRow) |
ConstNRowsBlockXpr< N >::Type | middleRows (Index startRow) const |
internal::traits< ArrayWrapper < ExpressionType > >::Scalar | minCoeff () const |
internal::traits< ArrayWrapper < ExpressionType > >::Scalar | minCoeff (IndexType *row, IndexType *col) const |
internal::traits< ArrayWrapper < ExpressionType > >::Scalar | minCoeff (IndexType *index) const |
const NestByValue < ArrayWrapper< ExpressionType > > | nestByValue () const |
const internal::remove_all < NestedExpressionType >::type & | nestedExpression () const |
Index | nonZeros () const |
const CwiseBinaryOp < internal::scalar_boolean_and_op, const ArrayWrapper < ExpressionType >, const OtherDerived > | operator&& (const Eigen::ArrayBase< OtherDerived > &other) const |
const ScalarMultipleReturnType | operator* (const Scalar &scalar) const |
const ScalarMultipleReturnType | operator* (const RealScalar &scalar) const |
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const ArrayWrapper < ExpressionType > > | operator* (const std::complex< Scalar > &scalar) const |
ArrayWrapper< ExpressionType > & | operator*= (const ArrayBase< OtherDerived > &other) |
ArrayWrapper< ExpressionType > & | operator*= (const Scalar &other) |
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const ArrayWrapper < ExpressionType > > | operator+ (const Scalar &scalar) const |
ArrayWrapper< ExpressionType > & | operator+= (const Scalar &scalar) |
ArrayWrapper< ExpressionType > & | operator+= (const ArrayBase< OtherDerived > &other) |
ArrayWrapper< ExpressionType > & | operator+= (const EigenBase< OtherDerived > &other) |
const CwiseUnaryOp < internal::scalar_opposite_op < typename internal::traits < ArrayWrapper< ExpressionType > >::Scalar >, const ArrayWrapper< ExpressionType > > | operator- () const |
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const ArrayWrapper < ExpressionType > > | operator- (const Scalar &scalar) const |
ArrayWrapper< ExpressionType > & | operator-= (const Scalar &scalar) |
ArrayWrapper< ExpressionType > & | operator-= (const ArrayBase< OtherDerived > &other) |
ArrayWrapper< ExpressionType > & | operator-= (const EigenBase< OtherDerived > &other) |
const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const ArrayWrapper < ExpressionType >, const OtherDerived > | operator/ (const Eigen::ArrayBase< OtherDerived > &other) const |
const CwiseUnaryOp < internal::scalar_quotient1_op < typename internal::traits < ArrayWrapper< ExpressionType > >::Scalar >, const ArrayWrapper< ExpressionType > > | operator/ (const Scalar &scalar) const |
ArrayWrapper< ExpressionType > & | operator/= (const ArrayBase< OtherDerived > &other) |
ArrayWrapper< ExpressionType > & | operator/= (const Scalar &other) |
CommaInitializer< ArrayWrapper < ExpressionType > > | operator<< (const Scalar &s) |
CommaInitializer< ArrayWrapper < ExpressionType > > | operator<< (const DenseBase< OtherDerived > &other) |
const CwiseBinaryOp < internal::scalar_boolean_or_op, const ArrayWrapper < ExpressionType >, const OtherDerived > | operator|| (const Eigen::ArrayBase< OtherDerived > &other) const |
Index | outerSize () const |
Index | outerStride () const |
template<int LoadMode> | |
const PacketScalar | packet (Index row, Index col) const |
template<int LoadMode> | |
const PacketScalar | packet (Index index) const |
const CwiseUnaryOp < internal::scalar_pow_op < Scalar >, const ArrayWrapper < ExpressionType > > | pow (const Scalar &exponent) const |
Scalar | prod () const |
RealReturnType | real () const |
NonConstRealReturnType | real () |
const Replicate< ArrayWrapper < ExpressionType >, RowFactor, ColFactor > | replicate () const |
const Replicate< ArrayWrapper < ExpressionType >, Dynamic, Dynamic > | replicate (Index rowFacor, Index colFactor) const |
void | resize (Index size) |
void | resize (Index rows, Index cols) |
ReverseReturnType | reverse () |
ConstReverseReturnType | reverse () const |
void | reverseInPlace () |
ColsBlockXpr | rightCols (Index n) |
ConstColsBlockXpr | rightCols (Index n) const |
NColsBlockXpr< N >::Type | rightCols () |
ConstNColsBlockXpr< N >::Type | rightCols () const |
RowXpr | row (Index i) |
ConstRowXpr | row (Index i) const |
Index | rows () const |
ConstRowwiseReturnType | rowwise () const |
RowwiseReturnType | rowwise () |
SegmentReturnType | segment (Index start, Index size) |
DenseBase::ConstSegmentReturnType | segment (Index start, Index size) const |
FixedSegmentReturnType< Size > ::Type | segment (Index start) |
ConstFixedSegmentReturnType < Size >::Type | segment (Index start) const |
const Select< ArrayWrapper < ExpressionType > , ThenDerived, ElseDerived > | select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const |
const Select< ArrayWrapper < ExpressionType > , ThenDerived, typename ThenDerived::ConstantReturnType > | select (const DenseBase< ThenDerived > &thenMatrix, typename ThenDerived::Scalar elseScalar) const |
const Select< ArrayWrapper < ExpressionType >, typename ElseDerived::ConstantReturnType, ElseDerived > | select (typename ElseDerived::Scalar thenScalar, const DenseBase< ElseDerived > &elseMatrix) const |
ArrayWrapper< ExpressionType > & | setConstant (const Scalar &value) |
ArrayWrapper< ExpressionType > & | setLinSpaced (Index size, const Scalar &low, const Scalar &high) |
ArrayWrapper< ExpressionType > & | setLinSpaced (const Scalar &low, const Scalar &high) |
ArrayWrapper< ExpressionType > & | setOnes () |
ArrayWrapper< ExpressionType > & | setRandom () |
ArrayWrapper< ExpressionType > & | setZero () |
const CwiseUnaryOp < internal::scalar_sin_op < Scalar >, const ArrayWrapper < ExpressionType > > | sin () const |
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const ArrayWrapper < ExpressionType > > | sqrt () const |
const CwiseUnaryOp < internal::scalar_square_op < Scalar >, const ArrayWrapper < ExpressionType > > | square () const |
Scalar | sum () const |
void | swap (const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase) |
void | swap (PlainObjectBase< OtherDerived > &other) |
SegmentReturnType | tail (Index size) |
DenseBase::ConstSegmentReturnType | tail (Index size) const |
FixedSegmentReturnType< Size > ::Type | tail () |
ConstFixedSegmentReturnType < Size >::Type | tail () const |
const CwiseUnaryOp < internal::scalar_tan_op < Scalar >, ArrayWrapper < ExpressionType > > | tan () const |
Block< ArrayWrapper < ExpressionType > > | topLeftCorner (Index cRows, Index cCols) |
const Block< const ArrayWrapper< ExpressionType > > | topLeftCorner (Index cRows, Index cCols) const |
Block< ArrayWrapper < ExpressionType >, CRows, CCols > | topLeftCorner () |
const Block< const ArrayWrapper< ExpressionType > , CRows, CCols > | topLeftCorner () const |
Block< ArrayWrapper < ExpressionType > > | topRightCorner (Index cRows, Index cCols) |
const Block< const ArrayWrapper< ExpressionType > > | topRightCorner (Index cRows, Index cCols) const |
Block< ArrayWrapper < ExpressionType >, CRows, CCols > | topRightCorner () |
const Block< const ArrayWrapper< ExpressionType > , CRows, CCols > | topRightCorner () const |
RowsBlockXpr | topRows (Index n) |
ConstRowsBlockXpr | topRows (Index n) const |
NRowsBlockXpr< N >::Type | topRows () |
ConstNRowsBlockXpr< N >::Type | topRows () const |
Scalar | trace () const |
Eigen::Transpose< ArrayWrapper < ExpressionType > > | transpose () |
ConstTransposeReturnType | transpose () const |
void | transposeInPlace () |
const CwiseUnaryOp < CustomUnaryOp, const ArrayWrapper< ExpressionType > > | unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const |
Apply a unary operator coefficient-wise. | |
const CwiseUnaryView < CustomViewOp, const ArrayWrapper< ExpressionType > > | unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const |
CoeffReturnType | value () const |
void | visit (Visitor &func) const |
template<int LoadMode> | |
void | writePacket (Index row, Index col, const PacketScalar &x) |
template<int LoadMode> | |
void | writePacket (Index index, const PacketScalar &x) |
Static Public Member Functions | |
static const ConstantReturnType | Constant (Index rows, Index cols, const Scalar &value) |
static const ConstantReturnType | Constant (Index size, const Scalar &value) |
static const ConstantReturnType | Constant (const Scalar &value) |
static const SequentialLinSpacedReturnType | LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high) |
static const RandomAccessLinSpacedReturnType | LinSpaced (Index size, const Scalar &low, const Scalar &high) |
static const SequentialLinSpacedReturnType | LinSpaced (Sequential_t, const Scalar &low, const Scalar &high) |
static const RandomAccessLinSpacedReturnType | LinSpaced (const Scalar &low, const Scalar &high) |
static const CwiseNullaryOp < CustomNullaryOp, ArrayWrapper< ExpressionType > > | NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func) |
static const CwiseNullaryOp < CustomNullaryOp, ArrayWrapper< ExpressionType > > | NullaryExpr (Index size, const CustomNullaryOp &func) |
static const CwiseNullaryOp < CustomNullaryOp, ArrayWrapper< ExpressionType > > | NullaryExpr (const CustomNullaryOp &func) |
static const ConstantReturnType | Ones (Index rows, Index cols) |
static const ConstantReturnType | Ones (Index size) |
static const ConstantReturnType | Ones () |
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, ArrayWrapper < ExpressionType > > | Random (Index rows, Index cols) |
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, ArrayWrapper < ExpressionType > > | Random (Index size) |
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, ArrayWrapper < ExpressionType > > | Random () |
static const ConstantReturnType | Zero (Index rows, Index cols) |
static const ConstantReturnType | Zero (Index size) |
static const ConstantReturnType | Zero () |
Protected Member Functions | |
void | checkTransposeAliasing (const OtherDerived &other) const |
ArrayWrapper< ExpressionType > & | operator+= (const MatrixBase< OtherDerived > &) |
ArrayWrapper< ExpressionType > & | operator-= (const MatrixBase< OtherDerived > &) |
Protected Attributes | |
NestedExpressionType | m_expression |
Friends | |
const ScalarMultipleReturnType | operator* (const Scalar &scalar, const StorageBaseType &matrix) |
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const ArrayWrapper < ExpressionType > > | operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix) |
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const ArrayWrapper < ExpressionType > > | operator+ (const Scalar &scalar, const Eigen::ArrayBase< ArrayWrapper< ExpressionType > > &other) |
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const CwiseUnaryOp < internal::scalar_opposite_op < Scalar >, const ArrayWrapper < ExpressionType > > > | operator- (const Scalar &scalar, const Eigen::ArrayBase< ArrayWrapper< ExpressionType > > &other) |
Expression of a mathematical vector or matrix as an array object.
This class is the return type of MatrixBase::array(), and most of the time this is the only way it is use.
typedef ArrayBase<ArrayWrapper> Base |
Reimplemented from DenseBase< ArrayWrapper< ExpressionType > >.
typedef Base::CoeffReturnType CoeffReturnType [inherited] |
typedef VectorwiseOp<ArrayWrapper< ExpressionType > , Vertical> ColwiseReturnType [inherited] |
typedef const VectorwiseOp<const ArrayWrapper< ExpressionType > , Vertical> ConstColwiseReturnType [inherited] |
typedef const Reverse<const ArrayWrapper< ExpressionType > , BothDirections> ConstReverseReturnType [inherited] |
typedef const VectorwiseOp<const ArrayWrapper< ExpressionType > , Horizontal> ConstRowwiseReturnType [inherited] |
typedef const VectorBlock<const ArrayWrapper< ExpressionType > > ConstSegmentReturnType [inherited] |
typedef const Transpose<const ArrayWrapper< ExpressionType > > ConstTransposeReturnType [inherited] |
typedef internal::add_const_on_value_type<typename internal::eval<ArrayWrapper< ExpressionType > >::type>::type EvalReturnType [inherited] |
typedef internal::traits<ArrayWrapper< ExpressionType > >::Index Index [inherited] |
The type of indices.
To change this, #define
the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE
.
typedef internal::nested<ExpressionType>::type NestedExpressionType |
typedef internal::packet_traits<Scalar>::type PacketScalar [inherited] |
typedef NumTraits<Scalar>::Real RealScalar [inherited] |
typedef Reverse<ArrayWrapper< ExpressionType > , BothDirections> ReverseReturnType [inherited] |
typedef VectorwiseOp<ArrayWrapper< ExpressionType > , Horizontal> RowwiseReturnType [inherited] |
typedef internal::traits<ArrayWrapper< ExpressionType > >::Scalar Scalar [inherited] |
typedef internal::conditional< internal::is_lvalue<ExpressionType>::value, Scalar, const Scalar >::type ScalarWithConstIfNotLvalue |
typedef VectorBlock<ArrayWrapper< ExpressionType > > SegmentReturnType [inherited] |
typedef internal::traits<ArrayWrapper< ExpressionType > >::StorageKind StorageKind [inherited] |
anonymous enum [inherited] |
anonymous enum [inherited] |
ArrayWrapper | ( | ExpressionType & | matrix | ) | [inline] |
const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const ArrayWrapper< ExpressionType > > abs | ( | ) | const [inline, inherited] |
*this
Example:
Array3d v(1,-2,-3); cout << v.abs() << endl;
Output:
1 2 3
const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const ArrayWrapper< ExpressionType > > abs2 | ( | ) | const [inline, inherited] |
const CwiseUnaryOp<internal::scalar_acos_op<Scalar>, const ArrayWrapper< ExpressionType > > acos | ( | ) | const [inline, inherited] |
Example:
Vector3f boxMin(Vector3f::Zero()), boxMax(Vector3f::Ones()); Vector3f p0 = Vector3f::Random(), p1 = Vector3f::Random().cwiseAbs(); // let's check if p0 and p1 are inside the axis aligned box defined by the corners boxMin,boxMax: cout << "Is (" << p0.transpose() << ") inside the box: " << ((boxMin.array()<p0.array()).all() && (boxMax.array()>p0.array()).all()) << endl; cout << "Is (" << p1.transpose() << ") inside the box: " << ((boxMin.array()<p1.array()).all() && (boxMax.array()>p1.array()).all()) << endl;
Output:
Is ( 0.68 -0.211 0.566) inside the box: 0 Is (0.597 0.823 0.605) inside the box: 1
ArrayBase<ArrayWrapper< ExpressionType > >& array | ( | ) | [inline, inherited] |
const ArrayBase<ArrayWrapper< ExpressionType > >& array | ( | ) | const [inline, inherited] |
const CwiseUnaryOp<internal::scalar_asin_op<Scalar>, const ArrayWrapper< ExpressionType > > asin | ( | ) | const [inline, inherited] |
const CwiseBinaryOp<CustomBinaryOp, const ArrayWrapper< ExpressionType > , const OtherDerived> binaryExpr | ( | const Eigen::ArrayBase< OtherDerived > & | other, |
const CustomBinaryOp & | func = CustomBinaryOp() |
||
) | const [inline, inherited] |
*this
and other *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**) { Matrix4d m1 = Matrix4d::Random(), m2 = Matrix4d::Random(); 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)
Block<ArrayWrapper< ExpressionType > > block | ( | Index | startRow, |
Index | startCol, | ||
Index | blockRows, | ||
Index | blockCols | ||
) | [inline, inherited] |
startRow | the first row in the block |
startCol | the first column in the block |
blockRows | the number of rows in the block |
blockCols | the number of columns in the block |
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.block(1, 1, 2, 2):" << endl << m.block(1, 1, 2, 2) << endl; m.block(1, 1, 2, 2).setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.block(1, 1, 2, 2): -6 1 -3 0 Now the matrix m is: 7 9 -5 -3 -2 0 0 0 6 0 0 9 6 6 3 9
const Block<const ArrayWrapper< ExpressionType > > block | ( | Index | startRow, |
Index | startCol, | ||
Index | blockRows, | ||
Index | blockCols | ||
) | const [inline, inherited] |
This is the const version of block(Index,Index,Index,Index).
Block<ArrayWrapper< ExpressionType > , BlockRows, BlockCols> block | ( | Index | startRow, |
Index | startCol | ||
) | [inline, inherited] |
The template parameters BlockRows and BlockCols are the number of rows and columns in the block.
startRow | the first row in the block |
startCol | the first column in the block |
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.block<2,2>(1,1):" << endl << m.block<2,2>(1,1) << endl; m.block<2,2>(1,1).setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.block<2,2>(1,1): -6 1 -3 0 Now the matrix m is: 7 9 -5 -3 -2 0 0 0 6 0 0 9 6 6 3 9
m.template block<3,3>(1,1);
const Block<const ArrayWrapper< ExpressionType > , BlockRows, BlockCols> block | ( | Index | startRow, |
Index | startCol | ||
) | const [inline, inherited] |
This is the const version of block<>(Index, Index).
Block<ArrayWrapper< ExpressionType > > bottomLeftCorner | ( | Index | cRows, |
Index | cCols | ||
) | [inline, inherited] |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.bottomLeftCorner(2, 2):" << endl; cout << m.bottomLeftCorner(2, 2) << endl; m.bottomLeftCorner(2, 2).setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomLeftCorner(2, 2): 6 -3 6 6 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 0 0 0 9 0 0 3 9
const Block<const ArrayWrapper< ExpressionType > > bottomLeftCorner | ( | Index | cRows, |
Index | cCols | ||
) | const [inline, inherited] |
This is the const version of bottomLeftCorner(Index, Index).
Block<ArrayWrapper< ExpressionType > , CRows, CCols> bottomLeftCorner | ( | ) | [inline, inherited] |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.bottomLeftCorner<2,2>():" << endl; cout << m.bottomLeftCorner<2,2>() << endl; m.bottomLeftCorner<2,2>().setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomLeftCorner<2,2>(): 6 -3 6 6 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 0 0 0 9 0 0 3 9
const Block<const ArrayWrapper< ExpressionType > , CRows, CCols> bottomLeftCorner | ( | ) | const [inline, inherited] |
This is the const version of bottomLeftCorner<int, int>().
Block<ArrayWrapper< ExpressionType > > bottomRightCorner | ( | Index | cRows, |
Index | cCols | ||
) | [inline, inherited] |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.bottomRightCorner(2, 2):" << endl; cout << m.bottomRightCorner(2, 2) << endl; m.bottomRightCorner(2, 2).setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomRightCorner(2, 2): 0 9 3 9 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 6 -3 0 0 6 6 0 0
const Block<const ArrayWrapper< ExpressionType > > bottomRightCorner | ( | Index | cRows, |
Index | cCols | ||
) | const [inline, inherited] |
This is the const version of bottomRightCorner(Index, Index).
Block<ArrayWrapper< ExpressionType > , CRows, CCols> bottomRightCorner | ( | ) | [inline, inherited] |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.bottomRightCorner<2,2>():" << endl; cout << m.bottomRightCorner<2,2>() << endl; m.bottomRightCorner<2,2>().setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomRightCorner<2,2>(): 0 9 3 9 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 6 -3 0 0 6 6 0 0
const Block<const ArrayWrapper< ExpressionType > , CRows, CCols> bottomRightCorner | ( | ) | const [inline, inherited] |
This is the const version of bottomRightCorner<int, int>().
RowsBlockXpr bottomRows | ( | Index | n | ) | [inline, inherited] |
n | the number of rows in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.bottomRows(2):" << endl; cout << a.bottomRows(2) << endl; a.bottomRows(2).setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.bottomRows(2): 6 -3 0 9 6 6 3 9 Now the array a is: 7 9 -5 -3 -2 -6 1 0 0 0 0 0 0 0 0 0
ConstRowsBlockXpr bottomRows | ( | Index | n | ) | const [inline, inherited] |
This is the const version of bottomRows(Index).
NRowsBlockXpr<N>::Type bottomRows | ( | ) | [inline, inherited] |
N | the number of rows in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.bottomRows<2>():" << endl; cout << a.bottomRows<2>() << endl; a.bottomRows<2>().setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.bottomRows<2>(): 6 -3 0 9 6 6 3 9 Now the array a is: 7 9 -5 -3 -2 -6 1 0 0 0 0 0 0 0 0 0
ConstNRowsBlockXpr<N>::Type bottomRows | ( | ) | const [inline, inherited] |
This is the const version of bottomRows<int>().
internal::cast_return_type<ArrayWrapper< ExpressionType > ,const CwiseUnaryOp<internal::scalar_cast_op<typename internal::traits<ArrayWrapper< ExpressionType > >::Scalar, NewType>, const ArrayWrapper< ExpressionType > > >::type cast | ( | ) | const [inline, inherited] |
The template parameter NewScalar is the type we are casting the scalars to.
void checkTransposeAliasing | ( | const OtherDerived & | other | ) | const [protected, inherited] |
CoeffReturnType coeff | ( | Index | row, |
Index | col | ||
) | const [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
CoeffReturnType coeff | ( | Index | index | ) | const [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
References ArrayWrapper< ExpressionType >::m_expression.
References ArrayWrapper< ExpressionType >::m_expression.
References ArrayWrapper< ExpressionType >::m_expression.
References ArrayWrapper< ExpressionType >::m_expression.
Example:
Output:
1 4 0 0 5 0 0 6 1
Referenced by ArrayWrapper< ExpressionType >::packet(), and ArrayWrapper< ExpressionType >::writePacket().
References ArrayWrapper< ExpressionType >::m_expression.
ConstColwiseReturnType colwise | ( | ) | const [inherited] |
Example:
Matrix3d m = Matrix3d::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is the sum of each column:" << endl << m.colwise().sum() << endl; cout << "Here is the maximum absolute value of each column:" << endl << m.cwiseAbs().colwise().maxCoeff() << endl;
Output:
Here is the matrix m: 0.68 0.597 -0.33 -0.211 0.823 0.536 0.566 -0.605 -0.444 Here is the sum of each column: 1.04 0.815 -0.238 Here is the maximum absolute value of each column: 0.68 0.823 0.536
ColwiseReturnType colwise | ( | ) | [inherited] |
ConjugateReturnType conjugate | ( | ) | const [inline, inherited] |
*this
.static const ConstantReturnType Constant | ( | Index | rows, |
Index | cols, | ||
const Scalar & | value | ||
) | [static, inherited] |
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this DenseBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
The parameter size is the size of the returned vector. Must be compatible with this DenseBase type.
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 variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.
The template parameter CustomNullaryOp is the type of the functor.
const CwiseUnaryOp<internal::scalar_cos_op<Scalar>, const ArrayWrapper< ExpressionType > > cos | ( | ) | const [inline, inherited] |
const CwiseUnaryOp<internal::scalar_cube_op<Scalar>, const ArrayWrapper< ExpressionType > > cube | ( | ) | const [inline, inherited] |
const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const ArrayWrapper< ExpressionType > > cwiseAbs | ( | ) | const [inline, inherited] |
*this
Example:
MatrixXd m(2,3); m << 2, -4, 6, -5, 1, 0; cout << m.cwiseAbs() << endl;
Output:
2 4 6 5 1 0
const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const ArrayWrapper< ExpressionType > > cwiseAbs2 | ( | ) | const [inline, inherited] |
*this
Example:
MatrixXd m(2,3); m << 2, -4, 6, -5, 1, 0; cout << m.cwiseAbs2() << endl;
Output:
4 16 36 25 1 0
const CwiseBinaryOp | ( | min | ) | const [inline, inherited] |
*this
and other Example:
Array3d v(2,3,4), w(4,2,3); cout << v.min(w) << endl;
Output:
2 2 3
*this
and scalar other const CwiseBinaryOp | ( | max | ) | const [inline, inherited] |
*this
and other Example:
Array3d v(2,3,4), w(4,2,3); cout << v.max(w) << endl;
Output:
4 3 4
*this
and scalar other const CwiseBinaryOp<std::equal_to<Scalar>, const ArrayWrapper< ExpressionType > , const OtherDerived> cwiseEqual | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
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
const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const ArrayWrapper< ExpressionType > > cwiseEqual | ( | const Scalar & | s | ) | const [inline, inherited] |
*this
and a scalar s const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const ArrayWrapper< ExpressionType > > cwiseInverse | ( | ) | const [inline, inherited] |
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
const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const ArrayWrapper< ExpressionType > , const OtherDerived> cwiseMax | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
Example:
Vector3d v(2,3,4), w(4,2,3); cout << v.cwiseMax(w) << endl;
Output:
4 3 4
const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const ArrayWrapper< ExpressionType > , const ConstantReturnType> cwiseMax | ( | const Scalar & | other | ) | const [inline, inherited] |
const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const ArrayWrapper< ExpressionType > , const OtherDerived> cwiseMin | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
Example:
Vector3d v(2,3,4), w(4,2,3); cout << v.cwiseMin(w) << endl;
Output:
2 2 3
const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const ArrayWrapper< ExpressionType > , const ConstantReturnType> cwiseMin | ( | const Scalar & | other | ) | const [inline, inherited] |
const CwiseBinaryOp<std::not_equal_to<Scalar>, const ArrayWrapper< ExpressionType > , const OtherDerived> cwiseNotEqual | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
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
const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const ArrayWrapper< ExpressionType > , const OtherDerived> cwiseQuotient | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
Example:
Vector3d v(2,3,4), w(4,2,3); cout << v.cwiseQuotient(w) << endl;
Output:
0.5 1.5 1.33
const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const ArrayWrapper< ExpressionType > > cwiseSqrt | ( | ) | const [inline, inherited] |
Example:
Vector3d v(1,2,4); cout << v.cwiseSqrt() << endl;
Output:
1 1.41 2
ScalarWithConstIfNotLvalue* data | ( | ) | [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
References ArrayWrapper< ExpressionType >::m_expression.
const EIGEN_CWISE_PRODUCT_RETURN_TYPE | ( | ArrayWrapper< ExpressionType > | , |
OtherDerived | |||
) | const [inline, inherited] |
*this
and other const EIGEN_CWISE_PRODUCT_RETURN_TYPE | ( | ArrayWrapper< ExpressionType > | , |
OtherDerived | |||
) | const [inline, inherited] |
Example:
Matrix3i a = Matrix3i::Random(), b = Matrix3i::Random(); 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
EvalReturnType eval | ( | ) | const [inline, inherited] |
Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.
void evalTo | ( | Dest & | dst | ) | const [inline] |
Reimplemented from DenseBase< ArrayWrapper< ExpressionType > >.
References ArrayWrapper< ExpressionType >::m_expression.
const CwiseUnaryOp<internal::scalar_exp_op<Scalar>, const ArrayWrapper< ExpressionType > > exp | ( | ) | const [inline, inherited] |
Alias for setConstant(): sets all coefficients in this expression to value.
const Flagged<ArrayWrapper< ExpressionType > , Added, Removed> flagged | ( | ) | const [inherited] |
This is mostly for internal use.
const ForceAlignedAccess<ArrayWrapper< ExpressionType > > forceAlignedAccess | ( | ) | const [inline, inherited] |
ForceAlignedAccess<ArrayWrapper< ExpressionType > > forceAlignedAccess | ( | ) | [inline, inherited] |
const internal::conditional<Enable,ForceAlignedAccess<ArrayWrapper< ExpressionType > >,ArrayWrapper< ExpressionType > &>::type forceAlignedAccessIf | ( | ) | const [inline, inherited] |
internal::conditional<Enable,ForceAlignedAccess<ArrayWrapper< ExpressionType > >,ArrayWrapper< ExpressionType > &>::type forceAlignedAccessIf | ( | ) | [inline, inherited] |
const WithFormat<ArrayWrapper< ExpressionType > > format | ( | const IOFormat & | fmt | ) | const [inline, inherited] |
See class IOFormat for some examples.
SegmentReturnType head | ( | Index | size | ) | [inherited] |
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.
size | the number of coefficients in the block |
Example:
RowVector4i v = RowVector4i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "Here is v.head(2):" << endl << v.head(2) << endl; v.head(2).setZero(); cout << "Now the vector v is:" << endl << v << endl;
Output:
Here is the vector v: 7 -2 6 6 Here is v.head(2): 7 -2 Now the vector v is: 0 0 6 6
DenseBase::ConstSegmentReturnType head | ( | Index | size | ) | const [inherited] |
This is the const version of head(Index).
FixedSegmentReturnType<Size>::Type head | ( | ) | [inherited] |
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.
The template parameter Size is the number of coefficients in the block
Example:
RowVector4i v = RowVector4i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "Here is v.head(2):" << endl << v.head<2>() << endl; v.head<2>().setZero(); cout << "Now the vector v is:" << endl << v << endl;
Output:
Here is the vector v: 7 -2 6 6 Here is v.head(2): 7 -2 Now the vector v is: 0 0 6 6
ConstFixedSegmentReturnType<Size>::Type head | ( | ) | const [inherited] |
This is the const version of head<int>().
const ImagReturnType imag | ( | ) | const [inline, inherited] |
*this
.NonConstImagReturnType imag | ( | ) | [inline, inherited] |
*this
.Index innerStride | ( | ) | const [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const ArrayWrapper< ExpressionType > > inverse | ( | ) | const [inline, inherited] |
Example:
Array3d v(2,3,4); cout << v.inverse() << endl;
Output:
0.5 0.333 0.25
bool isApprox | ( | const DenseBase< OtherDerived > & | other, |
RealScalar | prec = NumTraits<Scalar>::dummy_precision() |
||
) | const [inherited] |
true
if *this
is approximately equal to other, within the precision determined by prec.
*this
is approximately equal to the zero matrix or vector. Indeed, isApprox(zero)
returns false unless *this
itself is exactly the zero matrix or vector. If you want to test whether *this
is zero, use internal::isMuchSmallerThan(const RealScalar&, RealScalar) instead.bool isApproxToConstant | ( | const Scalar & | value, |
RealScalar | prec = NumTraits<Scalar>::dummy_precision() |
||
) | const [inherited] |
bool isConstant | ( | const Scalar & | value, |
RealScalar | prec = NumTraits<Scalar>::dummy_precision() |
||
) | const [inherited] |
This is just an alias for isApproxToConstant().
bool isMuchSmallerThan | ( | const RealScalar & | other, |
RealScalar | prec = NumTraits<Scalar>::dummy_precision() |
||
) | const [inherited] |
bool isMuchSmallerThan | ( | const DenseBase< OtherDerived > & | other, |
RealScalar | prec = NumTraits<Scalar>::dummy_precision() |
||
) | const [inherited] |
true
if the norm of *this
is much smaller than the norm of other, within the precision determined by prec.
bool isOnes | ( | RealScalar | prec = NumTraits<Scalar>::dummy_precision() | ) | const [inherited] |
Example:
Matrix3d m = Matrix3d::Ones(); m(0,2) += 1e-4; cout << "Here's the matrix m:" << endl << m << endl; cout << "m.isOnes() returns: " << m.isOnes() << endl; cout << "m.isOnes(1e-3) returns: " << m.isOnes(1e-3) << endl;
Output:
Here's the matrix m: 1 1 1 1 1 1 1 1 1 m.isOnes() returns: 0 m.isOnes(1e-3) returns: 1
bool isZero | ( | RealScalar | prec = NumTraits<Scalar>::dummy_precision() | ) | const [inherited] |
Example:
Matrix3d m = Matrix3d::Zero(); m(0,2) = 1e-4; cout << "Here's the matrix m:" << endl << m << endl; cout << "m.isZero() returns: " << m.isZero() << endl; cout << "m.isZero(1e-3) returns: " << m.isZero(1e-3) << endl;
Output:
Here's the matrix m: 0 0 0.0001 0 0 0 0 0 0 m.isZero() returns: 0 m.isZero(1e-3) returns: 1
n | the number of columns in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.leftCols(2):" << endl; cout << a.leftCols(2) << endl; a.leftCols(2).setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.leftCols(2): 7 9 -2 -6 6 -3 6 6 Now the array a is: 0 0 -5 -3 0 0 1 0 0 0 0 9 0 0 3 9
This is the const version of leftCols(Index).
NColsBlockXpr<N>::Type leftCols | ( | ) | [inline, inherited] |
N | the number of columns in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.leftCols<2>():" << endl; cout << a.leftCols<2>() << endl; a.leftCols<2>().setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.leftCols<2>(): 7 9 -2 -6 6 -3 6 6 Now the array a is: 0 0 -5 -3 0 0 1 0 0 0 0 9 0 0 3 9
ConstNColsBlockXpr<N>::Type leftCols | ( | ) | const [inline, inherited] |
This is the const version of leftCols<int>().
static const SequentialLinSpacedReturnType LinSpaced | ( | Sequential_t | , |
Index | size, | ||
const Scalar & | low, | ||
const Scalar & | high | ||
) | [static, inherited] |
Sets a linearly space vector.
The function generates 'size' equally spaced values in the closed interval [low,high]. This particular version of LinSpaced() uses sequential access, i.e. vector access is assumed to be a(0), a(1), ..., a(size). This assumption allows for better vectorization and yields faster code than the random access version.
When size is set to 1, a vector of length 1 containing 'high' is returned.
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.
Example:
cout << VectorXi::LinSpaced(Sequential,4,7,10).transpose() << endl; cout << VectorXd::LinSpaced(Sequential,5,0.0,1.0).transpose() << endl;
Output:
7 8 9 10 0 0.25 0.5 0.75 1
static const RandomAccessLinSpacedReturnType LinSpaced | ( | Index | size, |
const Scalar & | low, | ||
const Scalar & | high | ||
) | [static, inherited] |
Sets a linearly space vector.
The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
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.
Example:
cout << VectorXi::LinSpaced(4,7,10).transpose() << endl; cout << VectorXd::LinSpaced(5,0.0,1.0).transpose() << endl;
Output:
7 8 9 10 0 0.25 0.5 0.75 1
static const SequentialLinSpacedReturnType LinSpaced | ( | Sequential_t | , |
const Scalar & | low, | ||
const Scalar & | high | ||
) | [static, inherited] |
static const RandomAccessLinSpacedReturnType LinSpaced | ( | const Scalar & | low, |
const Scalar & | high | ||
) | [static, inherited] |
const CwiseUnaryOp<internal::scalar_log_op<Scalar>, const ArrayWrapper< ExpressionType > > log | ( | ) | const [inline, inherited] |
Example:
Array3d v(1,2,3); cout << v.log() << endl;
Output:
0 0.693 1.1
RealScalar lpNorm | ( | ) | const [inherited] |
MatrixWrapper<ArrayWrapper< ExpressionType > > matrix | ( | ) | [inline, inherited] |
const MatrixWrapper<const ArrayWrapper< ExpressionType > > matrix | ( | ) | const [inline, inherited] |
internal::traits<ArrayWrapper< ExpressionType > >::Scalar maxCoeff | ( | ) | const [inherited] |
internal::traits<ArrayWrapper< ExpressionType > >::Scalar maxCoeff | ( | IndexType * | row, |
IndexType * | col | ||
) | const [inherited] |
internal::traits<ArrayWrapper< ExpressionType > >::Scalar maxCoeff | ( | IndexType * | index | ) | const [inherited] |
ColsBlockXpr middleCols | ( | Index | startCol, |
Index | numCols | ||
) | [inline, inherited] |
startCol | the index of the first column in the block |
numCols | the number of columns in the block |
Example:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; int main(void) { int const N = 5; MatrixXi A(N,N); A.setRandom(); cout << "A =\n" << A << '\n' << endl; cout << "A(1..3,:) =\n" << A.middleCols(1,3) << endl; return 0; }
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(1..3,:) = -6 0 9 -3 3 3 6 -3 5 -5 0 -8 1 9 2
ConstColsBlockXpr middleCols | ( | Index | startCol, |
Index | numCols | ||
) | const [inline, inherited] |
This is the const version of middleCols(Index,Index).
NColsBlockXpr<N>::Type middleCols | ( | Index | startCol | ) | [inline, inherited] |
N | the number of columns in the block |
startCol | the index of the first column in the block |
Example:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; int main(void) { int const N = 5; MatrixXi A(N,N); A.setRandom(); cout << "A =\n" << A << '\n' << endl; cout << "A(:,1..3) =\n" << A.middleCols<3>(1) << endl; return 0; }
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(:,1..3) = -6 0 9 -3 3 3 6 -3 5 -5 0 -8 1 9 2
ConstNColsBlockXpr<N>::Type middleCols | ( | Index | startCol | ) | const [inline, inherited] |
This is the const version of middleCols<int>().
RowsBlockXpr middleRows | ( | Index | startRow, |
Index | numRows | ||
) | [inline, inherited] |
startRow | the index of the first row in the block |
numRows | the number of rows in the block |
Example:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; int main(void) { int const N = 5; MatrixXi A(N,N); A.setRandom(); cout << "A =\n" << A << '\n' << endl; cout << "A(2..3,:) =\n" << A.middleRows(2,2) << endl; return 0; }
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(2..3,:) = 6 6 -3 5 -8 6 -5 0 -8 6
ConstRowsBlockXpr middleRows | ( | Index | startRow, |
Index | numRows | ||
) | const [inline, inherited] |
This is the const version of middleRows(Index,Index).
NRowsBlockXpr<N>::Type middleRows | ( | Index | startRow | ) | [inline, inherited] |
N | the number of rows in the block |
startRow | the index of the first row in the block |
Example:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; int main(void) { int const N = 5; MatrixXi A(N,N); A.setRandom(); cout << "A =\n" << A << '\n' << endl; cout << "A(1..3,:) =\n" << A.middleRows<3>(1) << endl; return 0; }
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(1..3,:) = -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6
ConstNRowsBlockXpr<N>::Type middleRows | ( | Index | startRow | ) | const [inline, inherited] |
This is the const version of middleRows<int>().
internal::traits<ArrayWrapper< ExpressionType > >::Scalar minCoeff | ( | ) | const [inherited] |
internal::traits<ArrayWrapper< ExpressionType > >::Scalar minCoeff | ( | IndexType * | row, |
IndexType * | col | ||
) | const [inherited] |
internal::traits<ArrayWrapper< ExpressionType > >::Scalar minCoeff | ( | IndexType * | index | ) | const [inherited] |
const NestByValue<ArrayWrapper< ExpressionType > > nestByValue | ( | ) | const [inline, inherited] |
const internal::remove_all<NestedExpressionType>::type& nestedExpression | ( | ) | const [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
static const CwiseNullaryOp<CustomNullaryOp, ArrayWrapper< ExpressionType > > NullaryExpr | ( | Index | rows, |
Index | cols, | ||
const CustomNullaryOp & | func | ||
) | [static, inherited] |
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
static const CwiseNullaryOp<CustomNullaryOp, ArrayWrapper< ExpressionType > > NullaryExpr | ( | Index | size, |
const CustomNullaryOp & | func | ||
) | [static, inherited] |
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
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 variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
static const CwiseNullaryOp<CustomNullaryOp, ArrayWrapper< ExpressionType > > NullaryExpr | ( | const CustomNullaryOp & | func | ) | [static, inherited] |
This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.
The template parameter CustomNullaryOp is the type of the functor.
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Ones() should be used instead.
Example:
cout << MatrixXi::Ones(2,3) << endl;
Output:
1 1 1 1 1 1
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
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 variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Ones() should be used instead.
Example:
cout << 6 * RowVectorXi::Ones(4) << endl; cout << VectorXf::Ones(2) << endl;
Output:
6 6 6 6 1 1
static const ConstantReturnType Ones | ( | ) | [static, inherited] |
This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.
Example:
cout << Matrix2d::Ones() << endl; cout << 6 * RowVector4i::Ones() << endl;
Output:
1 1 1 1 6 6 6 6
const CwiseBinaryOp<internal::scalar_boolean_and_op, const ArrayWrapper< ExpressionType > , const OtherDerived> operator&& | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
Example:
Array3d v(-1,2,1), w(-3,2,3); cout << ((v<w) && (v<0)) << endl;
Output:
0 0 0
const ScalarMultipleReturnType operator* | ( | const Scalar & | scalar | ) | const [inline, inherited] |
*this
scaled by the scalar factor scalar const ScalarMultipleReturnType operator* | ( | const RealScalar & | scalar | ) | const [inherited] |
const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const ArrayWrapper< ExpressionType > > operator* | ( | const std::complex< Scalar > & | scalar | ) | const [inline, inherited] |
Overloaded for efficient real matrix times complex scalar value
ArrayWrapper< ExpressionType > & operator*= | ( | const ArrayBase< OtherDerived > & | other | ) | [inherited] |
replaces *this
by *this
* other coefficient wise.
*this
ArrayWrapper< ExpressionType > & operator*= | ( | const Scalar & | other | ) | [inline, inherited] |
const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const ArrayWrapper< ExpressionType > > operator+ | ( | const Scalar & | scalar | ) | const [inline, inherited] |
Example:
Array3d v(1,2,3), w(3,2,1); cout << (v<w) << endl;
Output:
1 0 0
Example:
Array3d v(1,2,3), w(3,2,1); cout << (v<=w) << endl;
Output:
1 1 0
Example:
Array3d v(1,2,3), w(3,2,1); cout << (v>w) << endl;
Output:
0 0 1
Example:
Array3d v(1,2,3), w(3,2,1); cout << (v>=w) << endl;
Output:
0 1 1
Example:
Array3d v(1,2,3), w(3,2,1); cout << (v==w) << endl;
Output:
0 1 0
Example:
Array3d v(1,2,3), w(3,2,1); cout << (v!=w) << endl;
Output:
1 0 1
*this
with each coeff incremented by the constant scalar Example:
Array3d v(1,2,3); cout << v+5 << endl;
Output:
6 7 8
ArrayWrapper< ExpressionType > & operator+= | ( | const Scalar & | scalar | ) | [inline, inherited] |
ArrayWrapper< ExpressionType > & operator+= | ( | const ArrayBase< OtherDerived > & | other | ) | [inherited] |
replaces *this
by *this
+ other.
*this
ArrayWrapper< ExpressionType > & operator+= | ( | const MatrixBase< OtherDerived > & | ) | [inline, protected, inherited] |
References EIGEN_STATIC_ASSERT.
ArrayWrapper< ExpressionType > & operator+= | ( | const EigenBase< OtherDerived > & | other | ) | [inherited] |
const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<ArrayWrapper< ExpressionType > >::Scalar>, const ArrayWrapper< ExpressionType > > operator- | ( | ) | const [inline, inherited] |
*this
const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const ArrayWrapper< ExpressionType > > operator- | ( | const Scalar & | scalar | ) | const [inline, inherited] |
*this
with each coeff decremented by the constant scalar Example:
Array3d v(1,2,3); cout << v-5 << endl;
Output:
-4 -3 -2
ArrayWrapper< ExpressionType > & operator-= | ( | const Scalar & | scalar | ) | [inline, inherited] |
ArrayWrapper< ExpressionType > & operator-= | ( | const ArrayBase< OtherDerived > & | other | ) | [inherited] |
replaces *this
by *this
- other.
*this
ArrayWrapper< ExpressionType > & operator-= | ( | const MatrixBase< OtherDerived > & | ) | [inline, protected, inherited] |
ArrayWrapper< ExpressionType > & operator-= | ( | const EigenBase< OtherDerived > & | other | ) | [inherited] |
const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const ArrayWrapper< ExpressionType > , const OtherDerived> operator/ | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
*this
and other const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<ArrayWrapper< ExpressionType > >::Scalar>, const ArrayWrapper< ExpressionType > > operator/ | ( | const Scalar & | scalar | ) | const [inline, inherited] |
*this
divided by the scalar value scalar ArrayWrapper< ExpressionType > & operator/= | ( | const ArrayBase< OtherDerived > & | other | ) | [inherited] |
replaces *this
by *this
/ other coefficient wise.
*this
ArrayWrapper< ExpressionType > & operator/= | ( | const Scalar & | other | ) | [inline, inherited] |
CommaInitializer<ArrayWrapper< ExpressionType > > operator<< | ( | const Scalar & | s | ) | [inherited] |
Convenient operator to set the coefficients of a matrix.
The coefficients must be provided in a row major order and exactly match the size of the matrix. Otherwise an assertion is raised.
Example:
Matrix3i m1; m1 << 1, 2, 3, 4, 5, 6, 7, 8, 9; cout << m1 << endl << endl; Matrix3i m2 = Matrix3i::Identity(); m2.block(0,0, 2,2) << 10, 11, 12, 13; cout << m2 << endl << endl; Vector2i v1; v1 << 14, 15; m2 << v1.transpose(), 16, v1, m1.block(1,1,2,2); cout << m2 << endl;
Output:
1 2 3 4 5 6 7 8 9 10 11 0 12 13 0 0 0 1 14 15 16 14 5 6 15 8 9
CommaInitializer<ArrayWrapper< ExpressionType > > operator<< | ( | const DenseBase< OtherDerived > & | other | ) | [inherited] |
const CwiseBinaryOp<internal::scalar_boolean_or_op, const ArrayWrapper< ExpressionType > , const OtherDerived> operator|| | ( | const Eigen::ArrayBase< OtherDerived > & | other | ) | const [inline, inherited] |
Example:
Array3d v(-1,2,1), w(-3,2,3); cout << ((v<w) || (v<0)) << endl;
Output:
1 0 1
rows()==1 || cols()==1
Index outerStride | ( | ) | const [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
const PacketScalar packet | ( | Index | row, |
Index | col | ||
) | const [inline] |
const PacketScalar packet | ( | Index | index | ) | const [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
const CwiseUnaryOp<internal::scalar_pow_op<Scalar>, const ArrayWrapper< ExpressionType > > pow | ( | const Scalar & | exponent | ) | const [inline, inherited] |
Example:
Matrix3d m = Matrix3d::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is the product of all the coefficients:" << endl << m.prod() << endl;
Output:
Here is the matrix m: 0.68 0.597 -0.33 -0.211 0.823 0.536 0.566 -0.605 -0.444 Here is the product of all the coefficients: 0.0019
static const CwiseNullaryOp<internal::scalar_random_op<Scalar>,ArrayWrapper< ExpressionType > > Random | ( | Index | rows, |
Index | cols | ||
) | [static, inherited] |
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Random() should be used instead.
Example:
cout << MatrixXi::Random(2,3) << endl;
Output:
7 6 9 -2 6 -6
This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.
static const CwiseNullaryOp<internal::scalar_random_op<Scalar>,ArrayWrapper< ExpressionType > > Random | ( | Index | size | ) | [static, inherited] |
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
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 variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Random() should be used instead.
Example:
cout << VectorXi::Random(2) << endl;
Output:
7 -2
This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary vector whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.
static const CwiseNullaryOp<internal::scalar_random_op<Scalar>,ArrayWrapper< ExpressionType > > Random | ( | ) | [static, inherited] |
This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.
Example:
cout << 100 * Matrix2i::Random() << endl;
Output:
700 600 -200 600
This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.
RealReturnType real | ( | ) | const [inline, inherited] |
*this
.NonConstRealReturnType real | ( | ) | [inline, inherited] |
*this
.References EIGEN_STATIC_ASSERT.
const Replicate<ArrayWrapper< ExpressionType > ,RowFactor,ColFactor> replicate | ( | ) | const [inherited] |
*this
Example:
MatrixXi m = MatrixXi::Random(2,3); cout << "Here is the matrix m:" << endl << m << endl; cout << "m.replicate<3,2>() = ..." << endl; cout << m.replicate<3,2>() << endl;
Output:
Here is the matrix m: 7 6 9 -2 6 -6 m.replicate<3,2>() = ... 7 6 9 7 6 9 -2 6 -6 -2 6 -6 7 6 9 7 6 9 -2 6 -6 -2 6 -6 7 6 9 7 6 9 -2 6 -6 -2 6 -6
const Replicate<ArrayWrapper< ExpressionType > ,Dynamic,Dynamic> replicate | ( | Index | rowFacor, |
Index | colFactor | ||
) | const [inherited] |
*this
Example:
Vector3i v = Vector3i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "v.replicate(2,5) = ..." << endl; cout << v.replicate(2,5) << endl;
Output:
Here is the vector v: 7 -2 6 v.replicate(2,5) = ... 7 7 7 7 7 -2 -2 -2 -2 -2 6 6 6 6 6 7 7 7 7 7 -2 -2 -2 -2 -2 6 6 6 6 6
Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). The present method only asserts that the new size equals the old size, and does nothing else.
Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). The present method only asserts that the new size equals the old size, and does nothing else.
ReverseReturnType reverse | ( | ) | [inherited] |
Example:
MatrixXi m = MatrixXi::Random(3,4); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is the reverse of m:" << endl << m.reverse() << endl; cout << "Here is the coefficient (1,0) in the reverse of m:" << endl << m.reverse()(1,0) << endl; cout << "Let us overwrite this coefficient with the value 4." << endl; m.reverse()(1,0) = 4; cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 6 -3 1 -2 9 6 0 6 -6 -5 3 Here is the reverse of m: 3 -5 -6 6 0 6 9 -2 1 -3 6 7 Here is the coefficient (1,0) in the reverse of m: 0 Let us overwrite this coefficient with the value 4. Now the matrix m is: 7 6 -3 1 -2 9 6 4 6 -6 -5 3
ConstReverseReturnType reverse | ( | ) | const [inherited] |
This is the const version of reverse().
void reverseInPlace | ( | ) | [inherited] |
This is the "in place" version of reverse: it reverses *this
.
In most cases it is probably better to simply use the reversed expression of a matrix. However, when reversing the matrix data itself is really needed, then this "in-place" version is probably the right choice because it provides the following additional features:
m = m.reverse().eval();
n | the number of columns in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.rightCols(2):" << endl; cout << a.rightCols(2) << endl; a.rightCols(2).setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.rightCols(2): -5 -3 1 0 0 9 3 9 Now the array a is: 7 9 0 0 -2 -6 0 0 6 -3 0 0 6 6 0 0
This is the const version of rightCols(Index).
NColsBlockXpr<N>::Type rightCols | ( | ) | [inline, inherited] |
N | the number of columns in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.rightCols<2>():" << endl; cout << a.rightCols<2>() << endl; a.rightCols<2>().setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.rightCols<2>(): -5 -3 1 0 0 9 3 9 Now the array a is: 7 9 0 0 -2 -6 0 0 6 -3 0 0 6 6 0 0
ConstNColsBlockXpr<N>::Type rightCols | ( | ) | const [inline, inherited] |
This is the const version of rightCols<int>().
Example:
Output:
1 0 0 4 5 6 0 0 1
Referenced by ArrayWrapper< ExpressionType >::packet(), and ArrayWrapper< ExpressionType >::writePacket().
References ArrayWrapper< ExpressionType >::m_expression.
ConstRowwiseReturnType rowwise | ( | ) | const [inherited] |
Example:
Matrix3d m = Matrix3d::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is the sum of each row:" << endl << m.rowwise().sum() << endl; cout << "Here is the maximum absolute value of each row:" << endl << m.cwiseAbs().rowwise().maxCoeff() << endl;
Output:
Here is the matrix m: 0.68 0.597 -0.33 -0.211 0.823 0.536 0.566 -0.605 -0.444 Here is the sum of each row: 0.948 1.15 -0.483 Here is the maximum absolute value of each row: 0.68 0.823 0.605
RowwiseReturnType rowwise | ( | ) | [inherited] |
SegmentReturnType segment | ( | Index | start, |
Index | size | ||
) | [inherited] |
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.
start | the first coefficient in the segment |
size | the number of coefficients in the segment |
Example:
RowVector4i v = RowVector4i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "Here is v.segment(1, 2):" << endl << v.segment(1, 2) << endl; v.segment(1, 2).setZero(); cout << "Now the vector v is:" << endl << v << endl;
Output:
Here is the vector v: 7 -2 6 6 Here is v.segment(1, 2): -2 6 Now the vector v is: 7 0 0 6
DenseBase::ConstSegmentReturnType segment | ( | Index | start, |
Index | size | ||
) | const [inherited] |
This is the const version of segment(Index,Index).
*this
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.
The template parameter Size is the number of coefficients in the block
start | the index of the first element of the sub-vector |
Example:
RowVector4i v = RowVector4i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "Here is v.segment<2>(1):" << endl << v.segment<2>(1) << endl; v.segment<2>(2).setZero(); cout << "Now the vector v is:" << endl << v << endl;
Output:
Here is the vector v: 7 -2 6 6 Here is v.segment<2>(1): -2 6 Now the vector v is: 7 -2 0 0
This is the const version of segment<int>(Index).
const Select<ArrayWrapper< ExpressionType > ,ThenDerived,ElseDerived> select | ( | const DenseBase< ThenDerived > & | thenMatrix, |
const DenseBase< ElseDerived > & | elseMatrix | ||
) | const [inherited] |
const Select<ArrayWrapper< ExpressionType > ,ThenDerived, typename ThenDerived::ConstantReturnType> select | ( | const DenseBase< ThenDerived > & | thenMatrix, |
typename ThenDerived::Scalar | elseScalar | ||
) | const [inline, inherited] |
Version of DenseBase::select(const DenseBase&, const DenseBase&) with the else expression being a scalar value.
const Select<ArrayWrapper< ExpressionType > , typename ElseDerived::ConstantReturnType, ElseDerived > select | ( | typename ElseDerived::Scalar | thenScalar, |
const DenseBase< ElseDerived > & | elseMatrix | ||
) | const [inline, inherited] |
Version of DenseBase::select(const DenseBase&, const DenseBase&) with the then expression being a scalar value.
ArrayWrapper< ExpressionType > & setConstant | ( | const Scalar & | value | ) | [inherited] |
Sets all coefficients in this expression to value.
ArrayWrapper< ExpressionType > & setLinSpaced | ( | Index | size, |
const Scalar & | low, | ||
const Scalar & | high | ||
) | [inherited] |
Sets a linearly space vector.
The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
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.
Example:
VectorXf v; v.setLinSpaced(5,0.5f,1.5f).transpose(); cout << v << endl;
Output:
0.5 0.75 1 1.25 1.5
ArrayWrapper< ExpressionType > & setLinSpaced | ( | const Scalar & | low, |
const Scalar & | high | ||
) | [inherited] |
Sets a linearly space vector.
The function fill *this with equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
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.
ArrayWrapper< ExpressionType > & setOnes | ( | ) | [inherited] |
Sets all coefficients in this expression to one.
Example:
Matrix4i m = Matrix4i::Random(); m.row(1).setOnes(); cout << m << endl;
Output:
7 9 -5 -3 1 1 1 1 6 -3 0 9 6 6 3 9
ArrayWrapper< ExpressionType > & setRandom | ( | ) | [inherited] |
Sets all coefficients in this expression to random values.
Example:
Matrix4i m = Matrix4i::Zero(); m.col(1).setRandom(); cout << m << endl;
Output:
0 7 0 0 0 -2 0 0 0 6 0 0 0 6 0 0
ArrayWrapper< ExpressionType > & setZero | ( | ) | [inherited] |
Sets all coefficients in this expression to zero.
Example:
Matrix4i m = Matrix4i::Random(); m.row(1).setZero(); cout << m << endl;
Output:
7 9 -5 -3 0 0 0 0 6 -3 0 9 6 6 3 9
const CwiseUnaryOp<internal::scalar_sin_op<Scalar>, const ArrayWrapper< ExpressionType > > sin | ( | ) | const [inline, inherited] |
const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const ArrayWrapper< ExpressionType > > sqrt | ( | ) | const [inline, inherited] |
const CwiseUnaryOp<internal::scalar_square_op<Scalar>, const ArrayWrapper< ExpressionType > > square | ( | ) | const [inline, inherited] |
Example:
Array3d v(2,3,4); cout << v.square() << endl;
Output:
4 9 16
void swap | ( | const DenseBase< OtherDerived > & | other, |
int | = OtherDerived::ThisConstantIsPrivateInPlainObjectBase |
||
) | [inline, inherited] |
swaps *this with the expression other.
void swap | ( | PlainObjectBase< OtherDerived > & | other | ) | [inline, inherited] |
swaps *this with the matrix or array other.
SegmentReturnType tail | ( | Index | size | ) | [inherited] |
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.
size | the number of coefficients in the block |
Example:
RowVector4i v = RowVector4i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "Here is v.tail(2):" << endl << v.tail(2) << endl; v.tail(2).setZero(); cout << "Now the vector v is:" << endl << v << endl;
Output:
Here is the vector v: 7 -2 6 6 Here is v.tail(2): 6 6 Now the vector v is: 7 -2 0 0
DenseBase::ConstSegmentReturnType tail | ( | Index | size | ) | const [inherited] |
This is the const version of tail(Index).
FixedSegmentReturnType<Size>::Type tail | ( | ) | [inherited] |
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.
The template parameter Size is the number of coefficients in the block
Example:
RowVector4i v = RowVector4i::Random(); cout << "Here is the vector v:" << endl << v << endl; cout << "Here is v.tail(2):" << endl << v.tail<2>() << endl; v.tail<2>().setZero(); cout << "Now the vector v is:" << endl << v << endl;
Output:
Here is the vector v: 7 -2 6 6 Here is v.tail(2): 6 6 Now the vector v is: 7 -2 0 0
ConstFixedSegmentReturnType<Size>::Type tail | ( | ) | const [inherited] |
This is the const version of tail<int>.
const CwiseUnaryOp<internal::scalar_tan_op<Scalar>, ArrayWrapper< ExpressionType > > tan | ( | ) | const [inline, inherited] |
Block<ArrayWrapper< ExpressionType > > topLeftCorner | ( | Index | cRows, |
Index | cCols | ||
) | [inline, inherited] |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.topLeftCorner(2, 2):" << endl; cout << m.topLeftCorner(2, 2) << endl; m.topLeftCorner(2, 2).setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topLeftCorner(2, 2): 7 9 -2 -6 Now the matrix m is: 0 0 -5 -3 0 0 1 0 6 -3 0 9 6 6 3 9
const Block<const ArrayWrapper< ExpressionType > > topLeftCorner | ( | Index | cRows, |
Index | cCols | ||
) | const [inline, inherited] |
This is the const version of topLeftCorner(Index, Index).
Block<ArrayWrapper< ExpressionType > , CRows, CCols> topLeftCorner | ( | ) | [inline, inherited] |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.topLeftCorner<2,2>():" << endl; cout << m.topLeftCorner<2,2>() << endl; m.topLeftCorner<2,2>().setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topLeftCorner<2,2>(): 7 9 -2 -6 Now the matrix m is: 0 0 -5 -3 0 0 1 0 6 -3 0 9 6 6 3 9
const Block<const ArrayWrapper< ExpressionType > , CRows, CCols> topLeftCorner | ( | ) | const [inline, inherited] |
This is the const version of topLeftCorner<int, int>().
Block<ArrayWrapper< ExpressionType > > topRightCorner | ( | Index | cRows, |
Index | cCols | ||
) | [inline, inherited] |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.topRightCorner(2, 2):" << endl; cout << m.topRightCorner(2, 2) << endl; m.topRightCorner(2, 2).setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topRightCorner(2, 2): -5 -3 1 0 Now the matrix m is: 7 9 0 0 -2 -6 0 0 6 -3 0 9 6 6 3 9
const Block<const ArrayWrapper< ExpressionType > > topRightCorner | ( | Index | cRows, |
Index | cCols | ||
) | const [inline, inherited] |
This is the const version of topRightCorner(Index, Index).
Block<ArrayWrapper< ExpressionType > , CRows, CCols> topRightCorner | ( | ) | [inline, inherited] |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Matrix4i m = Matrix4i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is m.topRightCorner<2,2>():" << endl; cout << m.topRightCorner<2,2>() << endl; m.topRightCorner<2,2>().setZero(); cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topRightCorner<2,2>(): -5 -3 1 0 Now the matrix m is: 7 9 0 0 -2 -6 0 0 6 -3 0 9 6 6 3 9
const Block<const ArrayWrapper< ExpressionType > , CRows, CCols> topRightCorner | ( | ) | const [inline, inherited] |
This is the const version of topRightCorner<int, int>().
n | the number of rows in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.topRows(2):" << endl; cout << a.topRows(2) << endl; a.topRows(2).setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.topRows(2): 7 9 -5 -3 -2 -6 1 0 Now the array a is: 0 0 0 0 0 0 0 0 6 -3 0 9 6 6 3 9
This is the const version of topRows(Index).
NRowsBlockXpr<N>::Type topRows | ( | ) | [inline, inherited] |
N | the number of rows in the block |
Example:
Array44i a = Array44i::Random(); cout << "Here is the array a:" << endl << a << endl; cout << "Here is a.topRows<2>():" << endl; cout << a.topRows<2>() << endl; a.topRows<2>().setZero(); cout << "Now the array a is:" << endl << a << endl;
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.topRows<2>(): 7 9 -5 -3 -2 -6 1 0 Now the array a is: 0 0 0 0 0 0 0 0 6 -3 0 9 6 6 3 9
ConstNRowsBlockXpr<N>::Type topRows | ( | ) | const [inline, inherited] |
This is the const version of topRows<int>().
Eigen::Transpose<ArrayWrapper< ExpressionType > > transpose | ( | ) | [inherited] |
Example:
Matrix2i m = Matrix2i::Random(); cout << "Here is the matrix m:" << endl << m << endl; cout << "Here is the transpose of m:" << endl << m.transpose() << endl; cout << "Here is the coefficient (1,0) in the transpose of m:" << endl << m.transpose()(1,0) << endl; cout << "Let us overwrite this coefficient with the value 0." << endl; m.transpose()(1,0) = 0; cout << "Now the matrix m is:" << endl << m << endl;
Output:
Here is the matrix m: 7 6 -2 6 Here is the transpose of m: 7 -2 6 6 Here is the coefficient (1,0) in the transpose of m: 6 Let us overwrite this coefficient with the value 0. Now the matrix m is: 7 0 -2 6
m = m.transpose(); // bug!!! caused by aliasing effect
m.transposeInPlace();
m = m.transpose().eval();
ConstTransposeReturnType transpose | ( | ) | const [inherited] |
This is the const version of transpose().
Make sure you read the warning for transpose() !
void transposeInPlace | ( | ) | [inherited] |
This is the "in place" version of transpose(): it replaces *this
by its own transpose. Thus, doing
m.transposeInPlace();
has the same effect on m as doing
m = m.transpose().eval();
and is faster and also safer because in the latter line of code, forgetting the eval() results in a bug caused by aliasing.
Notice however that this method is only useful if you want to replace a matrix by its own transpose. If you just need the transpose of a matrix, use transpose().
*this
must be a resizable matrix.const CwiseUnaryOp<CustomUnaryOp, const ArrayWrapper< ExpressionType > > unaryExpr | ( | const CustomUnaryOp & | func = CustomUnaryOp() | ) | const [inline, inherited] |
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:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; // define function to be applied coefficient-wise double ramp(double x) { if (x > 0) return x; else return 0; } int main(int, char**) { Matrix4d m1 = Matrix4d::Random(); cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(ptr_fun(ramp)) << endl; return 0; }
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:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; // define a custom template unary functor template<typename Scalar> struct CwiseClampOp { CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {} const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); } Scalar m_inf, m_sup; }; int main(int, char**) { Matrix4d m1 = Matrix4d::Random(); cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(CwiseClampOp<double>(-0.5,0.5)) << endl; return 0; }
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
const CwiseUnaryView<CustomViewOp, const ArrayWrapper< ExpressionType > > unaryViewExpr | ( | const CustomViewOp & | func = CustomViewOp() | ) | const [inline, inherited] |
The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.
Example:
#include <Eigen/Core> #include <iostream> using namespace Eigen; using namespace std; // define a custom template unary functor template<typename Scalar> struct CwiseClampOp { CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {} const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); } Scalar m_inf, m_sup; }; int main(int, char**) { Matrix4d m1 = Matrix4d::Random(); cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(CwiseClampOp<double>(-0.5,0.5)) << endl; return 0; }
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
CoeffReturnType value | ( | ) | const [inline, inherited] |
void visit | ( | Visitor & | func | ) | const [inherited] |
Applies the visitor visitor to the whole coefficients of the matrix or vector.
The template parameter Visitor is the type of the visitor and provides the following interface:
struct MyVisitor { // called for the first coefficient void init(const Scalar& value, Index i, Index j); // called for all other coefficients void operator() (const Scalar& value, Index i, Index j); };
void writePacket | ( | Index | row, |
Index | col, | ||
const PacketScalar & | x | ||
) | [inline] |
void writePacket | ( | Index | index, |
const PacketScalar & | x | ||
) | [inline] |
References ArrayWrapper< ExpressionType >::m_expression.
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.
Example:
cout << MatrixXi::Zero(2,3) << endl;
Output:
0 0 0 0 0 0
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
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 variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.
Example:
cout << RowVectorXi::Zero(4) << endl; cout << VectorXf::Zero(2) << endl;
Output:
0 0 0 0 0 0
static const ConstantReturnType Zero | ( | ) | [static, inherited] |
This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.
Example:
cout << Matrix2d::Zero() << endl; cout << RowVector4i::Zero() << endl;
Output:
0 0 0 0 0 0 0 0
const ScalarMultipleReturnType operator* | ( | const Scalar & | scalar, |
const StorageBaseType & | matrix | ||
) | [friend, inherited] |
const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const ArrayWrapper< ExpressionType > > operator* | ( | const std::complex< Scalar > & | scalar, |
const StorageBaseType & | matrix | ||
) | [friend, inherited] |
const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const ArrayWrapper< ExpressionType > > operator+ | ( | const Scalar & | scalar, |
const Eigen::ArrayBase< ArrayWrapper< ExpressionType > > & | other | ||
) | [friend, inherited] |
const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const ArrayWrapper< ExpressionType > > > operator- | ( | const Scalar & | scalar, |
const Eigen::ArrayBase< ArrayWrapper< ExpressionType > > & | other | ||
) | [friend, inherited] |
NestedExpressionType m_expression [protected] |
Referenced by ArrayWrapper< ExpressionType >::coeff(), ArrayWrapper< ExpressionType >::coeffRef(), ArrayWrapper< ExpressionType >::cols(), ArrayWrapper< ExpressionType >::data(), ArrayWrapper< ExpressionType >::evalTo(), ArrayWrapper< ExpressionType >::innerStride(), ArrayWrapper< ExpressionType >::nestedExpression(), ArrayWrapper< ExpressionType >::outerStride(), ArrayWrapper< ExpressionType >::packet(), ArrayWrapper< ExpressionType >::rows(), and ArrayWrapper< ExpressionType >::writePacket().