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
|
/* (C) Copyright 1999, 2000, 2001, 2002, 2003, 2004, 2005 Stijn van Dongen
* (C) Copyright 2006, 2007, 2008, 2009, 2010, 2011, 2012 Stijn van Dongen
* (C) Copyright 2013 Stijn van Dongen
*
* This file is part of MCL. You can redistribute and/or modify MCL under the
* terms of the GNU General Public License; either version 3 of the License or
* (at your option) any later version. You should have received a copy of the
* GPL along with MCL, in the file COPYING.
*/
/* TODO
* unify various select routines in callback frame.
*/
#ifndef impala_vector_h
#define impala_vector_h
#include <stdio.h>
#include <stdlib.h>
#include <float.h>
#include "pval.h"
#include "ivp.h"
#include "iface.h"
#include "util/types.h"
enum
{ KBAR_SELECT_SMALL = 10000
, KBAR_SELECT_LARGE
} ;
enum
{ MCL_VECTOR_COMPLETE = 1
, MCL_VECTOR_SPARSE
} ;
typedef struct
{ dim n_ivps
; long vid /* vector id */
; double val /* for misc purposes */
; mclIvp* ivps
;
} mclVector ;
#define mclv mclVector
#define MCLV_SIZE(vec) ((vec)->n_ivps)
#define MCLV_MAXID(vec) (MCLV_SIZE(vec) ? ((vec)->ivps)[MCLV_SIZE(vec)-1].idx : 0)
#define MCLV_MINID(vec) (MCLV_SIZE(vec) ? ((vec)->ivps)[0].idx : 0)
#define MCLV_IS_CANONICAL(vec) (!(vec)->n_ivps || \
((vec)->ivps[(vec)->n_ivps-1].idx == (long) ((vec)->n_ivps-1)))
#define PNUM_IN_RANGE(pivot, offset, count) \
((pivot) >= (offset) && (pivot) < (offset) + (count))
#define PNUM_IN_INTERVAL(pivot, left_inclusive, right_inclusive) \
((pivot) >= (left_inclusive) && (pivot) < (right_inclusive))
/* below are used for reading raw input */
#define MCLV_WARN_REPEAT_ENTRIES 1
#define MCLV_WARN_REPEAT_VECTORS 2
#define MCLV_WARN_REPEAT (MCLV_WARN_REPEAT_ENTRIES|MCLV_WARN_REPEAT_VECTORS)
/* INTEGRITY
* The idx members of the ivp array need to be nonnegative and ascending.
* The val members are usually positive, but this is not mandated.
*
* The setting n_ivps == 0, ivps == NULL is obviously legal.
*
* NOTE
* Most unary and binary operations remove resulting entries that are zero.
*
* This means it is dangerous to use those operations on vectors
* representing value lists (i.e. columns from value tables) that contain
* zero-valued entries - one might want to combine two different such
* vectors simply by using mclvAdd, but the zero-valued entries will be
* removed.
*
* mclvUpdateMeet is an exception to this rule.
*/
#define MCLV_CHECK_DEFAULT 0
#define MCLV_CHECK_POSITIVE 1
#define MCLV_CHECK_NONZERO 2
#define MCLV_CHECK_NONNEGATIVE (MCLV_CHECK_POSITIVE | MCLV_CHECK_NONZERO)
mcxstatus mclvCheck
( const mclVector* vec
, long min /* inclusive */
, long max /* inclusive */
, mcxbits modes
, mcxOnFail ON_FAIL
) ;
mclVector* mclvInit
( mclVector* vec
) ;
void* mclvInit_v
( void* vec
) ;
mclVector* mclvNew
( mclp* ivps
, dim n_ivps
) ;
mclVector* mclvRenew
( mclv* dst
, mclp* ivps
, dim n_ivps
) ;
/* This leaves vec in inconsistent state unless it is shrinking
* Inconsistent meaning: ivp with idx set to -1.
*
* vec argument can be NULL.
* If the vector is reduced in size, memory is not reclaimed.
* Conceivably a fixme.
*/
mclVector* mclvResize
( mclVector* vec
, dim n_ivps
) ;
/* NOTE
* src can be NULL
*/
mclVector* mclvCopy
( mclVector* dst
, const mclVector* src
) ;
/* NOTE
* src can be NULL
*/
mclVector* mclvClone
( const mclVector* src
) ;
/* NOTE
* *vec_p can be NULL
*/
void mclvFree
( mclVector** vec_p
) ;
void mclvFree_v
( void* vec_p
) ;
void mclvRelease
( mclVector* vec
) ;
void mclvRelease_v
( void* vec
) ;
mclv* mclvFromIvps
( mclv* dst
, mclp* ivps
, dim n_ivps
) ;
mclv* mclvFromPAR
( mclv* dst
, mclpAR* par
, mcxbits warnbits
, void (*ivpmerge)(void* ivp1, const void* ivp2)
, double (*fltbinary)(pval val1, pval val2)
) ;
/*
* If mul > 0, it will map indices i to mul*i + shift.
* If mul < 0, it will map indices i to (i+shift)/mul.
* Be careful to check the validity of the result (mul < 0)!
* shift may assume all values.
*/
mclVector* mclvMap
( mclVector* dst
, long mul
, long shift
, mclVector* src
) ;
mclVector* mclvCanonical
( mclVector* dst
, dim n_ivps
, double val
) ;
/* returns number of elements in src not found in dst
* dst and src must be different.
*/
dim mclvEmbed
( mclv* dst
, const mclv* src
, double val
) ;
/* Initialize values to those in dst; if the index
* is not present then set it to val
*/
mclVector* mclvCanonicalEmbed
( mclv* dst
, const mclv* src
, dim nr
, double val
) ;
/* Further extend a canonical vector.
* dst == NULL yields a new vector.
* dst->n_ivps > N is an acceptable no-op.
* dst not canonical will proceed (with the top index)
* and issue an error
*/
mclVector* mclvCanonicalExtend
( mclv* dst
, dim N
, double val
) ;
mclVector* mclvRange
( mclVector* dst
, dim n_ivps
, dim offset
, double val
) ;
void mclvSort
( mclVector* vec
, int (*mclpCmp)(const void*, const void*)
) ;
void mclvSortAscVal
( mclVector* vec
) ;
void mclvSortDescVal
( mclVector* vec
) ;
dim mclvUniqIdx
( mclVector* vec
, void (*merge)(void* ivp1, const void* ivp2)
) ;
/* sorts vectors and discards duplicates (based on idx) */
void mclvSortUniq
( mclVector* vec
) ;
/* this one uses GQ if possible, otherwise GQ threshold * (1+epsilon) */
void mclvSelectHighest
( mclVector* vec
, dim max_n_ivps
) ;
/* always uses GQ */
void mclvSelectHighestGQ
( mclVector* vec
, dim max_n_ivps
) ;
/* always uses GT */
void mclvSelectHighestGT
( mclVector* vec
, dim max_n_ivps
) ;
/*
* ignore:
* when searching k large elements, consider only those elements that are <
* ignore. case mode = KBAR_SELECT_LARGE
*
* when searching k small elements,
* consider only those elements that are >= ignore. case mode =
* KBAR_SELECT_SMALL
*/
double mclvKBar
( mclVector *vec
, dim max_n_ivps
, double ignore
, int mode
) ;
double mclvSelectValues
( mclv* src
, double *lft /* NULL for turning of lft comparison */
, double *rgt /* NULL for turning of rgt comparison */
, mcxbits equate /* 0,1,or 2 of { MCLX_EQT_GQ, MCLX_EQT_LQ } */
, mclv* dst
) ;
dim mclvSelectIdcs
( mclv *src
, long *lft
, long *rgt
, mcxbits equate
, mclv *dst
) ;
/* this one should be a wee bit more efficient than
* mclSelectValues - it should be measured sometime though.
* mclvSelectGqBar is often called by mcl - hence the
* special purpose routine. No siblings for lt, lq,
* you have to call mclvSelectValues for those.
*/
double mclvSelectGqBar
( mclVector* vec
, double bar
) ;
double mclvSelectGtBar
( mclVector* vec
, double fbar
) ;
/* If the vector is reduced in size, memory is not reclaimed.
* Conceivably a fixme.
*/
void mclvUnary
( mclVector* vec
, double (*operation)(pval val, void* argument)
, void* argument
) ;
mclVector* mclvBinary
( const mclVector* src1
, const mclVector* src2
, mclVector* dst
, double (*operation)(pval val1, pval val2)
) ;
mclVector* mclvBinaryx
( const mclVector* src1
, const mclVector* src2
, mclVector* dst
, double (*operation)(pval val1, pval val2, pval val3)
, double arg3
) ;
/* <!!!!> Experimental.
*
* <!!!> Returns number of entries in src1 set to zero.
* This one updates src1 in the meet with src2
*
* Be aware that result (src1) could contain zero-valued entries. Perhaps you
* know it cannot e.g. because fltAdd was used on vectors with only positive
* entries, otherwise consider the possibility and what needs to be done.
* Rationale: it can be used for efficient bookkeeping, with a starting vector
* full of zeroes.
*/
dim mclvUpdateMeet
( mclVector* src1
, const mclVector* src2
, double (*operation)(pval val1, pval val2)
) ;
dim mclvUpdateDiff
( mclVector* v1
, const mclVector* v2
, double (*op)(pval mval, pval nval)
) ;
long mclvUnaryList
( mclv* mx
, mclpAR* ar /* idx: MCLX_UNARY_mode, val: arg */
) ;
dim mclvCountGiven
( mclVector* src
, mcxbool (*operation)(mclIvp* ivp, void* arg)
, void* arg
) ;
/*
* src may equal dst.
* all ivps are copied/retained for which operation
* returns true.
*/
mclVector* mclvCopyGiven
( mclVector* dst
, mclVector* src
, mcxbool (*operation)(mclIvp* ivp, void* arg)
, void* arg
, dim size_upper_bound /* 0 for I-don't-know */
) ;
mclVector* mclvAdd
( const mclVector* lft
, const mclVector* rgt
, mclVector* dst
) ;
void mclvScale
( mclVector* vec
, double fac
) ;
double mclvNormalize
( mclVector* vec
) ;
/* Returns powsum^(1/(power-1)) */
double mclvInflate
( mclVector* vec
, double power
) ;
void mclvMakeConstant
( mclVector* vec
, double val
) ;
void mclvZeroValues
( mclVector* vec
) ;
void mclvMakeCharacteristic
( mclVector* vec
) ;
void mclvHdp
( mclVector* vec
, double pow
) ;
long mclvHighestIdx
( mclVector* vec
) ;
void mclvRemoveIdx
( mclVector* vec
, long idx
) ;
/* returns new vector with NULL vec argument */
mclVector* mclvInsertIdx
( mclVector* vec
, long idx
, double val
) ;
mclVector* mclvInsertIvp
( mclVector* vec
, long idx
, mclp** ivpp
) ;
/* Efficient replacement of an index.
* The index to be removed is specified by its ofset and the index
* to be inserted must not be present already, lest STATUS_FAIL
* is returned.
* The vector is reordered to be in canonical order.
* If !vec or ofs >= vec->n_ivps STATUS_FAIL is returned.
*/
mcxstatus mclvReplaceIdx
( mclVector* vec
, long ofs
, long idx
, double val
) ;
/* inner product */
double mclvIn
( const mclVector* lft
, const mclVector* rgt
) ;
mclVector* mcldMinus
( const mclVector* lft
, const mclVector* rgt
, mclVector* dst /* value from lft (naturally) */
) ;
mclVector* mcldMerge
( const mclVector* lft
, const mclVector* rgt
, mclVector* dst /* values in lft preferred over rgt */
) ;
/* simple generic implementation */
mclVector* mcldMeet
( const mclVector* lft
, const mclVector* rgt
, mclVector* dst /* values in dst are from lft */
) ;
/* this optimizes various scenarios at cost of increased code complexity */
mclVector* mcldMeet2
( const mclVector* lft
, const mclVector* rgt
, mclVector* dst /* values in dst are from lft */
) ;
mcxbool mcldIsCanonical
( mclVector* vec
) ;
/* l: size of left difference
* r: size of right difference
* m: size of meet.
*/
enum
{ MCLD_EQT_SUPER /* r == 0 */
, MCLD_EQT_SUB /* l == 0 */
, MCLD_EQT_EQUAL /* r == 0 && l == 0 */
, MCLD_EQT_DISJOINT /* m == 0 */
, MCLD_EQT_MEET /* m != 0 */
, MCLD_EQT_TRISPHERE /* l != 0 && m != 0 && r != 0 */
, MCLD_EQT_LDIFF /* l != 0 */
, MCLD_EQT_RDIFF /* r != 0 */
} ;
mcxbool mcldEquate
( const mclVector* dom1
, const mclVector* dom2
, mcxenum mode
) ;
#define MCLD_EQUAL(d1, d2) mcldEquate((d1), (d2), MCLD_EQT_EQUAL)
#define MCLD_SUPER(d1, d2) mcldEquate((d1), (d2), MCLD_EQT_SUPER)
#define MCLD_SUB(d1, d2) mcldEquate((d1), (d2), MCLD_EQT_SUB)
#define MCLD_DISJOINT(d1, d2) mcldEquate((d1), (d2), MCLD_EQT_DISJOINT)
dim mcldCountParts
( const mclVector* dom1
, const mclVector* dom2
, dim* ldif
, dim* meet
, dim* rdif
) ;
#define MCLD_CT_LDIFF 1
#define MCLD_CT_MEET 2
#define MCLD_CT_RDIFF 4
#define MCLD_CT_JOIN 7
dim mcldCountSet
( const mclVector* dom1
, const mclVector* dom2
, mcxbits parts
) ;
double mclvSum
( const mclVector* vec
) ;
void mclvMean
( const mclv* vec
, dim N /* vec does/might not store zeroes */
, double *mean
, double *stddev
) ;
void mclvAffine
( mclv* vec
, double mean
, double stddev
) ;
double mclvSelf
( const mclVector* vec
) ;
double mclvSize
( const mclVector* vec
) ;
double mclvVal
( const mclVector* vec
) ;
double mclvSelf
( const mclVector* vec
) ;
double mclvPowSum
( const mclVector* vec
, double power
) ;
double mclvNorm
( const mclVector* vec
, double power
) ;
double mclvHasLoop
( const mclVector* vec
) ;
double mclvMaxValue
( const mclVector* vec
) ;
double mclvMinValue
( const mclVector* vec
) ;
/**********************************************************************
* *
** Some get routines.
*/
mclIvp* mclvGetIvp
( const mclv* vec
, long idx
, const mclp* offset
) ;
ofs mclvGetIvpOffset
( const mclv* vec
, long idx
, ofs offset
) ;
double mclvIdxVal
( const mclv* vec
, long idx
, ofs* p_offset
) ;
/*
* ceil is smallest ivp for which ivp.idx >= idx
* NULL if for all ivp in vec ivp.idx < idx
* (result is minimal ceil to idx)
*/
mclIvp* mclvGetIvpCeil
( const mclVector* vec
, long idx
, const mclIvp* offset
) ;
/*
* floor is largest ivp for which ivp.idx <= idx,
* NULL if for all ivp in vec ivp.idx > idx
* (result is maximal floor to idx)
*/
mclIvp* mclvGetIvpFloor
( const mclVector* vec
, long idx
, const mclIvp* offset
) ;
/**********************************************************************
* *
** Some cmp routines.
*/
/* looks first at size, then at lexicographic ordering, ignores vid. */
int mclvSizeCmp
( const void* p1
, const void* p2
) ;
int mclvSizeRevCmp
( const void* p1
, const void* p2
) ;
/* looks at lexicographic ordering, ignores vid. */
int mclvLexCmp
( const void* p1
, const void* p2
) ;
/* looks at vid only. */
int mclvVidCmp
( const void* p1
, const void* p2
) ;
int mclvValCmp
( const void* p1
, const void* p2
) ;
int mclvValRevCmp
( const void* p1
, const void* p2
) ;
int mclvSumCmp
( const void* p1
, const void* p2
) ;
int mclvSumRevCmp
( const void* p1
, const void* p2
) ;
/* modes:
* 1 vid
* 2 values
* 4 closing '$'
*/
void mclvSprintf
( mcxTing* scr
, mclv* vec
, int valdigits
, mcxbits modes
) ;
#endif
|