36#include "./InternalHeaderCheck.h"
76template <
typename MatrixType,
typename Rhs,
typename Dest,
typename Preconditioner>
77EIGEN_DONT_INLINE Index lsmr(
const MatrixType& mat,
const Rhs& rhs, Dest& x,
const Preconditioner& precond,
78 Index& iters,
typename Dest::RealScalar& tol_error,
const typename Dest::RealScalar& atol,
79 const typename Dest::RealScalar& btol,
const typename Dest::RealScalar& lambda,
80 const typename Dest::RealScalar& conlim) {
81 using RealScalar =
typename Dest::RealScalar;
82 using Scalar =
typename Dest::Scalar;
83 using VectorType = Matrix<Scalar, Dynamic, 1>;
85 const RealScalar zero(0);
86 const RealScalar one(1);
88 const Index n = mat.cols();
89 const Index maxIters = iters;
92 VectorType v(n), Atu(n);
96 VectorType u = rhs - mat * x;
97 RealScalar alpha = zero;
98 RealScalar beta = u.stableNorm();
101 Atu.noalias() = mat.adjoint() * u;
102 v = precond.solve(Atu);
103 alpha = v.stableNorm();
104 if (alpha > zero) v /= alpha;
110 if (alpha * beta == zero) {
117 VectorType dx = VectorType::Zero(n);
119 VectorType hbar = VectorType::Zero(n);
123 RealScalar alphabar = alpha;
124 RealScalar zetabar = alpha * beta;
125 RealScalar rho = one;
126 RealScalar rhobar = one;
127 RealScalar cbar = one;
128 RealScalar sbar = zero;
131 RealScalar betadd = beta;
132 RealScalar betad = zero;
133 RealScalar rhodold = one;
134 RealScalar tautildeold = zero;
135 RealScalar thetatilde = zero;
136 RealScalar zeta = zero;
140 RealScalar normA2 = alpha * alpha;
141 RealScalar maxrbar = zero;
142 RealScalar minrbar = NumTraits<RealScalar>::highest();
144 const RealScalar normb = beta;
145 const RealScalar ctol = conlim > zero ? one / conlim : zero;
146 RealScalar test2 = zero;
157 t = precond.solve(v);
159 u.noalias() += mat * t;
160 beta = u.stableNorm();
163 Atu.noalias() = mat.adjoint() * u;
164 t = precond.solve(Atu);
166 alpha = v.stableNorm();
167 if (alpha > zero) v /= alpha;
171 const RealScalar alphahat = numext::hypot(alphabar, lambda);
172 const RealScalar chat = alphabar / alphahat;
173 const RealScalar shat = lambda / alphahat;
176 const RealScalar rhoold = rho;
177 rho = numext::hypot(alphahat, beta);
178 const RealScalar c = alphahat / rho;
179 const RealScalar s = beta / rho;
180 const RealScalar thetanew = s * alpha;
181 alphabar = c * alpha;
184 const RealScalar rhobarold = rhobar;
185 const RealScalar zetaold = zeta;
186 const RealScalar thetabar = sbar * rho;
187 const RealScalar rhotemp = cbar * rho;
188 rhobar = numext::hypot(cbar * rho, thetanew);
189 cbar = cbar * rho / rhobar;
190 sbar = thetanew / rhobar;
191 zeta = cbar * zetabar;
192 zetabar = -sbar * zetabar;
195 hbar = h - (thetabar * rho / (rhoold * rhobarold)) * hbar;
196 dx += (zeta / (rho * rhobar)) * hbar;
197 h = v - (thetanew / rho) * h;
200 const RealScalar betaacute = chat * betadd;
201 const RealScalar betacheck = -shat * betadd;
202 const RealScalar betahat = c * betaacute;
203 betadd = -s * betaacute;
205 const RealScalar thetatildeold = thetatilde;
206 const RealScalar rhotildeold = numext::hypot(rhodold, thetabar);
207 const RealScalar ctildeold = rhodold / rhotildeold;
208 const RealScalar stildeold = thetabar / rhotildeold;
209 thetatilde = stildeold * rhobar;
210 rhodold = ctildeold * rhobar;
211 betad = -stildeold * betad + ctildeold * betahat;
213 tautildeold = (zetaold - thetatildeold * tautildeold) / rhotildeold;
214 const RealScalar taud = (zeta - thetatilde * tautildeold) / rhodold;
215 d += betacheck * betacheck;
216 const RealScalar normr = numext::sqrt<RealScalar>(d + numext::abs2(betad - taud) + numext::abs2(betadd));
219 normA2 += beta * beta;
220 const RealScalar normA = numext::sqrt(normA2);
221 normA2 += alpha * alpha;
224 maxrbar = numext::maxi(maxrbar, rhobarold);
225 if (itn > 1) minrbar = numext::mini(minrbar, rhobarold);
226 const RealScalar condA = numext::maxi(maxrbar, rhotemp) / numext::mini(minrbar, rhotemp);
229 const RealScalar normAr = numext::abs(zetabar);
230 const RealScalar normx = dx.stableNorm();
232 const RealScalar test1 = normr / normb;
233 test2 = (normA * normr > zero) ? normAr / (normA * normr) : zero;
234 const RealScalar test3 = one / condA;
235 const RealScalar t1 = test1 / (one + normA * normx / normb);
236 const RealScalar rtol = btol + atol * normA * normx / normb;
245 else if (test2 <= atol)
247 else if (test3 <= ctol)
249 else if (one + t1 <= one)
251 else if (one + test2 <= one)
253 else if (one + test3 <= one)
255 else if (itn >= maxIters)
260 t = precond.solve(dx);
270template <
typename MatrixType_,
typename Preconditioner_ = IdentityPreconditioner>
275template <
typename MatrixType_,
typename Preconditioner_>
276struct traits<LSMR<MatrixType_, Preconditioner_> > {
277 using MatrixType = MatrixType_;
278 using Preconditioner = Preconditioner_;
351template <
typename MatrixType_,
typename Preconditioner_>
357 using Base::m_isInitialized;
358 using Base::m_iterations;
362 using MatrixType = MatrixType_;
363 using Scalar =
typename MatrixType::Scalar;
364 using RealScalar =
typename MatrixType::RealScalar;
365 using Preconditioner = Preconditioner_;
380 template <
typename MatrixDerived>
398 RealScalar
damping()
const {
return m_lambda; }
405 m_conditionLimit = conlim;
423 RealScalar
toleranceA()
const {
return m_atol >= RealScalar(0) ? m_atol : Base::m_tolerance; }
436 RealScalar
toleranceB()
const {
return m_btol >= RealScalar(0) ? m_btol : Base::m_tolerance; }
439 template <
typename Rhs,
typename Dest>
440 void _solve_vector_with_guess_impl(
const Rhs& b, Dest& x)
const {
443 Index istop = internal::lsmr(matrix(), b, x, Base::m_preconditioner, m_iterations, m_error,
toleranceA(),
453 RealScalar m_lambda = RealScalar(0);
454 RealScalar m_conditionLimit = RealScalar(0);
456 RealScalar m_atol = RealScalar(-1);
457 RealScalar m_btol = RealScalar(-1);
IterativeSolverBase()
Definition IterativeSolverBase.h:136
Index maxIterations() const
Definition IterativeSolverBase.h:246
An LSMR solver for sparse (or dense) least-squares problems.
Definition LSMR.h:352
LSMR(const EigenBase< MatrixDerived > &A)
Definition LSMR.h:381
LSMR()
Definition LSMR.h:368
LSMR & setConditionLimit(const RealScalar &conlim)
Definition LSMR.h:404
LSMR & setDamping(const RealScalar &lambda)
Definition LSMR.h:392
LSMR & setToleranceB(const RealScalar &btol)
Definition LSMR.h:429
RealScalar conditionLimit() const
Definition LSMR.h:410
RealScalar damping() const
Definition LSMR.h:398
RealScalar toleranceB() const
Definition LSMR.h:436
LSMR & setToleranceA(const RealScalar &atol)
Definition LSMR.h:416
RealScalar toleranceA() const
Definition LSMR.h:423
@ Success
Definition Constants.h:457
@ NoConvergence
Definition Constants.h:461
Definition EigenBase.h:34