Eigen  3.4.90 (git rev 9589cc4e7fd8e4538bedef80dd36c7738977a8be)
 
Loading...
Searching...
No Matches
DenseBase.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2007-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
5// Copyright (C) 2008-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
11#ifndef EIGEN_DENSEBASE_H
12#define EIGEN_DENSEBASE_H
13
14// IWYU pragma: private
15#include "./InternalHeaderCheck.h"
16
17namespace Eigen {
18
19// The index type defined by EIGEN_DEFAULT_DENSE_INDEX_TYPE must be a signed type.
20EIGEN_STATIC_ASSERT(NumTraits<DenseIndex>::IsSigned, THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE)
21
22
37template <typename Derived>
38class DenseBase
39#ifndef EIGEN_PARSED_BY_DOXYGEN
40 : public DenseCoeffsBase<Derived, internal::accessors_level<Derived>::value>
41#else
42 : public DenseCoeffsBase<Derived, DirectWriteAccessors>
43#endif // not EIGEN_PARSED_BY_DOXYGEN
44{
45 public:
49 typedef Eigen::InnerIterator<Derived> InnerIterator;
50
51 typedef typename internal::traits<Derived>::StorageKind StorageKind;
52
59 typedef typename internal::traits<Derived>::StorageIndex StorageIndex;
60
62 typedef typename internal::traits<Derived>::Scalar Scalar;
63
67 typedef Scalar value_type;
68
69 typedef typename NumTraits<Scalar>::Real RealScalar;
70 typedef DenseCoeffsBase<Derived, internal::accessors_level<Derived>::value> Base;
71
72 using Base::coeff;
73 using Base::coeffByOuterInner;
74 using Base::colIndexByOuterInner;
75 using Base::cols;
76 using Base::const_cast_derived;
77 using Base::derived;
78 using Base::rowIndexByOuterInner;
79 using Base::rows;
80 using Base::size;
81 using Base::operator();
82 using Base::operator[];
83 using Base::colStride;
84 using Base::innerStride;
85 using Base::outerStride;
86 using Base::rowStride;
87 using Base::stride;
88 using Base::w;
89 using Base::x;
90 using Base::y;
91 using Base::z;
92 typedef typename Base::CoeffReturnType CoeffReturnType;
93
94 enum {
95
96 RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
101
102 ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
107
108 SizeAtCompileTime = (internal::size_of_xpr_at_compile_time<Derived>::ret),
112
113 MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime,
117 *
118 * This value is useful to know when evaluating an expression, in order to determine
119 * whether it is possible to avoid doing a dynamic memory allocation.
120 *
121 * \sa RowsAtCompileTime, MaxColsAtCompileTime, MaxSizeAtCompileTime
122 */
123
124 MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime,
129
134
135 MaxSizeAtCompileTime = internal::size_at_compile_time(internal::traits<Derived>::MaxRowsAtCompileTime,
136 internal::traits<Derived>::MaxColsAtCompileTime),
140
146
147 IsVectorAtCompileTime =
148 internal::traits<Derived>::RowsAtCompileTime == 1 || internal::traits<Derived>::ColsAtCompileTime == 1,
151 * we are dealing with a column-vector (if there is only one column) or with
152 * a row-vector (if there is only one row). */
153
154 NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0
155 : bool(IsVectorAtCompileTime) ? 1
156 : 2,
160
161 Flags = internal::traits<Derived>::Flags,
165
166 IsRowMajor = int(Flags) & RowMajorBit,
167
168 InnerSizeAtCompileTime = int(IsVectorAtCompileTime) ? int(SizeAtCompileTime)
169 : int(IsRowMajor) ? int(ColsAtCompileTime)
170 : int(RowsAtCompileTime),
171
172 InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret,
173 OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret
174 };
175
176 typedef typename internal::find_best_packet<Scalar, SizeAtCompileTime>::type PacketScalar;
177
178 enum { IsPlainObjectBase = 0 };
179
182 typedef Matrix<typename internal::traits<Derived>::Scalar, internal::traits<Derived>::RowsAtCompileTime,
183 internal::traits<Derived>::ColsAtCompileTime,
184 AutoAlign | (internal::traits<Derived>::Flags & RowMajorBit ? RowMajor : ColMajor),
185 internal::traits<Derived>::MaxRowsAtCompileTime, internal::traits<Derived>::MaxColsAtCompileTime>
186 PlainMatrix;
187
190 typedef Array<typename internal::traits<Derived>::Scalar, internal::traits<Derived>::RowsAtCompileTime,
191 internal::traits<Derived>::ColsAtCompileTime,
192 AutoAlign | (internal::traits<Derived>::Flags & RowMajorBit ? RowMajor : ColMajor),
193 internal::traits<Derived>::MaxRowsAtCompileTime, internal::traits<Derived>::MaxColsAtCompileTime>
194 PlainArray;
195
202 typedef std::conditional_t<internal::is_same<typename internal::traits<Derived>::XprKind, MatrixXpr>::value,
203 PlainMatrix, PlainArray>
204 PlainObject;
205
211 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerSize() const {
212 return IsVectorAtCompileTime ? 1 : int(IsRowMajor) ? this->rows() : this->cols();
213 }
214
217 * \note For a vector, this is just the size. For a matrix (non-vector), this is the minor dimension
218 * with respect to the \ref TopicStorageOrders "storage order", i.e., the number of rows for a
219 * column-major matrix, and the number of columns for a row-major matrix. */
220 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerSize() const {
221 return IsVectorAtCompileTime ? this->size() : int(IsRowMajor) ? this->cols() : this->rows();
222 }
226
228 EIGEN_DEVICE_FUNC void resize(Index newSize) {
229 EIGEN_ONLY_USED_FOR_DEBUG(newSize);
230 eigen_assert(newSize == this->size() && "DenseBase::resize() does not actually allow to resize.");
231 }
232
236 EIGEN_DEVICE_FUNC void resize(Index rows, Index cols) {
237 EIGEN_ONLY_USED_FOR_DEBUG(rows);
238 EIGEN_ONLY_USED_FOR_DEBUG(cols);
239 eigen_assert(rows == this->rows() && cols == this->cols() &&
240 "DenseBase::resize() does not actually allow to resize.");
241 }
242
243#ifndef EIGEN_PARSED_BY_DOXYGEN
245 typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>, PlainObject> ConstantReturnType;
247 typedef CwiseNullaryOp<internal::scalar_zero_op<Scalar>, PlainObject> ZeroReturnType;
249 EIGEN_DEPRECATED typedef CwiseNullaryOp<internal::linspaced_op<Scalar>, PlainObject> SequentialLinSpacedReturnType;
251 typedef CwiseNullaryOp<internal::linspaced_op<Scalar>, PlainObject> RandomAccessLinSpacedReturnType;
253 typedef CwiseNullaryOp<internal::equalspaced_op<Scalar>, PlainObject> RandomAccessEqualSpacedReturnType;
254 /** \internal the return type of MatrixBase::eigenvalues() */
255 typedef Matrix<typename NumTraits<typename internal::traits<Derived>::Scalar>::Real,
256 internal::traits<Derived>::ColsAtCompileTime, 1>
257 EigenvaluesReturnType;
258
259#endif // not EIGEN_PARSED_BY_DOXYGEN
260
262 template <typename OtherDerived>
263 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator=(const DenseBase<OtherDerived>& other);
264
268 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator=(const DenseBase& other);
269
270 template <typename OtherDerived>
271 EIGEN_DEVICE_FUNC Derived& operator=(const EigenBase<OtherDerived>& other);
272
273 template <typename OtherDerived>
274 EIGEN_DEVICE_FUNC Derived& operator+=(const EigenBase<OtherDerived>& other);
275
276 template <typename OtherDerived>
277 EIGEN_DEVICE_FUNC Derived& operator-=(const EigenBase<OtherDerived>& other);
278
279 template <typename OtherDerived>
280 EIGEN_DEVICE_FUNC Derived& operator=(const ReturnByValue<OtherDerived>& func);
281
284 template <typename OtherDerived>
285 /** \deprecated */
286 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived& lazyAssign(const DenseBase<OtherDerived>& other);
287
288 EIGEN_DEVICE_FUNC CommaInitializer<Derived> operator<<(const Scalar& s);
289
290 template <unsigned int Added, unsigned int Removed>
291
292 EIGEN_DEPRECATED const Derived& flagged() const {
293 return derived();
294 }
295
296 template <typename OtherDerived>
297 EIGEN_DEVICE_FUNC CommaInitializer<Derived> operator<<(const DenseBase<OtherDerived>& other);
298
299 typedef Transpose<Derived> TransposeReturnType;
300 EIGEN_DEVICE_FUNC TransposeReturnType transpose();
301 typedef Transpose<const Derived> ConstTransposeReturnType;
302 EIGEN_DEVICE_FUNC const ConstTransposeReturnType transpose() const;
303 EIGEN_DEVICE_FUNC void transposeInPlace();
304
305 EIGEN_DEVICE_FUNC static const ConstantReturnType Constant(Index rows, Index cols, const Scalar& value);
306 EIGEN_DEVICE_FUNC static const ConstantReturnType Constant(Index size, const Scalar& value);
307 EIGEN_DEVICE_FUNC static const ConstantReturnType Constant(const Scalar& value);
308
309 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC static const RandomAccessLinSpacedReturnType LinSpaced(Sequential_t, Index size,
310 const Scalar& low,
311 const Scalar& high);
312 EIGEN_DEPRECATED EIGEN_DEVICE_FUNC static const RandomAccessLinSpacedReturnType LinSpaced(Sequential_t,
313 const Scalar& low,
314 const Scalar& high);
315
316 EIGEN_DEVICE_FUNC static const RandomAccessLinSpacedReturnType LinSpaced(Index size, const Scalar& low,
317 const Scalar& high);
318 EIGEN_DEVICE_FUNC static const RandomAccessLinSpacedReturnType LinSpaced(const Scalar& low, const Scalar& high);
319
320 EIGEN_DEVICE_FUNC static const RandomAccessEqualSpacedReturnType EqualSpaced(Index size, const Scalar& low,
321 const Scalar& step);
322 EIGEN_DEVICE_FUNC static const RandomAccessEqualSpacedReturnType EqualSpaced(const Scalar& low, const Scalar& step);
323
324 template <typename CustomNullaryOp>
325 EIGEN_DEVICE_FUNC static const CwiseNullaryOp<CustomNullaryOp, PlainObject> NullaryExpr(Index rows, Index cols,
326 const CustomNullaryOp& func);
327 template <typename CustomNullaryOp>
328 EIGEN_DEVICE_FUNC static const CwiseNullaryOp<CustomNullaryOp, PlainObject> NullaryExpr(Index size,
329 const CustomNullaryOp& func);
330 template <typename CustomNullaryOp>
331 EIGEN_DEVICE_FUNC static const CwiseNullaryOp<CustomNullaryOp, PlainObject> NullaryExpr(const CustomNullaryOp& func);
332
333 EIGEN_DEVICE_FUNC static const ZeroReturnType Zero(Index rows, Index cols);
334 EIGEN_DEVICE_FUNC static const ZeroReturnType Zero(Index size);
335 EIGEN_DEVICE_FUNC static const ZeroReturnType Zero();
336 EIGEN_DEVICE_FUNC static const ConstantReturnType Ones(Index rows, Index cols);
337 EIGEN_DEVICE_FUNC static const ConstantReturnType Ones(Index size);
338 EIGEN_DEVICE_FUNC static const ConstantReturnType Ones();
339
340 EIGEN_DEVICE_FUNC void fill(const Scalar& value);
341 EIGEN_DEVICE_FUNC Derived& setConstant(const Scalar& value);
342 EIGEN_DEVICE_FUNC Derived& setLinSpaced(Index size, const Scalar& low, const Scalar& high);
343 EIGEN_DEVICE_FUNC Derived& setLinSpaced(const Scalar& low, const Scalar& high);
344 EIGEN_DEVICE_FUNC Derived& setEqualSpaced(Index size, const Scalar& low, const Scalar& step);
345 EIGEN_DEVICE_FUNC Derived& setEqualSpaced(const Scalar& low, const Scalar& step);
346 EIGEN_DEVICE_FUNC Derived& setZero();
347 EIGEN_DEVICE_FUNC Derived& setOnes();
348 EIGEN_DEVICE_FUNC Derived& setRandom();
349
350 template <typename OtherDerived>
351 EIGEN_DEVICE_FUNC bool isApprox(const DenseBase<OtherDerived>& other,
352 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
353 EIGEN_DEVICE_FUNC bool isMuchSmallerThan(const RealScalar& other,
354 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
355 template <typename OtherDerived>
356 EIGEN_DEVICE_FUNC bool isMuchSmallerThan(const DenseBase<OtherDerived>& other,
357 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
358
359 EIGEN_DEVICE_FUNC bool isApproxToConstant(const Scalar& value,
360 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
361 EIGEN_DEVICE_FUNC bool isConstant(const Scalar& value,
362 const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
363 EIGEN_DEVICE_FUNC bool isZero(const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
364 EIGEN_DEVICE_FUNC bool isOnes(const RealScalar& prec = NumTraits<Scalar>::dummy_precision()) const;
365
366 EIGEN_DEVICE_FUNC inline bool hasNaN() const;
367 EIGEN_DEVICE_FUNC inline bool allFinite() const;
368
369 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator*=(const Scalar& other);
370 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator/=(const Scalar& other);
371
372 typedef internal::add_const_on_value_type_t<typename internal::eval<Derived>::type> EvalReturnType;
381 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType eval() const {
382 // Even though MSVC does not honor strong inlining when the return type
383 // is a dynamic matrix, we desperately need strong inlining for fixed
384 // size types on MSVC.
385 return typename internal::eval<Derived>::type(derived());
386 }
387
390 */
391 template <typename OtherDerived>
392 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap(const DenseBase<OtherDerived>& other) {
393 EIGEN_STATIC_ASSERT(!OtherDerived::IsPlainObjectBase, THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY);
394 eigen_assert(rows() == other.rows() && cols() == other.cols());
395 call_assignment(derived(), other.const_cast_derived(), internal::swap_assign_op<Scalar>());
396 }
397
401 template <typename OtherDerived>
402 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap(PlainObjectBase<OtherDerived>& other) {
403 eigen_assert(rows() == other.rows() && cols() == other.cols());
404 call_assignment(derived(), other.derived(), internal::swap_assign_op<Scalar>());
405 }
406
407 EIGEN_DEVICE_FUNC inline const NestByValue<Derived> nestByValue() const;
408 EIGEN_DEVICE_FUNC inline const ForceAlignedAccess<Derived> forceAlignedAccess() const;
409 EIGEN_DEVICE_FUNC inline ForceAlignedAccess<Derived> forceAlignedAccess();
410 template <bool Enable>
411 EIGEN_DEVICE_FUNC inline const std::conditional_t<Enable, ForceAlignedAccess<Derived>, Derived&>
412 forceAlignedAccessIf() const;
413 template <bool Enable>
414 EIGEN_DEVICE_FUNC inline std::conditional_t<Enable, ForceAlignedAccess<Derived>, Derived&> forceAlignedAccessIf();
415
416 EIGEN_DEVICE_FUNC Scalar sum() const;
417 EIGEN_DEVICE_FUNC Scalar mean() const;
418 EIGEN_DEVICE_FUNC Scalar trace() const;
419
420 EIGEN_DEVICE_FUNC Scalar prod() const;
421
422 template <int NaNPropagation>
423 EIGEN_DEVICE_FUNC typename internal::traits<Derived>::Scalar minCoeff() const;
424 template <int NaNPropagation>
425 EIGEN_DEVICE_FUNC typename internal::traits<Derived>::Scalar maxCoeff() const;
426
427 // By default, the fastest version with undefined NaN propagation semantics is
428 // used.
429 // TODO(rmlarsen): Replace with default template argument when we move to
430 // c++11 or beyond.
431 EIGEN_DEVICE_FUNC inline typename internal::traits<Derived>::Scalar minCoeff() const {
432 return minCoeff<PropagateFast>();
433 }
434 EIGEN_DEVICE_FUNC inline typename internal::traits<Derived>::Scalar maxCoeff() const {
435 return maxCoeff<PropagateFast>();
436 }
437
438 template <int NaNPropagation, typename IndexType>
439 EIGEN_DEVICE_FUNC typename internal::traits<Derived>::Scalar minCoeff(IndexType* row, IndexType* col) const;
440 template <int NaNPropagation, typename IndexType>
441 EIGEN_DEVICE_FUNC typename internal::traits<Derived>::Scalar maxCoeff(IndexType* row, IndexType* col) const;
442 template <int NaNPropagation, typename IndexType>
443 EIGEN_DEVICE_FUNC typename internal::traits<Derived>::Scalar minCoeff(IndexType* index) const;
444 template <int NaNPropagation, typename IndexType>
445 EIGEN_DEVICE_FUNC typename internal::traits<Derived>::Scalar maxCoeff(IndexType* index) const;
446
447 // TODO(rmlarsen): Replace these methods with a default template argument.
448 template <typename IndexType>
449 EIGEN_DEVICE_FUNC inline typename internal::traits<Derived>::Scalar minCoeff(IndexType* row, IndexType* col) const {
450 return minCoeff<PropagateFast>(row, col);
451 }
452 template <typename IndexType>
453 EIGEN_DEVICE_FUNC inline typename internal::traits<Derived>::Scalar maxCoeff(IndexType* row, IndexType* col) const {
454 return maxCoeff<PropagateFast>(row, col);
455 }
456 template <typename IndexType>
457 EIGEN_DEVICE_FUNC inline typename internal::traits<Derived>::Scalar minCoeff(IndexType* index) const {
458 return minCoeff<PropagateFast>(index);
459 }
460 template <typename IndexType>
461 EIGEN_DEVICE_FUNC inline typename internal::traits<Derived>::Scalar maxCoeff(IndexType* index) const {
462 return maxCoeff<PropagateFast>(index);
463 }
464
465 template <typename BinaryOp>
466 EIGEN_DEVICE_FUNC Scalar redux(const BinaryOp& func) const;
467
468 template <typename Visitor>
469 EIGEN_DEVICE_FUNC void visit(Visitor& func) const;
470
478 inline const WithFormat<Derived> format(const IOFormat& fmt) const { return WithFormat<Derived>(derived(), fmt); }
479
481 EIGEN_DEVICE_FUNC CoeffReturnType value() const {
482 EIGEN_STATIC_ASSERT_SIZE_1x1(Derived) eigen_assert(this->rows() == 1 && this->cols() == 1);
483 return derived().coeff(0, 0);
484 }
485
486 EIGEN_DEVICE_FUNC bool all() const;
487 EIGEN_DEVICE_FUNC bool any() const;
488 EIGEN_DEVICE_FUNC Index count() const;
489
490 typedef VectorwiseOp<Derived, Horizontal> RowwiseReturnType;
491 typedef const VectorwiseOp<const Derived, Horizontal> ConstRowwiseReturnType;
492 typedef VectorwiseOp<Derived, Vertical> ColwiseReturnType;
493 typedef const VectorwiseOp<const Derived, Vertical> ConstColwiseReturnType;
494
495 /** \returns a VectorwiseOp wrapper of *this for broadcasting and partial reductions
496 *
497 * Example: \include MatrixBase_rowwise.cpp
498 * Output: \verbinclude MatrixBase_rowwise.out
499 *
500 * \sa colwise(), class VectorwiseOp, \ref TutorialReductionsVisitorsBroadcasting
501 */
502 // Code moved here due to a CUDA compiler bug
503 EIGEN_DEVICE_FUNC inline ConstRowwiseReturnType rowwise() const { return ConstRowwiseReturnType(derived()); }
504 EIGEN_DEVICE_FUNC RowwiseReturnType rowwise();
505
513 EIGEN_DEVICE_FUNC inline ConstColwiseReturnType colwise() const { return ConstColwiseReturnType(derived()); }
514 EIGEN_DEVICE_FUNC ColwiseReturnType colwise();
515
516 typedef CwiseNullaryOp<internal::scalar_random_op<Scalar>, PlainObject> RandomReturnType;
517 static const RandomReturnType Random(Index rows, Index cols);
518 static const RandomReturnType Random(Index size);
519 static const RandomReturnType Random();
520
521 template <typename ThenDerived, typename ElseDerived>
522 inline EIGEN_DEVICE_FUNC
523 CwiseTernaryOp<internal::scalar_boolean_select_op<typename DenseBase<ThenDerived>::Scalar,
524 typename DenseBase<ElseDerived>::Scalar, Scalar>,
525 ThenDerived, ElseDerived, Derived>
526 select(const DenseBase<ThenDerived>& thenMatrix, const DenseBase<ElseDerived>& elseMatrix) const;
527
528 template <typename ThenDerived>
529 inline EIGEN_DEVICE_FUNC
530 CwiseTernaryOp<internal::scalar_boolean_select_op<typename DenseBase<ThenDerived>::Scalar,
531 typename DenseBase<ThenDerived>::Scalar, Scalar>,
532 ThenDerived, typename DenseBase<ThenDerived>::ConstantReturnType, Derived>
533 select(const DenseBase<ThenDerived>& thenMatrix, const typename DenseBase<ThenDerived>::Scalar& elseScalar) const;
534
535 template <typename ElseDerived>
536 inline EIGEN_DEVICE_FUNC
537 CwiseTernaryOp<internal::scalar_boolean_select_op<typename DenseBase<ElseDerived>::Scalar,
538 typename DenseBase<ElseDerived>::Scalar, Scalar>,
539 typename DenseBase<ElseDerived>::ConstantReturnType, ElseDerived, Derived>
540 select(const typename DenseBase<ElseDerived>::Scalar& thenScalar, const DenseBase<ElseDerived>& elseMatrix) const;
541
542 template <int p>
543 RealScalar lpNorm() const;
544
545 template <int RowFactor, int ColFactor>
546 EIGEN_DEVICE_FUNC const Replicate<Derived, RowFactor, ColFactor> replicate() const;
555 // Code moved here due to a CUDA compiler bug
556 EIGEN_DEVICE_FUNC const Replicate<Derived, Dynamic, Dynamic> replicate(Index rowFactor, Index colFactor) const {
557 return Replicate<Derived, Dynamic, Dynamic>(derived(), rowFactor, colFactor);
558 }
559
560 typedef Reverse<Derived, BothDirections> ReverseReturnType;
561 typedef const Reverse<const Derived, BothDirections> ConstReverseReturnType;
562 EIGEN_DEVICE_FUNC ReverseReturnType reverse();
564 // Code moved here due to a CUDA compiler bug
565 EIGEN_DEVICE_FUNC ConstReverseReturnType reverse() const { return ConstReverseReturnType(derived()); }
566 EIGEN_DEVICE_FUNC void reverseInPlace();
567
568#ifdef EIGEN_PARSED_BY_DOXYGEN
570 * iterator type as returned by the begin() and end() methods.
571 */
572 typedef random_access_iterator_type iterator;
574 typedef random_access_iterator_type const_iterator;
575#else
576 typedef std::conditional_t<(Flags & DirectAccessBit) == DirectAccessBit,
577 internal::pointer_based_stl_iterator<Derived>,
578 internal::generic_randaccess_stl_iterator<Derived> >
579 iterator_type;
580
581 typedef std::conditional_t<(Flags & DirectAccessBit) == DirectAccessBit,
582 internal::pointer_based_stl_iterator<const Derived>,
583 internal::generic_randaccess_stl_iterator<const Derived> >
584 const_iterator_type;
585
586 // Stl-style iterators are supported only for vectors.
587
588 typedef std::conditional_t<IsVectorAtCompileTime, iterator_type, void> iterator;
589
590 typedef std::conditional_t<IsVectorAtCompileTime, const_iterator_type, void> const_iterator;
591#endif
592
593 inline iterator begin();
594 inline const_iterator begin() const;
595 inline const_iterator cbegin() const;
596 inline iterator end();
597 inline const_iterator end() const;
598 inline const_iterator cend() const;
599
600#define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::DenseBase
601#define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
602#define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND)
603#define EIGEN_DOC_UNARY_ADDONS(X, Y)
604#include "../plugins/CommonCwiseUnaryOps.inc"
605#include "../plugins/BlockMethods.inc"
606#include "../plugins/IndexedViewMethods.inc"
607#include "../plugins/ReshapedMethods.inc"
608#ifdef EIGEN_DENSEBASE_PLUGIN
609#include EIGEN_DENSEBASE_PLUGIN
610#endif
611#undef EIGEN_CURRENT_STORAGE_BASE_CLASS
612#undef EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL
613#undef EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF
614#undef EIGEN_DOC_UNARY_ADDONS
615
616 // disable the use of evalTo for dense objects with a nice compilation error
617 template <typename Dest>
618 EIGEN_DEVICE_FUNC inline void evalTo(Dest&) const {
619 EIGEN_STATIC_ASSERT((internal::is_same<Dest, void>::value),
620 THE_EVAL_EVALTO_FUNCTION_SHOULD_NEVER_BE_CALLED_FOR_DENSE_OBJECTS);
621 }
622
623 protected:
624 EIGEN_DEFAULT_COPY_CONSTRUCTOR(DenseBase)
626#ifdef EIGEN_INTERNAL_DEBUGGING
627 EIGEN_DEVICE_FUNC constexpr DenseBase() {
628 /* Just checks for self-consistency of the flags.
629 * Only do it when debugging Eigen, as this borders on paranoia and could slow compilation down
630 */
631 EIGEN_STATIC_ASSERT(
632 (internal::check_implication(MaxRowsAtCompileTime == 1 && MaxColsAtCompileTime != 1, int(IsRowMajor)) &&
633 internal::check_implication(MaxColsAtCompileTime == 1 && MaxRowsAtCompileTime != 1, int(!IsRowMajor))),
634 INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
635 }
636#else
637 EIGEN_DEVICE_FUNC constexpr DenseBase() = default;
638#endif
639
640 private:
641 EIGEN_DEVICE_FUNC explicit DenseBase(int);
642 EIGEN_DEVICE_FUNC DenseBase(int, int);
643 template <typename OtherDerived>
644 EIGEN_DEVICE_FUNC explicit DenseBase(const DenseBase<OtherDerived>&);
645};
646
649template <typename DerivedA, typename DerivedB>
650EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
651 // Use forwarding references to capture all combinations of cv-qualified l+r-value cases.
652 std::enable_if_t<std::is_base_of<DenseBase<std::decay_t<DerivedA>>, std::decay_t<DerivedA>>::value &&
653 std::is_base_of<DenseBase<std::decay_t<DerivedB>>, std::decay_t<DerivedB>>::value,
654 void>
655 swap(DerivedA&& a, DerivedB&& b) {
656 a.swap(b);
657}
658
659} // end namespace Eigen
660
661#endif // EIGEN_DENSEBASE_H
Eigen::Array
General-purpose arrays with easy API for coefficient-wise operations.
Definition ForwardDeclarations.h:399
Eigen::CwiseNullaryOp
Generic expression of a matrix where all coefficients are defined by a functor.
Definition ForwardDeclarations.h:104
Eigen::CwiseTernaryOp
Generic expression where a coefficient-wise ternary operator is applied to two expressions.
Definition ForwardDeclarations.h:110
Eigen::DenseBase
Base class for all dense matrices, vectors, and arrays.
Definition ForwardDeclarations.h:59
Eigen::DenseBase::outerSize
EIGEN_CONSTEXPR Index outerSize() const
Definition DenseBase.h:211
Eigen::DenseBase::minCoeff
internal::traits< Derived >::Scalar minCoeff() const
Definition Redux.h:457
Eigen::DenseBase::operator<<
CommaInitializer< Derived > operator<<(const Scalar &s)
Definition CommaInitializer.h:135
Eigen::DenseBase::format
const WithFormat< Derived > format(const IOFormat &fmt) const
Definition DenseBase.h:478
Eigen::DenseBase::LinSpaced
static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType LinSpaced(Sequential_t, Index size, const Scalar &low, const Scalar &high)
Definition CwiseNullaryOp.h:240
Eigen::DenseBase::isConstant
bool isConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:330
Eigen::DenseBase::mean
Scalar mean() const
Definition Redux.h:491
Eigen::DenseBase::setOnes
Derived & setOnes()
Definition CwiseNullaryOp.h:694
Eigen::DenseBase::resize
void resize(Index rows, Index cols)
Definition DenseBase.h:236
Eigen::DenseBase::PlainObject
std::conditional_t< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray > PlainObject
The plain matrix or array type corresponding to this expression.
Definition DenseBase.h:204
Eigen::DenseBase::StorageIndex
internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition DenseBase.h:59
Eigen::DenseBase::resize
void resize(Index newSize)
Definition DenseBase.h:228
Eigen::DenseBase::const_iterator
random_access_iterator_type const_iterator
Definition DenseBase.h:574
Eigen::DenseBase::NullaryExpr
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > NullaryExpr(Index rows, Index cols, const CustomNullaryOp &func)
Definition CwiseNullaryOp.h:112
Eigen::DenseBase::nestByValue
const NestByValue< Derived > nestByValue() const
Definition NestByValue.h:74
Eigen::DenseBase::PlainMatrix
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:186
Eigen::DenseBase::visit
void visit(Visitor &func) const
Definition Visitor.h:382
Eigen::DenseBase::transpose
TransposeReturnType transpose()
Definition Transpose.h:162
Eigen::DenseBase::swap
void swap(PlainObjectBase< OtherDerived > &other)
Definition DenseBase.h:402
Eigen::DenseBase::InnerIterator
Eigen::InnerIterator< Derived > InnerIterator
Definition DenseBase.h:49
Eigen::DenseBase::begin
iterator begin()
Definition StlIterators.h:571
Eigen::DenseBase::colwise
ConstColwiseReturnType colwise() const
Definition DenseBase.h:513
Eigen::DenseBase::innerSize
EIGEN_CONSTEXPR Index innerSize() const
Definition DenseBase.h:220
Eigen::DenseBase::setLinSpaced
Derived & setLinSpaced(Index size, const Scalar &low, const Scalar &high)
Sets a linearly spaced vector.
Definition CwiseNullaryOp.h:432
Eigen::DenseBase::Scalar
internal::traits< Derived >::Scalar Scalar
Definition DenseBase.h:62
Eigen::DenseBase::replicate
const Replicate< Derived, RowFactor, ColFactor > replicate() const
Definition Replicate.h:109
Eigen::DenseBase::IsVectorAtCompileTime
@ IsVectorAtCompileTime
Definition DenseBase.h:147
Eigen::DenseBase::SizeAtCompileTime
@ SizeAtCompileTime
Definition DenseBase.h:108
Eigen::DenseBase::MaxSizeAtCompileTime
@ MaxSizeAtCompileTime
Definition DenseBase.h:135
Eigen::DenseBase::IsRowMajor
@ IsRowMajor
Definition DenseBase.h:166
Eigen::DenseBase::NumDimensions
@ NumDimensions
Definition DenseBase.h:154
Eigen::DenseBase::Flags
@ Flags
Definition DenseBase.h:161
Eigen::DenseBase::ColsAtCompileTime
@ ColsAtCompileTime
Definition DenseBase.h:102
Eigen::DenseBase::MaxColsAtCompileTime
@ MaxColsAtCompileTime
Definition DenseBase.h:124
Eigen::DenseBase::MaxRowsAtCompileTime
@ MaxRowsAtCompileTime
Definition DenseBase.h:113
Eigen::DenseBase::RowsAtCompileTime
@ RowsAtCompileTime
Definition DenseBase.h:96
Eigen::DenseBase::Zero
static const ZeroReturnType Zero(Index rows, Index cols)
Definition CwiseNullaryOp.h:487
Eigen::DenseBase::Constant
static const ConstantReturnType Constant(Index rows, Index cols, const Scalar &value)
Definition CwiseNullaryOp.h:186
Eigen::DenseBase::replicate
const Replicate< Derived, Dynamic, Dynamic > replicate(Index rowFactor, Index colFactor) const
Definition DenseBase.h:556
Eigen::DenseBase::maxCoeff
internal::traits< Derived >::Scalar maxCoeff() const
Definition Redux.h:470
Eigen::DenseBase::PlainArray
Array< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime > PlainArray
Definition DenseBase.h:194
Eigen::DenseBase::value
CoeffReturnType value() const
Definition DenseBase.h:481
Eigen::DenseBase::Ones
static const ConstantReturnType Ones(Index rows, Index cols)
Definition CwiseNullaryOp.h:631
Eigen::DenseBase::value_type
Scalar value_type
Definition DenseBase.h:67
Eigen::DenseBase::fill
void fill(const Scalar &value)
Definition CwiseNullaryOp.h:339
Eigen::DenseBase::reverse
ConstReverseReturnType reverse() const
Definition DenseBase.h:565
Eigen::DenseBase::DenseBase
constexpr DenseBase()=default
Eigen::DenseBase::rowwise
ConstRowwiseReturnType rowwise() const
Definition DenseBase.h:503
Eigen::DenseBase::isOnes
bool isOnes(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:682
Eigen::DenseBase::eval
EvalReturnType eval() const
Definition DenseBase.h:381
Eigen::DenseBase::operator=
Derived & operator=(const DenseBase< OtherDerived > &other)
Definition Assign.h:39
Eigen::DenseBase::setConstant
Derived & setConstant(const Scalar &value)
Definition CwiseNullaryOp.h:349
Eigen::DenseBase::setRandom
Derived & setRandom()
Definition Random.h:129
Eigen::DenseBase::transposeInPlace
void transposeInPlace()
Definition Transpose.h:320
Eigen::DenseBase::sum
Scalar sum() const
Definition Redux.h:481
Eigen::DenseBase::flagged
EIGEN_DEPRECATED const Derived & flagged() const
Definition DenseBase.h:292
Eigen::DenseBase::end
iterator end()
Definition StlIterators.h:597
Eigen::DenseBase::isApprox
bool isApprox(const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition Fuzzy.h:89
Eigen::DenseBase::Random
static const RandomReturnType Random(Index rows, Index cols)
Definition Random.h:59
Eigen::DenseBase::cbegin
const_iterator cbegin() const
Definition StlIterators.h:587
Eigen::DenseBase::cend
const_iterator cend() const
Definition StlIterators.h:613
Eigen::DenseBase::prod
Scalar prod() const
Definition Redux.h:510
Eigen::DenseBase::lazyAssign
EIGEN_DEPRECATED Derived & lazyAssign(const DenseBase< OtherDerived > &other)
Eigen::DenseBase::allFinite
bool allFinite() const
Definition Visitor.h:783
Eigen::DenseBase::setZero
Derived & setZero()
Definition CwiseNullaryOp.h:554
Eigen::DenseBase::isZero
bool isZero(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:538
Eigen::DenseBase::iterator
random_access_iterator_type iterator
Definition DenseBase.h:572
Eigen::DenseBase::isApproxToConstant
bool isApproxToConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition CwiseNullaryOp.h:318
Eigen::DenseBase::swap
void swap(const DenseBase< OtherDerived > &other)
Definition DenseBase.h:392
Eigen::ForceAlignedAccess
Enforce aligned packet loads and stores regardless of what is requested.
Definition ForwardDeclarations.h:84
Eigen::InnerIterator
An InnerIterator allows to loop over the element of any matrix expression.
Definition ForwardDeclarations.h:189
Eigen::Matrix
The matrix class, also used for vectors and row-vectors.
Definition ForwardDeclarations.h:70
Eigen::NestByValue
Expression which must be nested by value.
Definition ForwardDeclarations.h:82
Eigen::PlainObjectBase
Dense storage base class for matrices and arrays.
Definition ForwardDeclarations.h:61
Eigen::Replicate
Expression of the multiple replication of a matrix or vector.
Definition ForwardDeclarations.h:407
Eigen::Reverse
Expression of the reverse of a vector or matrix.
Definition ForwardDeclarations.h:409
Eigen::Transpose
Expression of the transpose of a matrix.
Definition ForwardDeclarations.h:100
Eigen::VectorwiseOp
Pseudo expression providing broadcasting and partial reduction operations.
Definition VectorwiseOp.h:192
Eigen::WithFormat
Pseudo expression providing matrix output with given format.
Definition ForwardDeclarations.h:177
Eigen::ColMajor
@ ColMajor
Definition Constants.h:318
Eigen::RowMajor
@ RowMajor
Definition Constants.h:320
Eigen::AutoAlign
@ AutoAlign
Definition Constants.h:322
Eigen::DirectAccessBit
const unsigned int DirectAccessBit
Definition Constants.h:159
Eigen::RowMajorBit
const unsigned int RowMajorBit
Definition Constants.h:70
Eigen
Namespace containing all symbols from the Eigen library.
Definition B01_Experimental.dox:1
Eigen::swap
std::enable_if_t< std::is_base_of< DenseBase< std::decay_t< DerivedA > >, std::decay_t< DerivedA > >::value &&std::is_base_of< DenseBase< std::decay_t< DerivedB > >, std::decay_t< DerivedB > >::value, void > swap(DerivedA &&a, DerivedB &&b)
Definition DenseBase.h:655
Eigen::Index
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition Meta.h:82
Eigen::CommaInitializer
Helper class used by the comma initializer operator.
Definition ForwardDeclarations.h:179
Eigen::EigenBase
Definition ForwardDeclarations.h:57
Eigen::IOFormat
Stores a set of parameters controlling the way matrices are printed.
Definition IO.h:52
Eigen::MatrixXpr
Definition Constants.h:534