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