This file is indexed.

/usr/include/spooles/LinSol/BridgeMT.h is in libspooles-dev 2.2-10build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
#include "../MT.h"
#include "../InpMtx.h"
#include "../ETree.h"
#include "../FrontMtx.h"
#include "../SymbFac.h"
#include "../misc.h"
#include "../timings.h"
/*
   ----------------------------------------------------------------
   this object is the bridge between the lanczos and spooles codes.

   NOTE: multithreaded version

   graph statistics
      neqns          -- number of vertices in the uncompressed graph
      nedges         -- number of edges in the uncompressed graph
      Neqns          -- number of vertices in the compressed graph
      Nedges         -- number of edges in the compressed graph

   ordering parameters
      maxdomainsize -- maximum domain size for recursive dissection
      maxnzeros     -- maximum number of zeros in a front
      maxsize       -- maximum size of a front
      seed          -- random number seed 
      compressCutoff -- cutoff for graph compression, 
         if Neqns <= compressCutoff * neqns then the compressed
         graph is created, ordered and used to create the symbolic
         factorization

   matrix parameters
      neqns        -- number of equations
      type         -- SPOOLES_REAL or SPOOLES_COMPLEX 
      symmetryflag -- SPOOLES_SYMMETRIC, SPOOLES_HERMITIAN 
         or SPOOLES_NONSYMMETRIC

   factorization parameters
      sparsityflag -- FRONTMTX_DENSE_FRONTS or FRONTMTX_SPARSE_FRONTS
      pivotingflag -- SPOOLES_PIVOTING or SPOOLES_NO_PIVOTING
      tau          -- upper bound on magnitude of factor entries
         when pivoting is used
      droptol      -- lower bound on magnitude of factor entries
         when sparse fronts are stored
      lookahead    -- lookahead parameter for factorization
                      recommended value = nthread

   message info
      msglvl -- message level for SPOOLES programs
         set msglvl =  0 for no output
         set msglvl =  1 for scalar and timing output
         set msglvl >= 2 for lots of output
      msgFile -- message file for debug and diagnostic output

   internal objects, free'd in cleanup
      frontETree -- object that contains the front tree information
      symbfacIVL -- object that contains the symbolic factorization
      mtxmanager -- SubMtx manager object that handles storage 
                    for the submatrices of the factors.
      frontmtx   -- object that contains the factorization
      oldToNewIV -- object that contains the old-to-new permutation
      newToOldIV -- object that contains the new-to-old permutation

   multithreaded information
      nthread   -- # of threads
      ownersIV  -- map from fronts to owning threads
      solvemap  -- map from submatrices to owning threads
      cumopsDV  -- vector that holds operations for each thread

   statistics
      stats[ 0] -- # of pivots
      stats[ 1] -- # of pivot tests
      stats[ 2] -- # of delayed rows and columns
      stats[ 3] -- # of entries in D
      stats[ 4] -- # of entries in L
      stats[ 5] -- # of entries in U

   timings
      cpus[ 0] -- time to construct Graph
      cpus[ 1] -- time to compress Graph
      cpus[ 2] -- time to order Graph
      cpus[ 3] -- time for symbolic factorization
      cpus[ 4] -- total setup time
      cpus[ 5] -- parallel factor setup time
      cpus[ 6] -- time to permute original matrix
      cpus[ 7] -- time to initialize the front matrix
      cpus[ 8] -- time to factor the front matrix
      cpus[ 9] -- time to post-process the front matrix
      cpus[10] -- total factor time
      cpus[11] -- parallel solve setup time
      cpus[12] -- permute rhs
      cpus[13] -- solve time
      cpus[14] -- permute solution
      cpus[15] -- total solve time

   created -- 98sep17, cca
   ----------------------------------------------------------------
*/
typedef struct _BridgeMT BridgeMT ;
struct _BridgeMT {
/*
   ----------------
   graph parameters
   ----------------
*/
  int           neqns          ;
  int           nedges         ;
  int           Neqns          ;
  int           Nedges         ;
/*
   -------------------
   ordering parameters
   -------------------
*/
  int           maxdomainsize  ;
  int           maxnzeros      ;
  int           maxsize        ;
  int           seed           ;
  double        compressCutoff ;
/*
   -----------------
   matrix parameters
   -----------------
*/
  int           type           ;
  int           symmetryflag   ;
/*
   ------------------------
   factorization parameters
   ------------------------
*/
  int              sparsityflag   ;
  int              pivotingflag   ;
  double           tau            ;
  double           droptol        ;
  int              lookahead      ;
  PatchAndGoInfo   *patchinfo    ;
/*
   -------------------
   pointers to objects
   -------------------
*/
  ETree         *frontETree    ;
  IVL           *symbfacIVL    ;
  SubMtxManager *mtxmanager    ;
  FrontMtx      *frontmtx      ;
  IV            *oldToNewIV    ;
  IV            *newToOldIV    ;
/*
   ------------------------
   multithreaded parameters
   ------------------------
*/
  int           nthread        ;
  IV            *ownersIV      ;
  SolveMap      *solvemap      ;
  DV            *cumopsDV      ;
/*
   ---------------------------------
   message info, statistics and cpus
   ---------------------------------
*/
  int           msglvl         ;
  FILE          *msgFile       ;
  int           stats[6]       ;
  double        cpus[16]       ;
} ;

/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
   -----------------------
   constructor method
 
   created -- 98sep18, cca
   -----------------------
*/
BridgeMT *
BridgeMT_new ( 
   void 
) ;
/*
   -----------------------
   set the default fields
 
   return value ---
      1 -- normal return
     -1 -- bridge is NULL
 
   created -- 98sep18, cca
   -----------------------
*/
int
BridgeMT_setDefaultFields ( 
   BridgeMT   *bridge
) ;
/*
   -----------------------
   clear the data fields
 
   return value ---
      1 -- normal return
     -1 -- bridge is NULL
 
   created -- 98sep18, cca
   -----------------------
*/
int
BridgeMT_clearData (
   BridgeMT   *bridge
) ;
/*
   -----------------------
   destructor
 
   return value ---
      1 -- normal return
     -1 -- bridge is NULL
 
   created -- 98sep18, cca
   -----------------------
*/
int
BridgeMT_free (
   BridgeMT   *bridge
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in setparams.c -------------------------------------
------------------------------------------------------------------------
*/
/*
   -------------------------------------------
   purpose -- to set the matrix parameters
 
   return value --
     1 -- normal return
    -1 -- bridge object is NULL
    -2 -- neqns <= 0
    -3 -- type is invalid
    -4 -- symmetryflag is invalid
    -5 -- matrix is hermitian but type is real
 
   created -- 98sep25, cca
   -------------------------------------------
*/
int
BridgeMT_setMatrixParams (
   BridgeMT   *bridge,
   int        neqns,
   int        type,
   int        symmetryflag
) ;
/*
   -------------------------------------------
   purpose -- to set the ordering parameters
 
   return value --
     1 -- normal return
    -1 -- bridge object is NULL
    -2 -- maxdomainsize <= 0 
    -3 -- maxsize <= 0 
    -4 -- compressCutoff > 1.0
 
   created -- 98sep25, cca
   -------------------------------------------
*/
int
BridgeMT_setOrderingParams (
   BridgeMT   *bridge,
   int         maxdomainsize, 
   int         maxnzeros, 
   int         maxsize,
   int         seed,
   int         compressCutoff
) ;
/*
   -------------------------------------
   purpose -- to set the message info
 
   return value --
     1 -- normal return
    -1 -- bridge object is NULL
    -2 -- msglvl > 0 and msgFile is NULL
 
   created -- 98sep18, cca
   -------------------------------------
*/
int
BridgeMT_setMessageInfo (
   BridgeMT   *bridge,
   int        msglvl,
   FILE       *msgFile 
) ;
/*
   ----------------------------------------------
   purpose -- to set the factorization parameters
 
   return value --
     1 -- normal return
    -1 -- bridge object is NULL
    -2 -- sparsityflag is invalid
    -3 -- pivotingflag is invalid
    -4 -- tau < 2.0
    -5 -- droptol < 0.0
    -6 -- lookahead < 0
 
   created -- 98sep25, cca
   ----------------------------------------------
*/
int
BridgeMT_setFactorParams (
   BridgeMT         *bridge,
   int              sparsityflag,
   int              pivotingflag,
   double           tau,
   double           droptol,
   int              lookahead,
   PatchAndGoInfo   *patchinfo
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in instance.c --------------------------------------
------------------------------------------------------------------------
*/
/*
   ---------------------------------------------
   purpose -- load *pobj with the address of the
              old-to-new permutation IV object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep18, cca
   ---------------------------------------------
*/
int
BridgeMT_oldToNewIV (
   BridgeMT   *bridge,
   IV         **pobj
) ;
/*
   ---------------------------------------------
   purpose -- load *pobj with the address of the
              new-to-old permutation IV object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep18, cca
   ---------------------------------------------
*/
int
BridgeMT_newToOldIV (
   BridgeMT   *bridge,
   IV         **pobj
) ;
/*
   --------------------------------------
   purpose -- load *pobj with the address
              of the front ETree object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep18, cca
   --------------------------------------
*/
int
BridgeMT_frontETree (
   BridgeMT   *bridge,
   ETree      **pobj
) ;
/*
   ---------------------------------------------
   purpose -- load *pobj with the address of the
              symbolic factorization IVL object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep18, cca
   ---------------------------------------------
*/
int
BridgeMT_symbfacIVL (
   BridgeMT   *bridge,
   IVL        **pobj
) ;
/*
   -----------------------------------------
   purpose -- load *pobj with the address of
              the submatrix manager object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep18, cca
   -----------------------------------------
*/
int
BridgeMT_mtxmanager (
   BridgeMT        *bridge,
   SubMtxManager   **pobj
) ;
/*
   --------------------------------------
   purpose -- load *pobj with the address
              of the front matrix object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep18, cca
   --------------------------------------
*/
int
BridgeMT_frontmtx (
   BridgeMT   *bridge,
   FrontMtx   **pobj
) ;
/*
   --------------------------------------
   purpose -- load *pobj with the address
              of the owners IV object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep24, cca
   --------------------------------------
*/
int
BridgeMT_ownersIV (
   BridgeMT   *bridge,
   IV         **pobj
) ;
/*
   -----------------------------------------
   purpose -- load *pobj with the address of
              the solve map SolveMap object
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pobj is NULL
 
   created -- 98sep24, cca
   -----------------------------------------
*/
int
BridgeMT_solvemap (
   BridgeMT   *bridge,
   SolveMap   **pobj
) ;
/*
   ----------------------------------------------------
   purpose -- load *pnthread with the number of threads
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- pnthread is NULL
 
   created -- 98sep24, cca
   ----------------------------------------------------
*/
int
BridgeMT_nthread (
   BridgeMT   *bridge,
   int        *pnthread
) ;
/*
   --------------------------------------------------------
   purpose -- load *plookahead with the lookahead parameter
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- plookahead is NULL
 
   created -- 98sep24, cca
   --------------------------------------------------------
*/
int
BridgeMT_lookahead (
   BridgeMT   *bridge,
   int        *plookahead
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in info.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
   --------------------------------------------------------------
   purpose --  generate and return some statistics 
               about the factor and solve
 
   type -- type of entries
     SPOOLES_REAL or SPOOLES_COMPLEX
   symmetryflag -- symmetry type
     SPOOLES_SYMMETRIC, SPOOLES_HERMITIAN or SPOOLES_NONSYMMETRIC
 
   on return ---
      *pnfront     -- # of fronts
      *pnfactorind -- # of factor indices
      *pnfactorent -- # of factor entries
      *pnsolveops  -- # of solve operations 
      *pnfactorops -- # of factor operations 
 
   return values --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- type is bad, must be SPOOLES_REAL or SPOOLES_COMPLEX
     -3 -- symmetryflag is bad, must be SPOOLES_SYMMETRIC,
           SPOOLES_HERMITIAN or SPOOLES_NONSYMMETRIC
     -4 -- type and symmetryflag mismatch
     -5 -- front tree is not present
     -6 -- pnfront is NULL
     -7 -- pnfactorind is NULL
     -8 -- pnfactorent is NULL
     -9 -- pnsolveops is NULL
    -10 -- pnfactorops is NULL
 
   created -- 98oct01, cca
   --------------------------------------------------------------
*/
int
BridgeMT_factorStats (
   BridgeMT   *bridge,
   int        type,
   int        symmetryflag,
   int        *pnfront,
   int        *pnfactorind,
   int        *pnfactorent,
   int        *pnsolveops,
   double     *pnfactorops
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in setup.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
   -------------------------------------------------------------------
   purpose --
 
   given an InpMtx object that contains the structure of A, initialize
     the bridge data structure for the serial factor's and solve's.

   note: all parameters are pointers to be compatible with
         fortran's call by reference.
 
   return value --
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- mtxA is NULL
 
   created -- 98sep17, cca
   -------------------------------------------------------------------
*/
int
BridgeMT_setup (
   BridgeMT   *bridge,
   InpMtx     *mtxA
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in factorSetup.c -----------------------------------
------------------------------------------------------------------------
*/
/*
   -------------------------------------------------------
   purpose -- to construct the map from fronts to threads,
      and compute operations for each thread.

   nthread -- number of threads
   maptype -- type of map for parallel factorization
     maptype = 1 --> wrap map
     maptype = 2 --> balanced map
     maptype = 3 --> subtree-subset map
     maptype = 4 --> domain decomposition map
   cutoff -- used when maptype = 4 as upper bound on
     relative domain size
  default is maptype = 4 and cutoff = 1/(2*nthread)

   return value --
      1 -- success
     -1 -- bridge is NULL
     -2 -- nthread is invalid, must be > 0
     -3 -- front tree is NULL

   created -- 98sep24, cca
   -------------------------------------------------------
*/
int
BridgeMT_factorSetup (
   BridgeMT   *bridge,
   int        nthread,
   int        maptype,
   double     cutoff
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in factor.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
   --------------------------------------------------------------
   purpose -- to permute (if necessary) the original matrix,
      and to initialize, factor and postprocess the factor matrix
 
   return value ---
      1 -- normal return, factorization complete
      0 -- factorization did not complete, see error flag
     -1 -- bridge is NULL
     -2 -- mtxA is NULL
     -3 -- perror is NULL 
 
   created -- 98sep18, cca
   --------------------------------------------------------------
*/
int
BridgeMT_factor (
   BridgeMT   *bridge,
   InpMtx     *mtxA,
   int        permuteflag,
   int        *perror
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in solveSetup.c ------------------------------------
------------------------------------------------------------------------
*/
/*
   -----------------------------------------------
   purpose -- to setup for the parallel solve
 
   return value ---
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- frontmtx is NULL
     -3 -- frontmtx has not yet been postprocessed
 
   created -- 98sep24, cca
   -----------------------------------------------
*/
int
BridgeMT_solveSetup (
   BridgeMT   *bridge
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in solve.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
   -------------------------------------
   purpose -- to solve the linear system
 
   return value ---
      1 -- normal return
     -1 -- bridge is NULL
     -2 -- X is NULL
     -3 -- Y is NULL
     -4 -- frontmtx is NULL
     -5 -- mtxmanager is NULL
     -6 -- oldToNewIV not available
     -7 -- newToOldIV not available
 
   created -- 98sep18, cca
   -------------------------------------
*/
int
BridgeMT_solve (
   BridgeMT   *bridge,
   int        permuteflag,
   DenseMtx   *X,
   DenseMtx   *Y
) ;
/*--------------------------------------------------------------------*/