WPILibC++ 2023.4.3
Solve.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) 2014 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_SOLVE_H
11#define EIGEN_SOLVE_H
12
13namespace Eigen {
14
15template<typename Decomposition, typename RhsType, typename StorageKind> class SolveImpl;
16
17/** \class Solve
18 * \ingroup Core_Module
19 *
20 * \brief Pseudo expression representing a solving operation
21 *
22 * \tparam Decomposition the type of the matrix or decomposition object
23 * \tparam Rhstype the type of the right-hand side
24 *
25 * This class represents an expression of A.solve(B)
26 * and most of the time this is the only way it is used.
27 *
28 */
29namespace internal {
30
31// this solve_traits class permits to determine the evaluation type with respect to storage kind (Dense vs Sparse)
32template<typename Decomposition, typename RhsType,typename StorageKind> struct solve_traits;
33
34template<typename Decomposition, typename RhsType>
35struct solve_traits<Decomposition,RhsType,Dense>
36{
37 typedef typename make_proper_matrix_type<typename RhsType::Scalar,
38 Decomposition::ColsAtCompileTime,
39 RhsType::ColsAtCompileTime,
40 RhsType::PlainObject::Options,
41 Decomposition::MaxColsAtCompileTime,
42 RhsType::MaxColsAtCompileTime>::type PlainObject;
43};
44
45template<typename Decomposition, typename RhsType>
46struct traits<Solve<Decomposition, RhsType> >
47 : traits<typename solve_traits<Decomposition,RhsType,typename internal::traits<RhsType>::StorageKind>::PlainObject>
48{
52 enum {
53 Flags = BaseTraits::Flags & RowMajorBit,
54 CoeffReadCost = HugeCost
55 };
56};
57
58}
59
60
61template<typename Decomposition, typename RhsType>
62class Solve : public SolveImpl<Decomposition,RhsType,typename internal::traits<RhsType>::StorageKind>
63{
64public:
67
68 Solve(const Decomposition &dec, const RhsType &rhs)
69 : m_dec(dec), m_rhs(rhs)
70 {}
71
74
75 EIGEN_DEVICE_FUNC const Decomposition& dec() const { return m_dec; }
76 EIGEN_DEVICE_FUNC const RhsType& rhs() const { return m_rhs; }
77
78protected:
79 const Decomposition &m_dec;
80 const RhsType &m_rhs;
81};
82
83
84// Specialization of the Solve expression for dense results
85template<typename Decomposition, typename RhsType>
86class SolveImpl<Decomposition,RhsType,Dense>
87 : public MatrixBase<Solve<Decomposition,RhsType> >
88{
90
91public:
92
95
96private:
97
98 Scalar coeff(Index row, Index col) const;
99 Scalar coeff(Index i) const;
100};
101
102// Generic API dispatcher
103template<typename Decomposition, typename RhsType, typename StorageKind>
104class SolveImpl : public internal::generic_xpr_base<Solve<Decomposition,RhsType>, MatrixXpr, StorageKind>::type
105{
106 public:
108};
109
110namespace internal {
111
112// Evaluator of Solve -> eval into a temporary
113template<typename Decomposition, typename RhsType>
114struct evaluator<Solve<Decomposition,RhsType> >
115 : public evaluator<typename Solve<Decomposition,RhsType>::PlainObject>
116{
120
121 enum { Flags = Base::Flags | EvalBeforeNestingBit };
122
123 EIGEN_DEVICE_FUNC explicit evaluator(const SolveType& solve)
124 : m_result(solve.rows(), solve.cols())
125 {
126 ::new (static_cast<Base*>(this)) Base(m_result);
127 solve.dec()._solve_impl(solve.rhs(), m_result);
128 }
129
130protected:
132};
133
134// Specialization for "dst = dec.solve(rhs)"
135// NOTE we need to specialize it for Dense2Dense to avoid ambiguous specialization error and a Sparse2Sparse specialization must exist somewhere
136template<typename DstXprType, typename DecType, typename RhsType, typename Scalar>
137struct Assignment<DstXprType, Solve<DecType,RhsType>, internal::assign_op<Scalar,Scalar>, Dense2Dense>
138{
140 static void run(DstXprType &dst, const SrcXprType &src, const internal::assign_op<Scalar,Scalar> &)
141 {
142 Index dstRows = src.rows();
143 Index dstCols = src.cols();
144 if((dst.rows()!=dstRows) || (dst.cols()!=dstCols))
145 dst.resize(dstRows, dstCols);
146
147 src.dec()._solve_impl(src.rhs(), dst);
148 }
149};
150
151// Specialization for "dst = dec.transpose().solve(rhs)"
152template<typename DstXprType, typename DecType, typename RhsType, typename Scalar>
153struct Assignment<DstXprType, Solve<Transpose<const DecType>,RhsType>, internal::assign_op<Scalar,Scalar>, Dense2Dense>
154{
156 static void run(DstXprType &dst, const SrcXprType &src, const internal::assign_op<Scalar,Scalar> &)
157 {
158 Index dstRows = src.rows();
159 Index dstCols = src.cols();
160 if((dst.rows()!=dstRows) || (dst.cols()!=dstCols))
161 dst.resize(dstRows, dstCols);
162
163 src.dec().nestedExpression().template _solve_impl_transposed<false>(src.rhs(), dst);
164 }
165};
166
167// Specialization for "dst = dec.adjoint().solve(rhs)"
168template<typename DstXprType, typename DecType, typename RhsType, typename Scalar>
169struct Assignment<DstXprType, Solve<CwiseUnaryOp<internal::scalar_conjugate_op<typename DecType::Scalar>, const Transpose<const DecType> >,RhsType>,
170 internal::assign_op<Scalar,Scalar>, Dense2Dense>
171{
173 static void run(DstXprType &dst, const SrcXprType &src, const internal::assign_op<Scalar,Scalar> &)
174 {
175 Index dstRows = src.rows();
176 Index dstCols = src.cols();
177 if((dst.rows()!=dstRows) || (dst.cols()!=dstCols))
178 dst.resize(dstRows, dstCols);
179
180 src.dec().nestedExpression().nestedExpression().template _solve_impl_transposed<true>(src.rhs(), dst);
181 }
182};
183
184} // end namespace internal
185
186} // end namespace Eigen
187
188#endif // EIGEN_SOLVE_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
Generic expression where a coefficient-wise unary operator is applied to an expression.
Definition: CwiseUnaryOp.h:56
internal::traits< Solve< Decomposition, RhsType > >::Scalar Scalar
The numeric type of the expression' coefficients, e.g.
Definition: DenseBase.h:66
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:50
Pseudo expression representing a solving operation.
Definition: Solve.h:63
internal::traits< Solve >::PlainObject PlainObject
Definition: Solve.h:65
const RhsType & m_rhs
Definition: Solve.h:80
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: Solve.h:73
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: Solve.h:72
internal::traits< Solve >::StorageIndex StorageIndex
Definition: Solve.h:66
EIGEN_DEVICE_FUNC const RhsType & rhs() const
Definition: Solve.h:76
const Decomposition & m_dec
Definition: Solve.h:79
Solve(const Decomposition &dec, const RhsType &rhs)
Definition: Solve.h:68
EIGEN_DEVICE_FUNC const Decomposition & dec() const
Definition: Solve.h:75
MatrixBase< Solve< Decomposition, RhsType > > Base
Definition: Solve.h:93
Definition: Solve.h:105
internal::generic_xpr_base< Solve< Decomposition, RhsType >, MatrixXpr, StorageKind >::type Base
Definition: Solve.h:107
Expression of the transpose of a matrix.
Definition: Transpose.h:54
Definition: XprHelper.h:258
type
Definition: core.h:575
const unsigned int EvalBeforeNestingBit
means the expression should be evaluated by the calling expression
Definition: Constants.h:70
const unsigned int RowMajorBit
for a matrix, this means that the storage order is row-major.
Definition: Constants.h:66
Namespace containing all symbols from the Eigen library.
Definition: MatrixExponential.h:16
const int HugeCost
This value means that the cost to evaluate an expression coefficient is either very expensive or cann...
Definition: Constants.h:44
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
Definition: Eigen_Colamd.h:50
The type used to identify a dense storage.
Definition: Constants.h:507
The type used to identify a matrix expression.
Definition: Constants.h:522
Solve< CwiseUnaryOp< internal::scalar_conjugate_op< typename DecType::Scalar >, const Transpose< const DecType > >, RhsType > SrcXprType
Definition: Solve.h:172
static void run(DstXprType &dst, const SrcXprType &src, const internal::assign_op< Scalar, Scalar > &)
Definition: Solve.h:140
static void run(DstXprType &dst, const SrcXprType &src, const internal::assign_op< Scalar, Scalar > &)
Definition: Solve.h:156
Definition: AssignEvaluator.h:824
Definition: AssignEvaluator.h:814
Definition: AssignmentFunctors.h:21
EIGEN_DEVICE_FUNC evaluator(const SolveType &solve)
Definition: Solve.h:123
SolveType::PlainObject PlainObject
Definition: Solve.h:118
evaluator< PlainObject > Base
Definition: Solve.h:119
Solve< Decomposition, RhsType > SolveType
Definition: Solve.h:117
Definition: CoreEvaluators.h:91
unary_evaluator< T > Base
Definition: CoreEvaluators.h:92
Definition: XprHelper.h:501
Definition: UnaryFunctors.h:109
make_proper_matrix_type< typenameRhsType::Scalar, Decomposition::ColsAtCompileTime, RhsType::ColsAtCompileTime, RhsType::PlainObject::Options, Decomposition::MaxColsAtCompileTime, RhsType::MaxColsAtCompileTime >::type PlainObject
Definition: Solve.h:42
Definition: Solve.h:32
solve_traits< Decomposition, RhsType, typenameinternal::traits< RhsType >::StorageKind >::PlainObject PlainObject
Definition: Solve.h:49
traits< PlainObject > BaseTraits
Definition: Solve.h:51
promote_index_type< typenameDecomposition::StorageIndex, typenameRhsType::StorageIndex >::type StorageIndex
Definition: Solve.h:50
Definition: ForwardDeclarations.h:17
Definition: Meta.h:96