/usr/include/spooles/Tree/Tree.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 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 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 | /* Tree.h */
#include "../cfiles.h"
#include "../IV.h"
#include "../DV.h"
/*--------------------------------------------------------------------*/
/*
-----------------------
simple tree object
created -- 95nov15, cca
-----------------------
*/
typedef struct _Tree Tree ;
struct _Tree {
int n ;
int root ;
int *par ;
int *fch ;
int *sib ;
} ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------
purpose -- create and return a new Tree object
created -- 95nov15, cca
-----------------------------------------------
*/
Tree *
Tree_new (
void
) ;
/*
------------------------------------------------------
purpose -- set the default fields for the Tree object
created -- 95nov15, cca
------------------------------------------------------
*/
void
Tree_setDefaultFields (
Tree *tree
) ;
/*
--------------------------------
purpose -- clear the data fields
created -- 95nov15, cca
--------------------------------
*/
void
Tree_clearData (
Tree *tree
) ;
/*
--------------------------------
purpose -- free the Tree object
created -- 95nov15, cca
--------------------------------
*/
void
Tree_free (
Tree *tree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in instance.c --------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------------
purpose -- return the number of nodes in the tree
created -- 98jun12, cca
-------------------------------------------------
*/
int
Tree_nnodes (
Tree *tree
) ;
/*
--------------------------------------
purpose -- return the root of the tree
created -- 98jun12, cca
--------------------------------------
*/
int
Tree_root (
Tree *tree
) ;
/*
------------------------------------------------
purpose -- return a pointer to the parent vector
created -- 98jun12, cca
------------------------------------------------
*/
int *
Tree_par (
Tree *tree
) ;
/*
-----------------------------------------------------
purpose -- return a pointer to the first child vector
created -- 98jun12, cca
-----------------------------------------------------
*/
int *
Tree_fch (
Tree *tree
) ;
/*
-------------------------------------------------
purpose -- return a pointer to the sibling vector
created -- 98jun12, cca
-------------------------------------------------
*/
int *
Tree_sib (
Tree *tree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in init.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
simplest constructor
created -- 95nov15, cca
-----------------------
*/
void
Tree_init1 (
Tree *tree,
int size
) ;
/*
--------------------------------
initialize given a parent vector
created -- 95nov15, cca
--------------------------------
*/
void
Tree_init2 (
Tree *tree,
int size,
int par[]
) ;
/*
---------------------------------
initialize given the tree vectors
created -- 95nov15, cca
---------------------------------
*/
void
Tree_init3 (
Tree *tree,
int size,
int par[],
int fch[],
int sib[]
) ;
/*
------------------------------------
set the fch[], sib[] and root fields
created -- 95nov15, cca
------------------------------------
*/
void
Tree_setFchSibRoot (
Tree *tree
) ;
/*
-----------------------
set the root field
created -- 95nov15, cca
-----------------------
*/
void
Tree_setRoot (
Tree *tree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in maximizeGain.c ----------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------------------
purpose --
given a gain value assigned to each node,
find a set of nodes, no two in a child-ancestor
relationship, that maximizes the total gain.
this problem arises in finding the optimal domain/schur
complement partition for a semi-implicit factorization.
created -- 98jun20, cca
-------------------------------------------------------
*/
IV *
Tree_maximizeGainIV (
Tree *tree,
IV *gainIV,
int *ptotalgain,
int msglvl,
FILE *msgFile
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in subtree.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------------
purpose -- to initialize subtree with the subtree
of tree using nodes in nodeidsIV
return values ---
1 -- normal return
-1 -- subtree is NULL
-2 -- nodeidsIV is NULL
-3 -- tree is NULL
-4 -- nodeidsIV is invalid
created -- 98oct15, cca
-------------------------------------------------
*/
int
Tree_initFromSubtree (
Tree *subtree,
IV *nodeidsIV,
Tree *tree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in util.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------------
return the first vertex in a post-order traversal
created -- 95nov15, cca
-------------------------------------------------
*/
int
Tree_postOTfirst (
Tree *tree
) ;
/*
----------------------------------------------------------
return the vertex that follows v in a post-order traversal
----------------------------------------------------------
*/
int
Tree_postOTnext (
Tree *tree,
int v
) ;
/*
------------------------------------------------
return the first vertex in a pre-order traversal
created -- 95nov15, cca
------------------------------------------------
*/
int
Tree_preOTfirst (
Tree *tree
) ;
/*
---------------------------------------------------------
return the vertex that follows v in a pre-order traversal
created -- 95nov15, cca
---------------------------------------------------------
*/
int
Tree_preOTnext (
Tree *tree,
int v
) ;
/*
---------------------------------------
return the number of leaves in the tree
created -- 95nov15, cca
---------------------------------------
*/
int
Tree_nleaves (
Tree *tree
) ;
/*
-----------------------------------------------
return the number of roots of the tree (forest)
created -- 95nov15, cca
-----------------------------------------------
*/
int
Tree_nroots (
Tree *tree
) ;
/*
-----------------------------------------
return the number of children of a vertex
created -- 95nov15, cca
-----------------------------------------
*/
int
Tree_nchild (
Tree *tree,
int v
) ;
/*
-------------------------------------------
this method returns an IV object that holds
the number of children for the tree nodes.
created -- 96dec18, cca
-------------------------------------------
*/
IV *
Tree_nchildIV (
Tree *tree
) ;
/*
-----------------------------
return the height of the tree
created -- 96aug23, cca
-----------------------------
*/
int
Tree_height (
Tree *tree
) ;
/*
-------------------------------------------------------------
return the maximum number of children of any node in the tree
created -- 96sep05, cca
-------------------------------------------------------------
*/
int
Tree_maxNchild (
Tree *tree
) ;
/*
---------------------------------------------
return the number of bytes used by the object
---------------------------------------------
*/
int
Tree_sizeOf (
Tree *tree
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in metrics.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------
create and return a subtree metric IV object
input : vmetricIV -- a metric defined on the vertices
return : tmetricIV -- a metric defined on the subtrees
created -- 96jun23, cca
------------------------------------------------------
*/
IV *
Tree_setSubtreeImetric (
Tree *tree,
IV *vmetricIV
) ;
/*
------------------------------------------------------
create and return a subtree metric DV object
input : vmetricDV -- a metric defined on the vertices
return : tmetricDV -- a metric defined on the subtrees
created -- 96jun23, cca
------------------------------------------------------
*/
DV *
Tree_setSubtreeDmetric (
Tree *tree,
DV *vmetricDV
) ;
/*
------------------------------------------------------------
create and return a depth metric IV object
input : vmetricIV -- a metric defined on the vertices
output : dmetric[] -- a depth metric defined on the vertices
dmetric[u] = vmetric[u] + dmetric[par[u]] if par[u] != -1
= vmetric[u] if par[u] == -1
created -- 96jun23, cca
------------------------------------------------------------
*/
IV *
Tree_setDepthImetric (
Tree *tree,
IV *vmetricIV
) ;
/*
------------------------------------------------------------
create and return a depth metric DV object
input : vmetricDV -- a metric defined on the vertices
output : dmetric[] -- a depth metric defined on the vertices
dmetric[u] = vmetric[u] + dmetric[par[u]] if par[u] != -1
= vmetric[u] if par[u] == -1
created -- 96jun23, cca
------------------------------------------------------------
*/
DV *
Tree_setDepthDmetric (
Tree *tree,
DV *vmetricDV
) ;
/*
------------------------------------------------------------------
create and return a height metric IV object
input : vmetricIV -- a metric defined on the vertices
output : dmetricIV -- a depth metric defined on the vertices
hmetric[v] = vmetric[v] + max{p(u) = v} hmetric[u] if fch[v] != -1
= vmetric[v] if fch[v] == -1
created -- 96jun23, cca
------------------------------------------------------------------
*/
IV *
Tree_setHeightImetric (
Tree *tree,
IV *vmetricIV
) ;
/*
------------------------------------------------------------------
create and return a height metric DV object
input : vmetricDV -- a metric defined on the vertices
output : dmetricDV -- a depth metric defined on the vertices
hmetric[v] = vmetric[v] + max{p(u) = v} hmetric[u] if fch[v] != -1
= vmetric[v] if fch[v] == -1
created -- 96jun23, cca
------------------------------------------------------------------
*/
DV *
Tree_setHeightDmetric (
Tree *tree,
DV *vmetricDV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in justify.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------------
left-justify a tree by subtree size
children are linked in ascending order of their subtree size
created -- 95nov15, cca
------------------------------------------------------------
*/
void
Tree_leftJustify (
Tree *tree
) ;
/*
------------------------------------------------------
left-justify a tree by a metric
children are linked in ascending order of their metric
created -- 96jun23, cca
------------------------------------------------------
*/
void
Tree_leftJustifyI (
Tree *tree,
IV *metricIV
) ;
/*
------------------------------------------------------
left-justify a tree by a metric
children are linked in ascending order of their metric
created -- 96jun23, cca
------------------------------------------------------
*/
void
Tree_leftJustifyD (
Tree *tree,
DV *metricDV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in perms.c -----------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------------
fill the new-to-old permutation vector
created -- 95nov15, cca
--------------------------------------
*/
void
Tree_fillNewToOldPerm (
Tree *tree,
int newToOld[]
) ;
/*
--------------------------------------
fill the old-to-new permutation vector
created -- 95nov15, cca
--------------------------------------
*/
void
Tree_fillOldToNewPerm (
Tree *tree,
int oldToNew[]
) ;
/*
------------------------------------------------------
fill the new-to-old and old-to-new permutation vectors
created -- 95nov15, cca
------------------------------------------------------
*/
void
Tree_fillBothPerms (
Tree *tree,
int newToOld[],
int oldToNew[]
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in IO.c --------------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------
purpose -- to read in an Tree object from a file
input --
fn -- filename, must be *.treeb or *.treef
return value -- 1 if success, 0 if failure
created -- 95nov15, cca
------------------------------------------------
*/
int
Tree_readFromFile (
Tree *tree,
char *fn
) ;
/*
-------------------------------------------------------
purpose -- to read an Tree object from a formatted file
return value -- 1 if success, 0 if failure
created -- 95nov15, cca
-------------------------------------------------------
*/
int
Tree_readFromFormattedFile (
Tree *tree,
FILE *fp
) ;
/*
---------------------------------------------------
purpose -- to read an Tree object from a binary file
return value -- 1 if success, 0 if failure
created -- 95nov15, cca
---------------------------------------------------
*/
int
Tree_readFromBinaryFile (
Tree *tree,
FILE *fp
) ;
/*
--------------------------------------------
purpose -- to write an Tree object to a file
input --
fn -- filename
*.treeb -- binary
*.treef -- formatted
anything else -- for human eye
return value -- 1 if success, 0 otherwise
created -- 95nov15, cca
--------------------------------------------
*/
int
Tree_writeToFile (
Tree *tree,
char *fn
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------
purpose -- to write an Tree object to a formatted file
return value -- 1 if success, 0 otherwise
created -- 95nov15, cca
------------------------------------------------------
*/
int
Tree_writeToFormattedFile (
Tree *tree,
FILE *fp
) ;
/*
---------------------------------------------------
purpose -- to write an Tree object to a binary file
return value -- 1 if success, 0 otherwise
created -- 95nov15, cca
---------------------------------------------------
*/
int
Tree_writeToBinaryFile (
Tree *tree,
FILE *fp
) ;
/*
--------------------------------------------------
purpose -- to write an Tree object for a human eye
return value -- 1 if success, 0 otherwise
created -- 95nov15, cca
--------------------------------------------------
*/
int
Tree_writeForHumanEye (
Tree *tree,
FILE *fp
) ;
/*
----------------------------------------------------------
purpose -- to write out the statistics for the Tree object
return value -- 1 if success, 0 otherwise
created -- 95nov15, cca
----------------------------------------------------------
*/
int
Tree_writeStats (
Tree *tree,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in compress.c --------------------------------------
------------------------------------------------------------------------
*/
/*
--------------------------------------------
create and return an IV object that contains
the map from vertices to fundamental chains.
return value -- # of fundamental chains
created -- 96jun23, cca
-------------------------------------------
*/
IV *
Tree_fundChainMap (
Tree *tree
) ;
/*
-----------------------------------------------------------------
compress a tree based on a map from old vertices to new vertices.
the restriction on the map is that the set {u | map[u] = U} must
be connected for all U.
created -- 95nov15, cca
modified -- 96jan04, cca
bug fixed, N computed incorrectly
modified -- 96jun23, cca
in calling sequence, int map[] converted to IV *mapIV
-----------------------------------------------------------------
*/
Tree *
Tree_compress (
Tree *tree,
IV *mapIV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in permute.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
return a permuted tree
created -- 96jan04, cca
-----------------------
*/
Tree *
Tree_permute (
Tree *tree,
int newToOld[],
int oldToNew[]
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in setBoxes.c --------------------------------------
------------------------------------------------------------------------
*/
/*
-------------------------------------------------------------
purpose -- fill boxes arrays for display of a tree
vmetric[] -- vector of metric on the nodes
tmetric[] -- vector of metric on the subtrees
xmin, xmax, ymin, ymax -- bounds on box for root
west[], east[], south[], north[] -- vector to hold bounds for
the nodes in the tree
return value --
1 --> success
2 --> no success, maxnchild > 3
created -- 96dec20, cca
-------------------------------------------------------------
*/
int
Tree_setBoxesII (
Tree *tree,
int vmetric[],
int tmetric[],
double xmin,
double xmax,
double ymin,
double ymax,
double west[],
double east[],
double south[],
double north[]
) ;
/*
-------------------------------------------------------------
purpose -- fill boxes arrays for display of a tree
vmetric[] -- vector of metric on the nodes
tmetric[] -- vector of metric on the subtrees
xmin, xmax, ymin, ymax -- bounds on box for root
west[], east[], south[], north[] -- vector to hold bounds for
the nodes in the tree
return value --
1 --> success
2 --> no success, maxnchild > 3
created -- 96dec20, cca
-------------------------------------------------------------
*/
int
Tree_setBoxesDD (
Tree *tree,
double vmetric[],
double tmetric[],
double xmin,
double xmax,
double ymin,
double ymax,
double west[],
double east[],
double south[],
double north[]
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in getCoords.c -------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------
purpose -- to get simple x[] and y[] coordinates
for the tree vertices
return values --
1 -- normal return
-1 -- tree is NULL
-2 -- heightflag is invalid
-3 -- coordflag is invalid
-4 -- xDV is NULL
-5 -- yDV is NULL
created -- 99jan07, cca
------------------------------------------------
*/
int
Tree_getSimpleCoords (
Tree *tree,
char heightflag,
char coordflag,
DV *xDV,
DV *yDV
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in draw.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------------
purpose -- to write an EPS file with a picture of a tree.
each node can have its own radius and label
filename -- name of the file to be written
xDV -- x coordinates
yDV -- y coordinates
rscale -- scaling factor for radius of nodes
radiusDV -- radius of nodes, if NULL then radius = 1
labelflag -- flag to specify whether labels are to be drawn
1 -- draw labels
otherwise -- do not draw labels
fontscale -- scaling factor for font
labelsIV -- IV object that contains the labels of the nodes.
if NULL then the node ids are used
bbox[] -- bounding box for figure
bbox[0] -- x_min
bbox[1] -- y_min
bbox[2] -- x_max
bbox[3] -- y_max
frame[] -- frame to hold tree
frame[0] -- x_min
frame[1] -- y_min
frame[2] -- x_max
frame[3] -- y_max
bounds[] -- bounds for local coordinates
if bounds is NULL then
the tree fills the frame. note, this is a nonlinear process
when the nodes have non-constant radii, and may not converge
when the maximum radius is large when compared to the frame.
if the process does not converge, a message is printed and
the program exits.
else
bounds[0] -- xi_min
bounds[1] -- eta_min
bounds[2] -- xi_max
bounds[3] -- eta_max
endif
recommendations,
bbox[] = { 0, 0, 500, 200 } for tall skinny trees
{ 0, 0, 500, 500 } for wide trees
frame[0] = bbox[0] + 10
frame[1] = bbox[1] + 10
frame[2] = bbox[2] - 10
frame[3] = bbox[3] - 10
return value
1 -- normal return
-1 -- tree is NULL
-2 -- filename is NULL
-3 -- xDV is NULL
-4 -- yDV is NULL
-5 -- rscale is negative
-6 -- fontscale is negative
-7 -- bbox is NULL
-8 -- frame is NULL
created -- 99jan07, cca
------------------------------------------------------------
*/
int
Tree_drawToEPS (
Tree *tree,
char *filename,
DV *xDV,
DV *yDV,
double rscale,
DV *radiusDV,
int labelflag,
double fontscale,
IV *labelsIV,
double bbox[],
double frame[],
double bounds[]
) ;
/*--------------------------------------------------------------------*/
|