WPILibC++ 2023.4.3
ForceAlignedAccess.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) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
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_FORCEALIGNEDACCESS_H
11#define EIGEN_FORCEALIGNEDACCESS_H
12
13namespace Eigen {
14
15/** \class ForceAlignedAccess
16 * \ingroup Core_Module
17 *
18 * \brief Enforce aligned packet loads and stores regardless of what is requested
19 *
20 * \param ExpressionType the type of the object of which we are forcing aligned packet access
21 *
22 * This class is the return type of MatrixBase::forceAlignedAccess()
23 * and most of the time this is the only way it is used.
24 *
25 * \sa MatrixBase::forceAlignedAccess()
26 */
27
28namespace internal {
29template<typename ExpressionType>
30struct traits<ForceAlignedAccess<ExpressionType> > : public traits<ExpressionType>
31{};
32}
33
34template<typename ExpressionType> class ForceAlignedAccess
35 : public internal::dense_xpr_base< ForceAlignedAccess<ExpressionType> >::type
36{
37 public:
38
41
42 EIGEN_DEVICE_FUNC explicit inline ForceAlignedAccess(const ExpressionType& matrix) : m_expression(matrix) {}
43
45 inline Index rows() const EIGEN_NOEXCEPT { return m_expression.rows(); }
47 inline Index cols() const EIGEN_NOEXCEPT { return m_expression.cols(); }
49 inline Index outerStride() const EIGEN_NOEXCEPT { return m_expression.outerStride(); }
51 inline Index innerStride() const EIGEN_NOEXCEPT { return m_expression.innerStride(); }
52
53 EIGEN_DEVICE_FUNC inline const CoeffReturnType coeff(Index row, Index col) const
54 {
55 return m_expression.coeff(row, col);
56 }
57
59 {
60 return m_expression.const_cast_derived().coeffRef(row, col);
61 }
62
63 EIGEN_DEVICE_FUNC inline const CoeffReturnType coeff(Index index) const
64 {
65 return m_expression.coeff(index);
66 }
67
68 EIGEN_DEVICE_FUNC inline Scalar& coeffRef(Index index)
69 {
70 return m_expression.const_cast_derived().coeffRef(index);
71 }
72
73 template<int LoadMode>
74 inline const PacketScalar packet(Index row, Index col) const
75 {
76 return m_expression.template packet<Aligned>(row, col);
77 }
78
79 template<int LoadMode>
80 inline void writePacket(Index row, Index col, const PacketScalar& x)
81 {
82 m_expression.const_cast_derived().template writePacket<Aligned>(row, col, x);
83 }
84
85 template<int LoadMode>
86 inline const PacketScalar packet(Index index) const
87 {
88 return m_expression.template packet<Aligned>(index);
89 }
90
91 template<int LoadMode>
92 inline void writePacket(Index index, const PacketScalar& x)
93 {
94 m_expression.const_cast_derived().template writePacket<Aligned>(index, x);
95 }
96
97 EIGEN_DEVICE_FUNC operator const ExpressionType&() const { return m_expression; }
98
99 protected:
100 const ExpressionType& m_expression;
101
102 private:
103 ForceAlignedAccess& operator=(const ForceAlignedAccess&);
104};
105
106/** \returns an expression of *this with forced aligned access
107 * \sa forceAlignedAccessIf(),class ForceAlignedAccess
108 */
109template<typename Derived>
112{
113 return ForceAlignedAccess<Derived>(derived());
114}
115
116/** \returns an expression of *this with forced aligned access
117 * \sa forceAlignedAccessIf(), class ForceAlignedAccess
118 */
119template<typename Derived>
120inline ForceAlignedAccess<Derived>
122{
123 return ForceAlignedAccess<Derived>(derived());
124}
125
126/** \returns an expression of *this with forced aligned access if \a Enable is true.
127 * \sa forceAlignedAccess(), class ForceAlignedAccess
128 */
129template<typename Derived>
130template<bool Enable>
131inline typename internal::add_const_on_value_type<typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type>::type
133{
134 return derived(); // FIXME This should not work but apparently is never used
135}
136
137/** \returns an expression of *this with forced aligned access if \a Enable is true.
138 * \sa forceAlignedAccess(), class ForceAlignedAccess
139 */
140template<typename Derived>
141template<bool Enable>
144{
145 return derived(); // FIXME This should not work but apparently is never used
146}
147
148} // end namespace Eigen
149
150#endif // EIGEN_FORCEALIGNEDACCESS_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_NOEXCEPT
Definition: Macros.h:1428
#define EIGEN_CONSTEXPR
Definition: Macros.h:797
#define EIGEN_DEVICE_FUNC
Definition: Macros.h:986
#define EIGEN_DENSE_PUBLIC_INTERFACE(Derived)
Definition: Macros.h:1293
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:36
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: ForceAlignedAccess.h:47
const PacketScalar packet(Index row, Index col) const
Definition: ForceAlignedAccess.h:74
void writePacket(Index row, Index col, const PacketScalar &x)
Definition: ForceAlignedAccess.h:80
void writePacket(Index index, const PacketScalar &x)
Definition: ForceAlignedAccess.h:92
const PacketScalar packet(Index index) const
Definition: ForceAlignedAccess.h:86
EIGEN_DEVICE_FUNC const CoeffReturnType coeff(Index row, Index col) const
Definition: ForceAlignedAccess.h:53
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride() const EIGEN_NOEXCEPT
Definition: ForceAlignedAccess.h:49
internal::dense_xpr_base< ForceAlignedAccess >::type Base
Definition: ForceAlignedAccess.h:39
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerStride() const EIGEN_NOEXCEPT
Definition: ForceAlignedAccess.h:51
const ExpressionType & m_expression
Definition: ForceAlignedAccess.h:100
EIGEN_DEVICE_FUNC const CoeffReturnType coeff(Index index) const
Definition: ForceAlignedAccess.h:63
EIGEN_DEVICE_FUNC Scalar & coeffRef(Index index)
Definition: ForceAlignedAccess.h:68
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: ForceAlignedAccess.h:45
EIGEN_DEVICE_FUNC Scalar & coeffRef(Index row, Index col)
Definition: ForceAlignedAccess.h:58
const Derived & forceAlignedAccessIf() const
Definition: MatrixBase.h:307
const Derived & forceAlignedAccess() const
Definition: MatrixBase.h:305
type
Definition: core.h:575
Namespace containing all symbols from the Eigen library.
Definition: MatrixExponential.h:16
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Definition: Eigen_Colamd.h:50
Definition: Meta.h:109
Definition: XprHelper.h:484
Definition: ForwardDeclarations.h:17