11#ifndef EIGEN_DENSEBASE_H
12#define EIGEN_DENSEBASE_H
20static inline void check_DenseIndex_is_signed() {
21 EIGEN_STATIC_ASSERT(NumTraits<DenseIndex>::IsSigned,THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE)
43 :
public DenseCoeffsBase<Derived, internal::accessors_level<Derived>::value>
77 using Base::const_cast_derived;
81 using Base::rowIndexByOuterInner;
82 using Base::colIndexByOuterInner;
84 using Base::coeffByOuterInner;
85 using Base::operator();
86 using Base::operator[];
92 using Base::innerStride;
93 using Base::outerStride;
94 using Base::rowStride;
95 using Base::colStride;
96 typedef typename Base::CoeffReturnType CoeffReturnType;
175 InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret,
176 OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret
179 typedef typename internal::find_best_packet<Scalar,SizeAtCompileTime>::type PacketScalar;
181 enum { IsPlainObjectBase = 0 };
214 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
222 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
226 : int(
IsRowMajor) ? this->rows() : this->cols();
234 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
238 : int(
IsRowMajor) ? this->cols() : this->rows();
248 EIGEN_ONLY_USED_FOR_DEBUG(
newSize);
249 eigen_assert(
newSize == this->size()
250 &&
"DenseBase::resize() does not actually allow to resize.");
259 EIGEN_ONLY_USED_FOR_DEBUG(rows);
260 EIGEN_ONLY_USED_FOR_DEBUG(cols);
261 eigen_assert(rows == this->rows() && cols == this->cols()
262 &&
"DenseBase::resize() does not actually allow to resize.");
265#ifndef EIGEN_PARSED_BY_DOXYGEN
278 template<
typename OtherDerived>
279 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
285 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
288 template<
typename OtherDerived>
292 template<
typename OtherDerived>
296 template<
typename OtherDerived>
300 template<
typename OtherDerived>
306 template<
typename OtherDerived>
308 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC
314 template<
unsigned int Added,
unsigned int Removed>
318 {
return derived(); }
320 template<
typename OtherDerived>
329 const ConstTransposeReturnType
transpose()
const;
333 EIGEN_DEVICE_FUNC
static const ConstantReturnType
335 EIGEN_DEVICE_FUNC
static const ConstantReturnType
337 EIGEN_DEVICE_FUNC
static const ConstantReturnType
340 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC
static const RandomAccessLinSpacedReturnType
342 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC
static const RandomAccessLinSpacedReturnType
345 EIGEN_DEVICE_FUNC
static const RandomAccessLinSpacedReturnType
347 EIGEN_DEVICE_FUNC
static const RandomAccessLinSpacedReturnType
350 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
353 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
356 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
360 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Zero(
Index rows,
Index cols);
361 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Zero(
Index size);
362 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Zero();
363 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Ones(
Index rows,
Index cols);
364 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Ones(
Index size);
365 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Ones();
371 EIGEN_DEVICE_FUNC Derived&
setZero();
372 EIGEN_DEVICE_FUNC Derived&
setOnes();
375 template<
typename OtherDerived> EIGEN_DEVICE_FUNC
379 bool isMuchSmallerThan(
const RealScalar& other,
381 template<
typename OtherDerived> EIGEN_DEVICE_FUNC
390 inline bool hasNaN()
const;
393 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
394 Derived& operator*=(
const Scalar& other);
395 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
396 Derived& operator/=(
const Scalar& other);
407 EIGEN_STRONG_INLINE EvalReturnType
eval()
const
418 template<
typename OtherDerived>
419 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
422 EIGEN_STATIC_ASSERT(!OtherDerived::IsPlainObjectBase,THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY);
423 eigen_assert(rows()==other.rows() && cols()==other.cols());
430 template<
typename OtherDerived>
431 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
434 eigen_assert(rows()==other.rows() && cols()==other.cols());
441 template<
bool Enable> EIGEN_DEVICE_FUNC
443 template<
bool Enable> EIGEN_DEVICE_FUNC
448 EIGEN_DEVICE_FUNC
Scalar trace()
const;
452 template<
int NaNPropagation>
454 template<
int NaNPropagation>
465 EIGEN_DEVICE_FUNC
inline typename internal::traits<Derived>::Scalar maxCoeff()
const {
466 return maxCoeff<PropagateFast>();
469 template<
int NaNPropagation,
typename IndexType>
471 typename internal::traits<Derived>::Scalar minCoeff(IndexType* row, IndexType* col)
const;
472 template<
int NaNPropagation,
typename IndexType>
474 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* row, IndexType* col)
const;
475 template<
int NaNPropagation,
typename IndexType>
477 typename internal::traits<Derived>::Scalar minCoeff(IndexType* index)
const;
478 template<
int NaNPropagation,
typename IndexType>
480 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* index)
const;
483 template<
typename IndexType>
484 EIGEN_DEVICE_FUNC
inline
485 typename internal::traits<Derived>::Scalar minCoeff(IndexType* row, IndexType* col)
const {
486 return minCoeff<PropagateFast>(row, col);
488 template<
typename IndexType>
489 EIGEN_DEVICE_FUNC
inline
490 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* row, IndexType* col)
const {
491 return maxCoeff<PropagateFast>(row, col);
493 template<
typename IndexType>
494 EIGEN_DEVICE_FUNC
inline
495 typename internal::traits<Derived>::Scalar minCoeff(IndexType* index)
const {
496 return minCoeff<PropagateFast>(index);
498 template<
typename IndexType>
499 EIGEN_DEVICE_FUNC
inline
500 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* index)
const {
501 return maxCoeff<PropagateFast>(index);
504 template<
typename BinaryOp>
506 Scalar redux(
const BinaryOp& func)
const;
508 template<
typename Visitor>
510 void visit(Visitor& func)
const;
528 EIGEN_STATIC_ASSERT_SIZE_1x1(Derived)
529 eigen_assert(this->rows() == 1 && this->cols() == 1);
530 return derived().coeff(0,0);
533 EIGEN_DEVICE_FUNC
bool all()
const;
534 EIGEN_DEVICE_FUNC
bool any()
const;
553 EIGEN_DEVICE_FUNC RowwiseReturnType
rowwise();
565 EIGEN_DEVICE_FUNC ColwiseReturnType
colwise();
570 static const RandomReturnType
Random();
572 template<
typename ThenDerived,
typename ElseDerived>
577 template<
typename ThenDerived>
581 template<
typename ElseDerived>
585 template<
int p> RealScalar lpNorm()
const;
587 template<
int RowFactor,
int ColFactor>
607 EIGEN_DEVICE_FUNC ReverseReturnType
reverse();
616 #ifdef EIGEN_PARSED_BY_DOXYGEN
627 >::type iterator_type;
632 >::type const_iterator_type;
644 >::type const_iterator;
647 inline iterator
begin();
648 inline const_iterator
begin()
const;
649 inline const_iterator
cbegin()
const;
650 inline iterator
end();
651 inline const_iterator
end()
const;
652 inline const_iterator
cend()
const;
654#define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::DenseBase
655#define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
656#define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND)
657#define EIGEN_DOC_UNARY_ADDONS(X,Y)
658# include "../plugins/CommonCwiseUnaryOps.h"
659# include "../plugins/BlockMethods.h"
660# include "../plugins/IndexedViewMethods.h"
661# include "../plugins/ReshapedMethods.h"
662# ifdef EIGEN_DENSEBASE_PLUGIN
663# include EIGEN_DENSEBASE_PLUGIN
665#undef EIGEN_CURRENT_STORAGE_BASE_CLASS
666#undef EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
667#undef EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF
668#undef EIGEN_DOC_UNARY_ADDONS
671 template<
typename Dest>
673 inline void evalTo(
Dest& )
const
679 EIGEN_DEFAULT_COPY_CONSTRUCTOR(
DenseBase)
686#ifdef EIGEN_INTERNAL_DEBUGGING
689 INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
694 EIGEN_DEVICE_FUNC
explicit DenseBase(
int);
Base class for all dense matrices, vectors, and arrays.
Definition DenseBase.h:47
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerSize() const
Definition DenseBase.h:235
@ IsVectorAtCompileTime
This is set to true if either the number of rows or the number of columns is known at compile-time to...
Definition DenseBase.h:153
@ SizeAtCompileTime
This is equal to the number of coefficients, i.e.
Definition DenseBase.h:113
@ MaxSizeAtCompileTime
This value is equal to the maximum possible number of coefficients that this expression might have.
Definition DenseBase.h:141
@ IsRowMajor
True if this expression has row-major storage order.
Definition DenseBase.h:170
@ NumDimensions
This value is equal to Tensor::NumDimensions, i.e.
Definition DenseBase.h:160
@ Flags
This stores expression Flags flags which may or may not be inherited by new expressions constructed f...
Definition DenseBase.h:165
@ ColsAtCompileTime
The number of columns at compile-time.
Definition DenseBase.h:106
@ MaxColsAtCompileTime
This value is equal to the maximum possible number of columns that this expression might have.
Definition DenseBase.h:130
@ MaxRowsAtCompileTime
This value is equal to the maximum possible number of rows that this expression might have.
Definition DenseBase.h:119
@ RowsAtCompileTime
The number of rows at compile-time.
Definition DenseBase.h:100
static EIGEN_DEVICE_FUNC const ConstantReturnType Constant(Index rows, Index cols, const Scalar &value)
Definition CwiseNullaryOp.h:189
EIGEN_DEVICE_FUNC void reverseInPlace()
This is the "in place" version of reverse: it reverses *this.
Definition Reverse.h:141
static EIGEN_DEVICE_FUNC const ConstantReturnType Ones()
Definition CwiseNullaryOp.h:670
EIGEN_DEVICE_FUNC void resize(Index newSize)
Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods...
Definition DenseBase.h:246
const WithFormat< Derived > format(const IOFormat &fmt) const
Definition DenseBase.h:519
EIGEN_DEVICE_FUNC Derived & setLinSpaced(Index size, const Scalar &low, const Scalar &high)
Sets a linearly spaced vector.
Definition CwiseNullaryOp.h:430
EIGEN_DEVICE_FUNC Derived & setConstant(const Scalar &value)
Sets all coefficients in this expression to value val.
Definition CwiseNullaryOp.h:345
EIGEN_DEVICE_FUNC bool all() const
Definition BooleanRedux.h:81
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerSize() const
Definition DenseBase.h:223
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap(PlainObjectBase< OtherDerived > &other)
swaps *this with the matrix or array other.
Definition DenseBase.h:432
EIGEN_DEVICE_FUNC void transposeInPlace()
This is the "in place" version of transpose(): it replaces *this by its own transpose.
Definition Transpose.h:344
internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition DenseBase.h:63
EIGEN_DEVICE_FUNC Derived & setRandom()
Sets all coefficients in this expression to random values.
Definition Random.h:131
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap(const DenseBase< OtherDerived > &other)
swaps *this with the expression other.
Definition DenseBase.h:420
EIGEN_DEVICE_FUNC const Select< Derived, ThenDerived, ElseDerived > select(const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
Definition Select.h:126
Eigen::InnerIterator< Derived > InnerIterator
Inner iterator type to iterate over the coefficients of a row or column.
Definition DenseBase.h:53
EIGEN_DEVICE_FUNC void fill(const Scalar &value)
Alias for setConstant(): sets all coefficients in this expression to val.
Definition CwiseNullaryOp.h:335
iterator begin()
returns an iterator to the first element of the 1D vector or array \only_for_vectors
Definition StlIterators.h:408
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator=(const DenseBase< OtherDerived > &other)
Copies other into *this.
Definition Assign.h:39
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType eval() const
Definition DenseBase.h:407
internal::traits< Derived >::Scalar Scalar
The numeric type of the expression' coefficients, e.g.
Definition DenseBase.h:66
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index nonZeros() const
Definition DenseBase.h:215
EIGEN_DEPRECATED static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType LinSpaced(Sequential_t, Index size, const Scalar &low, const Scalar &high)
Definition CwiseNullaryOp.h:244
EIGEN_DEVICE_FUNC void visit(Visitor &func) const
Applies the visitor visitor to the whole coefficients of the matrix or vector.
Definition Visitor.h:117
EIGEN_DEVICE_FUNC Index count() const
Definition BooleanRedux.h:129
static EIGEN_DEVICE_FUNC const ConstantReturnType Zero()
Definition CwiseNullaryOp.h:514
EIGEN_DEVICE_FUNC CoeffReturnType value() const
Definition DenseBase.h:526
EIGEN_DEVICE_FUNC bool isOnes(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:685
Scalar value_type
The numeric type of the expression' coefficients, e.g.
Definition DenseBase.h:71
EIGEN_DEVICE_FUNC ConstColwiseReturnType colwise() const
Definition DenseBase.h:562
EIGEN_DEVICE_FUNC const NestByValue< Derived > nestByValue() const
Definition NestByValue.h:63
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
The plain matrix type corresponding to this expression.
Definition DenseBase.h:191
EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived & lazyAssign(const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC bool isZero(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:528
EIGEN_DEVICE_FUNC bool isApproxToConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:310
bool hasNaN() const
Definition BooleanRedux.h:139
EIGEN_DEVICE_FUNC bool isConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
This is just an alias for isApproxToConstant().
Definition CwiseNullaryOp.h:325
EIGEN_DEVICE_FUNC Scalar prod() const
Definition Redux.h:493
EIGEN_DEVICE_FUNC Derived & setZero()
Sets all coefficients in this expression to zero.
Definition CwiseNullaryOp.h:546
EIGEN_DEVICE_FUNC Scalar sum() const
Definition Redux.h:459
EIGEN_DEVICE_FUNC Scalar mean() const
Definition Redux.h:472
EIGEN_DEVICE_FUNC TransposeReturnType transpose()
Definition Transpose.h:182
EIGEN_DEVICE_FUNC ReverseReturnType reverse()
Definition Reverse.h:120
EIGEN_DEVICE_FUNC Derived & setOnes()
Sets all coefficients in this expression to one.
Definition CwiseNullaryOp.h:698
internal::conditional< internal::is_same< typenameinternal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
The plain matrix or array type corresponding to this expression.
Definition DenseBase.h:210
EIGEN_DEVICE_FUNC ConstReverseReturnType reverse() const
This is the const version of reverse().
Definition DenseBase.h:610
EIGEN_DEPRECATED const Derived & flagged() const
Definition DenseBase.h:317
EIGEN_DEVICE_FUNC bool any() const
Definition BooleanRedux.h:105
EIGEN_DEVICE_FUNC const Replicate< Derived, RowFactor, ColFactor > replicate() const
Definition Replicate.h:119
EIGEN_DEVICE_FUNC CommaInitializer< Derived > operator<<(const Scalar &s)
Convenient operator to set the coefficients of a matrix.
Definition CommaInitializer.h:148
iterator end()
returns an iterator to the element following the last element of the 1D vector or array \only_for_vec...
Definition StlIterators.h:437
static const RandomReturnType Random()
Definition Random.h:113
EIGEN_DEVICE_FUNC DenseBase()
Default constructor.
Definition DenseBase.h:681
const_iterator cbegin() const
returns a read-only const_iterator to the first element of the 1D vector or array \only_for_vectors
Definition StlIterators.h:426
const_iterator cend() const
returns a read-only const_iterator to the element following the last element of the 1D vector or arra...
Definition StlIterators.h:455
EIGEN_DEVICE_FUNC void resize(Index rows, Index cols)
Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods...
Definition DenseBase.h:257
bool allFinite() const
Definition BooleanRedux.h:153
EIGEN_DEVICE_FUNC bool isApprox(const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition Fuzzy.h:103
EIGEN_DEVICE_FUNC ConstRowwiseReturnType rowwise() const
Definition DenseBase.h:550
EIGEN_DEVICE_FUNC const Replicate< Derived, Dynamic, Dynamic > replicate(Index rowFactor, Index colFactor) const
Definition DenseBase.h:600
Definition ForwardDeclarations.h:50
Base class for all dense matrices, vectors, and expressions.
Definition MatrixBase.h:50
Definition StlIterators.h:269
Definition StlIterators.h:180
@ ColMajor
Storage order is column major (see TopicStorageOrders).
Definition Constants.h:319
@ RowMajor
Storage order is row major (see TopicStorageOrders).
Definition Constants.h:321
@ AutoAlign
Align the matrix itself if it is vectorizable fixed-size.
Definition Constants.h:323
const unsigned int DirectAccessBit
Means that the underlying array of coefficients can be directly accessed as a plain strided array.
Definition Constants.h:155
const unsigned int RowMajorBit
for a matrix, this means that the storage order is row-major.
Definition Constants.h:66
Namespace containing all symbols from the Eigen library.
Definition LDLT.h:16
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition Meta.h:74
The type used to identify a matrix expression.
Definition Constants.h:522
Holds information about the various numeric (i.e.
Definition NumTraits.h:236
Definition XprHelper.h:332
Definition XprHelper.h:282
Definition AssignmentFunctors.h:142
Definition ForwardDeclarations.h:17