/usr/include/spooles/DV/DV.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 | /* DV.h */
#include "../cfiles.h"
/*--------------------------------------------------------------------*/
/*
---------------------------------------------------------
DV -- double vector object
size -- size of the vector
maxsize -- maximum size of the vector
owned -- owner flag
when == 1, storage pointed to by entries
has been allocated here and can be free'd.
when == 0, storage pointed to by entries
has not been allocated here and cannot be free'd.
vec -- pointer to base address
---------------------------------------------------------
*/
typedef struct _DV DV ;
struct _DV {
int size ;
int maxsize ;
int owned ;
double *vec ;
} ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
constructor method
created -- 96jun23, cca
-----------------------
*/
DV *
DV_new (
void
) ;
/*
-----------------------
set the default fields
created -- 96jun23, cca
-----------------------
*/
void
DV_setDefaultFields (
DV *dv
) ;
/*
-----------------------
clear the data fields
created -- 96jun23, cca
-----------------------
*/
void
DV_clearData (
DV *dv
) ;
/*
-----------------------
destructor
created -- 96jun23, cca
-----------------------
*/
void
DV_free (
DV *dv
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in init.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
---------------------------------------------
simplest initialization method
if entries != NULL
the object does not own the entries,
it just points to the entries base address
else if size > 0
the object will own the entries,
it allocates a vector of size int's.
else
nothing happens
endif
created -- 96aug28, cca
---------------------------------------------
*/
void
DV_init (
DV *iv,
int size,
double *entries
) ;
/*
-------------------------
basic initializion method
created -- 96jun23, cca
-------------------------
*/
void
DV_init1 (
DV *dv,
int Maxsize
) ;
/*
-------------------------
total initializion method
created -- 96jun23, cca
-------------------------
*/
void
DV_init2 (
DV *dv,
int Size,
int Maxsize,
int owned,
double *Dvec
) ;
/*
----------------------------------
set the maximum size of the vector
created -- 96dec08, cca
----------------------------------
*/
void
DV_setMaxsize (
DV *dv,
int newmaxsize
) ;
/*
--------------------------
set the size of the vector
created -- 96dec08, cca
--------------------------
*/
void
DV_setSize (
DV *dv,
int newsize
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in instance.c --------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------
return 1 if the entries are owned by the object
return 0 otherwise
created -- 96jun22, cca
-----------------------------------------------
*/
int
DV_owned (
DV *dv
) ;
/*
-----------------------
return the vector size
created -- 95oct06, cca
-----------------------
*/
int
DV_maxsize (
DV *dv
) ;
/*
-----------------------
return the vector size
created -- 95oct06, cca
-----------------------
*/
int
DV_size (
DV *dv
) ;
/*
-------------------------------------------------
return the loc'th entry of a vector.
note: if loc is out of range then 0.0 is returned
created -- 96jun29, cca
-------------------------------------------------
*/
double
DV_entry (
DV *dv,
int loc
) ;
/*
----------------------------------------------
return a pointer to the object's entries array
created -- 95oct06, cca
----------------------------------------------
*/
double *
DV_entries (
DV *dv
) ;
/*
--------------------------------------------
fill *psize with the vector's size
and *pentries with the address of the vector
created -- 95oct06, cca
--------------------------------------------
*/
void
DV_sizeAndEntries (
DV *dv,
int *psize,
double **pentries
) ;
/*
---------------------------
set and entry in the vector
created -- 96jul14, cca
---------------------------
*/
void
DV_setEntry (
DV *dv,
int loc,
double value
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in util.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------------------
shift the base of the entries and adjust the dimensions
note: this is a dangerous operation because the dv->vec
does not point to the base of the entries any longer,
and thus if the object owns its entries and it is called
to resize them or to free them, malloc and free will choke.
USE WITH CAUTION!
created -- 96aug25, cca
modified -- 96aug28, cca
structure changed
-----------------------------------------------------------
*/
void
DV_shiftBase (
DV *dv,
int offset
) ;
/*
-----------------------
resize the vector
created -- 96jun22, cca
-----------------------
*/
void
DV_resize (
DV *dv,
int Maxsize
) ;
/*
-----------------------
set the size to be zero
created -- 96jun23, cca
-----------------------
*/
void
DV_clear (
DV *dv
) ;
/*
---------------------------
push an entry onto the list
created -- 96jun23, cca
---------------------------
*/
void
DV_push (
DV *dv,
double val
) ;
/*
------------------------------------
minimum and maximum entries and sum
created -- 96jun23, cca
------------------------------------
*/
double
DV_min (
DV *dv
) ;
double
DV_max (
DV *dv
) ;
double
DV_sum (
DV *dv
) ;
/*
-------------------------------------------------------
sort each index list into ascending or descending order
created -- 96jun23, cca
-------------------------------------------------------
*/
void
DV_sortUp (
DV *dv
) ;
void
DV_sortDown (
DV *dv
) ;
/*
-----------------------
ramp the entries
created -- 96jun23, cca
-----------------------
*/
void
DV_ramp (
DV *dv,
double base,
double incr
) ;
/*
-----------------------
shuffle the list
created -- 96jun23, cca
-----------------------
*/
void
DV_shuffle (
DV *dv,
int seed
) ;
/*
----------------------------------------------
return the number of bytes taken by the object
created -- 96jun23, cca
----------------------------------------------
*/
int
DV_sizeOf (
DV *dv
) ;
/*
--------------------------------------------
iterator :
return the pointer to the head of the vector
created -- 96jun23, cca
--------------------------------------------
*/
double *
DV_first (
DV *dv
) ;
/*
-----------------------------------------------------
iterator :
return the pointer to the next location in the vector
created -- 96jun23, cca
-----------------------------------------------------
*/
double *
DV_next (
DV *dv,
double *pi
) ;
/*
--------------------------
fill a vector with a value
created -- 96jun22, cca
--------------------------
*/
void
DV_fill (
DV *dv,
double value
) ;
/*
--------------------------
fill a vector with zeros
created -- 98jun02, cca
--------------------------
*/
void
DV_zero (
DV *dv
) ;
/*
--------------------------------------
copy entries from dv2 into dv1.
note: this is a "mapped" copy,
dv1 and dv2 need not be the same size.
created -- 96aug31, cca
--------------------------------------
*/
void
DV_copy (
DV *dv1,
DV *dv2
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in profile.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------------------
to fill xDV and yDV with a log10 profile of the magnitudes of
the entries in the DV object. tausmall and tau big provide
cutoffs within which to examine the entries. pnzero, pnsmall
and pnbig are addresses to hold the number of entries zero,
smaller than tausmall and larger than taubig, respectively.
created -- 97feb14, cca
------------------------------------------------------------------
*/
void
DV_log10profile (
DV *dv,
int npts,
DV *xDV,
DV *yDV,
double tausmall,
double taubig,
int *pnzero,
int *pnsmall,
int *pnbig
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in IO.c --------------------------------------------
------------------------------------------------------------------------
*/
/*
----------------------------------------------
purpose -- to read in an DV object from a file
input --
fn -- filename, must be *.dvb or *.dvf
return value -- 1 if success, 0 if failure
created -- 96jun23, cca
----------------------------------------------
*/
int
DV_readFromFile (
DV *dv,
char *fn
) ;
/*
-----------------------------------------------------
purpose -- to read an DV object from a formatted file
return value -- 1 if success, 0 if failure
created -- 96jun23, cca
-----------------------------------------------------
*/
int
DV_readFromFormattedFile (
DV *dv,
FILE *fp
) ;
/*
---------------------------------------------------
purpose -- to read an DV object from a binary file
return value -- 1 if success, 0 if failure
created -- 96jun23, cca
---------------------------------------------------
*/
int
DV_readFromBinaryFile (
DV *dv,
FILE *fp
) ;
/*
-------------------------------------------
purpose -- to write an DV object to a file
input --
fn -- filename
*.dvb -- binary
*.dvf -- formatted
anything else -- for human eye
return value -- 1 if success, 0 otherwise
created -- 96jun23, cca
-------------------------------------------
*/
int
DV_writeToFile (
DV *dv,
char *fn
) ;
/*
-----------------------------------------------------
purpose -- to write an DV object to a formatted file
return value -- 1 if success, 0 otherwise
created -- 96jun23, cca
-----------------------------------------------------
*/
int
DV_writeToFormattedFile (
DV *dv,
FILE *fp
) ;
/*
--------------------------------------------------
purpose -- to write an DV object to a binary file
return value -- 1 if success, 0 otherwise
created -- 96jun23, cca
--------------------------------------------------
*/
int
DV_writeToBinaryFile (
DV *dv,
FILE *fp
) ;
/*
-------------------------------------------------
purpose -- to write an DV object for a human eye
return value -- 1 if success, 0 otherwise
created -- 96jun23, cca
-------------------------------------------------
*/
int
DV_writeForHumanEye (
DV *dv,
FILE *fp
) ;
/*
---------------------------------------------------------
purpose -- to write out the statistics for the DV object
return value -- 1 if success, 0 otherwise
created -- 96jun23, cca
---------------------------------------------------------
*/
int
DV_writeStats (
DV *dv,
FILE *fp
) ;
/*
-------------------------------------------------------------------
purpose -- to write out an integer vector with eighty column lines
input --
fp -- file pointer, must be formatted and write access
column -- present column
pierr -- pointer to int to hold return value,
should be 1 if any print was successful,
if fprintf() failed, then ierr = -1
return value -- present column
created -- 96jun22, cca
-------------------------------------------------------------------
*/
int
DV_fp80 (
DV *dv,
FILE *fp,
int column,
int *pierr
) ;
/*
---------------------------------------------------
purpose -- to write the DV object for a matlab file
return value -- 1 if success, 0 otherwise
created -- 98feb07, cca
---------------------------------------------------
*/
int
DV_writeForMatlab (
DV *dv,
char *name,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
|