isl_affine_hull.c: use tableau to detect implicit equalities
[platform/upstream/isl.git] / 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_extend(slice, 0, dim, 0, 0, 1);
250         k = isl_basic_set_alloc_inequality(slice);
251         if (k < 0)
252                 goto error;
253         if (up)
254                 isl_seq_cpy(slice->ineq[k], eq, 1 + dim);
255         else
256                 isl_seq_neg(slice->ineq[k], eq, 1 + dim);
257         isl_int_sub_ui(slice->ineq[k][0], slice->ineq[k][0], 1);
258
259         sample = isl_basic_set_sample(slice);
260         if (!sample)
261                 goto error;
262         if (sample->size == 0) {
263                 isl_vec_free(ctx, sample);
264                 point = isl_basic_set_empty_like(bset);
265         } else
266                 point = isl_basic_set_from_vec(ctx, sample);
267
268         return point;
269 error:
270         isl_basic_set_free(slice);
271         return NULL;
272 }
273
274 /* Look for all equalities satisfied by the integer points in bmap
275  * that are independent of the equalities already explicitly available
276  * in bmap.
277  *
278  * We first remove all equalities already explicitly available,
279  * then look for additional equalities in the reduced space
280  * and then transform the result to the original space.
281  * The original equalities are _not_ added to this set.  This is
282  * the responsibility of the calling function.
283  * The resulting basic set has all meaning about the dimensions removed.
284  * In particular, dimensions that correspond to existential variables
285  * in bmap and that are found to be fixed are not removed.
286  *
287  * The additional equalities are obtained by successively looking for
288  * a point that is affinely independent of the points found so far.
289  * In particular, for each equality satisfied by the points so far,
290  * we check if there is any point on a hyperplane parallel to the
291  * corresponding hyperplane shifted by at least one (in either direction).
292  */
293 static struct isl_basic_set *equalities_in_underlying_set(
294                                                 struct isl_basic_map *bmap)
295 {
296         int i, j;
297         struct isl_mat *T2 = NULL;
298         struct isl_basic_set *bset = NULL;
299         struct isl_basic_set *hull = NULL;
300         struct isl_vec *sample;
301         struct isl_ctx *ctx;
302         unsigned dim;
303
304         bset = isl_basic_map_underlying_set(bmap);
305         bset = isl_basic_set_remove_equalities(bset, NULL, &T2);
306         if (!bset)
307                 goto error;
308
309         ctx = bset->ctx;
310         sample = isl_basic_set_sample(isl_basic_set_copy(bset));
311         if (!sample)
312                 goto error;
313         if (sample->size == 0) {
314                 isl_vec_free(ctx, sample);
315                 hull = isl_basic_set_empty_like(bset);
316         } else
317                 hull = isl_basic_set_from_vec(ctx, sample);
318
319         dim = isl_basic_set_n_dim(bset);
320         for (i = 0; i < dim; ++i) {
321                 struct isl_basic_set *point;
322                 if (ISL_F_ISSET(hull, ISL_BASIC_SET_EMPTY))
323                         break;
324                 for (j = 0; j < hull->n_eq; ++j) {
325                         point = outside_point(ctx, bset, hull->eq[j], 1);
326                         if (!point)
327                                 goto error;
328                         if (!ISL_F_ISSET(point, ISL_BASIC_SET_EMPTY))
329                                 break;
330                         isl_basic_set_free(point);
331                         point = outside_point(ctx, bset, hull->eq[j], 0);
332                         if (!point)
333                                 goto error;
334                         if (!ISL_F_ISSET(point, ISL_BASIC_SET_EMPTY))
335                                 break;
336                         isl_basic_set_free(point);
337                 }
338                 if (j == hull->n_eq)
339                         break;
340                 hull = affine_hull(hull, point);
341         }
342         isl_basic_set_free(bset);
343         if (T2)
344                 hull = isl_basic_set_preimage(hull, T2);
345
346         return hull;
347 error:
348         isl_mat_free(ctx, T2);
349         isl_basic_set_free(bset);
350         isl_basic_set_free(hull);
351         return NULL;
352 }
353
354 /* Detect and make explicit all equalities satisfied by the (integer)
355  * points in bmap.
356  */
357 struct isl_basic_map *isl_basic_map_detect_equalities(
358                                                 struct isl_basic_map *bmap)
359 {
360         int i, j;
361         struct isl_basic_set *hull = NULL;
362
363         if (!bmap)
364                 return NULL;
365         if (bmap->n_ineq == 0)
366                 return bmap;
367         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_EMPTY))
368                 return bmap;
369         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_ALL_EQUALITIES))
370                 return bmap;
371         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_RATIONAL))
372                 return isl_basic_map_implicit_equalities(bmap);
373
374         hull = equalities_in_underlying_set(isl_basic_map_copy(bmap));
375         if (!hull)
376                 goto error;
377         bmap = isl_basic_map_extend_dim(bmap, isl_dim_copy(bmap->dim), 0,
378                                         hull->n_eq, 0);
379         for (i = 0; i < hull->n_eq; ++i) {
380                 j = isl_basic_map_alloc_equality(bmap);
381                 if (j < 0)
382                         goto error;
383                 isl_seq_cpy(bmap->eq[j], hull->eq[i],
384                                 1 + isl_basic_set_total_dim(hull));
385         }
386         isl_basic_set_free(hull);
387         ISL_F_SET(bmap, ISL_BASIC_MAP_NO_IMPLICIT | ISL_BASIC_MAP_ALL_EQUALITIES);
388         bmap = isl_basic_map_simplify(bmap);
389         return isl_basic_map_finalize(bmap);
390 error:
391         isl_basic_set_free(hull);
392         isl_basic_map_free(bmap);
393         return NULL;
394 }
395
396 /* After computing the rational affine hull (by detecting the implicit
397  * equalities), we compute the additional equalities satisfied by
398  * the integer points (if any) and add the original equalities back in.
399  */
400 struct isl_basic_map *isl_basic_map_affine_hull(struct isl_basic_map *bmap)
401 {
402         struct isl_basic_set *hull = NULL;
403
404         bmap = isl_basic_map_implicit_equalities(bmap);
405         if (!bmap)
406                 return NULL;
407         if (bmap->n_ineq == 0)
408                 return bmap;
409
410         if (ISL_F_ISSET(bmap, ISL_BASIC_MAP_RATIONAL)) {
411                 bmap = isl_basic_map_cow(bmap);
412                 isl_basic_map_free_inequality(bmap, bmap->n_ineq);
413                 return bmap;
414         }
415
416         hull = equalities_in_underlying_set(isl_basic_map_copy(bmap));
417         if (!hull)
418                 goto error;
419
420         bmap = isl_basic_map_cow(bmap);
421         if (!bmap)
422                 goto error;
423         isl_basic_map_free_inequality(bmap, bmap->n_ineq);
424         bmap = isl_basic_map_intersect(bmap,
425                                         isl_basic_map_overlying_set(hull,
426                                                 isl_basic_map_copy(bmap)));
427
428         return isl_basic_map_finalize(bmap);
429 error:
430         isl_basic_set_free(hull);
431         isl_basic_map_free(bmap);
432         return NULL;
433 }
434
435 struct isl_basic_set *isl_basic_set_affine_hull(struct isl_basic_set *bset)
436 {
437         return (struct isl_basic_set *)
438                 isl_basic_map_affine_hull((struct isl_basic_map *)bset);
439 }
440
441 struct isl_basic_map *isl_map_affine_hull(struct isl_map *map)
442 {
443         int i;
444         struct isl_basic_map *model = NULL;
445         struct isl_basic_map *hull = NULL;
446         struct isl_set *set;
447
448         if (!map)
449                 return NULL;
450
451         if (map->n == 0) {
452                 hull = isl_basic_map_empty_like_map(map);
453                 isl_map_free(map);
454                 return hull;
455         }
456
457         map = isl_map_align_divs(map);
458         model = isl_basic_map_copy(map->p[0]);
459         set = isl_map_underlying_set(map);
460         set = isl_set_cow(set);
461         if (!set)
462                 goto error;
463
464         for (i = 0; i < set->n; ++i) {
465                 set->p[i] = isl_basic_set_cow(set->p[i]);
466                 set->p[i] = isl_basic_set_affine_hull(set->p[i]);
467                 set->p[i] = isl_basic_set_gauss(set->p[i], NULL);
468                 if (!set->p[i])
469                         goto error;
470         }
471         set = isl_set_remove_empty_parts(set);
472         if (set->n == 0) {
473                 hull = isl_basic_map_empty_like(model);
474                 isl_basic_map_free(model);
475         } else {
476                 struct isl_basic_set *bset;
477                 while (set->n > 1) {
478                         set->p[0] = affine_hull(set->p[0], set->p[--set->n]);
479                         if (!set->p[0])
480                                 goto error;
481                 }
482                 bset = isl_basic_set_copy(set->p[0]);
483                 hull = isl_basic_map_overlying_set(bset, model);
484         }
485         isl_set_free(set);
486         hull = isl_basic_map_simplify(hull);
487         return isl_basic_map_finalize(hull);
488 error:
489         isl_basic_map_free(model);
490         isl_set_free(set);
491         return NULL;
492 }
493
494 struct isl_basic_set *isl_set_affine_hull(struct isl_set *set)
495 {
496         return (struct isl_basic_set *)
497                 isl_map_affine_hull((struct isl_map *)set);
498 }