/usr/include/spooles/ZV/ZV.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 | /* ZV.h */
#include "../DV.h"
/*--------------------------------------------------------------------*/
/*
---------------------------------------------------------
ZV -- double complex 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 _ZV ZV ;
struct _ZV {
int size ;
int maxsize ;
int owned ;
double *vec ;
} ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in basics.c ----------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------
constructor method
created -- 98jan22, cca
-----------------------
*/
ZV *
ZV_new (
void
) ;
/*
-----------------------
set the default fields
created -- 98jan22, cca
-----------------------
*/
void
ZV_setDefaultFields (
ZV *zv
) ;
/*
-----------------------
clear the data fields
created -- 98jan22, cca
-----------------------
*/
void
ZV_clearData (
ZV *zv
) ;
/*
-----------------------
destructor
created -- 98jan22, cca
-----------------------
*/
void
ZV_free (
ZV *zv
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in init.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
---------------------------------------------
simplest initialization method
data is cleared
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 2*size doubles's.
else
nothing happens
endif
created -- 98jan22, cca
---------------------------------------------
*/
void
ZV_init (
ZV *zv,
int size,
double *entries
) ;
/*
-------------------------
basic initializion method
created -- 98jan22, cca
-------------------------
*/
void
ZV_init1 (
ZV *zv,
int size
) ;
/*
-------------------------
total initializion method
created -- 98jan22, cca
-------------------------
*/
void
ZV_init2 (
ZV *zv,
int size,
int maxsize,
int owned,
double *vec
) ;
/*
----------------------------------
set the maximum size of the vector
created -- 98jan22, cca
----------------------------------
*/
void
ZV_setMaxsize (
ZV *zv,
int newmaxsize
) ;
/*
--------------------------
set the size of the vector
created -- 98jan22, cca
--------------------------
*/
void
ZV_setSize (
ZV *zv,
int newsize
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in instance.c --------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------
return 1 if the entries are owned by the object
return 0 otherwise
created -- 98jan22, cca
-----------------------------------------------
*/
int
ZV_owned (
ZV *dv
) ;
/*
-----------------------
return the vector size
created -- 98jan22, cca
-----------------------
*/
int
ZV_maxsize (
ZV *dv
) ;
/*
-----------------------
return the vector size
created -- 98jan22, cca
-----------------------
*/
int
ZV_size (
ZV *dv
) ;
/*
-------------------------------------------------
return the loc'th entry of a vector.
created -- 98jan22, cca
-------------------------------------------------
*/
void
ZV_entry (
ZV *dv,
int loc,
double *pReal,
double *pImag
) ;
/*
-------------------------------------------------
return pointers to the loc'th entry of a vector.
created -- 98jan22, cca
-------------------------------------------------
*/
void
ZV_pointersToEntry (
ZV *dv,
int loc,
double **ppReal,
double **ppImag
) ;
/*
----------------------------------------------
return a pointer to the object's entries array
created -- 98jan22, cca
----------------------------------------------
*/
double *
ZV_entries (
ZV *dv
) ;
/*
--------------------------------------------
fill *psize with the vector's size
and *pentries with the address of the vector
created -- 98jan22, cca
--------------------------------------------
*/
void
ZV_sizeAndEntries (
ZV *dv,
int *psize,
double **pentries
) ;
/*
---------------------------
set and entry in the vector
created -- 98jan22, cca
---------------------------
*/
void
ZV_setEntry (
ZV *dv,
int loc,
double real,
double imag
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in util.c ------------------------------------------
------------------------------------------------------------------------
*/
/*
-----------------------------------------------------------
shift the base of the entries and adjust the dimensions
note: this is a dangerous operation because the zv->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 -- 98jan22, cca
-----------------------------------------------------------
*/
void
ZV_shiftBase (
ZV *zv,
int offset
) ;
/*
--------------------------------------
push an entry onto the list
created -- 95oct06, cca
--------------------------------------
*/
void
ZV_push (
ZV *zv,
double real,
double imag
) ;
/*
---------------------------
minimum and maximum entries
created -- 95oct06, cca
---------------------------
*/
double
ZV_minabs (
ZV *zv
) ;
/*
----------------------------------------------
return the number of bytes taken by the object
created -- 95oct06, cca
----------------------------------------------
*/
int
ZV_sizeOf (
ZV *zv
) ;
/*
--------------------------
fill a vector with a value
created -- 96jun22, cca
--------------------------
*/
void
ZV_fill (
ZV *zv,
double real,
double imag
) ;
/*
------------------------
fill a vector with zeros
created -- 98jun02, cca
------------------------
*/
void
ZV_zero (
ZV *zv
) ;
/*
--------------------------------------
copy entries from zv2 into zv1.
note: this is a "mapped" copy,
zv1 and zv2 need not be the same size.
created -- 96aug31, cca
--------------------------------------
*/
void
ZV_copy (
ZV *zv1,
ZV *zv2
) ;
/*--------------------------------------------------------------------*/
/*
------------------------------------------------------------------------
----- methods found in profile.c ---------------------------------------
------------------------------------------------------------------------
*/
/*
------------------------------------------------------------------
to fill xDV and yDV with a log10 profile of the magnitudes of
the entries in the ZV 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
ZV_log10profile (
ZV *zv,
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 ZV object from a file
input --
fn -- filename, must be *.zvb or *.zvf
return value -- 1 if success, 0 if failure
created -- 98jan22, cca
----------------------------------------------
*/
int
ZV_readFromFile (
ZV *zv,
char *fn
) ;
/*
-----------------------------------------------------
purpose -- to read an ZV object from a formatted file
return value -- 1 if success, 0 if failure
created -- 98jan22, cca
-----------------------------------------------------
*/
int
ZV_readFromFormattedFile (
ZV *zv,
FILE *fp
) ;
/*
---------------------------------------------------
purpose -- to read an ZV object from a binary file
return value -- 1 if success, 0 if failure
created -- 98jan22, cca
---------------------------------------------------
*/
int
ZV_readFromBinaryFile (
ZV *zv,
FILE *fp
) ;
/*
-------------------------------------------
purpose -- to write an ZV object to a file
input --
fn -- filename
*.zvb -- binary
*.zvf -- formatted
anything else -- for human eye
return value -- 1 if success, 0 otherwise
created -- 98jan22, cca
-------------------------------------------
*/
int
ZV_writeToFile (
ZV *zv,
char *fn
) ;
/*
-----------------------------------------------------
purpose -- to write an ZV object to a formatted file
return value -- 1 if success, 0 otherwise
created -- 98jan22, cca
-----------------------------------------------------
*/
int
ZV_writeToFormattedFile (
ZV *zv,
FILE *fp
) ;
/*
--------------------------------------------------
purpose -- to write an ZV object to a binary file
return value -- 1 if success, 0 otherwise
created -- 98jan22, cca
--------------------------------------------------
*/
int
ZV_writeToBinaryFile (
ZV *zv,
FILE *fp
) ;
/*
-------------------------------------------------
purpose -- to write an ZV object for a human eye
return value -- 1 if success, 0 otherwise
created -- 98jan22, cca
-------------------------------------------------
*/
int
ZV_writeForHumanEye (
ZV *zv,
FILE *fp
) ;
/*
---------------------------------------------------------
purpose -- to write out the statistics for the ZV object
return value -- 1 if success, 0 otherwise
created -- 98jan22, cca
---------------------------------------------------------
*/
int
ZV_writeStats (
ZV *zv,
FILE *fp
) ;
/*
--------------------------------------------------
purpose -- write the vector entries out for matlab
created -- 98apr15, cca
--------------------------------------------------
*/
void
ZV_writeForMatlab (
ZV *zv,
char *vecname,
FILE *fp
) ;
/*--------------------------------------------------------------------*/
|