/usr/include/spooles/SolveMap/SolveMap.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 | /* SolveMap.h */
#include "../IVL.h"
#include "../Tree.h"
#include "../SPOOLES.h"
/*--------------------------------------------------------------------*/
typedef struct _SolveMap SolveMap ;
struct _SolveMap {
int symmetryflag ;
int nfront ;
int nproc ;
int *owners ;
int nblockUpper ;
int *rowidsUpper ;
int *colidsUpper ;
int *mapUpper ;
int nblockLower ;
int *rowidsLower ;
int *colidsLower ;
int *mapLower ;
} ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
simplest constructor
created -- 98mar19, cca
-----------------------
*/
SolveMap *
SolveMap_new (
void
) ;
/*
-----------------------
set the default fields
created -- 98mar19, cca
-----------------------
*/
void
SolveMap_setDefaultFields (
SolveMap *solvemap
) ;
/*
--------------------------------------------------
clear the data fields, releasing allocated storage
created -- 98mar19, cca
--------------------------------------------------
*/
void
SolveMap_clearData (
SolveMap *solvemap
) ;
/*
------------------------------------------
destructor, free's the object and its data
created -- 98mar19, cca
------------------------------------------
*/
SolveMap *
SolveMap_free (
SolveMap *solvemap
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in instance.c --------------------------------------
------------------------------------------------------------------------
*/
/*
----------------------------------------------------
purpose -- to return the symmetry flag of the object
created -- 98mar19, cca
----------------------------------------------------
*/
int
SolveMap_symmetryflag (
SolveMap *solvemap
) ;
/*
-----------------------------------------
purpose -- to return the number of fronts
created -- 98mar19, cca
-----------------------------------------
*/
int
SolveMap_nfront (
SolveMap *solvemap
) ;
/*
---------------------------------------------
purpose -- to return the number of processors
created -- 98mar19, cca
---------------------------------------------
*/
int
SolveMap_nproc (
SolveMap *solvemap
) ;
/*
----------------------------------------------------------------
purpose -- to return the number of blocks in the upper adjacency
created -- 98mar19, cca
----------------------------------------------------------------
*/
int
SolveMap_nblockUpper (
SolveMap *solvemap
) ;
/*
----------------------------------------------------------------
purpose -- to return the number of blocks in the lower adjacency
created -- 98mar19, cca
----------------------------------------------------------------
*/
int
SolveMap_nblockLower (
SolveMap *solvemap
) ;
/*
---------------------------------------------------
purpose -- to return a pointer to the owners vector
created -- 98mar19, cca
----------------------------------------------------
*/
int *
SolveMap_owners (
SolveMap *solvemap
) ;
/*
----------------------------------------------------
purpose -- to return a pointer to the row ids vector
for the upper adjacency structure
created -- 98mar19, cca
-----------------------------------------------------
*/
int *
SolveMap_rowidsUpper (
SolveMap *solvemap
) ;
/*
-------------------------------------------------------
purpose -- to return a pointer to the column ids vector
for the upper adjacency structure
created -- 98mar19, cca
--------------------------------------------------------
*/
int *
SolveMap_colidsUpper (
SolveMap *solvemap
) ;
/*
------------------------------------------------
purpose -- to return a pointer to the map vector
for the upper adjacency structure
created -- 98mar19, cca
-------------------------------------------------
*/
int *
SolveMap_mapUpper (
SolveMap *solvemap
) ;
/*
----------------------------------------------------
purpose -- to return a pointer to the row ids vector
for the upper adjacency structure
created -- 98mar19, cca
-----------------------------------------------------
*/
int *
SolveMap_rowidsLower (
SolveMap *solvemap
) ;
/*
-------------------------------------------------------
purpose -- to return a pointer to the column ids vector
for the upper adjacency structure
created -- 98mar19, cca
--------------------------------------------------------
*/
int *
SolveMap_colidsLower (
SolveMap *solvemap
) ;
/*
------------------------------------------------
purpose -- to return a pointer to the map vector
for the upper adjacency structure
created -- 98mar19, cca
-------------------------------------------------
*/
int *
SolveMap_mapLower (
SolveMap *solvemap
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in init.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------------------
purpose -- set the scalars and allocate the vectors for the object
created -- 98mar19, cca
------------------------------------------------------------------ */
void
SolveMap_init (
SolveMap *solvemap,
int symmetryflag,
int nfront,
int nproc,
int nblockUpper,
int nblockLower
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in maps.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------------
purpose -- map the off diagonal blocks
to processes in a random fashion
created -- 98mar19, cca
--------------------------------------
*/
void
SolveMap_randomMap (
SolveMap *solvemap,
int symmetryflag,
IVL *upperBlockIVL,
IVL *lowerBlockIVL,
int nproc,
IV *ownersIV,
int seed,
int msglvl,
FILE *msgFile
) ;
/*
----------------------------------------------
purpose -- map the off diagonal blocks to
processes in a domain decomposition fashion
created -- 98mar28, cca
----------------------------------------------
*/
void
SolveMap_ddMap (
SolveMap *solvemap,
int symmetryflag,
IVL *upperBlockIVL,
IVL *lowerBlockIVL,
int nproc,
IV *ownersIV,
Tree *tree,
int seed,
int msglvl,
FILE *msgFile
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in setup.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------------------
purpose -- to set up the linked lists for the forward solve
local to process myid
created -- 98mar19, cca
-----------------------------------------------------------
*/
IP **
SolveMap_forwardSetup (
SolveMap *solvemap,
int myid,
int msglvl,
FILE *msgFile
) ;
/*
------------------------------------------------------------
purpose -- to set up the linked lists for the backward solve
local to process myid
created -- 98mar19, cca
------------------------------------------------------------
*/
IP **
SolveMap_backwardSetup (
SolveMap *solvemap,
int myid,
int msglvl,
FILE *msgFile
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in util.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
----------------------------------------------------
purpose -- return the owner of block (rowid, colid).
created -- 98mar19, cca
----------------------------------------------------
*/
int
SolveMap_owner (
SolveMap *solvemap,
int rowid,
int colid
) ;
/*
---------------------------------------------------------------
purpose -- return an IVL object whose list K contains all
processes who do not own U(K,K) but own a U(J,K) for some J.
if myid == -1 then
the entire IVL object is created and returned
else
only the portion of the IVL object pertinent
to myid is created and returned
endif
created -- 98may24, cca
---------------------------------------------------------------
*/
IVL *
SolveMap_upperSolveIVL (
SolveMap *solvemap,
int myid,
int msglvl,
FILE *msgFile
) ;
/*
-----------------------------------------------------
purpose -- return an IV object whose entry J contains
the number of all processes who do not own U(J,J)
but own a U(J,K) for some J.
if myid == -1 then
all entries in the vector are filled
else
all those entries pertinent to myid are filled
endif
created -- 98mar19, cca
-----------------------------------------------------
*/
IV *
SolveMap_upperAggregateIV (
SolveMap *solvemap,
int myid,
int msglvl,
FILE *msgFile
) ;
/*
--------------------------------------------------------
purpose -- return an IV object whose J'th entry contains
the number of processes who do not own L(J,J) but own
a L(J,I) for some I < J.
if myid == -1 then
all entries in the vector are filled
else
all those entries pertinent to myid are filled
endif
created -- 98mar20, cca
--------------------------------------------------------
*/
IV *
SolveMap_lowerAggregateIV (
SolveMap *solvemap,
int myid,
int msglvl,
FILE *msgFile
) ;
/*
-------------------------------------------------------
purpose -- return an IVL object whose list J contains
the processes who do not own L(J,J) but own a L(K,J)
for some K > J.
if myid == -1 then
the entire IVL object is created and returned
else
only the portion of the IVL object pertinent
to myid is created and returned
endif
created -- 98may24, cca
-------------------------------------------------------
*/
IVL *
SolveMap_lowerSolveIVL (
SolveMap *solvemap,
int myid,
int msglvl,
FILE *msgFile
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in IO.c --------------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------------
purpose -- to read in an SolveMap object from a file
input --
fn -- filename, must be *.solvemapb or *.solvemapf
return value -- 1 if success, 0 if failure
created -- 98apr09, cca
-----------------------------------------------------
*/
int
SolveMap_readFromFile (
SolveMap *solvemap,
char *fn
) ;
/*
-----------------------------------------------------------
purpose -- to read an SolveMap object from a formatted file
return value -- 1 if success, 0 if failure
created -- 98apr09, cca
-----------------------------------------------------------
*/
int
SolveMap_readFromFormattedFile (
SolveMap *solvemap,
FILE *fp
) ;
/*
---------------------------------------------------
purpose -- to read an SolveMap object from a binary file
return value -- 1 if success, 0 if failure
created -- 98apr09, cca
---------------------------------------------------
*/
int
SolveMap_readFromBinaryFile (
SolveMap *solvemap,
FILE *fp
) ;
/*
------------------------------------------------
purpose -- to write an SolveMap object to a file
input --
fn -- filename
*.solvemapb -- binary
*.solvemapf -- formatted
anything else -- for human eye
return value -- 1 if success, 0 otherwise
created -- 98apr09, cca
------------------------------------------------
*/
int
SolveMap_writeToFile (
SolveMap *solvemap,
char *fn
) ;
/*
-----------------------------------------------------
purpose -- to write an SolveMap object to a formatted file
return value -- 1 if success, 0 otherwise
created -- 98apr09, cca
-----------------------------------------------------
*/
int
SolveMap_writeToFormattedFile (
SolveMap *solvemap,
FILE *fp
) ;
/*
--------------------------------------------------
purpose -- to write an SolveMap object to a binary file
return value -- 1 if success, 0 otherwise
created -- 98apr09, cca
--------------------------------------------------
*/
int
SolveMap_writeToBinaryFile (
SolveMap *solvemap,
FILE *fp
) ;
/*
------------------------------------------------------
purpose -- to write an SolveMap object for a human eye
return value -- 1 if success, 0 otherwise
created -- 98apr09, cca
------------------------------------------------------
*/
int
SolveMap_writeForHumanEye (
SolveMap *solvemap,
FILE *fp
) ;
/*
--------------------------------------------------------------
purpose -- to write out the statistics for the SolveMap object
return value -- 1 if success, 0 otherwise
created -- 98apr09, cca
--------------------------------------------------------------
*/
int
SolveMap_writeStats (
SolveMap *solvemap,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
|