isl_vec.c

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  * Copyright 2013      Ecole Normale Superieure
   4  *
   5  * Use of this software is governed by the MIT license
   6  *
   7  * Written by Sven Verdoolaege, K.U.Leuven, Departement
   8  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
   9  * and Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
  10  */
  11
  12 #include <isl_ctx_private.h>
  13 #include <isl_seq.h>
  14 #include <isl_val_private.h>
  15 #include <isl_vec_private.h>
  16
  17 isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec)
  18 {
  19         return vec ? vec->ctx : NULL;
  20 }
  21
  22 /* Return a hash value that digests "vec".
  23  */
  24 uint32_t isl_vec_get_hash(__isl_keep isl_vec *vec)
  25 {
  26         if (!vec)
  27                 return 0;
  28
  29         return isl_seq_get_hash(vec->el, vec->size);
  30 }
  31
  32 __isl_give isl_vec *isl_vec_alloc(struct isl_ctx *ctx, unsigned size)
  33 {
  34         struct isl_vec *vec;
  35
  36         vec = isl_alloc_type(ctx, struct isl_vec);
  37         if (!vec)
  38                 return NULL;
  39
  40         vec->block = isl_blk_alloc(ctx, size);
  41         if (isl_blk_is_error(vec->block))
  42                 goto error;
  43
  44         vec->ctx = ctx;
  45         isl_ctx_ref(ctx);
  46         vec->ref = 1;
  47         vec->size = size;
  48         vec->el = vec->block.data;
  49
  50         return vec;
  51 error:
  52         isl_blk_free(ctx, vec->block);
  53         free(vec);
  54         return NULL;
  55 }
  56
  57 __isl_give isl_vec *isl_vec_extend(__isl_take isl_vec *vec, unsigned size)
  58 {
  59         if (!vec)
  60                 return NULL;
  61         if (size <= vec->size)
  62                 return vec;
  63
  64         vec = isl_vec_cow(vec);
  65         if (!vec)
  66                 return NULL;
  67
  68         vec->block = isl_blk_extend(vec->ctx, vec->block, size);
  69         if (!vec->block.data)
  70                 goto error;
  71
  72         vec->size = size;
  73         vec->el = vec->block.data;
  74
  75         return vec;
  76 error:
  77         isl_vec_free(vec);
  78         return NULL;
  79 }
  80
  81 /* Apply the expansion specified by "exp" to the "n" elements starting at "pos".
  82  * "expanded" it the number of elements that need to replace those "n"
  83  * elements.  The entries in "exp" have increasing values between
  84  * 0 and "expanded".
  85  */
  86 __isl_give isl_vec *isl_vec_expand(__isl_take isl_vec *vec, int pos, int n,
  87         int *exp, int expanded)
  88 {
  89         int i, j;
  90         int old_size, extra;
  91
  92         if (!vec)
  93                 return NULL;
  94         if (expanded < n)
  95                 isl_die(isl_vec_get_ctx(vec), isl_error_invalid,
  96                         "not an expansion", return isl_vec_free(vec));
  97         if (expanded == n)
  98                 return vec;
  99         if (pos < 0 || n < 0 || pos + n > vec->size)
 100                 isl_die(isl_vec_get_ctx(vec), isl_error_invalid,
 101                         "position out of bounds", return isl_vec_free(vec));
 102
 103         old_size = vec->size;
 104         extra = expanded - n;
 105         vec = isl_vec_extend(vec, old_size + extra);
 106         vec = isl_vec_cow(vec);
 107         if (!vec)
 108                 return NULL;
 109
 110         for (i = old_size - 1; i >= pos + n; --i)
 111                 isl_int_set(vec->el[i + extra], vec->el[i]);
 112
 113         j = n - 1;
 114         for (i = expanded - 1; i >= 0; --i) {
 115                 if (j >= 0 && exp[j] == i) {
 116                         if (i != j)
 117                                 isl_int_swap(vec->el[pos + i],
 118                                              vec->el[pos + j]);
 119                         j--;
 120                 } else {
 121                         isl_int_set_si(vec->el[pos + i], 0);
 122                 }
 123         }
 124
 125         return vec;
 126 }
 127
 128 /* Create a vector of size "size" with zero-valued elements.
 129  */
 130 __isl_give isl_vec *isl_vec_zero(isl_ctx *ctx, unsigned size)
 131 {
 132         isl_vec *vec;
 133
 134         vec = isl_vec_alloc(ctx, size);
 135         if (!vec)
 136                 return NULL;
 137         isl_seq_clr(vec->el, size);
 138         return vec;
 139 }
 140
 141 __isl_give isl_vec *isl_vec_zero_extend(__isl_take isl_vec *vec, unsigned size)
 142 {
 143         int extra;
 144
 145         if (!vec)
 146                 return NULL;
 147         if (size <= vec->size)
 148                 return vec;
 149
 150         vec = isl_vec_cow(vec);
 151         if (!vec)
 152                 return NULL;
 153
 154         extra = size - vec->size;
 155         vec = isl_vec_extend(vec, size);
 156         if (!vec)
 157                 return NULL;
 158
 159         isl_seq_clr(vec->el + size - extra, extra);
 160
 161         return vec;
 162 }
 163
 164 /* Return a vector containing the elements of "vec1" followed by
 165  * those of "vec2".
 166  */
 167 __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
 168         __isl_take isl_vec *vec2)
 169 {
 170         if (!vec1 || !vec2)
 171                 goto error;
 172
 173         if (vec2->size == 0) {
 174                 isl_vec_free(vec2);
 175                 return vec1;
 176         }
 177
 178         if (vec1->size == 0) {
 179                 isl_vec_free(vec1);
 180                 return vec2;
 181         }
 182
 183         vec1 = isl_vec_extend(vec1, vec1->size + vec2->size);
 184         if (!vec1)
 185                 goto error;
 186
 187         isl_seq_cpy(vec1->el + vec1->size - vec2->size, vec2->el, vec2->size);
 188
 189         isl_vec_free(vec2);
 190         return vec1;
 191 error:
 192         isl_vec_free(vec1);
 193         isl_vec_free(vec2);
 194         return NULL;
 195 }
 196
 197 struct isl_vec *isl_vec_copy(struct isl_vec *vec)
 198 {
 199         if (!vec)
 200                 return NULL;
 201
 202         vec->ref++;
 203         return vec;
 204 }
 205
 206 struct isl_vec *isl_vec_dup(struct isl_vec *vec)
 207 {
 208         struct isl_vec *vec2;
 209
 210         if (!vec)
 211                 return NULL;
 212         vec2 = isl_vec_alloc(vec->ctx, vec->size);
 213         if (!vec2)
 214                 return NULL;
 215         isl_seq_cpy(vec2->el, vec->el, vec->size);
 216         return vec2;
 217 }
 218
 219 struct isl_vec *isl_vec_cow(struct isl_vec *vec)
 220 {
 221         struct isl_vec *vec2;
 222         if (!vec)
 223                 return NULL;
 224
 225         if (vec->ref == 1)
 226                 return vec;
 227
 228         vec2 = isl_vec_dup(vec);
 229         isl_vec_free(vec);
 230         return vec2;
 231 }
 232
 233 __isl_null isl_vec *isl_vec_free(__isl_take isl_vec *vec)
 234 {
 235         if (!vec)
 236                 return NULL;
 237
 238         if (--vec->ref > 0)
 239                 return NULL;
 240
 241         isl_ctx_deref(vec->ctx);
 242         isl_blk_free(vec->ctx, vec->block);
 243         free(vec);
 244
 245         return NULL;
 246 }
 247
 248 int isl_vec_size(__isl_keep isl_vec *vec)
 249 {
 250         return vec ? vec->size : -1;
 251 }
 252
 253 /* Check that "pos" is a valid element position for "vec".
 254  */
 255 static isl_stat check_pos(__isl_keep isl_vec *vec, int pos)
 256 {
 257         if (!vec)
 258                 return isl_stat_error;
 259         if (pos < 0 || pos >= vec->size)
 260                 isl_die(isl_vec_get_ctx(vec), isl_error_invalid,
 261                         "position out of range", return isl_stat_error);
 262         return isl_stat_ok;
 263 }
 264
 265 /* Is the element at position "pos" of "vec" equal to zero?
 266  */
 267 isl_bool isl_vec_element_is_zero(__isl_keep isl_vec *vec, int pos)
 268 {
 269         if (check_pos(vec, pos) < 0)
 270                 return isl_bool_error;
 271         return isl_int_is_zero(vec->el[pos]);
 272 }
 273
 274 /* Extract the element at position "pos" of "vec".
 275  */
 276 __isl_give isl_val *isl_vec_get_element_val(__isl_keep isl_vec *vec, int pos)
 277 {
 278         isl_ctx *ctx;
 279
 280         if (check_pos(vec, pos) < 0)
 281                 return NULL;
 282         ctx = isl_vec_get_ctx(vec);
 283         return isl_val_int_from_isl_int(ctx, vec->el[pos]);
 284 }
 285
 286 __isl_give isl_vec *isl_vec_set_element(__isl_take isl_vec *vec,
 287         int pos, isl_int v)
 288 {
 289         if (check_pos(vec, pos) < 0)
 290                 return isl_vec_free(vec);
 291         vec = isl_vec_cow(vec);
 292         if (!vec)
 293                 return NULL;
 294         isl_int_set(vec->el[pos], v);
 295         return vec;
 296 }
 297
 298 __isl_give isl_vec *isl_vec_set_element_si(__isl_take isl_vec *vec,
 299         int pos, int v)
 300 {
 301         if (check_pos(vec, pos) < 0)
 302                 return isl_vec_free(vec);
 303         vec = isl_vec_cow(vec);
 304         if (!vec)
 305                 return NULL;
 306         isl_int_set_si(vec->el[pos], v);
 307         return vec;
 308 }
 309
 310 /* Replace the element at position "pos" of "vec" by "v".
 311  */
 312 __isl_give isl_vec *isl_vec_set_element_val(__isl_take isl_vec *vec,
 313         int pos, __isl_take isl_val *v)
 314 {
 315         if (!v)
 316                 return isl_vec_free(vec);
 317         if (!isl_val_is_int(v))
 318                 isl_die(isl_val_get_ctx(v), isl_error_invalid,
 319                         "expecting integer value", goto error);
 320         vec = isl_vec_set_element(vec, pos, v->n);
 321         isl_val_free(v);
 322         return vec;
 323 error:
 324         isl_val_free(v);
 325         return isl_vec_free(vec);
 326 }
 327
 328 /* Compare the elements of "vec1" and "vec2" at position "pos".
 329  */
 330 int isl_vec_cmp_element(__isl_keep isl_vec *vec1, __isl_keep isl_vec *vec2,
 331         int pos)
 332 {
 333         if (check_pos(vec1, pos) < 0 || check_pos(vec2, pos) < 0)
 334                 return 0;
 335         return isl_int_cmp(vec1->el[pos], vec2->el[pos]);
 336 }
 337
 338 /* Does "vec" contain only zero elements?
 339  */
 340 isl_bool isl_vec_is_zero(__isl_keep isl_vec *vec)
 341 {
 342         if (!vec)
 343                 return isl_bool_error;
 344         return isl_seq_first_non_zero(vec->el, vec->size) < 0;
 345 }
 346
 347 isl_bool isl_vec_is_equal(__isl_keep isl_vec *vec1, __isl_keep isl_vec *vec2)
 348 {
 349         if (!vec1 || !vec2)
 350                 return isl_bool_error;
 351
 352         if (vec1->size != vec2->size)
 353                 return isl_bool_false;
 354
 355         return isl_seq_eq(vec1->el, vec2->el, vec1->size);
 356 }
 357
 358 __isl_give isl_printer *isl_printer_print_vec(__isl_take isl_printer *printer,
 359         __isl_keep isl_vec *vec)
 360 {
 361         int i;
 362
 363         if (!printer || !vec)
 364                 goto error;
 365
 366         printer = isl_printer_print_str(printer, "[");
 367         for (i = 0; i < vec->size; ++i) {
 368                 if (i)
 369                         printer = isl_printer_print_str(printer, ",");
 370                 printer = isl_printer_print_isl_int(printer, vec->el[i]);
 371         }
 372         printer = isl_printer_print_str(printer, "]");
 373
 374         return printer;
 375 error:
 376         isl_printer_free(printer);
 377         return NULL;
 378 }
 379
 380 void isl_vec_dump(struct isl_vec *vec)
 381 {
 382         isl_printer *printer;
 383
 384         if (!vec)
 385                 return;
 386
 387         printer = isl_printer_to_file(vec->ctx, stderr);
 388         printer = isl_printer_print_vec(printer, vec);
 389         printer = isl_printer_end_line(printer);
 390
 391         isl_printer_free(printer);
 392 }
 393
 394 __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec, isl_int v)
 395 {
 396         vec = isl_vec_cow(vec);
 397         if (!vec)
 398                 return NULL;
 399         isl_seq_set(vec->el, v, vec->size);
 400         return vec;
 401 }
 402
 403 __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec, int v)
 404 {
 405         vec = isl_vec_cow(vec);
 406         if (!vec)
 407                 return NULL;
 408         isl_seq_set_si(vec->el, v, vec->size);
 409         return vec;
 410 }
 411
 412 /* Replace all elements of "vec" by "v".
 413  */
 414 __isl_give isl_vec *isl_vec_set_val(__isl_take isl_vec *vec,
 415         __isl_take isl_val *v)
 416 {
 417         vec = isl_vec_cow(vec);
 418         if (!vec || !v)
 419                 goto error;
 420         if (!isl_val_is_int(v))
 421                 isl_die(isl_val_get_ctx(v), isl_error_invalid,
 422                         "expecting integer value", goto error);
 423         isl_seq_set(vec->el, v->n, vec->size);
 424         isl_val_free(v);
 425         return vec;
 426 error:
 427         isl_vec_free(vec);
 428         isl_val_free(v);
 429         return NULL;
 430 }
 431
 432 __isl_give isl_vec *isl_vec_clr(__isl_take isl_vec *vec)
 433 {
 434         vec = isl_vec_cow(vec);
 435         if (!vec)
 436                 return NULL;
 437         isl_seq_clr(vec->el, vec->size);
 438         return vec;
 439 }
 440
 441 void isl_vec_lcm(struct isl_vec *vec, isl_int *lcm)
 442 {
 443         isl_seq_lcm(vec->block.data, vec->size, lcm);
 444 }
 445
 446 /* Given a rational vector, with the denominator in the first element
 447  * of the vector, round up all coordinates.
 448  */
 449 __isl_give isl_vec *isl_vec_ceil(__isl_take isl_vec *vec)
 450 {
 451         vec = isl_vec_cow(vec);
 452         if (!vec)
 453                 return NULL;
 454
 455         isl_seq_cdiv_q(vec->el + 1, vec->el + 1, vec->el[0], vec->size - 1);
 456
 457         isl_int_set_si(vec->el[0], 1);
 458
 459         return vec;
 460 }
 461
 462 struct isl_vec *isl_vec_normalize(struct isl_vec *vec)
 463 {
 464         if (!vec)
 465                 return NULL;
 466         isl_seq_normalize(vec->ctx, vec->el, vec->size);
 467         return vec;
 468 }
 469
 470 __isl_give isl_vec *isl_vec_neg(__isl_take isl_vec *vec)
 471 {
 472         vec = isl_vec_cow(vec);
 473         if (!vec)
 474                 return NULL;
 475         isl_seq_neg(vec->el, vec->el, vec->size);
 476         return vec;
 477 }
 478
 479 __isl_give isl_vec *isl_vec_scale(__isl_take isl_vec *vec, isl_int m)
 480 {
 481         if (isl_int_is_one(m))
 482                 return vec;
 483         vec = isl_vec_cow(vec);
 484         if (!vec)
 485                 return NULL;
 486         isl_seq_scale(vec->el, vec->el, m, vec->size);
 487         return vec;
 488 }
 489
 490 /* Reduce the elements of "vec" modulo "m".
 491  */
 492 __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec, isl_int m)
 493 {
 494         vec = isl_vec_cow(vec);
 495         if (!vec)
 496                 return NULL;
 497
 498         isl_seq_fdiv_r(vec->el, vec->el, m, vec->size);
 499
 500         return vec;
 501 }
 502
 503 __isl_give isl_vec *isl_vec_add(__isl_take isl_vec *vec1,
 504         __isl_take isl_vec *vec2)
 505 {
 506         vec1 = isl_vec_cow(vec1);
 507         if (!vec1 || !vec2)
 508                 goto error;
 509
 510         isl_assert(vec1->ctx, vec1->size == vec2->size, goto error);
 511
 512         isl_seq_combine(vec1->el, vec1->ctx->one, vec1->el,
 513                         vec1->ctx->one, vec2->el, vec1->size);
 514
 515         isl_vec_free(vec2);
 516         return vec1;
 517 error:
 518         isl_vec_free(vec1);
 519         isl_vec_free(vec2);
 520         return NULL;
 521 }
 522
 523 static int qsort_int_cmp(const void *p1, const void *p2)
 524 {
 525         const isl_int *i1 = (const isl_int *) p1;
 526         const isl_int *i2 = (const isl_int *) p2;
 527
 528         return isl_int_cmp(*i1, *i2);
 529 }
 530
 531 __isl_give isl_vec *isl_vec_sort(__isl_take isl_vec *vec)
 532 {
 533         if (!vec)
 534                 return NULL;
 535
 536         qsort(vec->el, vec->size, sizeof(*vec->el), &qsort_int_cmp);
 537
 538         return vec;
 539 }
 540
 541 __isl_give isl_vec *isl_vec_drop_els(__isl_take isl_vec *vec,
 542         unsigned pos, unsigned n)
 543 {
 544         if (n == 0)
 545                 return vec;
 546         vec = isl_vec_cow(vec);
 547         if (!vec)
 548                 return NULL;
 549
 550         if (pos + n > vec->size)
 551                 isl_die(vec->ctx, isl_error_invalid,
 552                         "range out of bounds", goto error);
 553
 554         if (pos + n != vec->size)
 555                 isl_seq_cpy(vec->el + pos, vec->el + pos + n,
 556                             vec->size - pos - n);
 557
 558         vec->size -= n;
 559
 560         return vec;
 561 error:
 562         isl_vec_free(vec);
 563         return NULL;
 564 }
 565
 566 __isl_give isl_vec *isl_vec_insert_els(__isl_take isl_vec *vec,
 567         unsigned pos, unsigned n)
 568 {
 569         isl_vec *ext = NULL;
 570
 571         if (n == 0)
 572                 return vec;
 573         if (!vec)
 574                 return NULL;
 575
 576         if (pos > vec->size)
 577                 isl_die(vec->ctx, isl_error_invalid,
 578                         "position out of bounds", goto error);
 579
 580         ext =  isl_vec_alloc(vec->ctx, vec->size + n);
 581         if (!ext)
 582                 goto error;
 583
 584         isl_seq_cpy(ext->el, vec->el, pos);
 585         isl_seq_cpy(ext->el + pos + n, vec->el + pos, vec->size - pos);
 586
 587         isl_vec_free(vec);
 588         return ext;
 589 error:
 590         isl_vec_free(vec);
 591         isl_vec_free(ext);
 592         return NULL;
 593 }
 594
 595 __isl_give isl_vec *isl_vec_insert_zero_els(__isl_take isl_vec *vec,
 596         unsigned pos, unsigned n)
 597 {
 598         vec = isl_vec_insert_els(vec, pos, n);
 599         if (!vec)
 600                 return NULL;
 601
 602         isl_seq_clr(vec->el + pos, n);
 603
 604         return vec;
 605 }
 606
 607 /* Move the "n" elements starting as "src_pos" of "vec"
 608  * to "dst_pos".  The elements originally at "dst_pos" are moved
 609  * up or down depending on whether "dst_pos" is smaller or greater
 610  * than "src_pos".
 611  */
 612 __isl_give isl_vec *isl_vec_move_els(__isl_take isl_vec *vec,
 613         unsigned dst_pos, unsigned src_pos, unsigned n)
 614 {
 615         isl_vec *res;
 616
 617         if (!vec)
 618                 return NULL;
 619
 620         if (src_pos + n > vec->size)
 621                 isl_die(vec->ctx, isl_error_invalid,
 622                         "source range out of bounds", return isl_vec_free(vec));
 623         if (dst_pos + n > vec->size)
 624                 isl_die(vec->ctx, isl_error_invalid,
 625                         "destination range out of bounds",
 626                         return isl_vec_free(vec));
 627
 628         if (n == 0 || dst_pos == src_pos)
 629                 return vec;
 630
 631         res = isl_vec_alloc(vec->ctx, vec->size);
 632         if (!res)
 633                 return isl_vec_free(vec);
 634
 635         if (dst_pos < src_pos) {
 636                 isl_seq_cpy(res->el, vec->el, dst_pos);
 637                 isl_seq_cpy(res->el + dst_pos, vec->el + src_pos, n);
 638                 isl_seq_cpy(res->el + dst_pos + n,
 639                             vec->el + dst_pos, src_pos - dst_pos);
 640                 isl_seq_cpy(res->el + src_pos + n,
 641                             vec->el + src_pos + n, res->size - src_pos - n);
 642         } else {
 643                 isl_seq_cpy(res->el, vec->el, src_pos);
 644                 isl_seq_cpy(res->el + src_pos,
 645                             vec->el + src_pos + n, dst_pos - src_pos);
 646                 isl_seq_cpy(res->el + dst_pos, vec->el + src_pos, n);
 647                 isl_seq_cpy(res->el + dst_pos + n,
 648                             vec->el + dst_pos + n, res->size - dst_pos - n);
 649         }
 650
 651         isl_vec_free(vec);
 652         return res;
 653 }