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