11 #ifndef EIGEN_DENSEBASE_H
12 #define EIGEN_DENSEBASE_H
20 static 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>
46 #endif // not EIGEN_PARSED_BY_DOXYGEN
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 };
226 : int(
IsRowMajor) ? this->rows() : this->cols();
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
275 #endif // not 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 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
352 NullaryExpr(
Index rows,
Index cols,
const CustomNullaryOp& func);
353 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
355 NullaryExpr(
Index size,
const CustomNullaryOp& func);
356 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
358 NullaryExpr(
const CustomNullaryOp& 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;
455 template<
typename IndexType> EIGEN_DEVICE_FUNC
457 template<
typename IndexType> EIGEN_DEVICE_FUNC
459 template<
typename IndexType> EIGEN_DEVICE_FUNC
461 template<
typename IndexType> EIGEN_DEVICE_FUNC
464 template<
typename BinaryOp>
466 Scalar redux(
const BinaryOp& func)
const;
468 template<
typename Visitor>
470 void visit(Visitor& func)
const;
488 EIGEN_STATIC_ASSERT_SIZE_1x1(Derived)
489 eigen_assert(this->rows() == 1 && this->cols() == 1);
490 return derived().coeff(0,0);
493 EIGEN_DEVICE_FUNC
bool all()
const;
494 EIGEN_DEVICE_FUNC
bool any()
const;
513 EIGEN_DEVICE_FUNC RowwiseReturnType
rowwise();
525 EIGEN_DEVICE_FUNC ColwiseReturnType
colwise();
530 static const RandomReturnType
Random();
532 template<
typename ThenDerived,
typename ElseDerived>
537 template<
typename ThenDerived>
541 template<
typename ElseDerived>
545 template<
int p> RealScalar lpNorm()
const;
547 template<
int RowFactor,
int ColFactor>
567 EIGEN_DEVICE_FUNC ReverseReturnType
reverse();
576 #ifdef EIGEN_PARSED_BY_DOXYGEN
580 typedef random_access_iterator_type iterator;
582 typedef random_access_iterator_type const_iterator;
587 >::type iterator_type;
592 >::type const_iterator_type;
604 >::type const_iterator;
607 inline iterator
begin();
608 inline const_iterator
begin()
const;
609 inline const_iterator
cbegin()
const;
610 inline iterator
end();
611 inline const_iterator
end()
const;
612 inline const_iterator
cend()
const;
614 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::DenseBase
615 #define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
616 #define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND)
617 #define EIGEN_DOC_UNARY_ADDONS(X,Y)
618 # include "../plugins/CommonCwiseUnaryOps.h"
619 # include "../plugins/BlockMethods.h"
620 # include "../plugins/IndexedViewMethods.h"
621 # include "../plugins/ReshapedMethods.h"
622 # ifdef EIGEN_DENSEBASE_PLUGIN
623 # include EIGEN_DENSEBASE_PLUGIN
625 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS
626 #undef EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
627 #undef EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF
628 #undef EIGEN_DOC_UNARY_ADDONS
631 template<
typename Dest>
633 inline void evalTo(Dest& )
const
639 EIGEN_DEFAULT_COPY_CONSTRUCTOR(
DenseBase)
646 #ifdef EIGEN_INTERNAL_DEBUGGING
649 INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
654 EIGEN_DEVICE_FUNC
explicit DenseBase(
int);
661 #endif // EIGEN_DENSEBASE_H
EIGEN_DEVICE_FUNC DenseBase()
Definition: DenseBase.h:641
internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
The plain matrix or array type corresponding to this expression.
Definition: DenseBase.h:210
static EIGEN_DEVICE_FUNC const ConstantReturnType Constant(Index rows, Index cols, const Scalar &value)
Definition: CwiseNullaryOp.h:189
EIGEN_DEVICE_FUNC CommaInitializer< Derived > operator<<(const Scalar &s)
Definition: CommaInitializer.h:148
@ RowsAtCompileTime
Definition: DenseBase.h:100
Definition: Constants.h:518
Namespace containing all symbols from the Eigen library.
Definition: LDLT.h:16
EIGEN_DEVICE_FUNC Derived & setZero()
Definition: CwiseNullaryOp.h:519
Definition: ReturnByValue.h:52
EIGEN_DEVICE_FUNC bool isZero(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:501
@ SizeAtCompileTime
Definition: DenseBase.h:113
EIGEN_DEPRECATED static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType LinSpaced(Sequential_t, Index size, const Scalar &low, const Scalar &high)
Definition: CwiseNullaryOp.h:244
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:36
static EIGEN_DEVICE_FUNC const ConstantReturnType Ones()
Definition: CwiseNullaryOp.h:617
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
Definition: EigenBase.h:30
internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition: DenseBase.h:63
EIGEN_DEVICE_FUNC bool isApproxToConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:310
EIGEN_DEVICE_FUNC Derived & setConstant(const Scalar &value)
Definition: CwiseNullaryOp.h:345
const unsigned int RowMajorBit
Definition: Constants.h:65
General-purpose arrays with easy API for coefficient-wise operations.
Definition: Array.h:47
Pseudo expression providing broadcasting and partial reduction operations.
Definition: VectorwiseOp.h:187
EIGEN_DEVICE_FUNC Scalar mean() const
Definition: Redux.h:464
@ IsRowMajor
Definition: DenseBase.h:170
@ RowMajor
Definition: Constants.h:320
EIGEN_DEVICE_FUNC Index nonZeros() const
Definition: DenseBase.h:215
EIGEN_DEVICE_FUNC ConstReverseReturnType reverse() const
Definition: DenseBase.h:570
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType eval() const
Definition: DenseBase.h:407
Expression of the transpose of a matrix.
Definition: Transpose.h:54
const unsigned int DirectAccessBit
Definition: Constants.h:154
EIGEN_DEPRECATED const Derived & flagged() const
Definition: DenseBase.h:317
bool hasNaN() const
Definition: BooleanRedux.h:137
EIGEN_DEVICE_FUNC Derived & setLinSpaced(Index size, const Scalar &low, const Scalar &high)
Sets a linearly spaced vector.
Definition: CwiseNullaryOp.h:403
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:61
EIGEN_DEVICE_FUNC Index innerSize() const
Definition: DenseBase.h:235
EIGEN_DEVICE_FUNC Scalar prod() const
Definition: Redux.h:485
EIGEN_DEVICE_FUNC bool isOnes(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:632
@ MaxColsAtCompileTime
Definition: DenseBase.h:130
iterator end()
Definition: StlIterators.h:434
EIGEN_DEVICE_FUNC Index outerSize() const
Definition: DenseBase.h:223
EIGEN_DEVICE_FUNC bool all() const
Definition: BooleanRedux.h:79
EIGEN_DEVICE_FUNC ReverseReturnType reverse()
Definition: Reverse.h:118
@ IsVectorAtCompileTime
Definition: DenseBase.h:153
EIGEN_DEVICE_FUNC TransposeReturnType transpose()
Definition: Transpose.h:182
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap(PlainObjectBase< OtherDerived > &other)
Definition: DenseBase.h:432
EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived & lazyAssign(const DenseBase< OtherDerived > &other)
Eigen::InnerIterator< Derived > InnerIterator
Definition: DenseBase.h:53
Definition: StlIterators.h:177
EIGEN_DEVICE_FUNC const NestByValue< Derived > nestByValue() const
Definition: NestByValue.h:63
@ NumDimensions
Definition: DenseBase.h:160
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar maxCoeff() const
Definition: Redux.h:438
Definition: AssignmentFunctors.h:142
Expression of the reverse of a vector or matrix.
Definition: Reverse.h:65
Expression of the multiple replication of a matrix or vector.
Definition: Replicate.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
Definition: DenseBase.h:191
static const RandomReturnType Random()
Definition: Random.h:113
@ MaxSizeAtCompileTime
Definition: DenseBase.h:141
Definition: StlIterators.h:266
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar minCoeff() const
Definition: Redux.h:427
Definition: PlainObjectBase.h:100
EIGEN_DEVICE_FUNC bool isConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:325
iterator begin()
Definition: StlIterators.h:405
EIGEN_DEVICE_FUNC const Replicate< Derived, Dynamic, Dynamic > replicate(Index rowFactor, Index colFactor) const
Definition: DenseBase.h:560
@ AutoAlign
Definition: Constants.h:322
EIGEN_DEVICE_FUNC void fill(const Scalar &value)
Definition: CwiseNullaryOp.h:335
EIGEN_DEVICE_FUNC bool any() const
Definition: BooleanRedux.h:103
An InnerIterator allows to loop over the element of any matrix expression.
Definition: CoreIterators.h:34
EIGEN_DEVICE_FUNC Scalar sum() const
Definition: Redux.h:451
EIGEN_DEVICE_FUNC ConstRowwiseReturnType rowwise() const
Definition: DenseBase.h:510
EIGEN_DEVICE_FUNC const Replicate< Derived, RowFactor, ColFactor > replicate() const
Definition: Replicate.h:119
@ MaxRowsAtCompileTime
Definition: DenseBase.h:119
EIGEN_DEVICE_FUNC void visit(Visitor &func) const
Definition: Visitor.h:117
EIGEN_DEVICE_FUNC const Select< Derived, ThenDerived, ElseDerived > select(const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
Definition: Select.h:124
EIGEN_DEVICE_FUNC ConstColwiseReturnType colwise() const
Definition: DenseBase.h:522
const WithFormat< Derived > format(const IOFormat &fmt) const
Definition: DenseBase.h:479
Definition: ForwardDeclarations.h:17
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:47
EIGEN_DEVICE_FUNC bool isApprox(const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Fuzzy.h:103
EIGEN_DEVICE_FUNC void reverseInPlace()
Definition: Reverse.h:139
@ ColsAtCompileTime
Definition: DenseBase.h:106
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator=(const DenseBase< OtherDerived > &other)
Definition: Assign.h:39
const_iterator cbegin() const
Definition: StlIterators.h:423
Helper class used by the comma initializer operator.
Definition: CommaInitializer.h:29
Expression which must be nested by value.
Definition: NestByValue.h:40
@ Flags
Definition: DenseBase.h:165
EIGEN_DEVICE_FUNC Derived & setOnes()
Definition: CwiseNullaryOp.h:645
EIGEN_DEVICE_FUNC Index count() const
Definition: BooleanRedux.h:127
Scalar value_type
Definition: DenseBase.h:71
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180
EIGEN_DEVICE_FUNC void resize(Index rows, Index cols)
Definition: DenseBase.h:257
EIGEN_DEVICE_FUNC void resize(Index newSize)
Definition: DenseBase.h:246
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap(const DenseBase< OtherDerived > &other)
Definition: DenseBase.h:420
@ ColMajor
Definition: Constants.h:318
EIGEN_DEVICE_FUNC Derived & setRandom()
Definition: Random.h:131
Definition: XprHelper.h:340
Definition: ForwardDeclarations.h:50
EIGEN_DEVICE_FUNC void transposeInPlace()
Definition: Transpose.h:344
Expression of a coefficient wise version of the C++ ternary operator ?:
Definition: Select.h:54
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
Definition: NumTraits.h:213
Definition: XprHelper.h:290
static EIGEN_DEVICE_FUNC const ConstantReturnType Zero()
Definition: CwiseNullaryOp.h:487
EIGEN_DEVICE_FUNC CoeffReturnType value() const
Definition: DenseBase.h:486
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:42
const_iterator cend() const
Definition: StlIterators.h:452
bool allFinite() const
Definition: BooleanRedux.h:151