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)
42#ifndef EIGEN_PARSED_BY_DOXYGEN
43 :
public DenseCoeffsBase<Derived, internal::accessors_level<Derived>::value>
45 :
public DenseCoeffsBase<Derived,DirectWriteAccessors>
53 typedef Eigen::InnerIterator<Derived> InnerIterator;
55 typedef typename internal::traits<Derived>::StorageKind StorageKind;
63 typedef typename internal::traits<Derived>::StorageIndex
StorageIndex;
66 typedef typename internal::traits<Derived>::Scalar
Scalar;
73 typedef typename NumTraits<Scalar>::Real RealScalar;
74 typedef DenseCoeffsBase<Derived, internal::accessors_level<Derived>::value> Base;
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;
113 SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
114 internal::traits<Derived>::ColsAtCompileTime>::ret),
141 MaxSizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::MaxRowsAtCompileTime,
142 internal::traits<Derived>::MaxColsAtCompileTime>::ret),
154 || internal::traits<Derived>::ColsAtCompileTime == 1,
165 Flags = internal::traits<Derived>::Flags,
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 };
186 internal::traits<Derived>::RowsAtCompileTime,
187 internal::traits<Derived>::ColsAtCompileTime,
189 internal::traits<Derived>::MaxRowsAtCompileTime,
190 internal::traits<Derived>::MaxColsAtCompileTime
196 internal::traits<Derived>::RowsAtCompileTime,
197 internal::traits<Derived>::ColsAtCompileTime,
199 internal::traits<Derived>::MaxRowsAtCompileTime,
200 internal::traits<Derived>::MaxColsAtCompileTime
209 typedef typename internal::conditional<internal::is_same<typename internal::traits<Derived>::XprKind,
MatrixXpr >
::value,
214 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
222 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
234 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
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>
302 Derived&
operator=(
const ReturnByValue<OtherDerived>& func);
306 template<
typename OtherDerived>
308 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC
314 template<
unsigned int Added,
unsigned int Removed>
320 template<
typename OtherDerived>
327 typedef typename internal::add_const<Transpose<const Derived> >::type ConstTransposeReturnType;
329 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
361 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Zero(
Index size);
362 EIGEN_DEVICE_FUNC
static const ConstantReturnType
Zero();
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);
398 typedef typename internal::add_const_on_value_type<typename internal::eval<Derived>::type>::type EvalReturnType;
407 EIGEN_STRONG_INLINE EvalReturnType
eval()
const
412 return typename internal::eval<Derived>::type(
derived());
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);
424 call_assignment(
derived(), other.const_cast_derived(), internal::swap_assign_op<Scalar>());
430 template<
typename OtherDerived>
431 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
434 eigen_assert(
rows()==other.rows() &&
cols()==other.cols());
435 call_assignment(
derived(), other.derived(), internal::swap_assign_op<Scalar>());
441 template<
bool Enable> EIGEN_DEVICE_FUNC
442 inline const typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf()
const;
443 template<
bool Enable> EIGEN_DEVICE_FUNC
444 inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf();
448 EIGEN_DEVICE_FUNC
Scalar trace()
const;
452 template<
int NaNPropagation>
453 EIGEN_DEVICE_FUNC
typename internal::traits<Derived>::Scalar
minCoeff()
const;
454 template<
int NaNPropagation>
455 EIGEN_DEVICE_FUNC
typename internal::traits<Derived>::Scalar
maxCoeff()
const;
462 EIGEN_DEVICE_FUNC
inline typename internal::traits<Derived>::Scalar
minCoeff()
const {
463 return minCoeff<PropagateFast>();
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);
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
625 internal::pointer_based_stl_iterator<Derived>,
626 internal::generic_randaccess_stl_iterator<Derived>
627 >::type iterator_type;
630 internal::pointer_based_stl_iterator<const Derived>,
631 internal::generic_randaccess_stl_iterator<const Derived>
632 >::type const_iterator_type;
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
675 EIGEN_STATIC_ASSERT((internal::is_same<Dest,void>::value),THE_EVAL_EVALTO_FUNCTION_SHOULD_NEVER_BE_CALLED_FOR_DENSE_OBJECTS);
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);
General-purpose arrays with easy API for coefficient-wise operations.
Definition: Array.h:47
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:61
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:47
EIGEN_CONSTEXPR Index outerSize() const
Definition: DenseBase.h:223
@ IsVectorAtCompileTime
Definition: DenseBase.h:153
@ SizeAtCompileTime
Definition: DenseBase.h:113
@ MaxSizeAtCompileTime
Definition: DenseBase.h:141
@ IsRowMajor
Definition: DenseBase.h:170
@ NumDimensions
Definition: DenseBase.h:160
@ Flags
Definition: DenseBase.h:165
@ ColsAtCompileTime
Definition: DenseBase.h:106
@ MaxColsAtCompileTime
Definition: DenseBase.h:130
@ MaxRowsAtCompileTime
Definition: DenseBase.h:119
@ RowsAtCompileTime
Definition: DenseBase.h:100
internal::traits< Derived >::Scalar minCoeff() const
Definition: Redux.h:431
CommaInitializer< Derived > operator<<(const Scalar &s)
Definition: CommaInitializer.h:148
const WithFormat< Derived > format(const IOFormat &fmt) const
Definition: DenseBase.h:519
static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType LinSpaced(Sequential_t, Index size, const Scalar &low, const Scalar &high)
Definition: CwiseNullaryOp.h:244
bool isConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:325
Scalar mean() const
Definition: Redux.h:472
Index count() const
Definition: BooleanRedux.h:127
Derived & setOnes()
Definition: CwiseNullaryOp.h:698
void resize(Index rows, Index cols)
Definition: DenseBase.h:257
static const ConstantReturnType Ones()
Definition: CwiseNullaryOp.h:670
internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition: DenseBase.h:63
void resize(Index newSize)
Definition: DenseBase.h:246
random_access_iterator_type const_iterator
Definition: DenseBase.h:622
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > NullaryExpr(Index rows, Index cols, const CustomNullaryOp &func)
Definition: CwiseNullaryOp.h:114
ReverseReturnType reverse()
Definition: Reverse.h:120
const NestByValue< Derived > nestByValue() const
Definition: NestByValue.h:63
void visit(Visitor &func) const
Definition: Visitor.h:117
static const ConstantReturnType Zero()
Definition: CwiseNullaryOp.h:514
void swap(PlainObjectBase< OtherDerived > &other)
Definition: DenseBase.h:432
iterator begin()
Definition: StlIterators.h:408
ConstColwiseReturnType colwise() const
Definition: DenseBase.h:562
EIGEN_CONSTEXPR Index innerSize() const
Definition: DenseBase.h:235
Derived & setLinSpaced(Index size, const Scalar &low, const Scalar &high)
Sets a linearly spaced vector.
Definition: CwiseNullaryOp.h:430
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
const Replicate< Derived, RowFactor, ColFactor > replicate() const
Definition: Replicate.h:119
const Select< Derived, ThenDerived, ElseDerived > select(const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
Definition: Select.h:126
static const ConstantReturnType Constant(Index rows, Index cols, const Scalar &value)
Definition: CwiseNullaryOp.h:189
const Replicate< Derived, Dynamic, Dynamic > replicate(Index rowFactor, Index colFactor) const
Definition: DenseBase.h:600
internal::traits< Derived >::Scalar maxCoeff() const
Definition: Redux.h:446
CoeffReturnType value() const
Definition: DenseBase.h:526
Scalar value_type
Definition: DenseBase.h:71
void fill(const Scalar &value)
Definition: CwiseNullaryOp.h:335
ConstReverseReturnType reverse() const
Definition: DenseBase.h:610
ConstRowwiseReturnType rowwise() const
Definition: DenseBase.h:550
DenseBase()
Definition: DenseBase.h:681
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
Definition: DenseBase.h:191
bool isOnes(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:685
EvalReturnType eval() const
Definition: DenseBase.h:407
bool hasNaN() const
Definition: BooleanRedux.h:137
Derived & operator=(const DenseBase< OtherDerived > &other)
Definition: Assign.h:39
bool any() const
Definition: BooleanRedux.h:103
Derived & setConstant(const Scalar &value)
Definition: CwiseNullaryOp.h:345
Derived & setRandom()
Definition: Random.h:131
void transposeInPlace()
Definition: Transpose.h:344
TransposeReturnType transpose()
Definition: Transpose.h:182
EIGEN_CONSTEXPR Index nonZeros() const
Definition: DenseBase.h:215
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
void reverseInPlace()
Definition: Reverse.h:141
Scalar sum() const
Definition: Redux.h:459
EIGEN_DEPRECATED const Derived & flagged() const
Definition: DenseBase.h:317
bool all() const
Definition: BooleanRedux.h:79
iterator end()
Definition: StlIterators.h:437
static const RandomReturnType Random()
Definition: Random.h:113
bool isApprox(const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Fuzzy.h:103
const_iterator cbegin() const
Definition: StlIterators.h:426
const_iterator cend() const
Definition: StlIterators.h:455
Scalar prod() const
Definition: Redux.h:493
EIGEN_DEPRECATED Derived & lazyAssign(const DenseBase< OtherDerived > &other)
bool allFinite() const
Definition: BooleanRedux.h:151
Derived & setZero()
Definition: CwiseNullaryOp.h:546
bool isZero(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:528
random_access_iterator_type iterator
Definition: DenseBase.h:620
bool isApproxToConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:310
void swap(const DenseBase< OtherDerived > &other)
Definition: DenseBase.h:420
EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: EigenBase.h:63
Derived & derived()
Definition: EigenBase.h:46
EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: EigenBase.h:60
EIGEN_CONSTEXPR Index size() const EIGEN_NOEXCEPT
Definition: EigenBase.h:67
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:36
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180
Expression which must be nested by value.
Definition: NestByValue.h:40
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:100
Expression of the multiple replication of a matrix or vector.
Definition: Replicate.h:63
Expression of the reverse of a vector or matrix.
Definition: Reverse.h:65
Expression of a coefficient wise version of the C++ ternary operator ?:
Definition: Select.h:54
Expression of the transpose of a matrix.
Definition: Transpose.h:54
Pseudo expression providing broadcasting and partial reduction operations.
Definition: VectorwiseOp.h:187
@ ColMajor
Definition: Constants.h:319
@ RowMajor
Definition: Constants.h:321
@ AutoAlign
Definition: Constants.h:323
const unsigned int DirectAccessBit
Definition: Constants.h:155
const unsigned int RowMajorBit
Definition: Constants.h:66
Namespace containing all symbols from the Eigen library.
Definition: Core:141
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Helper class used by the comma initializer operator.
Definition: CommaInitializer.h:29
Definition: EigenBase.h:30
Definition: Constants.h:522
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
Definition: NumTraits.h:233