-
Notifications
You must be signed in to change notification settings - Fork 40
/
appendix.html
2430 lines (2195 loc) · 263 KB
/
appendix.html
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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Parameters Description — PRIMME 3.2 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Singular Value Problems" href="apisvds.html" />
<link rel="prev" title="MATLAB Interface" href="mateigs.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: white" >
<a href="readme.html">
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">PRIMME: PReconditioned Iterative MultiMethod Eigensolver</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apieigs.html">Eigenvalue Problems</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="primmec.html">C Library Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="primmef77.html">FORTRAN 77 Library Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="primmef90.html">FORTRAN 90 Library Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyeigsh.html">Python Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="mateigs.html">MATLAB Interface</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Parameters Description</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#types">Types</a></li>
<li class="toctree-l3"><a class="reference internal" href="#other-macros">Other macros</a></li>
<li class="toctree-l3"><a class="reference internal" href="#primme-params">primme_params</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#preset-methods">Preset Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="#error-codes">Error Codes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apisvds.html">Singular Value Problems</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="readme.html">PRIMME</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="readme.html" class="icon icon-home"></a> »</li>
<li><a href="apieigs.html">Eigenvalue Problems</a> »</li>
<li>Parameters Description</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/appendix.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
<a href="apisvds.html" class="btn btn-neutral float-right" title="Singular Value Problems" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mateigs.html" class="btn btn-neutral float-left" title="MATLAB Interface" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="parameters-description">
<h1>Parameters Description<a class="headerlink" href="#parameters-description" title="Permalink to this headline">¶</a></h1>
<div class="section" id="types">
<h2>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h2>
<p>The following data types are macros used in PRIMME as followed.</p>
<dl class="c type">
<dt id="c.PRIMME_INT">
<em class="property">type </em><code class="sig-name descname">PRIMME_INT</code><a class="headerlink" href="#c.PRIMME_INT" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Integer type used in matrix dimensions (such as <a class="reference internal" href="#c.primme_params.n" title="primme_params.n"><code class="xref c c-member docutils literal notranslate"><span class="pre">n</span></code></a> and <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a>) and counters (such as <a class="reference internal" href="#c.primme_params.stats.numMatvecs" title="primme_params.stats.numMatvecs"><code class="xref c c-member docutils literal notranslate"><span class="pre">numMatvecs</span></code></a>).</p>
<p>The integer size is controlled by the compilation flag <code class="docutils literal notranslate"><span class="pre">PRIMME_INT_SIZE</span></code>, see <a class="reference internal" href="intro.html#making"><span class="std std-ref">Making and Linking</span></a>.</p>
</dd></dl>
<dl class="c type">
<dt id="c.PRIMME_HALF">
<em class="property">type </em><code class="sig-name descname">PRIMME_HALF</code><a class="headerlink" href="#c.PRIMME_HALF" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Macro that is <code class="docutils literal notranslate"><span class="pre">__fp16</span></code> if half precision is supported by the compiler.
Otherwise it is a struct with the same size as <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">short</span></code>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c type">
<dt id="c.PRIMME_COMPLEX_HALF">
<em class="property">type </em><code class="sig-name descname">PRIMME_COMPLEX_HALF</code><a class="headerlink" href="#c.PRIMME_COMPLEX_HALF" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Macro that is a struct with fields <code class="docutils literal notranslate"><span class="pre">r</span></code> and <code class="docutils literal notranslate"><span class="pre">i</span></code> with type <code class="docutils literal notranslate"><span class="pre">PRIMME_HALF</span></code>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c type">
<dt id="c.PRIMME_COMPLEX_FLOAT">
<em class="property">type </em><code class="sig-name descname">PRIMME_COMPLEX_FLOAT</code><a class="headerlink" href="#c.PRIMME_COMPLEX_FLOAT" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Macro that is <code class="docutils literal notranslate"><span class="pre">complex</span> <span class="pre">float</span></code> in C and <code class="docutils literal notranslate"><span class="pre">std::complex<float></span></code> in C++.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.0.</span></p>
</div>
</dd></dl>
<dl class="c type">
<dt id="c.PRIMME_COMPLEX_DOUBLE">
<em class="property">type </em><code class="sig-name descname">PRIMME_COMPLEX_DOUBLE</code><a class="headerlink" href="#c.PRIMME_COMPLEX_DOUBLE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Macro that is <code class="docutils literal notranslate"><span class="pre">complex</span> <span class="pre">double</span></code> in C and <code class="docutils literal notranslate"><span class="pre">std::complex<double></span></code> in C++.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.0.</span></p>
</div>
</dd></dl>
</div>
<div class="section" id="other-macros">
<h2>Other macros<a class="headerlink" href="#other-macros" title="Permalink to this headline">¶</a></h2>
<dl class="c macro">
<dt id="c.PRIMME_VERSION_MAJOR">
<code class="sig-name descname">PRIMME_VERSION_MAJOR</code><a class="headerlink" href="#c.PRIMME_VERSION_MAJOR" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constant <code class="docutils literal notranslate"><span class="pre">int</span></code> with the major version number.</p>
<p>For instance, the value of the macro is <code class="docutils literal notranslate"><span class="pre">3</span></code> for version 3.0.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c macro">
<dt id="c.PRIMME_VERSION_MINOR">
<code class="sig-name descname">PRIMME_VERSION_MINOR</code><a class="headerlink" href="#c.PRIMME_VERSION_MINOR" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constant <code class="docutils literal notranslate"><span class="pre">int</span></code> with the minor version number.</p>
<p>For instance, the value of the macro is <code class="docutils literal notranslate"><span class="pre">0</span></code> for version 3.0.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
</div>
<div class="section" id="primme-params">
<h2>primme_params<a class="headerlink" href="#primme-params" title="Permalink to this headline">¶</a></h2>
<dl class="c type">
<dt id="c.primme_params">
<em class="property">type </em><code class="sig-name descname">primme_params</code><a class="headerlink" href="#c.primme_params" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Structure to set the problem matrices and eigensolver options.</p>
<dl class="c member">
<dt id="c.primme_params.n">
<a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> <code class="sig-name descname">n</code><a class="headerlink" href="#c.primme_params.n" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Dimension of the matrix.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.matrixMatvec">
void (*<code class="sig-name descname">matrixMatvec</code>)<span class="sig-paren">(</span>void *x, <a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> *ldx, void *y, <a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> *ldy, int *blockSize, <a class="reference internal" href="#c.primme_params" title="primme_params">primme_params</a> *primme, int *ierr<span class="sig-paren">)</span><a class="headerlink" href="#c.primme_params.matrixMatvec" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Block matrix-multivector multiplication, <span class="math notranslate nohighlight">\(y = A x\)</span> in solving <span class="math notranslate nohighlight">\(A x = \lambda x\)</span> or <span class="math notranslate nohighlight">\(A x = \lambda B x\)</span>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – matrix of size <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a> x <code class="docutils literal notranslate"><span class="pre">blockSize</span></code> in <a class="reference external" href="https://en.wikipedia.org/wiki/Row-major_order">column-major</a> order with leading dimension <code class="docutils literal notranslate"><span class="pre">ldx</span></code>.</p></li>
<li><p><strong>ldx</strong> – the leading dimension of the array <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p><strong>y</strong> – matrix of size <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a> x <code class="docutils literal notranslate"><span class="pre">blockSize</span></code> in <a class="reference external" href="https://en.wikipedia.org/wiki/Row-major_order">column-major</a> order with leading dimension <code class="docutils literal notranslate"><span class="pre">ldy</span></code>.</p></li>
<li><p><strong>ldy</strong> – the leading dimension of the array <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>blockSize</strong> – number of columns in <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>primme</strong> – parameters structure.</p></li>
<li><p><strong>ierr</strong> – output error code; if it is set to non-zero, the current call to PRIMME will stop.</p></li>
</ul>
</dd>
</dl>
<p>The actual type of <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> matches the type of <code class="docutils literal notranslate"><span class="pre">evecs</span></code> of the
calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant), unless the user sets <a class="reference internal" href="#c.primme_params.matrixMatvec_type" title="primme_params.matrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec_type</span></code></a> to
another precision.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to NULL;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you have performance issues with leading dimension different from <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a>,
set <a class="reference internal" href="#c.primme_params.ldOPs" title="primme_params.ldOPs"><code class="xref c c-member docutils literal notranslate"><span class="pre">ldOPs</span></code></a> to <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a>.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.matrixMatvec_type">
primme_op_datatype <code class="sig-name descname">matrixMatvec_type</code><a class="headerlink" href="#c.primme_params.matrixMatvec_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> passed to <a class="reference internal" href="#c.primme_params.matrixMatvec" title="primme_params.matrixMatvec"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec</span></code></a>.</p>
<p>If it is <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>, the vectors’ type matches the calling
<a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant). Otherwise, the user can force the precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> to be a particular precision regardless of the calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant) function: half,
single, or double, if <a class="reference internal" href="#c.primme_params.matrixMatvec_type" title="primme_params.matrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec_type</span></code></a> is <code class="docutils literal notranslate"><span class="pre">primme_half</span></code>, <code class="docutils literal notranslate"><span class="pre">primme_float</span></code>
or <code class="docutils literal notranslate"><span class="pre">primme_double</span></code> respectively.</p>
<p>It is not recommended to set a lower precision than the one required to converge.
An example of this is calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> setting <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a> to 1e-10 and <a class="reference internal" href="#c.primme_params.matrixMatvec_type" title="primme_params.matrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec_type</span></code></a> to <code class="docutils literal notranslate"><span class="pre">primme_op_half</span></code>.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>, and if it is
<code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code> it is set to the value that matches the precision of
calling function.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.applyPreconditioner">
void (*<code class="sig-name descname">applyPreconditioner</code>)<span class="sig-paren">(</span>void *x, <a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> *ldx, void *y, <a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> *ldy, int *blockSize, <a class="reference internal" href="#c.primme_params" title="primme_params">primme_params</a> *primme, int *ierr<span class="sig-paren">)</span><a class="headerlink" href="#c.primme_params.applyPreconditioner" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Block preconditioner-multivector application, <span class="math notranslate nohighlight">\(y = M^{-1}x\)</span> where <span class="math notranslate nohighlight">\(M\)</span> is usually an approximation of <span class="math notranslate nohighlight">\(A - \sigma I\)</span> or <span class="math notranslate nohighlight">\(A - \sigma B\)</span> for finding eigenvalues close to <span class="math notranslate nohighlight">\(\sigma\)</span>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – matrix of size <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a> x <code class="docutils literal notranslate"><span class="pre">blockSize</span></code> in <a class="reference external" href="https://en.wikipedia.org/wiki/Row-major_order">column-major</a> order with leading dimension <code class="docutils literal notranslate"><span class="pre">ldx</span></code>.</p></li>
<li><p><strong>ldx</strong> – the leading dimension of the array <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p><strong>y</strong> – matrix of size <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a> x <code class="docutils literal notranslate"><span class="pre">blockSize</span></code> in <a class="reference external" href="https://en.wikipedia.org/wiki/Row-major_order">column-major</a> order with leading dimension <code class="docutils literal notranslate"><span class="pre">ldy</span></code>.</p></li>
<li><p><strong>ldy</strong> – the leading dimension of the array <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>blockSize</strong> – number of columns in <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>primme</strong> – parameters structure.</p></li>
<li><p><strong>ierr</strong> – output error code; if it is set to non-zero, the current call to PRIMME will stop.</p></li>
</ul>
</dd>
</dl>
<p>The actual type of <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> matches the type of <code class="docutils literal notranslate"><span class="pre">evecs</span></code> of the
calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant), unless the user sets <a class="reference internal" href="#c.primme_params.applyPreconditioner_type" title="primme_params.applyPreconditioner_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">applyPreconditioner_type</span></code></a> to
another precision.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to NULL;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.applyPreconditioner_type">
primme_op_datatype <code class="sig-name descname">applyPreconditioner_type</code><a class="headerlink" href="#c.primme_params.applyPreconditioner_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> passed to <a class="reference internal" href="#c.primme_params.applyPreconditioner" title="primme_params.applyPreconditioner"><code class="xref c c-member docutils literal notranslate"><span class="pre">applyPreconditioner</span></code></a>.</p>
<p>If it is <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>, the vectors’ type matches the calling
<a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant). Otherwise, the user can force the precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> to be a particular precision regardless of the calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant) function: half,
single, or double, if <a class="reference internal" href="#c.primme_params.matrixMatvec_type" title="primme_params.matrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec_type</span></code></a> is <code class="docutils literal notranslate"><span class="pre">primme_half</span></code>, <code class="docutils literal notranslate"><span class="pre">primme_float</span></code>
or <code class="docutils literal notranslate"><span class="pre">primme_double</span></code> respectively.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>, and if it is
<code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code> it is set to the value that matches the precision of
calling function.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.massMatrixMatvec">
void (*<code class="sig-name descname">massMatrixMatvec</code>)<span class="sig-paren">(</span>void *x, <a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> *ldx, void *y, <a class="reference internal" href="#c.PRIMME_INT" title="PRIMME_INT">PRIMME_INT</a> *ldy, int *blockSize, <a class="reference internal" href="#c.primme_params" title="primme_params">primme_params</a> *primme, int *ierr<span class="sig-paren">)</span><a class="headerlink" href="#c.primme_params.massMatrixMatvec" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Block matrix-multivector multiplication, <span class="math notranslate nohighlight">\(y = B x\)</span> in solving <span class="math notranslate nohighlight">\(A x = \lambda B x\)</span>.
If it is NULL, the standard eigenvalue problem <span class="math notranslate nohighlight">\(A x = \lambda x\)</span> is solved.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – matrix of size <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a> x <code class="docutils literal notranslate"><span class="pre">blockSize</span></code> in <a class="reference external" href="https://en.wikipedia.org/wiki/Row-major_order">column-major</a> order with leading dimension <code class="docutils literal notranslate"><span class="pre">ldx</span></code>.</p></li>
<li><p><strong>ldx</strong> – the leading dimension of the array <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p><strong>y</strong> – matrix of size <a class="reference internal" href="#c.primme_params.nLocal" title="primme_params.nLocal"><code class="xref c c-member docutils literal notranslate"><span class="pre">nLocal</span></code></a> x <code class="docutils literal notranslate"><span class="pre">blockSize</span></code> in <a class="reference external" href="https://en.wikipedia.org/wiki/Row-major_order">column-major</a> order with leading dimension <code class="docutils literal notranslate"><span class="pre">ldy</span></code>.</p></li>
<li><p><strong>ldy</strong> – the leading dimension of the array <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>blockSize</strong> – number of columns in <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></li>
<li><p><strong>primme</strong> – parameters structure.</p></li>
<li><p><strong>ierr</strong> – output error code; if it is set to non-zero, the current call to PRIMME will stop.</p></li>
</ul>
</dd>
</dl>
<p>The actual type of <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> matches the type of <code class="docutils literal notranslate"><span class="pre">evecs</span></code> of the
calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant), unless the user sets <a class="reference internal" href="#c.primme_params.matrixMatvec_type" title="primme_params.matrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec_type</span></code></a> to
another precision.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to NULL;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.massMatrixMatvec_type">
primme_op_datatype <code class="sig-name descname">massMatrixMatvec_type</code><a class="headerlink" href="#c.primme_params.massMatrixMatvec_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> passed to <a class="reference internal" href="#c.primme_params.massMatrixMatvec" title="primme_params.massMatrixMatvec"><code class="xref c c-member docutils literal notranslate"><span class="pre">massMatrixMatvec</span></code></a>.</p>
<p>If it is <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>, the vectors’ type matches the calling
<a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant). Otherwise, the user can force the precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> to be a particular precision regardless of the calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant) function: half,
single, or double, if <a class="reference internal" href="#c.primme_params.massMatrixMatvec_type" title="primme_params.massMatrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">massMatrixMatvec_type</span></code></a> is <code class="docutils literal notranslate"><span class="pre">primme_half</span></code>, <code class="docutils literal notranslate"><span class="pre">primme_float</span></code>
or <code class="docutils literal notranslate"><span class="pre">primme_double</span></code> respectively.</p>
<p>It is not recommended to set a lower precision than the one required to converge.
An example of this is calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> setting <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a> to 1e-10 and <a class="reference internal" href="#c.primme_params.massMatrixMatvec_type" title="primme_params.massMatrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">massMatrixMatvec_type</span></code></a> to <code class="docutils literal notranslate"><span class="pre">primme_op_half</span></code>.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>, and if it is
<code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code> it is set to the value that matches the precision of
calling function.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.numProcs">
int <code class="sig-name descname">numProcs</code><a class="headerlink" href="#c.primme_params.numProcs" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Number of processes calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> or <a class="reference internal" href="primmec.html#c.zprimme" title="zprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">zprimme()</span></code></a> in parallel.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 1;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.procID">
int <code class="sig-name descname">procID</code><a class="headerlink" href="#c.primme_params.procID" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The identity of the local process within a parallel execution calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> or
<a class="reference internal" href="primmec.html#c.zprimme" title="zprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">zprimme()</span></code></a>.
Only the process with id 0 prints information.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0;</div>
<div class="line"><a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> sets this field to 0 if <a class="reference internal" href="#c.primme_params.numProcs" title="primme_params.numProcs"><code class="xref c c-member docutils literal notranslate"><span class="pre">numProcs</span></code></a> is 1;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.nLocal">
int <code class="sig-name descname">nLocal</code><a class="headerlink" href="#c.primme_params.nLocal" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Number of local rows on this process.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to -1;</div>
<div class="line"><a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> sets this field to <a class="reference internal" href="#c.primme_params.n" title="primme_params.n"><code class="xref c c-member docutils literal notranslate"><span class="pre">n</span></code></a> if <a class="reference internal" href="#c.primme_params.numProcs" title="primme_params.numProcs"><code class="xref c c-member docutils literal notranslate"><span class="pre">numProcs</span></code></a> is 1;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.commInfo">
void *<code class="sig-name descname">commInfo</code><a class="headerlink" href="#c.primme_params.commInfo" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>A pointer to whatever parallel environment structures needed.
For example, with MPI, it could be a pointer to the MPI communicator.
PRIMME does not use this. It is available for possible use in
user functions defined in <a class="reference internal" href="#c.primme_params.matrixMatvec" title="primme_params.matrixMatvec"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec</span></code></a>,
<a class="reference internal" href="#c.primme_params.applyPreconditioner" title="primme_params.applyPreconditioner"><code class="xref c c-member docutils literal notranslate"><span class="pre">applyPreconditioner</span></code></a>, <a class="reference internal" href="#c.primme_params.massMatrixMatvec" title="primme_params.massMatrixMatvec"><code class="xref c c-member docutils literal notranslate"><span class="pre">massMatrixMatvec</span></code></a>,
<a class="reference internal" href="#c.primme_params.globalSumReal" title="primme_params.globalSumReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal</span></code></a>, and <a class="reference internal" href="#c.primme_params.broadcastReal" title="primme_params.broadcastReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">broadcastReal</span></code></a>.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to NULL;</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.globalSumReal">
void (*<code class="sig-name descname">globalSumReal</code>)<span class="sig-paren">(</span>void *sendBuf, void *recvBuf, int *count, <a class="reference internal" href="#c.primme_params" title="primme_params">primme_params</a> *primme, int *ierr<span class="sig-paren">)</span><a class="headerlink" href="#c.primme_params.globalSumReal" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Global sum reduction function. No need to set for sequential programs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sendBuf</strong> – array of size <code class="docutils literal notranslate"><span class="pre">count</span></code> with the local input values.</p></li>
<li><p><strong>recvBuf</strong> – array of size <code class="docutils literal notranslate"><span class="pre">count</span></code> with the global output values
so that the i-th element of recvBuf is the sum over all processes of the i-th element
of <code class="docutils literal notranslate"><span class="pre">sendBuf</span></code>.</p></li>
<li><p><strong>count</strong> – array size of <code class="docutils literal notranslate"><span class="pre">sendBuf</span></code> and <code class="docutils literal notranslate"><span class="pre">recvBuf</span></code>.</p></li>
<li><p><strong>primme</strong> – parameters structure.</p></li>
<li><p><strong>ierr</strong> – output error code; if it is set to non-zero, the current call to PRIMME will stop.</p></li>
</ul>
</dd>
</dl>
<p>The actual type of <code class="docutils literal notranslate"><span class="pre">sendBuf</span></code> and <code class="docutils literal notranslate"><span class="pre">recvBuf</span></code> matches the type of <code class="docutils literal notranslate"><span class="pre">evecs</span></code> of the
calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant), unless the user sets <a class="reference internal" href="#c.primme_params.globalSumReal_type" title="primme_params.globalSumReal_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal_type</span></code></a> to
another precision. See the recomendation about precision in <a class="reference internal" href="#c.primme_params.globalSumReal_type" title="primme_params.globalSumReal_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal_type</span></code></a>.</p>
<p>Note that <code class="docutils literal notranslate"><span class="pre">count</span></code> is the number of values of the real type.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to an internal function;</div>
<div class="line"><a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> sets this field to an internal function if <a class="reference internal" href="#c.primme_params.numProcs" title="primme_params.numProcs"><code class="xref c c-member docutils literal notranslate"><span class="pre">numProcs</span></code></a> is 1 and <a class="reference internal" href="#c.primme_params.globalSumReal" title="primme_params.globalSumReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal</span></code></a> is NULL;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<p>When MPI is used, this can be a simply wrapper to MPI_Allreduce() as shown below:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="nf">par_GlobalSumForDouble</span><span class="p">(</span><span class="kt">void</span> <span class="o">*</span><span class="n">sendBuf</span><span class="p">,</span> <span class="kt">void</span> <span class="o">*</span><span class="n">recvBuf</span><span class="p">,</span> <span class="kt">int</span> <span class="o">*</span><span class="n">count</span><span class="p">,</span>
<span class="n">primme_params</span> <span class="o">*</span><span class="n">primme</span><span class="p">,</span> <span class="kt">int</span> <span class="o">*</span><span class="n">ierr</span><span class="p">)</span> <span class="p">{</span>
<span class="n">MPI_Comm</span> <span class="n">communicator</span> <span class="o">=</span> <span class="o">*</span><span class="p">(</span><span class="n">MPI_Comm</span> <span class="o">*</span><span class="p">)</span> <span class="n">primme</span><span class="o">-></span><span class="n">commInfo</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="n">sendBuf</span> <span class="o">==</span> <span class="n">recvBuf</span><span class="p">)</span> <span class="p">{</span>
<span class="o">*</span><span class="n">ierr</span> <span class="o">=</span> <span class="n">MPI_Allreduce</span><span class="p">(</span><span class="n">MPI_IN_PLACE</span><span class="p">,</span> <span class="n">recvBuf</span><span class="p">,</span> <span class="o">*</span><span class="n">count</span><span class="p">,</span> <span class="n">MPIU_REAL</span><span class="p">,</span> <span class="n">MPI_SUM</span><span class="p">,</span> <span class="n">communicator</span><span class="p">)</span> <span class="o">!=</span> <span class="n">MPI_SUCCESS</span><span class="p">;</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="o">*</span><span class="n">ierr</span> <span class="o">=</span> <span class="n">MPI_Allreduce</span><span class="p">(</span><span class="n">sendBuf</span><span class="p">,</span> <span class="n">recvBuf</span><span class="p">,</span> <span class="o">*</span><span class="n">count</span><span class="p">,</span> <span class="n">MPIU_REAL</span><span class="p">,</span> <span class="n">MPI_SUM</span><span class="p">,</span> <span class="n">communicator</span><span class="p">)</span> <span class="o">!=</span> <span class="n">MPI_SUCCESS</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>When calling <a class="reference internal" href="primmec.html#c.sprimme" title="sprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">sprimme()</span></code></a> and <a class="reference internal" href="primmec.html#c.cprimme" title="cprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">cprimme()</span></code></a> replace <code class="docutils literal notranslate"><span class="pre">MPI_DOUBLE</span></code> by <code class="docutils literal notranslate"><span class="pre">`MPI_FLOAT</span></code>.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 2.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.globalSumReal_type">
primme_op_datatype <code class="sig-name descname">globalSumReal_type</code><a class="headerlink" href="#c.primme_params.globalSumReal_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Precision of the vectors <code class="docutils literal notranslate"><span class="pre">sendBuf</span></code> and <code class="docutils literal notranslate"><span class="pre">recvBuf</span></code> passed to <a class="reference internal" href="#c.primme_params.globalSumReal" title="primme_params.globalSumReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal</span></code></a>.</p>
<p>If it is <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>, the vectors’ type matches the calling
<a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant). Otherwise, the user can force the precision of the vectors <code class="docutils literal notranslate"><span class="pre">sendBuf</span></code> and <code class="docutils literal notranslate"><span class="pre">recvBuf</span></code> to be a particular precision regardless of the calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant) function: half,
single, or double, if <a class="reference internal" href="#c.primme_params.globalSumReal_type" title="primme_params.globalSumReal_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal_type</span></code></a> is <code class="docutils literal notranslate"><span class="pre">primme_half</span></code>, <code class="docutils literal notranslate"><span class="pre">primme_float</span></code>
or <code class="docutils literal notranslate"><span class="pre">primme_double</span></code> respectively.</p>
<p>It is recommended to set a precision so that the machine precision times log2(<a class="reference internal" href="#c.primme_params.numProcs" title="primme_params.numProcs"><code class="xref c c-member docutils literal notranslate"><span class="pre">numProcs</span></code></a>) is smaller than the precision required to converge.
An example of this is calling <a class="reference internal" href="primmec.html#c.hprimme" title="hprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">hprimme()</span></code></a> setting <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a> to 0.01 and <a class="reference internal" href="#c.primme_params.globalSumReal_type" title="primme_params.globalSumReal_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal_type</span></code></a> to <code class="docutils literal notranslate"><span class="pre">primme_op_single</span></code> for 1000 processes.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>, and if it is
<code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code> it is set to the value that matches the precision of
calling function.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.broadcastReal">
void (*<code class="sig-name descname">broadcastReal</code>)<span class="sig-paren">(</span>void *buffer, int *count, <a class="reference internal" href="#c.primme_params" title="primme_params">primme_params</a> *primme, int *ierr<span class="sig-paren">)</span><a class="headerlink" href="#c.primme_params.broadcastReal" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Broadcast function from process with ID zero. It is optional in parallel executions, and not needed for sequential programs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>buffer</strong> – array of size <code class="docutils literal notranslate"><span class="pre">count</span></code> with the local input values.</p></li>
<li><p><strong>count</strong> – array size of <code class="docutils literal notranslate"><span class="pre">sendBuf</span></code> and <code class="docutils literal notranslate"><span class="pre">recvBuf</span></code>.</p></li>
<li><p><strong>primme</strong> – parameters structure.</p></li>
<li><p><strong>ierr</strong> – output error code; if it is set to non-zero, the current call to PRIMME will stop.</p></li>
</ul>
</dd>
</dl>
<p>The actual type of <code class="docutils literal notranslate"><span class="pre">buffer</span></code> matches the type of <code class="docutils literal notranslate"><span class="pre">evecs</span></code> of the
calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant), unless the user sets <a class="reference internal" href="#c.primme_params.broadcastReal_type" title="primme_params.broadcastReal_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">broadcastReal_type</span></code></a> to
another precision.</p>
<p>If <a class="reference internal" href="#c.primme_params.broadcastReal" title="primme_params.broadcastReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">broadcastReal</span></code></a> is not provided, PRIMME uses <a class="reference internal" href="#c.primme_params.globalSumReal" title="primme_params.globalSumReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">globalSumReal</span></code></a> for broadcasting, which is usually a bit more expensive.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to NULL;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<p>When MPI is used, this can be a simply wrapper to MPI_Bcast() as shown below:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="nf">broadcastForDouble</span><span class="p">(</span><span class="kt">void</span> <span class="o">*</span><span class="n">buffer</span><span class="p">,</span> <span class="kt">int</span> <span class="o">*</span><span class="n">count</span><span class="p">,</span>
<span class="n">primme_params</span> <span class="o">*</span><span class="n">primme</span><span class="p">,</span> <span class="kt">int</span> <span class="o">*</span><span class="n">ierr</span><span class="p">)</span> <span class="p">{</span>
<span class="n">MPI_Comm</span> <span class="n">communicator</span> <span class="o">=</span> <span class="o">*</span><span class="p">(</span><span class="n">MPI_Comm</span> <span class="o">*</span><span class="p">)</span> <span class="n">primme</span><span class="o">-></span><span class="n">commInfo</span><span class="p">;</span>
<span class="k">if</span><span class="p">(</span><span class="n">MPI_Bcast</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="o">*</span><span class="n">count</span><span class="p">,</span> <span class="n">MPI_DOUBLE</span><span class="p">,</span> <span class="mi">0</span> <span class="cm">/* root */</span><span class="p">,</span>
<span class="n">communicator</span><span class="p">)</span> <span class="o">==</span> <span class="n">MPI_SUCCESS</span><span class="p">)</span> <span class="p">{</span>
<span class="o">*</span><span class="n">ierr</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="o">*</span><span class="n">ierr</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>When calling <a class="reference internal" href="primmec.html#c.sprimme" title="sprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">sprimme()</span></code></a> and <a class="reference internal" href="primmec.html#c.cprimme" title="cprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">cprimme()</span></code></a> replace <code class="docutils literal notranslate"><span class="pre">MPI_DOUBLE</span></code> by <code class="docutils literal notranslate"><span class="pre">`MPI_FLOAT</span></code>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.broadcastReal_type">
primme_op_datatype <code class="sig-name descname">broadcastReal_type</code><a class="headerlink" href="#c.primme_params.broadcastReal_type" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Precision of the vector <code class="docutils literal notranslate"><span class="pre">buffer`</span></code> passed to <a class="reference internal" href="#c.primme_params.broadcastReal" title="primme_params.broadcastReal"><code class="xref c c-member docutils literal notranslate"><span class="pre">broadcastReal</span></code></a>.</p>
<p>If it is <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>, the vectors’ type matches the calling
<a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant). Otherwise, the user can force the precision of the vectors <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> to be a particular precision regardless of the calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant) function: half,
single, or double, if <a class="reference internal" href="#c.primme_params.matrixMatvec_type" title="primme_params.matrixMatvec_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">matrixMatvec_type</span></code></a> is <code class="docutils literal notranslate"><span class="pre">primme_half</span></code>, <code class="docutils literal notranslate"><span class="pre">primme_float</span></code>
or <code class="docutils literal notranslate"><span class="pre">primme_double</span></code> respectively.</p>
<p>It is not recommended to set a lower precision than the one required to converge.
An example of this is calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> setting <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a> to 1e-10 and <a class="reference internal" href="#c.primme_params.broadcastReal_type" title="primme_params.broadcastReal_type"><code class="xref c c-member docutils literal notranslate"><span class="pre">broadcastReal_type</span></code></a> to <code class="docutils literal notranslate"><span class="pre">primme_op_half</span></code>.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>, and if it is
<code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code> it is set to the value that matches the precision of
calling function.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.internalPrecision">
primme_op_datatype <code class="sig-name descname">internalPrecision</code><a class="headerlink" href="#c.primme_params.internalPrecision" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Internal working precision.</p>
<p>If it is <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>, most of the vectors are stored with the
same precision as the calling <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> (or a variant), and most of the
computations are done in that precision too. Otherwise, the working precision
is changed to half, single, or double, if the user sets <a class="reference internal" href="#c.primme_params.internalPrecision" title="primme_params.internalPrecision"><code class="xref c c-member docutils literal notranslate"><span class="pre">internalPrecision</span></code></a> to
<code class="docutils literal notranslate"><span class="pre">primme_half</span></code>, <code class="docutils literal notranslate"><span class="pre">primme_float</span></code> or <code class="docutils literal notranslate"><span class="pre">primme_double</span></code> respectively.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_op_default</span></code>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.numEvals">
int <code class="sig-name descname">numEvals</code><a class="headerlink" href="#c.primme_params.numEvals" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Number of eigenvalues wanted.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 1;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.primme_set_method" title="primme_set_method"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_set_method()</span></code></a> (see <a class="reference internal" href="#methods"><span class="std std-ref">Preset Methods</span></a>) and <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<span class="target" id="index-0"></span><dl class="c member">
<dt id="c.primme_params.target">
primme_target <code class="sig-name descname">target</code><a class="headerlink" href="#c.primme_params.target" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Which eigenpairs to find:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">primme_smallest</span></code></dt><dd><p>Smallest algebraic eigenvalues; <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a> is ignored.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">primme_largest</span></code></dt><dd><p>Largest algebraic eigenvalues; <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a> is ignored.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">primme_closest_geq</span></code></dt><dd><p>Closest to, but greater or equal than the shifts in <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">primme_closest_leq</span></code></dt><dd><p>Closest to, but less or equal than the shifts in <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">primme_closest_abs</span></code></dt><dd><p>Closest in absolute value to the shifts in <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">primme_largest_abs</span></code></dt><dd><p>Furthest in absolute value to the shifts in <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a>.</p>
</dd>
</dl>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_smallest</span></code></a>;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<span class="target" id="index-1"></span><dl class="c member">
<dt id="c.primme_params.numTargetShifts">
int <code class="sig-name descname">numTargetShifts</code><a class="headerlink" href="#c.primme_params.numTargetShifts" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Size of the array <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a>.
Used only when <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">target</span></code></a> is <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_geq</span></code></a>,
<a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_leq</span></code></a>, <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_abs</span></code></a> or <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_largest_abs</span></code></a>.
The default values is 0.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<span class="target" id="index-2"></span><dl class="c member">
<dt id="c.primme_params.targetShifts">
double *<code class="sig-name descname">targetShifts</code><a class="headerlink" href="#c.primme_params.targetShifts" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Array of shifts, at least of size <a class="reference internal" href="#c.primme_params.numTargetShifts" title="primme_params.numTargetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">numTargetShifts</span></code></a>.
Used only when <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">target</span></code></a> is <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_geq</span></code></a>,
<a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_leq</span></code></a>, <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_abs</span></code></a> or <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_largest_abs</span></code></a>.</p>
<p>Eigenvalues are computed in order so that the
i-th eigenvalue is the closest (or closest but left or closest but right, see <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">target</span></code></a>)
to the i-th shift. If <a class="reference internal" href="#c.primme_params.numTargetShifts" title="primme_params.numTargetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">numTargetShifts</span></code></a> < <a class="reference internal" href="#c.primme_params.numEvals" title="primme_params.numEvals"><code class="xref c c-member docutils literal notranslate"><span class="pre">numEvals</span></code></a>, the last shift given
is used for all the remaining i’s.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to NULL;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Considerations for interior problems:</p>
<ul class="simple">
<li><p>PRIMME will try to compute the eigenvalues in the order given in the
<a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a>. However, for code efficiency and robustness, the shifts
should be ordered. Order them in ascending (descending) order for shifts
closer to the lower (higher) end of the spectrum.</p></li>
<li><p>If some shift is close to the lower (higher) end of the spectrum,
use either <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_geq</span></code></a> (<a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_leq</span></code></a>) or
<a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_abs</span></code></a>.</p></li>
<li><p><a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_leq</span></code></a> and <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_geq</span></code></a> are more efficient
than <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_closest_abs</span></code></a>.</p></li>
<li><p>For interior eigenvalues larger <a class="reference internal" href="#c.primme_params.maxBasisSize" title="primme_params.maxBasisSize"><code class="xref c c-member docutils literal notranslate"><span class="pre">maxBasisSize</span></code></a> is usually more robust.</p></li>
<li><p>To find the largest magnitude eigenvalues set <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">target</span></code></a> to <a class="reference internal" href="#c.primme_params.target" title="primme_params.target"><code class="xref c c-member docutils literal notranslate"><span class="pre">primme_largest_abs</span></code></a>,
<a class="reference internal" href="#c.primme_params.numTargetShifts" title="primme_params.numTargetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">numTargetShifts</span></code></a> to 1 and <a class="reference internal" href="#c.primme_params.targetShifts" title="primme_params.targetShifts"><code class="xref c c-member docutils literal notranslate"><span class="pre">targetShifts</span></code></a> to an array with a zero value.</p></li>
</ul>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.printLevel">
int <code class="sig-name descname">printLevel</code><a class="headerlink" href="#c.primme_params.printLevel" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The level of message reporting from the code. All output is written in <a class="reference internal" href="#c.primme_params.outputFile" title="primme_params.outputFile"><code class="xref c c-member docutils literal notranslate"><span class="pre">outputFile</span></code></a>.</p>
<p>One of:</p>
<ul>
<li><p>0: silent.</p></li>
<li><p>1: print some error messages when these occur.</p></li>
<li><p>2: as in 1, and info about targeted eigenpairs when they are marked as converged:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#Converged $1 eval[ $2 ]= $3 norm $4 Mvecs $5 Time $7</span>
</pre></div>
</div>
<p>or locked:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#Lock epair[ $1 ]= $3 norm $4 Mvecs $5 Time $7</span>
</pre></div>
</div>
</li>
<li><p>3: in as 2, and info about targeted eigenpairs every outer iteration:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">OUT</span> <span class="n">$6</span> <span class="n">conv</span> <span class="n">$1</span> <span class="n">blk</span> <span class="n">$8</span> <span class="n">MV</span> <span class="n">$5</span> <span class="n">Sec</span> <span class="n">$7</span> <span class="n">EV</span> <span class="n">$3</span> <span class="o">|</span><span class="n">r</span><span class="o">|</span> <span class="n">$4</span>
</pre></div>
</div>
<p>Also, if it is used the dynamic method, show JDQMR/GDk performance ratio and
the current method in use.</p>
</li>
<li><p>4: in as 3, and info about targeted eigenpairs every inner iteration:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">INN</span> <span class="n">MV</span> <span class="n">$5</span> <span class="n">Sec</span> <span class="n">$7</span> <span class="n">Eval</span> <span class="n">$3</span> <span class="n">Lin</span><span class="o">|</span><span class="n">r</span><span class="o">|</span> <span class="n">$9</span> <span class="n">EV</span><span class="o">|</span><span class="n">r</span><span class="o">|</span> <span class="n">$4</span>
</pre></div>
</div>
</li>
<li><p>5: in as 4, and verbose info about certain choices of the algorithm.</p></li>
</ul>
<p>Output key:</p>
<div class="line-block">
<div class="line">$1: Number of converged pairs up to now.</div>
<div class="line">$2: The index of the pair currently converged.</div>
<div class="line">$3: The eigenvalue.</div>
<div class="line">$4: Its residual norm.</div>
<div class="line">$5: The current number of matrix-vector products.</div>
<div class="line">$6: The current number of outer iterations.</div>
<div class="line">$7: The current elapsed time.</div>
<div class="line">$8: Index within the block of the targeted pair .</div>
<div class="line">$9: QMR norm of the linear system residual.</div>
</div>
<p>In parallel programs, output is produced in call with
<a class="reference internal" href="#c.primme_params.procID" title="primme_params.procID"><code class="xref c c-member docutils literal notranslate"><span class="pre">procID</span></code></a> 0 when <a class="reference internal" href="#c.primme_params.printLevel" title="primme_params.printLevel"><code class="xref c c-member docutils literal notranslate"><span class="pre">printLevel</span></code></a>
is from 0 to 4.
If <a class="reference internal" href="#c.primme_params.printLevel" title="primme_params.printLevel"><code class="xref c c-member docutils literal notranslate"><span class="pre">printLevel</span></code></a> is 5 output can be produced in any of
the parallel calls.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 1;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Convergence history for plotting may be produced simply by:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>grep OUT outpufile <span class="p">|</span> awk <span class="s1">'{print $8" "$14}'</span> > out
grep INN outpufile <span class="p">|</span> awk <span class="s1">'{print $3" "$11}'</span> > inn
</pre></div>
</div>
<p>Then in gnuplot:</p>
<div class="highlight-gnuplot notranslate"><div class="highlight"><pre><span></span><span class="k">plot</span> <span class="s">'out'</span> <span class="nb">w</span> <span class="n">lp</span><span class="o">,</span> <span class="s">'inn'</span> <span class="nb">w</span> <span class="n">lp</span>
</pre></div>
</div>
</div>
<dl class="c member">
<dt id="c.primme_params.aNorm">
double <code class="sig-name descname">aNorm</code><a class="headerlink" href="#c.primme_params.aNorm" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>An estimate of the norm of <span class="math notranslate nohighlight">\(A\)</span>, which is used in the default convergence
criterion (see <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a>).</p>
<p>If <a class="reference internal" href="#c.primme_params.aNorm" title="primme_params.aNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">aNorm</span></code></a> is less than or equal to 0, the code uses the largest absolute
Ritz value seen divided by <a class="reference internal" href="#c.primme_params.invBNorm" title="primme_params.invBNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">invBNorm</span></code></a>. On return, <a class="reference internal" href="#c.primme_params.aNorm" title="primme_params.aNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">aNorm</span></code></a> is then replaced with that value.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0.0;</div>
<div class="line">this field is read and written by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.BNorm">
double <code class="sig-name descname">BNorm</code><a class="headerlink" href="#c.primme_params.BNorm" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>An estimate of the norm of <span class="math notranslate nohighlight">\(B\)</span>, which is used to estimate the
conditioning number of the matrix <span class="math notranslate nohighlight">\(B\)</span>.</p>
<p>If <a class="reference internal" href="#c.primme_params.BNorm" title="primme_params.BNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">BNorm</span></code></a> is less than or equal to 0, the code uses the largest inner-product with <span class="math notranslate nohighlight">\(B\)</span>
seen. On return, <a class="reference internal" href="#c.primme_params.BNorm" title="primme_params.BNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">BNorm</span></code></a> is then replaced with that value.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0.0;</div>
<div class="line">this field is read and written by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.invBNorm">
double <code class="sig-name descname">invBNorm</code><a class="headerlink" href="#c.primme_params.invBNorm" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>An estimate of the norm of the inverse of <span class="math notranslate nohighlight">\(B\)</span>, which is used in the default convergence
criterion (see <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a>).</p>
<p>If <a class="reference internal" href="#c.primme_params.invBNorm" title="primme_params.invBNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">invBNorm</span></code></a> is less than or equal to 0, the code uses the inverse of the smallest inner-product with <span class="math notranslate nohighlight">\(B\)</span>
seen. On return, <a class="reference internal" href="#c.primme_params.invBNorm" title="primme_params.invBNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">invBNorm</span></code></a> is then replaced with that value.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0.0;</div>
<div class="line">this field is read and written by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.orth">
primme_orth <code class="sig-name descname">orth</code><a class="headerlink" href="#c.primme_params.orth" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Selects the orthogonalization method used by PRIMME.</p>
<p>If the value is <code class="docutils literal notranslate"><span class="pre">primme_orth_implicit_I</span></code>, the bases are orthogonalized with
classical Gram-Schmidt with reorthogonalization stopping when the new vector’s
norm is not reduced more than <span class="math notranslate nohighlight">\(1/sqrt{2}\)</span> (Daniel’s test) from the previous
iteration. If several vectors are going to be orthogonalized, the algorithm is
applied vector by vector.</p>
<p>If the value is <code class="docutils literal notranslate"><span class="pre">primme_orth_explicit_I</span></code>, the bases are orthogonalized with
iterative Cholesky QR (or SVQB if Cholesky factorization fails), stopping
when the conditioning of the basis is around <span class="math notranslate nohighlight">\(sqrt(3)\)</span>. That
deviation of the orthogonality level is taken into account in the Galerkin
method.</p>
<p>The option <code class="docutils literal notranslate"><span class="pre">primme_orth_explicit_I</span></code> is usually more expensive in FLOPS,
but it may be faster in time than <code class="docutils literal notranslate"><span class="pre">primme_orth_implicit_I</span></code> when <a class="reference internal" href="#c.primme_params.maxBlockSize" title="primme_params.maxBlockSize"><code class="xref c c-member docutils literal notranslate"><span class="pre">maxBlockSize</span></code></a>
is large.</p>
<p><code class="docutils literal notranslate"><span class="pre">primme_orth_implicit_I</span></code> is set by default if the precision is higher than
single precision and <a class="reference internal" href="#c.primme_params.maxBlockSize" title="primme_params.maxBlockSize"><code class="xref c c-member docutils literal notranslate"><span class="pre">maxBlockSize</span></code></a> is 1. Otherwise, <code class="docutils literal notranslate"><span class="pre">primme_orth_explicit_I</span></code>
is set by default.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to <code class="docutils literal notranslate"><span class="pre">primme_orth_default</span></code>;</div>
<div class="line">this field is read and written by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.</span></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.eps">
double <code class="sig-name descname">eps</code><a class="headerlink" href="#c.primme_params.eps" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>If <a class="reference internal" href="#c.primme_params.convTestFun" title="primme_params.convTestFun"><code class="xref c c-member docutils literal notranslate"><span class="pre">convTestFun</span></code></a> is NULL, an eigenpairs is marked as converged when the 2-norm
of the residual vector is less than <a class="reference internal" href="#c.primme_params.eps" title="primme_params.eps"><code class="xref c c-member docutils literal notranslate"><span class="pre">eps</span></code></a> * <a class="reference internal" href="#c.primme_params.aNorm" title="primme_params.aNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">aNorm</span></code></a> * <a class="reference internal" href="#c.primme_params.invBNorm" title="primme_params.invBNorm"><code class="xref c c-member docutils literal notranslate"><span class="pre">invBNorm</span></code></a>.
The residual vector is <span class="math notranslate nohighlight">\(A x - \lambda x\)</span> or <span class="math notranslate nohighlight">\(A x - \lambda B x\)</span>.</p>
<p>The default value is machine precision times <span class="math notranslate nohighlight">\(10^4\)</span>.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0.0;</div>
<div class="line">this field is read and written by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.outputFile">
FILE *<code class="sig-name descname">outputFile</code><a class="headerlink" href="#c.primme_params.outputFile" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Opened file to write down the output.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to the standard output;</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a> and <a class="reference internal" href="primmec.html#c.primme_display_params" title="primme_display_params"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_display_params()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.dynamicMethodSwitch">
int <code class="sig-name descname">dynamicMethodSwitch</code><a class="headerlink" href="#c.primme_params.dynamicMethodSwitch" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>If this value is 1, it alternates dynamically between <a class="reference internal" href="#c.primme_preset_method.PRIMME_DEFAULT_MIN_TIME" title="primme_preset_method.PRIMME_DEFAULT_MIN_TIME"><code class="xref c c-member docutils literal notranslate"><span class="pre">PRIMME_DEFAULT_MIN_TIME</span></code></a>
and <a class="reference internal" href="#c.primme_preset_method.PRIMME_DEFAULT_MIN_MATVECS" title="primme_preset_method.PRIMME_DEFAULT_MIN_MATVECS"><code class="xref c c-member docutils literal notranslate"><span class="pre">PRIMME_DEFAULT_MIN_MATVECS</span></code></a>, trying to identify the fastest method.</p>
<p>On exit, it holds a recommended method for future runs on this problem:</p>
<blockquote>
<div><div class="line-block">
<div class="line">-1: use <a class="reference internal" href="#c.primme_preset_method.PRIMME_DEFAULT_MIN_MATVECS" title="primme_preset_method.PRIMME_DEFAULT_MIN_MATVECS"><code class="xref c c-member docutils literal notranslate"><span class="pre">PRIMME_DEFAULT_MIN_MATVECS</span></code></a> next time.</div>
<div class="line">-2: use <a class="reference internal" href="#c.primme_preset_method.PRIMME_DEFAULT_MIN_TIME" title="primme_preset_method.PRIMME_DEFAULT_MIN_TIME"><code class="xref c c-member docutils literal notranslate"><span class="pre">PRIMME_DEFAULT_MIN_TIME</span></code></a> next time.</div>
<div class="line">-3: close call, use <a class="reference internal" href="#c.primme_preset_method.PRIMME_DYNAMIC" title="primme_preset_method.PRIMME_DYNAMIC"><code class="xref c c-member docutils literal notranslate"><span class="pre">PRIMME_DYNAMIC</span></code></a> next time again.</div>
</div>
</div></blockquote>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to 0;</div>
<div class="line">written by <a class="reference internal" href="primmec.html#c.primme_set_method" title="primme_set_method"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_set_method()</span></code></a> (see <a class="reference internal" href="#methods"><span class="std std-ref">Preset Methods</span></a>);</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Even for expert users we do not recommend setting <a class="reference internal" href="#c.primme_params.dynamicMethodSwitch" title="primme_params.dynamicMethodSwitch"><code class="xref c c-member docutils literal notranslate"><span class="pre">dynamicMethodSwitch</span></code></a>
directly, but through <a class="reference internal" href="primmec.html#c.primme_set_method" title="primme_set_method"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_set_method()</span></code></a>.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The code obtains timings by the <code class="docutils literal notranslate"><span class="pre">gettimeofday</span></code> Unix utility. If a cheaper, more
accurate timer is available, modify the <code class="docutils literal notranslate"><span class="pre">PRIMMESRC/COMMONSRC/wtime.c</span></code></p>
</div>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.locking">
int <code class="sig-name descname">locking</code><a class="headerlink" href="#c.primme_params.locking" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>If set to 1, hard locking will be used (locking converged eigenvectors
out of the search basis). If set to 0, the code will try to use soft
locking (à la ARPACK), when large enough <a class="reference internal" href="#c.primme_params.minRestartSize" title="primme_params.minRestartSize"><code class="xref c c-member docutils literal notranslate"><span class="pre">minRestartSize</span></code></a> is available.</p>
<p>Input/output:</p>
<blockquote>
<div><div class="line-block">
<div class="line"><a class="reference internal" href="primmec.html#c.primme_initialize" title="primme_initialize"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_initialize()</span></code></a> sets this field to -1;</div>
<div class="line">written by <a class="reference internal" href="primmec.html#c.primme_set_method" title="primme_set_method"><code class="xref c c-func docutils literal notranslate"><span class="pre">primme_set_method()</span></code></a> (see <a class="reference internal" href="#methods"><span class="std std-ref">Preset Methods</span></a>);</div>
<div class="line">this field is read by <a class="reference internal" href="primmec.html#c.dprimme" title="dprimme"><code class="xref c c-func docutils literal notranslate"><span class="pre">dprimme()</span></code></a>.</div>
</div>
</div></blockquote>
</dd></dl>
<dl class="c member">
<dt id="c.primme_params.initSize">
int <code class="sig-name descname">initSize</code><a class="headerlink" href="#c.primme_params.initSize" title="Permalink to this definition">¶</a><br /></dt>