WPILibC++ 2023.4.3-108-ge5452e3
DenseCoeffsBase.h
Go to the documentation of this file.
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
5//
6// This Source Code Form is subject to the terms of the Mozilla
7// Public License v. 2.0. If a copy of the MPL was not distributed
8// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9
10#ifndef EIGEN_DENSECOEFFSBASE_H
11#define EIGEN_DENSECOEFFSBASE_H
12
13namespace Eigen {
14
15namespace internal {
16template<typename T> struct add_const_on_value_type_if_arithmetic
17{
19};
20}
21
22/** \brief Base class providing read-only coefficient access to matrices and arrays.
23 * \ingroup Core_Module
24 * \tparam Derived Type of the derived class
25 *
26 * \note #ReadOnlyAccessors Constant indicating read-only access
27 *
28 * This class defines the \c operator() \c const function and friends, which can be used to read specific
29 * entries of a matrix or array.
30 *
31 * \sa DenseCoeffsBase<Derived, WriteAccessors>, DenseCoeffsBase<Derived, DirectAccessors>,
32 * \ref TopicClassHierarchy
33 */
34template<typename Derived>
35class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived>
36{
37 public:
41
42 // Explanation for this CoeffReturnType typedef.
43 // - This is the return type of the coeff() method.
44 // - The LvalueBit means exactly that we can offer a coeffRef() method, which means exactly that we can get references
45 // to coeffs, which means exactly that we can have coeff() return a const reference (as opposed to returning a value).
46 // - The is_artihmetic check is required since "const int", "const double", etc. will cause warnings on some systems
47 // while the declaration of "const T", where T is a non arithmetic type does not. Always returning "const Scalar&" is
48 // not possible, since the underlying expressions might not offer a valid address the reference could be referring to.
50 const Scalar&,
53
57
59 using Base::rows;
60 using Base::cols;
61 using Base::size;
62 using Base::derived;
63
66 {
67 return int(Derived::RowsAtCompileTime) == 1 ? 0
68 : int(Derived::ColsAtCompileTime) == 1 ? inner
69 : int(Derived::Flags)&RowMajorBit ? outer
70 : inner;
71 }
72
75 {
76 return int(Derived::ColsAtCompileTime) == 1 ? 0
77 : int(Derived::RowsAtCompileTime) == 1 ? inner
78 : int(Derived::Flags)&RowMajorBit ? inner
79 : outer;
80 }
81
82 /** Short version: don't use this function, use
83 * \link operator()(Index,Index) const \endlink instead.
84 *
85 * Long version: this function is similar to
86 * \link operator()(Index,Index) const \endlink, but without the assertion.
87 * Use this for limiting the performance cost of debugging code when doing
88 * repeated coefficient access. Only use this when it is guaranteed that the
89 * parameters \a row and \a col are in range.
90 *
91 * If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this
92 * function equivalent to \link operator()(Index,Index) const \endlink.
93 *
94 * \sa operator()(Index,Index) const, coeffRef(Index,Index), coeff(Index) const
95 */
98 {
99 eigen_internal_assert(row >= 0 && row < rows()
100 && col >= 0 && col < cols());
101 return internal::evaluator<Derived>(derived()).coeff(row,col);
102 }
103
106 {
107 return coeff(rowIndexByOuterInner(outer, inner),
108 colIndexByOuterInner(outer, inner));
109 }
110
111 /** \returns the coefficient at given the given row and column.
112 *
113 * \sa operator()(Index,Index), operator[](Index)
114 */
117 {
118 eigen_assert(row >= 0 && row < rows()
119 && col >= 0 && col < cols());
120 return coeff(row, col);
121 }
122
123 /** Short version: don't use this function, use
124 * \link operator[](Index) const \endlink instead.
125 *
126 * Long version: this function is similar to
127 * \link operator[](Index) const \endlink, but without the assertion.
128 * Use this for limiting the performance cost of debugging code when doing
129 * repeated coefficient access. Only use this when it is guaranteed that the
130 * parameter \a index is in range.
131 *
132 * If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this
133 * function equivalent to \link operator[](Index) const \endlink.
134 *
135 * \sa operator[](Index) const, coeffRef(Index), coeff(Index,Index) const
136 */
137
139 EIGEN_STRONG_INLINE CoeffReturnType
140 coeff(Index index) const
141 {
143 THIS_COEFFICIENT_ACCESSOR_TAKING_ONE_ACCESS_IS_ONLY_FOR_EXPRESSIONS_ALLOWING_LINEAR_ACCESS)
145 return internal::evaluator<Derived>(derived()).coeff(index);
146 }
147
148
149 /** \returns the coefficient at given index.
150 *
151 * This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
152 *
153 * \sa operator[](Index), operator()(Index,Index) const, x() const, y() const,
154 * z() const, w() const
155 */
156
158 EIGEN_STRONG_INLINE CoeffReturnType
159 operator[](Index index) const
160 {
161 EIGEN_STATIC_ASSERT(Derived::IsVectorAtCompileTime,
162 THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD)
163 eigen_assert(index >= 0 && index < size());
164 return coeff(index);
165 }
166
167 /** \returns the coefficient at given index.
168 *
169 * This is synonymous to operator[](Index) const.
170 *
171 * This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
172 *
173 * \sa operator[](Index), operator()(Index,Index) const, x() const, y() const,
174 * z() const, w() const
175 */
176
178 EIGEN_STRONG_INLINE CoeffReturnType
179 operator()(Index index) const
180 {
181 eigen_assert(index >= 0 && index < size());
182 return coeff(index);
183 }
184
185 /** equivalent to operator[](0). */
186
188 EIGEN_STRONG_INLINE CoeffReturnType
189 x() const { return (*this)[0]; }
190
191 /** equivalent to operator[](1). */
192
194 EIGEN_STRONG_INLINE CoeffReturnType
195 y() const
196 {
197 EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=2, OUT_OF_RANGE_ACCESS);
198 return (*this)[1];
199 }
200
201 /** equivalent to operator[](2). */
202
204 EIGEN_STRONG_INLINE CoeffReturnType
205 z() const
206 {
207 EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=3, OUT_OF_RANGE_ACCESS);
208 return (*this)[2];
209 }
210
211 /** equivalent to operator[](3). */
212
214 EIGEN_STRONG_INLINE CoeffReturnType
215 w() const
216 {
217 EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=4, OUT_OF_RANGE_ACCESS);
218 return (*this)[3];
219 }
220
221 /** \internal
222 * \returns the packet of coefficients starting at the given row and column. It is your responsibility
223 * to ensure that a packet really starts there. This method is only available on expressions having the
224 * PacketAccessBit.
225 *
226 * The \a LoadMode parameter may have the value \a #Aligned or \a #Unaligned. Its effect is to select
227 * the appropriate vectorization instruction. Aligned access is faster, but is only possible for packets
228 * starting at an address which is a multiple of the packet size.
229 */
230
231 template<int LoadMode>
233 {
234 typedef typename internal::packet_traits<Scalar>::type DefaultPacketType;
235 eigen_internal_assert(row >= 0 && row < rows() && col >= 0 && col < cols());
236 return internal::evaluator<Derived>(derived()).template packet<LoadMode,DefaultPacketType>(row,col);
237 }
238
239
240 /** \internal */
241 template<int LoadMode>
243 {
244 return packet<LoadMode>(rowIndexByOuterInner(outer, inner),
245 colIndexByOuterInner(outer, inner));
246 }
247
248 /** \internal
249 * \returns the packet of coefficients starting at the given index. It is your responsibility
250 * to ensure that a packet really starts there. This method is only available on expressions having the
251 * PacketAccessBit and the LinearAccessBit.
252 *
253 * The \a LoadMode parameter may have the value \a #Aligned or \a #Unaligned. Its effect is to select
254 * the appropriate vectorization instruction. Aligned access is faster, but is only possible for packets
255 * starting at an address which is a multiple of the packet size.
256 */
257
258 template<int LoadMode>
260 {
262 THIS_COEFFICIENT_ACCESSOR_TAKING_ONE_ACCESS_IS_ONLY_FOR_EXPRESSIONS_ALLOWING_LINEAR_ACCESS)
263 typedef typename internal::packet_traits<Scalar>::type DefaultPacketType;
265 return internal::evaluator<Derived>(derived()).template packet<LoadMode,DefaultPacketType>(index);
266 }
267
268 protected:
269 // explanation: DenseBase is doing "using ..." on the methods from DenseCoeffsBase.
270 // But some methods are only available in the DirectAccess case.
271 // So we add dummy methods here with these names, so that "using... " doesn't fail.
272 // It's not private so that the child class DenseBase can access them, and it's not public
273 // either since it's an implementation detail, so has to be protected.
274 void coeffRef();
278 void copyCoeff();
282 void stride();
285 void rowStride();
286 void colStride();
287};
288
289/** \brief Base class providing read/write coefficient access to matrices and arrays.
290 * \ingroup Core_Module
291 * \tparam Derived Type of the derived class
292 *
293 * \note #WriteAccessors Constant indicating read/write access
294 *
295 * This class defines the non-const \c operator() function and friends, which can be used to write specific
296 * entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which
297 * defines the const variant for reading specific entries.
298 *
299 * \sa DenseCoeffsBase<Derived, DirectAccessors>, \ref TopicClassHierarchy
300 */
301template<typename Derived>
302class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived, ReadOnlyAccessors>
303{
304 public:
305
307
312
313 using Base::coeff;
314 using Base::rows;
315 using Base::cols;
316 using Base::size;
317 using Base::derived;
318 using Base::rowIndexByOuterInner;
319 using Base::colIndexByOuterInner;
320 using Base::operator[];
321 using Base::operator();
322 using Base::x;
323 using Base::y;
324 using Base::z;
325 using Base::w;
326
327 /** Short version: don't use this function, use
328 * \link operator()(Index,Index) \endlink instead.
329 *
330 * Long version: this function is similar to
331 * \link operator()(Index,Index) \endlink, but without the assertion.
332 * Use this for limiting the performance cost of debugging code when doing
333 * repeated coefficient access. Only use this when it is guaranteed that the
334 * parameters \a row and \a col are in range.
335 *
336 * If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this
337 * function equivalent to \link operator()(Index,Index) \endlink.
338 *
339 * \sa operator()(Index,Index), coeff(Index, Index) const, coeffRef(Index)
340 */
343 {
344 eigen_internal_assert(row >= 0 && row < rows()
345 && col >= 0 && col < cols());
346 return internal::evaluator<Derived>(derived()).coeffRef(row,col);
347 }
348
350 EIGEN_STRONG_INLINE Scalar&
352 {
353 return coeffRef(rowIndexByOuterInner(outer, inner),
354 colIndexByOuterInner(outer, inner));
355 }
356
357 /** \returns a reference to the coefficient at given the given row and column.
358 *
359 * \sa operator[](Index)
360 */
361
363 EIGEN_STRONG_INLINE Scalar&
365 {
366 eigen_assert(row >= 0 && row < rows()
367 && col >= 0 && col < cols());
368 return coeffRef(row, col);
369 }
370
371
372 /** Short version: don't use this function, use
373 * \link operator[](Index) \endlink instead.
374 *
375 * Long version: this function is similar to
376 * \link operator[](Index) \endlink, but without the assertion.
377 * Use this for limiting the performance cost of debugging code when doing
378 * repeated coefficient access. Only use this when it is guaranteed that the
379 * parameters \a row and \a col are in range.
380 *
381 * If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this
382 * function equivalent to \link operator[](Index) \endlink.
383 *
384 * \sa operator[](Index), coeff(Index) const, coeffRef(Index,Index)
385 */
386
388 EIGEN_STRONG_INLINE Scalar&
390 {
392 THIS_COEFFICIENT_ACCESSOR_TAKING_ONE_ACCESS_IS_ONLY_FOR_EXPRESSIONS_ALLOWING_LINEAR_ACCESS)
394 return internal::evaluator<Derived>(derived()).coeffRef(index);
395 }
396
397 /** \returns a reference to the coefficient at given index.
398 *
399 * This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
400 *
401 * \sa operator[](Index) const, operator()(Index,Index), x(), y(), z(), w()
402 */
403
405 EIGEN_STRONG_INLINE Scalar&
407 {
408 EIGEN_STATIC_ASSERT(Derived::IsVectorAtCompileTime,
409 THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD)
410 eigen_assert(index >= 0 && index < size());
411 return coeffRef(index);
412 }
413
414 /** \returns a reference to the coefficient at given index.
415 *
416 * This is synonymous to operator[](Index).
417 *
418 * This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.
419 *
420 * \sa operator[](Index) const, operator()(Index,Index), x(), y(), z(), w()
421 */
422
424 EIGEN_STRONG_INLINE Scalar&
426 {
427 eigen_assert(index >= 0 && index < size());
428 return coeffRef(index);
429 }
430
431 /** equivalent to operator[](0). */
432
434 EIGEN_STRONG_INLINE Scalar&
435 x() { return (*this)[0]; }
436
437 /** equivalent to operator[](1). */
438
440 EIGEN_STRONG_INLINE Scalar&
442 {
443 EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=2, OUT_OF_RANGE_ACCESS);
444 return (*this)[1];
445 }
446
447 /** equivalent to operator[](2). */
448
450 EIGEN_STRONG_INLINE Scalar&
452 {
453 EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=3, OUT_OF_RANGE_ACCESS);
454 return (*this)[2];
455 }
456
457 /** equivalent to operator[](3). */
458
460 EIGEN_STRONG_INLINE Scalar&
462 {
463 EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=4, OUT_OF_RANGE_ACCESS);
464 return (*this)[3];
465 }
466};
467
468/** \brief Base class providing direct read-only coefficient access to matrices and arrays.
469 * \ingroup Core_Module
470 * \tparam Derived Type of the derived class
471 *
472 * \note #DirectAccessors Constant indicating direct access
473 *
474 * This class defines functions to work with strides which can be used to access entries directly. This class
475 * inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which defines functions to access entries read-only using
476 * \c operator() .
477 *
478 * \sa \blank \ref TopicClassHierarchy
479 */
480template<typename Derived>
481class DenseCoeffsBase<Derived, DirectAccessors> : public DenseCoeffsBase<Derived, ReadOnlyAccessors>
482{
483 public:
484
488
489 using Base::rows;
490 using Base::cols;
491 using Base::size;
492 using Base::derived;
493
494 /** \returns the pointer increment between two consecutive elements within a slice in the inner direction.
495 *
496 * \sa outerStride(), rowStride(), colStride()
497 */
499 inline Index innerStride() const
500 {
501 return derived().innerStride();
502 }
503
504 /** \returns the pointer increment between two consecutive inner slices (for example, between two consecutive columns
505 * in a column-major matrix).
506 *
507 * \sa innerStride(), rowStride(), colStride()
508 */
510 inline Index outerStride() const
511 {
512 return derived().outerStride();
513 }
514
515 // FIXME shall we remove it ?
517 {
518 return Derived::IsVectorAtCompileTime ? innerStride() : outerStride();
519 }
520
521 /** \returns the pointer increment between two consecutive rows.
522 *
523 * \sa innerStride(), outerStride(), colStride()
524 */
526 inline Index rowStride() const
527 {
528 return Derived::IsRowMajor ? outerStride() : innerStride();
529 }
530
531 /** \returns the pointer increment between two consecutive columns.
532 *
533 * \sa innerStride(), outerStride(), rowStride()
534 */
536 inline Index colStride() const
537 {
538 return Derived::IsRowMajor ? innerStride() : outerStride();
539 }
540};
541
542/** \brief Base class providing direct read/write coefficient access to matrices and arrays.
543 * \ingroup Core_Module
544 * \tparam Derived Type of the derived class
545 *
546 * \note #DirectWriteAccessors Constant indicating direct access
547 *
548 * This class defines functions to work with strides which can be used to access entries directly. This class
549 * inherits DenseCoeffsBase<Derived, WriteAccessors> which defines functions to access entries read/write using
550 * \c operator().
551 *
552 * \sa \blank \ref TopicClassHierarchy
553 */
554template<typename Derived>
556 : public DenseCoeffsBase<Derived, WriteAccessors>
557{
558 public:
559
563
564 using Base::rows;
565 using Base::cols;
566 using Base::size;
567 using Base::derived;
568
569 /** \returns the pointer increment between two consecutive elements within a slice in the inner direction.
570 *
571 * \sa outerStride(), rowStride(), colStride()
572 */
575 {
576 return derived().innerStride();
577 }
578
579 /** \returns the pointer increment between two consecutive inner slices (for example, between two consecutive columns
580 * in a column-major matrix).
581 *
582 * \sa innerStride(), rowStride(), colStride()
583 */
586 {
587 return derived().outerStride();
588 }
589
590 // FIXME shall we remove it ?
592 {
593 return Derived::IsVectorAtCompileTime ? innerStride() : outerStride();
594 }
595
596 /** \returns the pointer increment between two consecutive rows.
597 *
598 * \sa innerStride(), outerStride(), colStride()
599 */
602 {
603 return Derived::IsRowMajor ? outerStride() : innerStride();
604 }
605
606 /** \returns the pointer increment between two consecutive columns.
607 *
608 * \sa innerStride(), outerStride(), rowStride()
609 */
612 {
613 return Derived::IsRowMajor ? innerStride() : outerStride();
614 }
615};
616
617namespace internal {
618
619template<int Alignment, typename Derived, bool JustReturnZero>
621{
622 static EIGEN_CONSTEXPR inline Index run(const Derived&) EIGEN_NOEXCEPT
623 { return 0; }
624};
625
626template<int Alignment, typename Derived>
627struct first_aligned_impl<Alignment, Derived, false>
628{
629 static inline Index run(const Derived& m)
630 {
631 return internal::first_aligned<Alignment>(m.data(), m.size());
632 }
633};
634
635/** \internal \returns the index of the first element of the array stored by \a m that is properly aligned with respect to \a Alignment for vectorization.
636 *
637 * \tparam Alignment requested alignment in Bytes.
638 *
639 * There is also the variant first_aligned(const Scalar*, Integer) defined in Memory.h. See it for more
640 * documentation.
641 */
642template<int Alignment, typename Derived>
644{
645 enum { ReturnZero = (int(evaluator<Derived>::Alignment) >= Alignment) || !(Derived::Flags & DirectAccessBit) };
647}
648
649template<typename Derived>
651{
652 typedef typename Derived::Scalar Scalar;
653 typedef typename packet_traits<Scalar>::type DefaultPacketType;
655}
656
657template<typename Derived, bool HasDirectAccess = has_direct_access<Derived>::ret>
659{
661};
662
663template<typename Derived>
664struct inner_stride_at_compile_time<Derived, false>
665{
666 enum { ret = 0 };
667};
668
669template<typename Derived, bool HasDirectAccess = has_direct_access<Derived>::ret>
671{
673};
674
675template<typename Derived>
676struct outer_stride_at_compile_time<Derived, false>
677{
678 enum { ret = 0 };
679};
680
681} // end namespace internal
682
683} // end namespace Eigen
684
685#endif // EIGEN_DENSECOEFFSBASE_H
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ColXpr col(Index i)
This is the const version of col().
Definition: BlockMethods.h:1097
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE RowXpr row(Index i)
This is the const version of row(). *‍/.
Definition: BlockMethods.h:1118
#define eigen_internal_assert(x)
Definition: Macros.h:1053
#define EIGEN_NOEXCEPT
Definition: Macros.h:1428
#define EIGEN_CONSTEXPR
Definition: Macros.h:797
#define EIGEN_DEVICE_FUNC
Definition: Macros.h:986
#define eigen_assert(x)
Definition: Macros.h:1047
#define EIGEN_STRONG_INLINE
Definition: Macros.h:927
#define EIGEN_STATIC_ASSERT(CONDITION, MSG)
Definition: StaticAssert.h:127
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:47
EIGEN_CONSTEXPR Index stride() const
Definition: DenseCoeffsBase.h:516
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index colStride() const
Definition: DenseCoeffsBase.h:536
DenseCoeffsBase< Derived, ReadOnlyAccessors > Base
Definition: DenseCoeffsBase.h:485
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride() const
Definition: DenseCoeffsBase.h:510
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rowStride() const
Definition: DenseCoeffsBase.h:526
NumTraits< Scalar >::Real RealScalar
Definition: DenseCoeffsBase.h:487
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerStride() const
Definition: DenseCoeffsBase.h:499
internal::traits< Derived >::Scalar Scalar
Definition: DenseCoeffsBase.h:486
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerStride() const EIGEN_NOEXCEPT
Definition: DenseCoeffsBase.h:574
NumTraits< Scalar >::Real RealScalar
Definition: DenseCoeffsBase.h:562
DenseCoeffsBase< Derived, WriteAccessors > Base
Definition: DenseCoeffsBase.h:560
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rowStride() const EIGEN_NOEXCEPT
Definition: DenseCoeffsBase.h:601
internal::traits< Derived >::Scalar Scalar
Definition: DenseCoeffsBase.h:561
EIGEN_CONSTEXPR Index stride() const EIGEN_NOEXCEPT
Definition: DenseCoeffsBase.h:591
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride() const EIGEN_NOEXCEPT
Definition: DenseCoeffsBase.h:585
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index colStride() const EIGEN_NOEXCEPT
Definition: DenseCoeffsBase.h:611
Base class providing read-only coefficient access to matrices and arrays.
Definition: DenseCoeffsBase.h:36
internal::packet_traits< Scalar >::type PacketScalar
Definition: DenseCoeffsBase.h:40
internal::add_const_on_value_type_if_arithmetic< typenameinternal::packet_traits< Scalar >::type >::type PacketReturnType
Definition: DenseCoeffsBase.h:56
internal::traits< Derived >::StorageKind StorageKind
Definition: DenseCoeffsBase.h:38
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator()(Index row, Index col) const
Definition: DenseCoeffsBase.h:116
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType x() const
equivalent to operator[](0).
Definition: DenseCoeffsBase.h:189
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType w() const
equivalent to operator[](3).
Definition: DenseCoeffsBase.h:215
internal::conditional< bool(internal::traits< Derived >::Flags &LvalueBit), constScalar &, typenameinternal::conditional< internal::is_arithmetic< Scalar >::value, Scalar, constScalar >::type >::type CoeffReturnType
Definition: DenseCoeffsBase.h:52
EIGEN_STRONG_INLINE PacketReturnType packet(Index index) const
Definition: DenseCoeffsBase.h:259
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator()(Index index) const
Definition: DenseCoeffsBase.h:179
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index colIndexByOuterInner(Index outer, Index inner) const
Definition: DenseCoeffsBase.h:74
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeffByOuterInner(Index outer, Index inner) const
Definition: DenseCoeffsBase.h:105
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType z() const
equivalent to operator[](2).
Definition: DenseCoeffsBase.h:205
EIGEN_STRONG_INLINE PacketReturnType packetByOuterInner(Index outer, Index inner) const
Definition: DenseCoeffsBase.h:242
EIGEN_STRONG_INLINE PacketReturnType packet(Index row, Index col) const
Definition: DenseCoeffsBase.h:232
internal::traits< Derived >::Scalar Scalar
Definition: DenseCoeffsBase.h:39
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index rowIndexByOuterInner(Index outer, Index inner) const
Definition: DenseCoeffsBase.h:65
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType operator[](Index index) const
Definition: DenseCoeffsBase.h:159
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeff(Index row, Index col) const
Short version: don't use this function, use operator()(Index,Index) const instead.
Definition: DenseCoeffsBase.h:97
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType coeff(Index index) const
Short version: don't use this function, use operator[](Index) const instead.
Definition: DenseCoeffsBase.h:140
EigenBase< Derived > Base
Definition: DenseCoeffsBase.h:58
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType y() const
equivalent to operator[](1).
Definition: DenseCoeffsBase.h:195
Base class providing read/write coefficient access to matrices and arrays.
Definition: DenseCoeffsBase.h:303
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & x()
equivalent to operator[](0).
Definition: DenseCoeffsBase.h:435
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator[](Index index)
Definition: DenseCoeffsBase.h:406
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & y()
equivalent to operator[](1).
Definition: DenseCoeffsBase.h:441
NumTraits< Scalar >::Real RealScalar
Definition: DenseCoeffsBase.h:311
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef(Index row, Index col)
Short version: don't use this function, use operator()(Index,Index) instead.
Definition: DenseCoeffsBase.h:342
DenseCoeffsBase< Derived, ReadOnlyAccessors > Base
Definition: DenseCoeffsBase.h:306
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator()(Index row, Index col)
Definition: DenseCoeffsBase.h:364
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & z()
equivalent to operator[](2).
Definition: DenseCoeffsBase.h:451
internal::packet_traits< Scalar >::type PacketScalar
Definition: DenseCoeffsBase.h:310
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & operator()(Index index)
Definition: DenseCoeffsBase.h:425
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef(Index index)
Short version: don't use this function, use operator[](Index) instead.
Definition: DenseCoeffsBase.h:389
internal::traits< Derived >::Scalar Scalar
Definition: DenseCoeffsBase.h:309
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRefByOuterInner(Index outer, Index inner)
Definition: DenseCoeffsBase.h:351
internal::traits< Derived >::StorageKind StorageKind
Definition: DenseCoeffsBase.h:308
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & w()
equivalent to operator[](3).
Definition: DenseCoeffsBase.h:461
Definition: ForwardDeclarations.h:50
type
Definition: core.h:575
@ DirectAccessors
Direct read-only access to the coefficients.
Definition: Constants.h:380
@ ReadOnlyAccessors
Read-only access via a member function.
Definition: Constants.h:376
@ WriteAccessors
Read/write access via member functions.
Definition: Constants.h:378
@ DirectWriteAccessors
Direct read/write access to the coefficients.
Definition: Constants.h:382
const unsigned int LinearAccessBit
Short version: means the expression can be seen as 1D vector.
Definition: Constants.h:130
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 LvalueBit
Means the expression has a coeffRef() method, i.e.
Definition: Constants.h:144
const unsigned int RowMajorBit
for a matrix, this means that the storage order is row-major.
Definition: Constants.h:66
const Scalar & y
Definition: MathFunctions.h:821
EIGEN_CONSTEXPR Index size(const T &x)
Definition: Meta.h:479
EIGEN_DEVICE_FUNC Index first_aligned(const Scalar *array, Index size)
Definition: Memory.h:469
EIGEN_DEVICE_FUNC Index first_default_aligned(const Scalar *array, Index size)
Definition: Memory.h:497
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
Definition: Eigen_Colamd.h:50
Common base class for all classes T such that MatrixBase has an operator=(T) and a constructor Matrix...
Definition: EigenBase.h:30
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:39
Holds information about the various numeric (i.e.
Definition: NumTraits.h:233
conditional< is_arithmetic< T >::value, T, typenameadd_const_on_value_type< T >::type >::type type
Definition: DenseCoeffsBase.h:18
const T type
Definition: Meta.h:214
Definition: Meta.h:109
Definition: CoreEvaluators.h:91
static Index run(const Derived &m)
Definition: DenseCoeffsBase.h:629
Definition: DenseCoeffsBase.h:621
static EIGEN_CONSTEXPR Index run(const Derived &) EIGEN_NOEXCEPT
Definition: DenseCoeffsBase.h:622
Definition: DenseCoeffsBase.h:659
@ ret
Definition: DenseCoeffsBase.h:660
Definition: DenseCoeffsBase.h:671
@ ret
Definition: DenseCoeffsBase.h:672
T type
Definition: GenericPacketMath.h:108
Definition: ForwardDeclarations.h:17
Definition: Meta.h:96
Definition: GenericPacketMath.h:133