isl_affine_hull.c

   1 #include "isl_ctx.h"
   2 #include "isl_seq.h"
   3 #include "isl_set.h"
   4 #include "isl_lp.h"
   5 #include "isl_map.h"
   6 #include "isl_map_private.h"
   7 #include "isl_equalities.h"
   8 #include "isl_sample.h"
   9 #include "isl_tab.h"
  10
  11 struct isl_basic_map *isl_basic_map_implicit_equalities(
  12                                                 struct isl_basic_map *bmap)
  13 {
  14         struct isl_tab *tab;
  15
  16         if (!bmap)
  17                 return bmap;
  18
  19         bmap = isl_basic_map_gauss(bmap, NULL);
  20         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_EMPTY))
  21                 return bmap;
  22         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_NO_IMPLICIT))
  23                 return bmap;
  24         if (bmap->n_ineq <= 1)
  25                 return bmap;
  26
  27         tab = isl_tab_from_basic_map(bmap);
  28         tab = isl_tab_detect_equalities(bmap->ctx, tab);
  29         bmap = isl_basic_map_update_from_tab(bmap, tab);
  30         isl_tab_free(bmap->ctx, tab);
  31         ISL_F_SET(bmap, ISL_BASIC_MAP_NO_IMPLICIT);
  32         return bmap;
  33 }
  34
  35 /* Make eq[row][col] of both bmaps equal so we can add the row
  36  * add the column to the common matrix.
  37  * Note that because of the echelon form, the columns of row row
  38  * after column col are zero.
  39  */
  40 static void set_common_multiple(
  41         struct isl_basic_set *bset1, struct isl_basic_set *bset2,
  42         unsigned row, unsigned col)
  43 {
  44         isl_int m, c;
  45
  46         if (isl_int_eq(bset1->eq[row][col], bset2->eq[row][col]))
  47                 return;
  48
  49         isl_int_init(c);
  50         isl_int_init(m);
  51         isl_int_lcm(m, bset1->eq[row][col], bset2->eq[row][col]);
  52         isl_int_divexact(c, m, bset1->eq[row][col]);
  53         isl_seq_scale(bset1->eq[row], bset1->eq[row], c, col+1);
  54         isl_int_divexact(c, m, bset2->eq[row][col]);
  55         isl_seq_scale(bset2->eq[row], bset2->eq[row], c, col+1);
  56         isl_int_clear(c);
  57         isl_int_clear(m);
  58 }
  59
  60 /* Delete a given equality, moving all the following equalities one up.
  61  */
  62 static void delete_row(struct isl_basic_set *bset, unsigned row)
  63 {
  64         isl_int *t;
  65         int r;
  66
  67         t = bset->eq[row];
  68         bset->n_eq--;
  69         for (r = row; r < bset->n_eq; ++r)
  70                 bset->eq[r] = bset->eq[r+1];
  71         bset->eq[bset->n_eq] = t;
  72 }
  73
  74 /* Make first row entries in column col of bset1 identical to
  75  * those of bset2, using the fact that entry bset1->eq[row][col]=a
  76  * is non-zero.  Initially, these elements of bset1 are all zero.
  77  * For each row i < row, we set
  78  *              A[i] = a * A[i] + B[i][col] * A[row]
  79  *              B[i] = a * B[i]
  80  * so that
  81  *              A[i][col] = B[i][col] = a * old(B[i][col])
  82  */
  83 static void construct_column(
  84         struct isl_basic_set *bset1, struct isl_basic_set *bset2,
  85         unsigned row, unsigned col)
  86 {
  87         int r;
  88         isl_int a;
  89         isl_int b;
  90         unsigned total;
  91
  92         isl_int_init(a);
  93         isl_int_init(b);
  94         total = 1 + isl_basic_set_n_dim(bset1);
  95         for (r = 0; r < row; ++r) {
  96                 if (isl_int_is_zero(bset2->eq[r][col]))
  97                         continue;
  98                 isl_int_gcd(b, bset2->eq[r][col], bset1->eq[row][col]);
  99                 isl_int_divexact(a, bset1->eq[row][col], b);
 100                 isl_int_divexact(b, bset2->eq[r][col], b);
 101                 isl_seq_combine(bset1->eq[r], a, bset1->eq[r],
 102                                               b, bset1->eq[row], total);
 103                 isl_seq_scale(bset2->eq[r], bset2->eq[r], a, total);
 104         }
 105         isl_int_clear(a);
 106         isl_int_clear(b);
 107         delete_row(bset1, row);
 108 }
 109
 110 /* Make first row entries in column col of bset1 identical to
 111  * those of bset2, using only these entries of the two matrices.
 112  * Let t be the last row with different entries.
 113  * For each row i < t, we set
 114  *      A[i] = (A[t][col]-B[t][col]) * A[i] + (B[i][col]-A[i][col) * A[t]
 115  *      B[i] = (A[t][col]-B[t][col]) * B[i] + (B[i][col]-A[i][col) * B[t]
 116  * so that
 117  *      A[i][col] = B[i][col] = old(A[t][col]*B[i][col]-A[i][col]*B[t][col])
 118  */
 119 static int transform_column(
 120         struct isl_basic_set *bset1, struct isl_basic_set *bset2,
 121         unsigned row, unsigned col)
 122 {
 123         int i, t;
 124         isl_int a, b, g;
 125         unsigned total;
 126
 127         for (t = row-1; t >= 0; --t)
 128                 if (isl_int_ne(bset1->eq[t][col], bset2->eq[t][col]))
 129                         break;
 130         if (t < 0)
 131                 return 0;
 132
 133         total = 1 + isl_basic_set_n_dim(bset1);
 134         isl_int_init(a);
 135         isl_int_init(b);
 136         isl_int_init(g);
 137         isl_int_sub(b, bset1->eq[t][col], bset2->eq[t][col]);
 138         for (i = 0; i < t; ++i) {
 139                 isl_int_sub(a, bset2->eq[i][col], bset1->eq[i][col]);
 140                 isl_int_gcd(g, a, b);
 141                 isl_int_divexact(a, a, g);
 142                 isl_int_divexact(g, b, g);
 143                 isl_seq_combine(bset1->eq[i], g, bset1->eq[i], a, bset1->eq[t],
 144                                 total);
 145                 isl_seq_combine(bset2->eq[i], g, bset2->eq[i], a, bset2->eq[t],
 146                                 total);
 147         }
 148         isl_int_clear(a);
 149         isl_int_clear(b);
 150         isl_int_clear(g);
 151         delete_row(bset1, t);
 152         delete_row(bset2, t);
 153         return 1;
 154 }
 155
 156 /* The implementation is based on Section 5.2 of Michael Karr,
 157  * "Affine Relationships Among Variables of a Program",
 158  * except that the echelon form we use starts from the last column
 159  * and that we are dealing with integer coefficients.
 160  */
 161 static struct isl_basic_set *affine_hull(
 162         struct isl_basic_set *bset1, struct isl_basic_set *bset2)
 163 {
 164         unsigned total;
 165         int col;
 166         int row;
 167
 168         total = 1 + isl_basic_set_n_dim(bset1);
 169
 170         row = 0;
 171         for (col = total-1; col >= 0; --col) {
 172                 int is_zero1 = row >= bset1->n_eq ||
 173                         isl_int_is_zero(bset1->eq[row][col]);
 174                 int is_zero2 = row >= bset2->n_eq ||
 175                         isl_int_is_zero(bset2->eq[row][col]);
 176                 if (!is_zero1 && !is_zero2) {
 177                         set_common_multiple(bset1, bset2, row, col);
 178                         ++row;
 179                 } else if (!is_zero1 && is_zero2) {
 180                         construct_column(bset1, bset2, row, col);
 181                 } else if (is_zero1 && !is_zero2) {
 182                         construct_column(bset2, bset1, row, col);
 183                 } else {
 184                         if (transform_column(bset1, bset2, row, col))
 185                                 --row;
 186                 }
 187         }
 188         isl_basic_set_free(bset2);
 189         isl_assert(ctx, row == bset1->n_eq, goto error);
 190         return bset1;
 191 error:
 192         isl_basic_set_free(bset1);
 193         return NULL;
 194 }
 195
 196 static struct isl_basic_set *isl_basic_set_from_vec(struct isl_ctx *ctx,
 197         struct isl_vec *vec)
 198 {
 199         int i;
 200         int k;
 201         struct isl_basic_set *bset = NULL;
 202         unsigned dim;
 203
 204         if (!vec)
 205                 return NULL;
 206         isl_assert(ctx, vec->size != 0, goto error);
 207
 208         bset = isl_basic_set_alloc(ctx, 0, vec->size - 1, 0, vec->size - 1, 0);
 209         if (!bset)
 210                 goto error;
 211         dim = isl_basic_set_n_dim(bset);
 212         for (i = dim - 1; i >= 0; --i) {
 213                 k = isl_basic_set_alloc_equality(bset);
 214                 if (k < 0)
 215                         goto error;
 216                 isl_seq_clr(bset->eq[k], 1 + dim);
 217                 isl_int_neg(bset->eq[k][0], vec->block.data[1 + i]);
 218                 isl_int_set(bset->eq[k][1 + i], vec->block.data[0]);
 219         }
 220         isl_vec_free(ctx, vec);
 221
 222         return bset;
 223 error:
 224         isl_basic_set_free(bset);
 225         isl_vec_free(ctx, vec);
 226         return NULL;
 227 }
 228
 229 /* Find an integer point in "bset" that lies outside of the equality
 230  * "eq" e(x) = 0.
 231  * If "up" is true, look for a point satisfying e(x) - 1 >= 0.
 232  * Otherwise, look for a point satisfying -e(x) - 1 >= 0 (i.e., e(x) <= -1).
 233  * The point, if found, is returned as a singleton set.
 234  * If no point can be found, the empty set is returned.
 235  */
 236 static struct isl_basic_set *outside_point(struct isl_ctx *ctx,
 237         struct isl_basic_set *bset, isl_int *eq, int up)
 238 {
 239         struct isl_basic_set *slice = NULL;
 240         struct isl_vec *sample;
 241         struct isl_basic_set *point;
 242         unsigned dim;
 243         int k;
 244
 245         slice = isl_basic_set_copy(bset);
 246         if (!slice)
 247                 goto error;
 248         dim = isl_basic_set_n_dim(slice);
 249         slice = isl_basic_set_cow(slice);
 250         slice = isl_basic_set_extend(slice, 0, dim, 0, 0, 1);
 251         k = isl_basic_set_alloc_inequality(slice);
 252         if (k < 0)
 253                 goto error;
 254         if (up)
 255                 isl_seq_cpy(slice->ineq[k], eq, 1 + dim);
 256         else
 257                 isl_seq_neg(slice->ineq[k], eq, 1 + dim);
 258         isl_int_sub_ui(slice->ineq[k][0], slice->ineq[k][0], 1);
 259
 260         sample = isl_basic_set_sample(slice);
 261         if (!sample)
 262                 goto error;
 263         if (sample->size == 0) {
 264                 isl_vec_free(ctx, sample);
 265                 point = isl_basic_set_empty_like(bset);
 266         } else
 267                 point = isl_basic_set_from_vec(ctx, sample);
 268
 269         return point;
 270 error:
 271         isl_basic_set_free(slice);
 272         return NULL;
 273 }
 274
 275 /* Look for all equalities satisfied by the integer points in bset,
 276  * which is assume not to have any explicit equalities.
 277  *
 278  * The equalities are obtained by successively looking for
 279  * a point that is affinely independent of the points found so far.
 280  * In particular, for each equality satisfied by the points so far,
 281  * we check if there is any point on a hyperplane parallel to the
 282  * corresponding hyperplane shifted by at least one (in either direction).
 283  */
 284 static struct isl_basic_set *uset_affine_hull(struct isl_basic_set *bset)
 285 {
 286         int i, j;
 287         struct isl_basic_set *hull = NULL;
 288         struct isl_vec *sample;
 289         struct isl_ctx *ctx;
 290         unsigned dim;
 291
 292         if (isl_basic_set_is_empty(bset))
 293                 return bset;
 294
 295         ctx = bset->ctx;
 296         sample = isl_basic_set_sample(isl_basic_set_copy(bset));
 297         if (!sample)
 298                 goto error;
 299         if (sample->size == 0) {
 300                 isl_vec_free(ctx, sample);
 301                 hull = isl_basic_set_empty_like(bset);
 302                 isl_basic_set_free(bset);
 303                 return hull;
 304         } else
 305                 hull = isl_basic_set_from_vec(ctx, sample);
 306
 307         dim = isl_basic_set_n_dim(bset);
 308         for (i = 0; i < dim; ++i) {
 309                 struct isl_basic_set *point;
 310                 for (j = 0; j < hull->n_eq; ++j) {
 311                         point = outside_point(ctx, bset, hull->eq[j], 1);
 312                         if (!point)
 313                                 goto error;
 314                         if (!ISL_F_ISSET(point, ISL_BASIC_SET_EMPTY))
 315                                 break;
 316                         isl_basic_set_free(point);
 317                         point = outside_point(ctx, bset, hull->eq[j], 0);
 318                         if (!point)
 319                                 goto error;
 320                         if (!ISL_F_ISSET(point, ISL_BASIC_SET_EMPTY))
 321                                 break;
 322                         isl_basic_set_free(point);
 323                 }
 324                 if (j == hull->n_eq)
 325                         break;
 326                 hull = affine_hull(hull, point);
 327         }
 328         isl_basic_set_free(bset);
 329
 330         return hull;
 331 error:
 332         isl_basic_set_free(bset);
 333         isl_basic_set_free(hull);
 334         return NULL;
 335 }
 336
 337 /* Look for all equalities satisfied by the integer points in bmap
 338  * that are independent of the equalities already explicitly available
 339  * in bmap.
 340  *
 341  * We first remove all equalities already explicitly available,
 342  * then look for additional equalities in the reduced space
 343  * and then transform the result to the original space.
 344  * The original equalities are _not_ added to this set.  This is
 345  * the responsibility of the calling function.
 346  * The resulting basic set has all meaning about the dimensions removed.
 347  * In particular, dimensions that correspond to existential variables
 348  * in bmap and that are found to be fixed are not removed.
 349  */
 350 static struct isl_basic_set *equalities_in_underlying_set(
 351                                                 struct isl_basic_map *bmap)
 352 {
 353         struct isl_mat *T2 = NULL;
 354         struct isl_basic_set *bset = NULL;
 355         struct isl_basic_set *hull = NULL;
 356         struct isl_ctx *ctx;
 357
 358         ctx = bmap->ctx;
 359         bset = isl_basic_map_underlying_set(bmap);
 360         bset = isl_basic_set_remove_equalities(bset, NULL, &T2);
 361         if (!bset)
 362                 goto error;
 363
 364         hull = uset_affine_hull(bset);
 365         if (T2)
 366                 hull = isl_basic_set_preimage(hull, T2);
 367
 368         return hull;
 369 error:
 370         isl_mat_free(ctx, T2);
 371         isl_basic_set_free(bset);
 372         isl_basic_set_free(hull);
 373         return NULL;
 374 }
 375
 376 /* Detect and make explicit all equalities satisfied by the (integer)
 377  * points in bmap.
 378  */
 379 struct isl_basic_map *isl_basic_map_detect_equalities(
 380                                                 struct isl_basic_map *bmap)
 381 {
 382         int i, j;
 383         struct isl_basic_set *hull = NULL;
 384
 385         if (!bmap)
 386                 return NULL;
 387         if (bmap->n_ineq == 0)
 388                 return bmap;
 389         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_EMPTY))
 390                 return bmap;
 391         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_ALL_EQUALITIES))
 392                 return bmap;
 393         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_RATIONAL))
 394                 return isl_basic_map_implicit_equalities(bmap);
 395
 396         hull = equalities_in_underlying_set(isl_basic_map_copy(bmap));
 397         if (!hull)
 398                 goto error;
 399         bmap = isl_basic_map_extend_dim(bmap, isl_dim_copy(bmap->dim), 0,
 400                                         hull->n_eq, 0);
 401         for (i = 0; i < hull->n_eq; ++i) {
 402                 j = isl_basic_map_alloc_equality(bmap);
 403                 if (j < 0)
 404                         goto error;
 405                 isl_seq_cpy(bmap->eq[j], hull->eq[i],
 406                                 1 + isl_basic_set_total_dim(hull));
 407         }
 408         isl_basic_set_free(hull);
 409         ISL_F_SET(bmap, ISL_BASIC_MAP_NO_IMPLICIT | ISL_BASIC_MAP_ALL_EQUALITIES);
 410         bmap = isl_basic_map_simplify(bmap);
 411         return isl_basic_map_finalize(bmap);
 412 error:
 413         isl_basic_set_free(hull);
 414         isl_basic_map_free(bmap);
 415         return NULL;
 416 }
 417
 418 struct isl_map *isl_map_detect_equalities(struct isl_map *map)
 419 {
 420         struct isl_basic_map *bmap;
 421         int i;
 422
 423         if (!map)
 424                 return NULL;
 425
 426         for (i = 0; i < map->n; ++i) {
 427                 bmap = isl_basic_map_copy(map->p[i]);
 428                 bmap = isl_basic_map_detect_equalities(bmap);
 429                 if (!bmap)
 430                         goto error;
 431                 isl_basic_map_free(map->p[i]);
 432                 map->p[i] = bmap;
 433         }
 434
 435         return map;
 436 error:
 437         isl_map_free(map);
 438         return NULL;
 439 }
 440
 441 /* After computing the rational affine hull (by detecting the implicit
 442  * equalities), we compute the additional equalities satisfied by
 443  * the integer points (if any) and add the original equalities back in.
 444  */
 445 struct isl_basic_map *isl_basic_map_affine_hull(struct isl_basic_map *bmap)
 446 {
 447         struct isl_basic_set *hull = NULL;
 448
 449         bmap = isl_basic_map_detect_equalities(bmap);
 450         bmap = isl_basic_map_cow(bmap);
 451         isl_basic_map_free_inequality(bmap, bmap->n_ineq);
 452         return bmap;
 453 }
 454
 455 struct isl_basic_set *isl_basic_set_affine_hull(struct isl_basic_set *bset)
 456 {
 457         return (struct isl_basic_set *)
 458                 isl_basic_map_affine_hull((struct isl_basic_map *)bset);
 459 }
 460
 461 struct isl_basic_map *isl_map_affine_hull(struct isl_map *map)
 462 {
 463         int i;
 464         struct isl_basic_map *model = NULL;
 465         struct isl_basic_map *hull = NULL;
 466         struct isl_set *set;
 467
 468         if (!map)
 469                 return NULL;
 470
 471         if (map->n == 0) {
 472                 hull = isl_basic_map_empty_like_map(map);
 473                 isl_map_free(map);
 474                 return hull;
 475         }
 476
 477         map = isl_map_detect_equalities(map);
 478         map = isl_map_align_divs(map);
 479         if (!map)
 480                 return NULL;
 481         model = isl_basic_map_copy(map->p[0]);
 482         set = isl_map_underlying_set(map);
 483         set = isl_set_cow(set);
 484         if (!set)
 485                 goto error;
 486
 487         for (i = 0; i < set->n; ++i) {
 488                 set->p[i] = isl_basic_set_cow(set->p[i]);
 489                 set->p[i] = isl_basic_set_affine_hull(set->p[i]);
 490                 set->p[i] = isl_basic_set_gauss(set->p[i], NULL);
 491                 if (!set->p[i])
 492                         goto error;
 493         }
 494         set = isl_set_remove_empty_parts(set);
 495         if (set->n == 0) {
 496                 hull = isl_basic_map_empty_like(model);
 497                 isl_basic_map_free(model);
 498         } else {
 499                 struct isl_basic_set *bset;
 500                 while (set->n > 1) {
 501                         set->p[0] = affine_hull(set->p[0], set->p[--set->n]);
 502                         if (!set->p[0])
 503                                 goto error;
 504                 }
 505                 bset = isl_basic_set_copy(set->p[0]);
 506                 hull = isl_basic_map_overlying_set(bset, model);
 507         }
 508         isl_set_free(set);
 509         hull = isl_basic_map_simplify(hull);
 510         return isl_basic_map_finalize(hull);
 511 error:
 512         isl_basic_map_free(model);
 513         isl_set_free(set);
 514         return NULL;
 515 }
 516
 517 struct isl_basic_set *isl_set_affine_hull(struct isl_set *set)
 518 {
 519         return (struct isl_basic_set *)
 520                 isl_map_affine_hull((struct isl_map *)set);
 521 }