/usr/include/spooles/DenseMtx/DenseMtx.h is in libspooles-dev 2.2-11.
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 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 | /* DenseMtx */
#include "../cfiles.h"
#include "../Drand.h"
#include "../A2.h"
/*--------------------------------------------------------------------*/
/*
-------------------------------------------------------------------
this object handles a dense real and complex matrix.
type -- type of entries
1 -- real
2 -- complex
rowid -- id for the rows in this matrix
colid -- id for the columns in this matrix
nrow -- # of rows in the matrix
ncol -- # of columns in the matrix
inc1 -- row increment for the entries
inc2 -- column increment for the entries
rowind -- pointer to row indices
colind -- pointer to column indices
entries -- pointer to matrix entries
wrkDV -- DV object to manage workspace
next -- pointer to next DenseMtx object in a singly linked list
-------------------------------------------------------------------
*/
typedef struct _DenseMtx DenseMtx ;
struct _DenseMtx {
int type ;
int rowid ;
int colid ;
int nrow ;
int ncol ;
int inc1 ;
int inc2 ;
int *rowind ;
int *colind ;
double *entries ;
DV wrkDV ;
DenseMtx *next ;
} ;
#define DENSEMTX_IS_REAL(mtx) ((mtx)->type == SPOOLES_REAL)
#define DENSEMTX_IS_COMPLEX(mtx) ((mtx)->type == SPOOLES_COMPLEX)
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
simplest constructor
created -- 98may02, cca
-----------------------
*/
DenseMtx *
DenseMtx_new (
void
) ;
/*
-----------------------
set the default fields
created -- 98may02, cca
-----------------------
*/
void
DenseMtx_setDefaultFields (
DenseMtx *mtx
) ;
/*
--------------------------------------------------
clear the data fields, releasing allocated storage
created -- 98may02, cca
--------------------------------------------------
*/
void
DenseMtx_clearData (
DenseMtx *mtx
) ;
/*
------------------------------------------
destructor, free's the object and its data
created -- 98may02, cca
------------------------------------------
*/
void
DenseMtx_free (
DenseMtx *mtx
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in instance.c --------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------
return the row id of the object
created -- 98may02, cca
-------------------------------
*/
int
DenseMtx_rowid (
DenseMtx *mtx
) ;
/*
----------------------------------
return the column id of the object
created -- 98may02, cca
----------------------------------
*/
int
DenseMtx_colid (
DenseMtx *mtx
) ;
/*
------------------------------------------
fill *pnrow with nrow and *pncol with ncol
created -- 98may02, cca
------------------------------------------
*/
void
DenseMtx_dimensions (
DenseMtx *mtx,
int *pnrow,
int *pncol
) ;
/*
------------------------
return the row increment
created -- 98may02, cca
------------------------
*/
int
DenseMtx_rowIncrement (
DenseMtx *mtx
) ;
/*
---------------------------
return the column increment
created -- 98may02, cca
---------------------------
*/
int
DenseMtx_columnIncrement (
DenseMtx *mtx
) ;
/*
-------------------------------------------
fill *pnrow with nrow, *prowind with rowind
created -- 98may02, cca
-------------------------------------------
*/
void
DenseMtx_rowIndices (
DenseMtx *mtx,
int *pnrow,
int **prowind
) ;
/*
-------------------------------------------
fill *pncol with ncol, *pcolind with colind
created -- 98may02, cca
-------------------------------------------
*/
void
DenseMtx_columnIndices (
DenseMtx *mtx,
int *pncol,
int **pcolind
) ;
/*
--------------------------------------------
fill *pentries with a pointer to the entries
created -- 98may02, cca
--------------------------------------------
*/
double *
DenseMtx_entries(
DenseMtx *mtx
) ;
/*
---------------------------------
return a pointer to the workspace
created -- 98may02, cca
---------------------------------
*/
void *
DenseMtx_workspace(
DenseMtx *mtx
) ;
/*
------------------------------------------
fill *pValue with the entry in (irow,jcol)
created -- 98jun05, cca
------------------------------------------
*/
void
DenseMtx_realEntry (
DenseMtx *mtx,
int irow,
int jcol,
double *pValue
) ;
/*
----------------------------------------------------
fill *pReal and *pImag with the entry in (irow,jcol)
created -- 98jun05, cca
----------------------------------------------------
*/
void
DenseMtx_complexEntry (
DenseMtx *mtx,
int irow,
int jcol,
double *pReal,
double *pImag
) ;
/*
------------------------------
set entry (irow,jcol) to value
created -- 98jun05, cca
------------------------------
*/
void
DenseMtx_setRealEntry (
DenseMtx *mtx,
int irow,
int jcol,
double value
) ;
/*
------------------------------------
set entry (irow,jcol) to (real,imag)
created -- 98jun05, cca
------------------------------------
*/
void
DenseMtx_setComplexEntry (
DenseMtx *mtx,
int irow,
int jcol,
double real,
double imag
) ;
/*
----------------------------------------------------------
purpose -- fill *prowent with the base address of row irow
return values --
1 -- normal return
-1 -- mtx is NULL
-2 -- invalid type for mtx
-3 -- irow is invalid
-4 -- prowent is NULL
created -- 98nov11, cca
----------------------------------------------------------
*/
int
DenseMtx_row (
DenseMtx *mtx,
int irow,
double **prowent
) ;
/*
-------------------------------------------------------------
purpose -- fill *pcolent with the base address of column jcol
return values --
1 -- normal return
-1 -- mtx is NULL
-2 -- invalid type for mtx
-3 -- jcol is invalid
-4 -- pcolent is NULL
created -- 98nov11, cca
-------------------------------------------------------------
*/
int
DenseMtx_column (
DenseMtx *mtx,
int jcol,
double **pcolent
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in init.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------------
return the number of bytes needed for an object of this size
created -- 98may02, cca
------------------------------------------------------------
*/
int
DenseMtx_nbytesNeeded (
int type,
int nrow,
int ncol
) ;
/*
----------------------------------------------------------------
return the number of bytes in the workspace owned by this object
created -- 98may02, cca
----------------------------------------------------------------
*/
int
DenseMtx_nbytesInWorkspace (
DenseMtx *mtx
) ;
/*
-------------------------------------------------------------
set the number of bytes in the workspace owned by this object
created -- 98may02, cca
-------------------------------------------------------------
*/
void
DenseMtx_setNbytesInWorkspace (
DenseMtx *mtx,
int nbytes
) ;
/*
---------------------------------------
purpose -- set the fields of the object
created -- 98may02, cca
---------------------------------------
*/
void
DenseMtx_setFields (
DenseMtx *mtx,
int type,
int rowid,
int colid,
int nrow,
int ncol,
int inc1,
int inc2
) ;
/*
----------------------------
purpose -- basic initializer
created -- 98may02, cca
----------------------------
*/
void
DenseMtx_init (
DenseMtx *mtx,
int type,
int rowid,
int colid,
int nrow,
int ncol,
int inc1,
int inc2
) ;
/*
---------------------------------------------------------
purpose -- initialize the object from its working storage
used when the object is a MPI message
created -- 98may02, cca
---------------------------------------------------------
*/
void
DenseMtx_initFromBuffer (
DenseMtx *mtx
) ;
/*
------------------------------------
purpose -- initializer with pointers
created -- 98may02, cca
------------------------------------
*/
void
DenseMtx_initWithPointers (
DenseMtx *mtx,
int type,
int rowid,
int colid,
int nrow,
int ncol,
int inc1,
int inc2,
int *rowind,
int *colind,
double *entries
) ;
/*
-----------------------------------
this method initializes a A2 object
to point into the entries
created -- 98may02, cca
-----------------------------------
*/
void
DenseMtx_setA2 (
DenseMtx *mtx,
A2 *a2
) ;
/*
----------------------------------------------------------------
purpose -- initialize as a submatrix of another DenseMtx object.
B = A(firstrow:lastrow, firstcol:lastcol)
note, B only points into the storage of A.
return values --
1 -- normal return
-1 -- B is NULL
-2 -- A is NULL
-3 -- A has invalid type
-4 -- requested rows are invalid
-5 -- requested columns are invalid
created -- 98nov11, cca
----------------------------------------------------------------
*/
int
DenseMtx_initAsSubmatrix (
DenseMtx *B,
DenseMtx *A,
int firstrow,
int lastrow,
int firstcol,
int lastcol
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in IO.c --------------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------------------
purpose -- to read in the object from a file
input --
fn -- filename, must be *.densemtxb or *.densemtxf
return value -- 1 if success, 0 if failure
created -- 98aug13
-----------------------------------------------------------
*/
int
DenseMtx_readFromFile (
DenseMtx *mtx,
char *fn
) ;
/*
--------------------------------------------------
purpose -- to read an object from a formatted file
return value -- 1 if success, 0 if failure
created -- 98aug13
--------------------------------------------------
*/
int
DenseMtx_readFromFormattedFile (
DenseMtx *mtx,
FILE *fp
) ;
/*
-----------------------------------------------
purpose -- to read an object from a binary file
return value -- 1 if success, 0 if failure
created -- 98aug13
-----------------------------------------------
*/
int
DenseMtx_readFromBinaryFile (
DenseMtx *mtx,
FILE *fp
) ;
/*
---------------------------------------
purpose -- to write an object to a file
input --
fn -- filename
*.densemtxb -- binary
*.densemtxf -- formatted
anything else -- for human eye
error return --
1 -- normal return
-1 -- mtx is NULL
-2 -- fn is NULL
-3 -- unable to open file
created -- 98aug13
---------------------------------------
*/
int
DenseMtx_writeToFile (
DenseMtx *mtx,
char *fn
) ;
/*
-------------------------------------------------
purpose -- to write an object to a formatted file
return value --
1 -- normal return
-1 -- mtx is NULL
-2 -- fn is NULL
created -- 98aug13
-------------------------------------------------
*/
int
DenseMtx_writeToFormattedFile (
DenseMtx *mtx,
FILE *fp
) ;
/*
--------------------------------------------------------
purpose -- to write an adjacency object to a binary file
return value --
1 -- normal return
-1 -- mtx is NULL
-2 -- fn is NULL
created -- 98aug13
--------------------------------------------------------
*/
int
DenseMtx_writeToBinaryFile (
DenseMtx *mtx,
FILE *fp
) ;
/*
-----------------------------------------------------
purpose -- to write the object's statistics to a file
in human readable form
return value --
1 -- normal return
-1 -- mtx is NULL
-2 -- fp is NULL
created -- 98may02, cca
-----------------------------------------------------
*/
int
DenseMtx_writeStats (
DenseMtx *mtx,
FILE *fp
) ;
/*
----------------------------------------
purpose -- to write the object to a file
in human readable form
return value --
1 -- normal return
-1 -- mtx is NULL
-2 -- fp is NULL
created -- 98may02, cca
----------------------------------------
*/
int
DenseMtx_writeForHumanEye (
DenseMtx *mtx,
FILE *fp
) ;
/*
-----------------------------------------------
purpose -- to write the object to a matlab file
return value --
1 -- normal return
-1 -- mtx is NULL
-2 -- mtx is NULL
-3 -- fp is NULL
created -- 98may02, cca
-----------------------------------------------
*/
int
DenseMtx_writeForMatlab (
DenseMtx *mtx,
char *mtxname,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in permute.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------
purpose -- to permute the rows of an object
created -- 98may02, cca
-------------------------------------------
*/
void
DenseMtx_permuteRows (
DenseMtx *mtx,
IV *oldToNewIV
) ;
/*
----------------------------------------------
purpose -- to permute the columns of an object
created -- 98may02, cca
----------------------------------------------
*/
void
DenseMtx_permuteColumns (
DenseMtx *mtx,
IV *oldToNewIV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in util.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
---------------------------------------------------------
sort the rows so the row ids are in ascending order
sort the columns so the column ids are in ascending order
created -- 98may02, cca
---------------------------------------------------------
*/
void
DenseMtx_sort (
DenseMtx *mtx
) ;
/*
-----------------------------------------------
copy row irowA from mtxA into row irowB in mtxB
created -- 98may02, cca
-----------------------------------------------
*/
void
DenseMtx_copyRow (
DenseMtx *mtxB,
int irowB,
DenseMtx *mtxA,
int irowA
) ;
/*
---------------------------------------------------------------
copy row irowA from mtxA into row irowB in mtxB
and copy row index irowB from mtxB into row index irowA of mtxA
created -- 98aug12, cca
---------------------------------------------------------------
*/
void
DenseMtx_copyRowAndIndex (
DenseMtx *mtxB,
int irowB,
DenseMtx *mtxA,
int irowA
) ;
/*
----------------------------------------------
add row irowA from mtxA into row irowB in mtxB
created -- 98aug12, cca
----------------------------------------------
*/
void
DenseMtx_addRow (
DenseMtx *mtxB,
int irowB,
DenseMtx *mtxA,
int irowA
) ;
/*
-----------------------
zero the entries
created -- 98may16, cca
-----------------------
*/
void
DenseMtx_zero (
DenseMtx *mtx
) ;
/*
------------------------
fill with random entries
created -- 98may16, cca
------------------------
*/
void
DenseMtx_fillRandomEntries (
DenseMtx *mtx,
Drand *drand
) ;
/*
-----------------------------------
compute three checksums
sums[0] = sum of row indices
sums[1] = sum of columns indices
sums[2] = sum of entry magnitudes
created -- 98may16, cca
-----------------------------------
*/
void
DenseMtx_checksums (
DenseMtx *mtx,
double sums[]
) ;
/*
-------------------------------------------
return the maximum magnitude of the entries
created -- 98may15, cca
-------------------------------------------
*/
double
DenseMtx_maxabs (
DenseMtx *mtx
) ;
/*
--------------------------------------------
subtract one matrix from another, B := B - A
created -- 98may25, cca
--------------------------------------------
*/
void
DenseMtx_sub (
DenseMtx *mtxB,
DenseMtx *mtxA
) ;
/*
----------------------------------------------------
purpose -- to copy a row of the matrix into a vector
irow -- local row id
vec -- double vector to receive the row entries
created -- 98jul31, cca
----------------------------------------------------
*/
void
DenseMtx_copyRowIntoVector (
DenseMtx *mtx,
int irow,
double *vec
) ;
/*
----------------------------------------------------
purpose -- to copy a row of the matrix into a vector
irow -- local row id
vec -- double vector to supply the row entries
created -- 98jul31, cca
----------------------------------------------------
*/
void
DenseMtx_copyVectorIntoRow (
DenseMtx *mtx,
int irow,
double *vec
) ;
/*
----------------------------------------------------
purpose -- to add a row of the matrix into a vector
irow -- local row id
vec -- double vector to supply the row entries
created -- 98aug12, cca
----------------------------------------------------
*/
void
DenseMtx_addVectorIntoRow (
DenseMtx *mtx,
int irow,
double *vec
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in scale.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------------
purpose -- to scale a dense matrix object by a scalar
A := alpha * A ;
return values ---
1 -- normal return
-1 -- A is NULL
-2 -- A has invalid type
-3 -- alpha is NULL
created -- 98nov06, cca
-----------------------------------------------------
*/
int
DenseMtx_scale (
DenseMtx *A,
double alpha[]
) ;
/*--------------------------------------------------------------------*/
|