/usr/include/spooles/DSTree/DSTree.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 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 | /* DSTree.h */
#include "../cfiles.h"
#include "../Tree.h"
#include "../IV.h"
/*--------------------------------------------------------------------*/
/*
---------------------------------------------------------------------
the DSTree object models a domain/separator tree.
it contains a Tree object to represent the connectivity of
the domains and separators and an IV object to contain the
map from vertices to domains and separators.
tree -- pointer to a Tree object that contains the tree adjacency
mapIV -- pointer to IV object that contains the map
from vertices to domains and separators
created -- 96mar10, cca
---------------------------------------------------------------------
*/
typedef struct _DSTree DSTree ;
struct _DSTree {
Tree *tree ;
IV *mapIV ;
} ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods founds in basics.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------
purpose -- create and return a new DSTree object
created -- 96mar10, cca
-----------------------------------------------
*/
DSTree *
DSTree_new (
void
) ;
/*
------------------------------------------------------
purpose -- set the default fields for the DSTree object
created -- 96mar10, cca
------------------------------------------------------
*/
void
DSTree_setDefaultFields (
DSTree *dstree
) ;
/*
--------------------------------
purpose -- clear the data fields
created -- 96mar10, cca
--------------------------------
*/
void
DSTree_clearData (
DSTree *dstree
) ;
/*
--------------------------------
purpose -- free the DSTree object
created -- 96mar10, cca
--------------------------------
*/
void
DSTree_free (
DSTree *dstree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods founds in instance.c -------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------------------
return a pointer to the internal Tree object
created -- 97jun21, cca
--------------------------------------------
*/
Tree *
DSTree_tree (
DSTree *dstree
) ;
/*
-------------------------------------
return a pointer to the map IV object
created -- 97jun21, cca
-------------------------------------
*/
IV *
DSTree_mapIV (
DSTree *dstree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods founds in init.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------
initialize the object given the number of nodes
created -- 96mar10, cca
-----------------------------------------------
*/
void
DSTree_init1 (
DSTree *dstree,
int ndomsep,
int nvtx
) ;
/*
-----------------------------------------
initialize the object given a Tree object
created -- 96mar10, cca
-----------------------------------------
*/
void
DSTree_init2 (
DSTree *dstree,
Tree *tree,
IV *mapIV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods founds in stages.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------------------
create a stages vector for a nested dissection ordering
created -- 96mar10, cca
-------------------------------------------------------
*/
IV *
DSTree_NDstages (
DSTree *dstree
) ;
/*
----------------------------------------------------------------
create a stages vector for a ``half'' nested dissection ordering
created -- 96mar10, cca
----------------------------------------------------------------
*/
IV *
DSTree_ND2stages (
DSTree *dstree
) ;
/*
------------------------------------------------------------
create a stages vector for a two-level multisection ordering
created -- 96mar10, cca
------------------------------------------------------------
*/
IV *
DSTree_MS2stages (
DSTree *dstree
) ;
/*
--------------------------------------------------------------
create a stages vector for a three-level multisection ordering
created -- 96mar10, cca
--------------------------------------------------------------
*/
IV *
DSTree_MS3stages (
DSTree *dstree
) ;
/*
---------------------------------------------------
create a stages vector via cutoff on domain weights
created -- 96mar10, cca
---------------------------------------------------
*/
IV *
DSTree_stagesViaDomainWeight (
DSTree *dstree,
int *vwghts,
DV *cutoffDV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods founds in util.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
----------------------------------------------
return the number of bytes taken by the object
created -- 96mar10, cca
----------------------------------------------
*/
int
DSTree_sizeOf (
DSTree *dstree
) ;
/*
---------------------------------------------
renumber the fronts by a post-order traversal
created -- 96apr13, cca
---------------------------------------------
*/
void
DSTree_renumberViaPostOT (
DSTree * dstree
) ;
/*
-----------------------------------------------------------
purpose -- return the weight of the vertices in the domains
created -- 97jun21, cca
-----------------------------------------------------------
*/
int
DSTree_domainWeight (
DSTree *dstree,
int vwghts[]
) ;
/*
-----------------------------------------------------------
purpose -- return the weight of the vertices in the domains
created -- 97jun21, cca
-----------------------------------------------------------
*/
int
DSTree_domainWeight (
DSTree *dstree,
int vwghts[]
) ;
/*
--------------------------------------------------------------
purpose -- return the weight of the vertices in the separators
created -- 97jun21, cca
--------------------------------------------------------------
*/
int
DSTree_separatorWeight (
DSTree *dstree,
int vwghts[]
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods founds in IO.c -------------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------------------------
purpose -- to read in an DSTree object from a file
input --
fn -- filename, must be *.dstreeb or *.dstreef
return value -- 1 if success, 0 if failure
created -- 96mar10, cca
--------------------------------------------------
*/
int
DSTree_readFromFile (
DSTree *dstree,
char *fn
) ;
/*
---------------------------------------------------------
purpose -- to read an DSTree object from a formatted file
return value -- 1 if success, 0 if failure
created -- 96mar10, cca
---------------------------------------------------------
*/
int
DSTree_readFromFormattedFile (
DSTree *dstree,
FILE *fp
) ;
/*
------------------------------------------------------
purpose -- to read an DSTree object from a binary file
return value -- 1 if success, 0 if failure
created -- 96mar10, cca
------------------------------------------------------
*/
int
DSTree_readFromBinaryFile (
DSTree *dstree,
FILE *fp
) ;
/*
----------------------------------------------
purpose -- to write an DSTree object to a file
input --
fn -- filename
*.dstreeb -- binary
*.dstreef -- formatted
anything else -- for human eye
return value -- 1 if success, 0 otherwise
created -- 96mar10, cca
----------------------------------------------
*/
int
DSTree_writeToFile (
DSTree *dstree,
char *fn
) ;
/*
--------------------------------------------------------
purpose -- to write an DSTree object to a formatted file
return value -- 1 if success, 0 otherwise
created -- 96mar10, cca
--------------------------------------------------------
*/
int
DSTree_writeToFormattedFile (
DSTree *dstree,
FILE *fp
) ;
/*
-----------------------------------------------------
purpose -- to write an DSTree object to a binary file
return value -- 1 if success, 0 otherwise
created -- 96mar10, cca
-----------------------------------------------------
*/
int
DSTree_writeToBinaryFile (
DSTree *dstree,
FILE *fp
) ;
/*
----------------------------------------------------
purpose -- to write an DSTree object for a human eye
return value -- 1 if success, 0 otherwise
created -- 96mar10, cca
----------------------------------------------------
*/
int
DSTree_writeForHumanEye (
DSTree *dstree,
FILE *fp
) ;
/*
------------------------------------------------------------
purpose -- to write out the statistics for the DSTree object
return value -- 1 if success, 0 otherwise
created -- 96mar10, cca
------------------------------------------------------------
*/
int
DSTree_writeStats (
DSTree *dstree,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
|