forked from Irubataru/qdp-to-openqcd
-
Notifications
You must be signed in to change notification settings - Fork 1
/
minres1.m
664 lines (565 loc) · 22.8 KB
/
minres1.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
(*
MINRES linear system solver
Import MATLAB code from https://web.stanford.edu/group/SOL/software/minresqlp/
The intention here is for the Mathematica code to match, as close as possible,
the original MATLAB code. Here, we rip out the QLP code, leaving only
the MINRES algorithm.
function [x, flag, iter, relres, relAres,
Anorm, Acond, xnorm, Axnorm, resvec, Aresvec] =
minres1(A, b, M, shift, rtol, maxit, maxxnorm, stepMontor, Acondlim, printDetails)
MINRES1: min-length solution to symmetric (possibly singular) Ax=b or
min||Ax-b||.
MINRES1(A,B) solves the system of linear equations A*X=B
or the least-squares problem min norm(B-A*X) if A is singular.
The N-by-N matrix A must be symmetric or Hermitian, but need not be
positive definite or nonsingular. The rhs vector B must have length N.
MINRES1(AFUN,B) accepts a function handle AFUN instead of
the matrix A. Y = AFUN(X) returns the matrix-vector product Y=A*X.
In all of the following syntaxes, A can be replaced by AFUN.
MINRES1(A,B,M) uses a matrix M as preconditioner.
M must be positive definite and symmetric or Hermitian.
It may be a function handle MFUN such that Y=MFUN(X) returns a
solution of M.Y=X.
If M is not supplied or M=None, a preconditioner is not applied.
MINRES1(A,B,M,SHIFT) solves (A - SHIFT*I)X = B, or the corresponding
least-squares problem if (A - SHIFT*I) is singular, where SHIFT is a
real scalar.
Default SHIFT = 0.
rTolerance specifies a stopping tolerance.
Default rTolerance = machine epsilon.
maxIterations specifies the maximum number of iterations.
Default maxIterations = 4*N.
stepMonitor is a user-supplied function that is called
directly after each x update.
Default stepMonitor = None.
maxXNorm and aConditionLimit are parameters associated
with singular or ill-conditioned systems (A - SHIFT*I)*X = B.
maxXNorm is an upper bound on norm(X).
Default maxXNorm = 10^7.
aConditionLimit is an upper bound on ACOND, an estimate of condition(A).
Default aConditionLimit = 10^15.
printDetails specifies the printing option.
If printDetails=True, an iteration log will be output.
If printDetails=False, the log is suppressed.
Default printDetails=False.
If returnVectors is True, then the RESVEC and ARESVEC are returned.
Returns an array {X, FLAG, ITER, RELRES, RELARES,
ANORM, ACOND, XNORM, AXNORM, RESVEC, ARESVEC} where:
X is the solution
Convergence FLAG:
-1 (beta2=0) B and X are eigenvectors of (A - SHIFT*I).
0 (beta1=0) B = 0. The exact solution is X = 0.
1 X solves the compatible (possibly singular) system (A - SHIFT*I)X = B
to the desired tolerance:
RELRES = RNORM / (ANORM*XNORM + NORM(B)) <= RTOL,
where
R = B - (A - SHIFT*I)X and RNORM = norm(R).
2 X solves the incompatible (singular) system (A - SHIFT*I)X = B
to the desired tolerance:
RELARES = ARNORM / (ANORM * RNORM) <= RTOL,
where
AR = (A - SHIFT*I)R and ARNORM = NORM(AR).
3 Same as 1 with RTOL = EPS.
4 Same as 2 with RTOL = EPS.
5 X converged to an eigenvector of (A - SHIFT*I).
6 XNORM exceeded MAXXNORM.
7 ACOND exceeded ACONDLIM.
8 MAXIT iterations were performed before one of the previous
conditions was satisfied.
9 The system appears to be exactly singular. XNORM does not
yet exceed MAXXNORM, but would if further iterations were
performed.
ITER is the number of iterations performed.
The relative residuals for (A - SHIFT*I)X = B and the
associated least-squares problem. RELRES and RELARES are
defined above in the description of FLAG.
Further norms:
ANORM, an estimate of the 2-norm of A-SHIFT*I.
ACOND, an estimate of COND(A-SHIFT*I,2).
XNORM, a recurred estimate of NORM(X).
AXNORM, a recurred estimate of NORM((A-SHIFT*I)X)
Vectors:
RESVEC, a vector of estimates of NORM(R) at each iteration,
including NORM(B) as the first entry.
ARESVEC, a vector of estimates of NORM((A-SHIFT*I)R) at each
iteration, including NORM((A-SHIFT*I)B) as the first entry.
RESVEC and ARESVEC have length ITER+1.
See also BICG, BICGSTAB, BICGSTABL, CGS, GMRES, LSQR, PCG, QMR, SYMMLQ,
TFQMR, CHOLINC, FUNCTION_HANDLE.
Also MINRES, SYMMLQ, LSQR, CGLS downloadable from
http://www.stanford.edu/group/SOL/software.html
REFERENCES:
Sou-Cheng T. Choi and Michael A. Saunders,
ALGORITHM: MINRES-QLP for Singular Symmetric and Hermitian Linear
Equations and Least-Squares Problems, to appear in ACM Transactions on
Mathematical Software.
Sou-Cheng T. Choi, Christopher C. Paige, and Michael A. Saunders,
MINRES-QLP: A Krylov Subspace Method for Indefinite or Singular Symmetric
Systems, SIAM Journal on Scientific Computing, Vol. 33, No. 4, August
2011, pp. 1810--1836.
Sou-Cheng T. Choi's PhD Dissertation, Stanford University, 2006:
http://www.stanford.edu/group/SOL/dissertations.html
CURRENT / FUTURE RELEASES of minresqlp:
Version 2:
http://code.google.com/p/minres-qlp/
http://www.mathworks.com/matlabcentral/fileexchange
Version 1:
http://code.google.com/p/minres-qlp/
http://www.stanford.edu/group/SOL/download.html
Other implementations in Fortran 90/95, Python:
http://code.google.com/p/minres-qlp/
MODIFICATION HISTORY:
28 Jun 2013: Second version for MATLAB Central.
27 Jun 2013: (1) Fixed iteration log:
(a) The heading came out ok every 20 lines initially, but
stopped after itn 80.
(b) Subsequent output was for itns 109, 119, ... rather
than 110, 120,...
(2) Introduced local variable "likeLS", which is true if
Ax = b looks more like a least-squares system.
(3) Fixed an error in minresxxxM(). Moved two lines that
involve R into the else statement. Added code for handling
preconditioner as a function handle.
(4) Added debug statements.
28 Jul 2012: (1) Fixed a bug in pnorm_0 used in Anorm recurrence
relation so that {Anorm(k)} are monotonic increasing
underestimates of ||A||_2.
(2) Fixed SymOrtho to ensure the 2x2 Hermitian reflectors
are orthonormal.
20 Jul 2012: (1) Changed default RTOL to 1e-15 and default MAXIT to 4N.
(2) Initalized a few local variables to zeros.
12 May 2006: Created MINRESQLPs.m from research file minresqlp35.m.
19 Apr 2010: Help formatted like Matlab routines. Added output Aresvec.
25 Apr 2010: Eliminated unreferenced variables. Shortened
resvec and Aresvec from maxit to (iter+1).
The final rnorm, Arnorm, xnorm are computed directly.
26 Apr 2010: Special tests for beta2=0 and/or alfa1=0 when no
preconditioning.
02 May 2010: First version for
http://www.stanford.edu/group/SOL/software.html.
AUTHORS: Sou-Cheng (Terrya) Choi, CI, University of Chicago
Michael Saunders, SOL, Stanford University
COPYRIGHT NOTICE:
This is Copyrighted Material. The software is COPYRIGHTED by the
original authors.
COPYLEFT NOTICE:
Permission is granted to make and distribute verbatim copies of this
file, provided that the entire file is copied **together** as a
**unit**.
The purpose of this permission notice is to allow you to make copies
of the software and distribute them to others, for free or for a fee,
subject to the constraint that you maintain the entire file here
as a unit. This enables people you give the software to be aware
of its origins, to ask questions of us by e-mail, to request
improvements, obtain later releases, and so forth.
If you seek permission to copy and distribute translations of this
software into another language, please e-mail a specific request to
saunders@stanford.edu and scchoi@stanford.edu.
If you seek permission to excerpt a **part** of the software library,
for example to appear in a scientific publication, please e-mail a
specific request to saunders@stanford.edu and scchoi@stanford.edu.
COMMENTS?
Email sctchoi@uchicago.edu and saunders@stanford.edu
*)
minres1::usage = "MINRES-QLP solver for symmetric indefinte linear systems. The matrix can be expressed as a pure function that acts on a vector.";
minres1::indefinite = "`1` appears to be indefinite.";
Options[minres1] = {rTolerance -> $MachineEpsilon,
maxIterations -> Automatic, maxXNorm -> 10.0^7, stepMonitor -> None,
aConditionLimit -> 10.0^15,
printDetails -> False, returnVectors->True};
minres1[A_?MatrixQ, rest__] := minres1[(A.#)&, rest];
minres1[A_, b_, M_?MatrixQ, rest___] :=
minres1[A, b, LinearSolve[M], rest];
minres1[A_Function, b_, M:(None|_Function|_LinearSolveFunction):None,
shift:_?NumberQ:0, OptionsPattern[]] :=
Module[{
(* MATLAB constants *)
eps = $MachineEpsilon,
realmax = $MaxMachineNumber,
realmin = $MinMachineNumber,
(* Mimic MATLAB function *)
zeros = Function[Array[0.0&, {##}]],
show = Replace[OptionValue[printDetails], {False -> 0, True -> 1}],
rtol = OptionValue[rTolerance], maxxnorm = OptionValue[maxXNorm],
Acondlim = OptionValue[aConditionLimit],
maxit = OptionValue[maxIterations],
debug = False,
n = Length[b],
resvec = None, Aresvec = None, r2, r3, beta1},
If[maxit === Automatic, maxit = 4 n];
If[OptionValue[returnVectors],
resvec = zeros[maxit + 1];
Aresvec = zeros[maxit + 1]];
(* Set up {beta1,p,v} for the first Lanczos vector v1. *)
r2 = N[b]; (* r2=b *)
r3 = r2; (* r3=b *)
beta1 = Norm[r2]; (* beta1=norm(b) *)
If[M =!= None,
r3 = M[r2]; (* M*r3=b *)
beta1 = Conjugate[r3].r2; (* beta1=b'*inv(M)*b *)
If[beta1 < 0,
Message[minres1::indefinite, "M"];
beta1 = $Failed,
beta1 = Sqrt[beta1]]];
(* Initialize other quantities. *)
Block[{
flag0 = -2, flag,
iter = 0,
lines = 1, headlines = 20,
beta = 0, tau = 0, taul = 0, phi = beta1,
betan = beta1, gmin = 0, cs = -1, sn = 0,
cr1 = -1, sr1 = 0, cr2 = -1, sr2 = 0,
dltan = 0, eplnn = 0, gama = 0, gamal = 0,
gamal2, eta = 0, etal = 0, etal2 = 0,
vepln = 0, veplnl = 0, veplnl2 = 0, ul3 = 0,
ul2 = 0, ul = 0, u, rnorm,
xnorm = 0, xl2norm = 0, Axnorm = 0,
Anorm = 0, Acond = 1,
gminl = 0,
relres,
relresl = 0,
relAresl = 0,
v, x, xl2, w, wl, wl2, r1,
betal, alfa, pnorm, dlta, gbar, xnorml, taul2, epln,
likeLS, Anorml, Acondl, rnorml, Arnorml, dltaQLP, gamaTmp, gamalTmp},
flag = flag0; rnorm = betan;
relres = rnorm/(beta1 + 10.0^-50); (* Safeguard for beta1=0 *)
x = zeros[n];
xl2 = x;
w = x;
wl = x;
r1 = x;
If[resvec =!= None, resvec[[1]] = Re[beta1]];
(* print header if show *)
Block[{first = "Enter minres1. ",
last = "Exit minres1. ",
msg = {
" beta2=0. b and x are eigenvectors ", (* -1 *)
" beta1=0. The exact solution is x = 0 ", (* 0 *)
" A solution to Ax = b found, given rtol ", (* 1 *)
" Min-length solution for singular LS problem, given rtol", (* 2 *)
" A solution to Ax = b found, given eps ", (* 3 *)
" Min-length solution for singular LS problem, given eps ", (* 4 *)
" x has converged to an eigenvector ", (* 5 *)
" xnorm has exceeded maxxnorm ", (* 6 *)
" Acond has exceeded Acondlim ", (* 7 *)
" The iteration limit was reached ", (* 8 *)
" Least-squares problem but no converged solution yet "}, (* 9 *)
head = {"iter", "rnorm", "Arnorm", "Compatible", "LS",
"Anorm","Acond","xnorm"}},
If[show > 1,
Print[first];
Print["Min-length solution of symmetric (A-sI)x = b or min ||(A-sI)x - b||"];
Print["n=", n, " ||b||=", beta1, " shift=", shift,
" rtol=", rtol];
Print["maxit=", maxit, " maxxnorm=", If[NumberQ[maxxnorm], maxxnorm,
"function"],
" Acondlim=", Acondlim];
Print[" ", head]];
If[beta1 == 0, flag = 0]; (* b=0 => x=0. We will skip the main loop. *)
(* Main iteration *)
While[flag == flag0 && iter < maxit,
(* Lanczos *)
iter = iter + 1;
betal = beta; beta = Re[betan];
v = r3*(1/beta); r3 = A[v];
If[shift != 0, r3 = r3 - shift*v];
If[iter > 1, r3 = r3 - (beta/betal)*r1];
alfa = Re[Conjugate[r3].v]; (* Allow for Hermitian A. Must get real alfa here. *)
r3 = r3 - (alfa/beta)*r2; r1 = r2; r2 = r3;
If[M === None,
betan = Norm[r3];
If[iter == 1, (* Something special can happen *)
If[betan == 0, (* beta2=0 *)
If[alfa == 0, (* alfa1=0 *)
flag = 0; (* Ab = 0 and x = 0 ("A" = (A - shift*I)) *)
Break[],
flag = -1; (* Ab = alfa1 b, x = b/alfa1, an eigenvector *)
x = N[b]/alfa;
Break[]]]],
r3 = M[r2]; betan = Conjugate[r2].r3;
If[betan > 0,
betan = Sqrt[betan],
Message[minres1::indefinite, "M"];
betan = $Failed]];
If[iter <= 2,
pnorm = Norm[{alfa, betan}],
pnorm = Norm[{betal, alfa, betan}]];
If[debug,
Print["Lanczos iteration ", iter, ":"];
Print[" v_", iter, " = ", Take[v, Min[n, 5]]];
Print[" r1_", iter, " = ", Take[r1, Min[n, 5]]];
Print[" r2_", iter, " = ", Take[r2, Min[n, 5]]];
Print[" r3_", iter, " = ", Take[r3, Min[n, 5]]];
Print[" alpha_", iter, " = ", alfa, ", beta_", iter, " = ",
beta, ", beta_", iter + 1, " = ", betan, " pnorm_", iter,
" = ", pnorm]];
(* Apply previous left reflection Q_{k-1} *)
Block[{dbar = dltan},
dlta = cs*dbar + sn*alfa; epln = eplnn;
gbar = sn*dbar - cs*alfa; eplnn = sn*betan;
dltan = -cs*betan; dltaQLP = dlta;
If[debug,
Print["Apply previous left reflection Q_{", iter-1, ",", iter, "}:"];
Print[" c_", iter-1, " = ", cs,", s_", iter-1," = ",sn];
Print[" dlta_", iter, " = ", dlta, ", gbar_", iter, " = ", gbar];
Print[" epln_", iter+1, " = ", eplnn, ", dbar_", iter+1," = ",dltan]]];
(* Compute the current left reflection Q_k *)
gamal2 = gamal; gamal = gama;
{cs, sn, gama} = SymOrtho[gbar, betan]; gamaTmp = gama;
taul2 = taul; taul = tau; tau = cs*phi;
Axnorm = Norm[{Axnorm, tau}]; phi = sn*phi;
If[debug,
Print["Compute the current left reflection Q_{",iter,",",iter+1,"}:"];
Print[" c_",iter, " = ",cs, ", s_",iter," = ",sn];
Print[" tau_",iter," = ",tau,", phi_",iter," = ",phi];
Print[" gama_", iter, " = ", gama]];
(* Apply the previous right reflection P{k-2,k} *)
Block[{dltaTmp},
If[iter > 2,
veplnl2 = veplnl; etal2 = etal; etal = eta;
dltaTmp = sr2*vepln - cr2*dlta;
veplnl = cr2*vepln + sr2*dlta;
dlta = dltaTmp; eta = sr2*gama; gama = -cr2*gama;
If[debug,
Print["Apply the previous right reflection P_{",iter-2,",",iter,"}:"];
Print[" cr2_",iter, " = ",cr2,", sr2_",iter, " = ",sr2];
Print[" gama_",iter-2, " = ", gamal2, ", gama_",iter-1,
" = ",gamal,", gama_",iter," = ",gama];
Print[" dlta_",iter, " = ", dlta, ", vepln_",iter-1,
" = ",veplnl, ", eta_",iter," = ", eta]]]];
(* Compute the current right reflection P{k-1,k}, P_12, P_23, ... *)
If[iter > 1,
{cr1, sr1, gamal} = SymOrtho[gamal, dlta];
vepln = sr1*gama;
gama = -cr1*gama;
If[debug,
Print["Compute the second current right reflections P_{",iter-1,",",iter,"}:"];
Print[" cr1_",iter, " = ", cr1, ", sr1_",iter," = " sr1];
Print[" gama_",iter-1, " = ", gamal, ", gama_",iter,
" = ", gama, ", vepln_",iter, " = ", vepln]]];
(* Update xnorm *)
Block[{ul4 = ul3,xnormTmp},
xnorml = xnorm; ul3 = ul2;
If[iter > 2,
ul2 = (taul2 - etal2*ul4 - veplnl2*ul3)/gamal2];
If[iter > 1,
ul = (taul - etal*ul3 - veplnl*ul2)/gamal];
xnormTmp = Norm[{xl2norm, ul2, ul}];
likeLS = (relresl >= relAresl);
If[Abs[gama] > realmin && xnormTmp < maxxnorm,
u = (tau - eta*ul2 - vepln*ul)/gama;
If[Norm[{xnormTmp, u}] > maxxnorm && likeLS,
u = 0; flag = 6],
u = 0; flag = 9];
xl2norm = Norm[{xl2norm, ul2}];
xnorm = Norm[{xl2norm, ul, u}]];
(* Update w. Update x except if it will become too big *)
(* MINRES updates *)
wl2 = wl; wl = w;
w = (v - epln*wl2 - dltaQLP*wl)*(1/gamaTmp);
If[xnorm < maxxnorm,
x = x + tau*w,
flag = 6];
If[OptionValue[stepMonitor] =!= None,
OptionValue[stepMonitor][iter, x, w, v]];
If[debug,
Print["Update w:"];
Print[" w_",iter, " = ", Take[wl, Min[n, 5]]];
Print[" w_",iter, " = ", Take[w, Min[n, 5]]];
Print["Update u, x and xnorm:"];
Print[" u_",iter - 2, " = ", ul2, ", u_",iter - 1,
" = ", ul, ", u_",iter, " = ", u];
Print[" x_",iter, " = ", Take[x, Min[n, 5]]];
Print[" ||x_",iter, "|| = ", xnorm]];
(* Compute the next right reflection P{k-1,k+1} *)
gamalTmp = gamal;
{cr2, sr2, gamal} = SymOrtho[gamal, eplnn];
(* Estimate various norms *)
Block[{gminl2, rootl, absGama},
absGama = Abs[gama]; Anorml = Anorm;
Anorm = Max[{Anorm, gamal, absGama, pnorm}];
Which[iter == 1,
gmin = gama; gminl = gmin,
iter > 1,
gminl2 = gminl; gminl = gmin; gmin = Min[{gminl2, gamal, absGama}]];
Acondl = Acond; Acond = Anorm/gmin;
rnorml = rnorm; relresl = relres;
If[flag != 9,
rnorm = phi];
relres = rnorm/(Anorm*xnorm + beta1);
rootl = Norm[{gbar, dltan}];
Arnorml = rnorml*rootl;
relAresl = rootl/Anorm];
(* See if any of the stopping criteria are satisfied. *)
Block[{epsx = Anorm*xnorm*eps, t1, t2},
If[flag == flag0 || flag == 9,
t1 = 1 + relres;
t2 = 1 + relAresl;
If[iter >= maxit, flag = 8]; (* Too many itns *)
If[Acond >= Acondlim, flag = 7]; (* Huge Acond *)
If[xnorm >= maxxnorm, flag = 6]; (* xnorm exceeded its limit *)
If[epsx >= beta1, flag = 5]; (* x is an eigenvector *)
If[t2 <= 1, flag = 4]; (* Accurate LS solution *)
If[t1 <= 1, flag = 3]; (* Accurate Ax=b solution *)
If[relAresl <= rtol, flag = 2]; (* Good enough LS solution *)
If[relres <= rtol, flag = 1]; (* Good enough Ax=b solution *)
If[debug,
Print["Update other norms:"];
Print[" gmin_",iter, " = ", gmin];
Print[" pnorm_",iter, " = ", pnorm];
Print[" rnorm_",iter, " = ", rnorm];
Print[" Arnorm_",iter - 1, " = ", Arnorml];
Print[" Acond_",iter, " = ", Acond]]]];
(*
The "disable" option allowed iterations to continue until xnorm
became large and x was effectively a nullvector.
We know that r will become a nullvector much sooner,
so we now disable the disable option. :-)
If[disable && (iter<maxit),
flag=0;
If[Axnorm<rtol*Anorm*xnorm,
flag=10]];
*)
If[flag == 2 || flag == 4 || (flag == 6 && likeLS) || flag == 7, (* Possibly singular *)
iter = iter - 1;
Acond = Acondl; rnorm = rnorml; relres = relresl,
If[resvec =!= None,
resvec[[iter + 1]] = rnorm;
Aresvec[[iter]] = Arnorml];
If[show > 1 && Mod[iter-1,lines] == 0,
Which[iter == 101,
lines = 10; headlines = 20*lines,
iter == 1001,
lines = 100; headlines = 20*lines];
Print[" ",
{iter-1, rnorml, Arnorml,
relresl, relAresl, Anorml, Acondl, xnorml}];
If[iter > 1 && Mod[iter, headlines] == 1,
Print[head]]]]];
(* We have exited the main loop. *)
Block[{Arnorm, relAres,
start = " "},
(* Compute final quantities directly. *)
r1 = b - A[x] + shift*x; (* r1 is workspace for residual vector *)
rnorm = Norm[r1];
Arnorm = Norm[A[r1] - shift*r1];
xnorm = Norm[x];
relres = rnorm/(Anorm*xnorm + beta1);
relAres = 0;
If[rnorm > realmin, relAres = Arnorm/(Anorm*rnorm)];
If[Aresvec =!= None,
Aresvec[[iter + 1]] = Arnorm;
Aresvec = Take[Aresvec,iter + 1]];
If[resvec =!= None,
resvec = Take[resvec,iter + 1]];
If[show > 1,
If[rnorm > realmin,
Print[start, {iter, rnorm, Arnorm, relres, relAres, Anorm,
Acond, xnorm}],
Print[start, {iter, rnorm, Arnorm, relres, 0, Anorm, Acond,
xnorm}]]];
If[show > 0,
Print[last, " flag=", flag, " ", msg[[flag + 2]]];
Print[last, " iter=", iter];
Print[last, " rnorm=", rnorm, " rnorm direct=", Norm[r1]];
Print[last, " Arnorm direct=", Arnorm];
Print[last, " xnorm=", xnorm, " xnorm direct=", Norm[x]];
Print[last, " Anorm=", Anorm, " Acond=", Acond]];
(* Return values *)
{x, flag, iter, relres, relAres, Anorm, Acond, xnorm, Axnorm,
resvec, Aresvec}]]]];
(*
SymOrtho: Stable Symmetric Householder reflection
INPUTS:
a first element of a two-vector (a, b)
b second element of a two-vector (a, b)
OUTPUTS:
c cosine(theta), where theta is the implicit angle of rotation
(counter-clockwise) in a plane-rotation
s sine(theta)
r two-norm of (a, b)
DESCRIPTION:
Stable symmetric Householder reflection that gives c and s such that
( c s )(a) = (d),
( s -c )(b) = (0)
where d = two-norm of vector (a, b),
c = a / sqrt(a^2 + b^2) = a / d,
s = b / sqrt(a^2 + b^2) = b / d.
The implementation guards against overlow in computing sqrt(a^2 + b^2).
EXAMPLE:
description
SEE ALSO:
TESTSYMGIVENS.m,
PLANEROT (MATLAB's function) --- 4 divisions while 2 would be enough,
though not too time-consuming on modern machines
REFERENCES:
Algorithm 4.9, stable *unsymmetric* Givens rotations in
Golub and van Loan's book Matrix Computations, 3rd edition.
MODIFICATION HISTORY:
10/06/2004: Replace d = norm([a,b]) by
d = a/c if |b| < |a| or b/s otherwise.
10/07/2004: First two cases (either b or a == 0) rewritten to make sure
(1) d >= 0
(2) if [a,b] = 0, then c = 1 and s = 0 but not c = s = 0.
09/27/2011: Change filename from SYMGIVENS2 to SYMORTHO.
01/16/2012: Change file from SYMORTHO to SYMREFL.
KNOWN BUGS:
MM/DD/2004: description
AUTHORS: Sou-Cheng (Terrya) Choi, CI, University of Chicago
Michael Saunders, SOL, Stanford University
CREATION DATE: 09/28/2004
*)
SymOrtho[a_, b_] := Block[{
absa = Abs[a],
absb = Abs[b],
signa = Sign[a],
signb = Sign[b],
t,c,s,r},
If[ Im[a]==0 && Im[b]==0,
(* Both a and b are real numbers *)
(* Special cases: a or b is 0 *)
Which[b == 0,
If[a == 0,
c = 1.0,
c = signa]; (* NOTE: Sign(0) = 0 in Mathematica *)
s = 0;
r = absa,
a == 0,
c = 0;
s = signb;
r = absb,
(* Both a and b are non-zero *)
absb > absa,
t = a/b;
s = signb / Sqrt[1 + t^2];
c = s*t;
r = b/s, (* computationally better than d = a / c since |c| <= |s| *)
True,
t = b/a;
c = signa / Sqrt[1 + t^2];
s = c*t;
r = a/c], (* computationally better than d = b / s since |s| <= |c| *)
(* a and/or b are complex numbers *)
(* Special cases: a or b is 0 *)
Which[ b == 0,
c = 1;
s = 0;
r = a,
a == 0,
c = 0;
s = 1;
r = b,
(* Both a and b are non-zero *)
absb > absa,
t = absa/absb;
c = 1/Sqrt[1+t^2]; (* temporary *)
s = c*Conjugate[signb/signa];
c = c*t;
r = b/Conjugate[s],
True,
t = absb/absa;
c = 1/Sqrt[1+t^2];
s = c*t*Conjugate[signb/signa];
r = a/c]];
{c, s, r}];