/usr/include/spooles/Pencil/Pencil.h is in libspooles-dev 2.2-9.
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 | /* Pencil.h */
#include "../InpMtx.h"
#include "../DenseMtx.h"
#include "../Drand.h"
#include "../SPOOLES.h"
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------
this object stores a matrix pencil
A + sigma * B
created -- 98may02, cca
------------------------------------------------------------------
*/
typedef struct _Pencil Pencil ;
struct _Pencil {
int type ;
int symflag ;
InpMtx *inpmtxA ;
InpMtx *inpmtxB ;
double sigma[2] ;
} ;
#define PENCIL_IS_REAL(pencil) ((pencil)->type == SPOOLES_REAL)
#define PENCIL_IS_COMPLEX(pencil) ((pencil)->type == SPOOLES_COMPLEX)
#define PENCIL_IS_SYMMETRIC(pencil) \
((pencil)->symflag == SPOOLES_SYMMETRIC)
#define PENCIL_IS_HERMITIAN(pencil) \
((pencil)->symflag == SPOOLES_HERMITIAN)
#define PENCIL_IS_NONSYMMETRIC(pencil) \
((pencil)->symflag == SPOOLES_NONSYMMETRIC)
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
simplest constructor
created -- 98may02, cca
-----------------------
*/
Pencil *
Pencil_new (
void
) ;
/*
-----------------------
set the default fields
created -- 98may02, cca
-----------------------
*/
void
Pencil_setDefaultFields (
Pencil *pencil
) ;
/*
--------------------------------------------------
clear the data fields, releasing allocated storage
created -- 98may02, cca
--------------------------------------------------
*/
void
Pencil_clearData (
Pencil *pencil
) ;
/*
------------------------------------------
destructor, free's the object and its data
created -- 98may02, cca
------------------------------------------
*/
Pencil *
Pencil_free (
Pencil *pencil
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in init.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
initialize the object
created -- 98may02, cca
-----------------------
*/
void
Pencil_init (
Pencil *pencil,
int type,
int symflag,
InpMtx *inpmtxA,
double sigma[],
InpMtx *inpmtxB
) ;
/*
--------------------------
change the coordinate type
created -- 98may02, cca
--------------------------
*/
void
Pencil_changeCoordType (
Pencil *pencil,
int newType
) ;
/*
-----------------------
change the storage mode
created -- 98may02, cca
-----------------------
*/
void
Pencil_changeStorageMode (
Pencil *pencil,
int newMode
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in permute.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------
permute the matrix pencil
created -- 98may02, cca
-------------------------
*/
void
Pencil_permute (
Pencil *pencil,
IV *rowOldToNewIV,
IV *colOldToNewIV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in mmm.c -------------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------
compute Y := Y + (A + sigma*B)*X
created -- 98may02, cca
--------------------------------
*/
void
Pencil_mmm (
Pencil *pencil,
DenseMtx *Y,
DenseMtx *X
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in setup.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
----------------------------------------------------------------
initialize the matrix pencil A + sigma*B
myid -- id of process, used in MPI implementation
if myid = 0 then
the pencil is loaded with the matrices read from the files
else
the pencil is loaded with the empty matrices
endif
symflag -- symmetry flag,
PENCIL_SYMMETRIC -- symmetric
PENCIL_HERMITIAN -- hermitian
PENCIL_NONSYMMETRIC -- nonsymmetric
if symmetric or hermitian, drop entries in lower triangle
inpmtxAfile -- filename for A
sigma -- scaling factor
inpmtxBfile -- filename for B
randomflag -- random flag,
if 1 then fill with random numbers
drand -- random number generator
msglvl -- message level
msgFile -- message file
return value -- pointer to a Pencil object
created -- 98may02, cca
----------------------------------------------------------------
*/
Pencil *
Pencil_setup (
int myid,
int symflag,
char *inpmtxAfile,
double sigma[],
char *inpmtxBfile,
int randomflag,
Drand *drand,
int msglvl,
FILE *msgFile
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in util.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------------
sort and compress the pencil's entries
created -- 98may02, cca
--------------------------------------
*/
void
Pencil_sortAndCompress (
Pencil *pencil
) ;
/*
------------------------------
convert the storage to vectors
created -- 98may02, cca
------------------------------
*/
void
Pencil_convertToVectors (
Pencil *pencil
) ;
/*
----------------------------------------------
map entries to the lower triangle,
used after a permutation of a symmetric matrix
created -- 98may02, cca
----------------------------------------------
*/
void
Pencil_mapToLowerTriangle (
Pencil *pencil
) ;
/*
----------------------------------------------
map entries to the upper triangle,
used after a permutation of a symmetric matrix
created -- 98may02, cca
----------------------------------------------
*/
void
Pencil_mapToUpperTriangle (
Pencil *pencil
) ;
/*
-------------------------------------------------------------
purpose -- to return the full, symmetric adjacency IVL object
for the graph of (A + B) + sigma * (A + B)^T
created -- 98may02, cca
-------------------------------------------------------------
*/
IVL *
Pencil_fullAdjacency (
Pencil *pencil
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in IO.c --------------------------------------------
------------------------------------------------------------------------
*/
/*
---------------------------------------------------
purpose -- to read in a Pencil object from a file
input --
fn -- filename, must be *.inpmtxb or *.inpmtxf
return value -- 1 if success, 0 if failure
created -- 98may02, cca
--------------------------------------------------
*/
int
Pencil_readFromFiles (
Pencil *pencil,
char *inpmtxAfileName,
char *inpmtxBfileName
) ;
/*
----------------------------------------------------
purpose -- to write a Pencil object for a human eye
return value -- 1 if success, 0 otherwise
created -- 98may02, cca
----------------------------------------------------
*/
int
Pencil_writeForHumanEye (
Pencil *pencil,
FILE *fp
) ;
/*
-------------------------------------------------------------
purpose -- to write out the statistics for the Pencil object
return value -- 1 if success, 0 otherwise
created -- 98may02, cca
-------------------------------------------------------------
*/
int
Pencil_writeStats (
Pencil *pencil,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
|