add isl_tab_set_initial_basis_with_cone
[platform/upstream/isl.git] / isl_sample.c
1 #include "isl_sample.h"
2 #include "isl_sample_piplib.h"
3 #include "isl_vec.h"
4 #include "isl_mat.h"
5 #include "isl_seq.h"
6 #include "isl_map_private.h"
7 #include "isl_equalities.h"
8 #include "isl_tab.h"
9 #include "isl_basis_reduction.h"
10
11 static struct isl_vec *empty_sample(struct isl_basic_set *bset)
12 {
13         struct isl_vec *vec;
14
15         vec = isl_vec_alloc(bset->ctx, 0);
16         isl_basic_set_free(bset);
17         return vec;
18 }
19
20 /* Construct a zero sample of the same dimension as bset.
21  * As a special case, if bset is zero-dimensional, this
22  * function creates a zero-dimensional sample point.
23  */
24 static struct isl_vec *zero_sample(struct isl_basic_set *bset)
25 {
26         unsigned dim;
27         struct isl_vec *sample;
28
29         dim = isl_basic_set_total_dim(bset);
30         sample = isl_vec_alloc(bset->ctx, 1 + dim);
31         if (sample) {
32                 isl_int_set_si(sample->el[0], 1);
33                 isl_seq_clr(sample->el + 1, dim);
34         }
35         isl_basic_set_free(bset);
36         return sample;
37 }
38
39 static struct isl_vec *interval_sample(struct isl_basic_set *bset)
40 {
41         int i;
42         isl_int t;
43         struct isl_vec *sample;
44
45         bset = isl_basic_set_simplify(bset);
46         if (!bset)
47                 return NULL;
48         if (isl_basic_set_fast_is_empty(bset))
49                 return empty_sample(bset);
50         if (bset->n_eq == 0 && bset->n_ineq == 0)
51                 return zero_sample(bset);
52
53         sample = isl_vec_alloc(bset->ctx, 2);
54         isl_int_set_si(sample->block.data[0], 1);
55
56         if (bset->n_eq > 0) {
57                 isl_assert(bset->ctx, bset->n_eq == 1, goto error);
58                 isl_assert(bset->ctx, bset->n_ineq == 0, goto error);
59                 if (isl_int_is_one(bset->eq[0][1]))
60                         isl_int_neg(sample->el[1], bset->eq[0][0]);
61                 else {
62                         isl_assert(bset->ctx, isl_int_is_negone(bset->eq[0][1]),
63                                    goto error);
64                         isl_int_set(sample->el[1], bset->eq[0][0]);
65                 }
66                 isl_basic_set_free(bset);
67                 return sample;
68         }
69
70         isl_int_init(t);
71         if (isl_int_is_one(bset->ineq[0][1]))
72                 isl_int_neg(sample->block.data[1], bset->ineq[0][0]);
73         else
74                 isl_int_set(sample->block.data[1], bset->ineq[0][0]);
75         for (i = 1; i < bset->n_ineq; ++i) {
76                 isl_seq_inner_product(sample->block.data,
77                                         bset->ineq[i], 2, &t);
78                 if (isl_int_is_neg(t))
79                         break;
80         }
81         isl_int_clear(t);
82         if (i < bset->n_ineq) {
83                 isl_vec_free(sample);
84                 return empty_sample(bset);
85         }
86
87         isl_basic_set_free(bset);
88         return sample;
89 error:
90         isl_basic_set_free(bset);
91         isl_vec_free(sample);
92         return NULL;
93 }
94
95 static struct isl_mat *independent_bounds(struct isl_basic_set *bset)
96 {
97         int i, j, n;
98         struct isl_mat *dirs = NULL;
99         struct isl_mat *bounds = NULL;
100         unsigned dim;
101
102         if (!bset)
103                 return NULL;
104
105         dim = isl_basic_set_n_dim(bset);
106         bounds = isl_mat_alloc(bset->ctx, 1+dim, 1+dim);
107         if (!bounds)
108                 return NULL;
109
110         isl_int_set_si(bounds->row[0][0], 1);
111         isl_seq_clr(bounds->row[0]+1, dim);
112         bounds->n_row = 1;
113
114         if (bset->n_ineq == 0)
115                 return bounds;
116
117         dirs = isl_mat_alloc(bset->ctx, dim, dim);
118         if (!dirs) {
119                 isl_mat_free(bounds);
120                 return NULL;
121         }
122         isl_seq_cpy(dirs->row[0], bset->ineq[0]+1, dirs->n_col);
123         isl_seq_cpy(bounds->row[1], bset->ineq[0], bounds->n_col);
124         for (j = 1, n = 1; n < dim && j < bset->n_ineq; ++j) {
125                 int pos;
126
127                 isl_seq_cpy(dirs->row[n], bset->ineq[j]+1, dirs->n_col);
128
129                 pos = isl_seq_first_non_zero(dirs->row[n], dirs->n_col);
130                 if (pos < 0)
131                         continue;
132                 for (i = 0; i < n; ++i) {
133                         int pos_i;
134                         pos_i = isl_seq_first_non_zero(dirs->row[i], dirs->n_col);
135                         if (pos_i < pos)
136                                 continue;
137                         if (pos_i > pos)
138                                 break;
139                         isl_seq_elim(dirs->row[n], dirs->row[i], pos,
140                                         dirs->n_col, NULL);
141                         pos = isl_seq_first_non_zero(dirs->row[n], dirs->n_col);
142                         if (pos < 0)
143                                 break;
144                 }
145                 if (pos < 0)
146                         continue;
147                 if (i < n) {
148                         int k;
149                         isl_int *t = dirs->row[n];
150                         for (k = n; k > i; --k)
151                                 dirs->row[k] = dirs->row[k-1];
152                         dirs->row[i] = t;
153                 }
154                 ++n;
155                 isl_seq_cpy(bounds->row[n], bset->ineq[j], bounds->n_col);
156         }
157         isl_mat_free(dirs);
158         bounds->n_row = 1+n;
159         return bounds;
160 }
161
162 static void swap_inequality(struct isl_basic_set *bset, int a, int b)
163 {
164         isl_int *t = bset->ineq[a];
165         bset->ineq[a] = bset->ineq[b];
166         bset->ineq[b] = t;
167 }
168
169 /* Skew into positive orthant and project out lineality space.
170  *
171  * We perform a unimodular transformation that turns a selected
172  * maximal set of linearly independent bounds into constraints
173  * on the first dimensions that impose that these first dimensions
174  * are non-negative.  In particular, the constraint matrix is lower
175  * triangular with positive entries on the diagonal and negative
176  * entries below.
177  * If "bset" has a lineality space then these constraints (and therefore
178  * all constraints in bset) only involve the first dimensions.
179  * The remaining dimensions then do not appear in any constraints and
180  * we can select any value for them, say zero.  We therefore project
181  * out this final dimensions and plug in the value zero later.  This
182  * is accomplished by simply dropping the final columns of
183  * the unimodular transformation.
184  */
185 static struct isl_basic_set *isl_basic_set_skew_to_positive_orthant(
186         struct isl_basic_set *bset, struct isl_mat **T)
187 {
188         struct isl_mat *U = NULL;
189         struct isl_mat *bounds = NULL;
190         int i, j;
191         unsigned old_dim, new_dim;
192
193         *T = NULL;
194         if (!bset)
195                 return NULL;
196
197         isl_assert(bset->ctx, isl_basic_set_n_param(bset) == 0, goto error);
198         isl_assert(bset->ctx, bset->n_div == 0, goto error);
199         isl_assert(bset->ctx, bset->n_eq == 0, goto error);
200         
201         old_dim = isl_basic_set_n_dim(bset);
202         /* Try to move (multiples of) unit rows up. */
203         for (i = 0, j = 0; i < bset->n_ineq; ++i) {
204                 int pos = isl_seq_first_non_zero(bset->ineq[i]+1, old_dim);
205                 if (pos < 0)
206                         continue;
207                 if (isl_seq_first_non_zero(bset->ineq[i]+1+pos+1,
208                                                 old_dim-pos-1) >= 0)
209                         continue;
210                 if (i != j)
211                         swap_inequality(bset, i, j);
212                 ++j;
213         }
214         bounds = independent_bounds(bset);
215         if (!bounds)
216                 goto error;
217         new_dim = bounds->n_row - 1;
218         bounds = isl_mat_left_hermite(bounds, 1, &U, NULL);
219         if (!bounds)
220                 goto error;
221         U = isl_mat_drop_cols(U, 1 + new_dim, old_dim - new_dim);
222         bset = isl_basic_set_preimage(bset, isl_mat_copy(U));
223         if (!bset)
224                 goto error;
225         *T = U;
226         isl_mat_free(bounds);
227         return bset;
228 error:
229         isl_mat_free(bounds);
230         isl_mat_free(U);
231         isl_basic_set_free(bset);
232         return NULL;
233 }
234
235 /* Find a sample integer point, if any, in bset, which is known
236  * to have equalities.  If bset contains no integer points, then
237  * return a zero-length vector.
238  * We simply remove the known equalities, compute a sample
239  * in the resulting bset, using the specified recurse function,
240  * and then transform the sample back to the original space.
241  */
242 static struct isl_vec *sample_eq(struct isl_basic_set *bset,
243         struct isl_vec *(*recurse)(struct isl_basic_set *))
244 {
245         struct isl_mat *T;
246         struct isl_vec *sample;
247
248         if (!bset)
249                 return NULL;
250
251         bset = isl_basic_set_remove_equalities(bset, &T, NULL);
252         sample = recurse(bset);
253         if (!sample || sample->size == 0)
254                 isl_mat_free(T);
255         else
256                 sample = isl_mat_vec_product(T, sample);
257         return sample;
258 }
259
260 /* Return a matrix containing the equalities of the tableau
261  * in constraint form.  The tableau is assumed to have
262  * an associated bset that has been kept up-to-date.
263  */
264 static struct isl_mat *tab_equalities(struct isl_tab *tab)
265 {
266         int i, j;
267         int n_eq;
268         struct isl_mat *eq;
269         struct isl_basic_set *bset;
270
271         if (!tab)
272                 return NULL;
273
274         isl_assert(tab->mat->ctx, tab->bset, return NULL);
275         bset = tab->bset;
276
277         n_eq = tab->n_var - tab->n_col + tab->n_dead;
278         if (tab->empty || n_eq == 0)
279                 return isl_mat_alloc(tab->mat->ctx, 0, tab->n_var);
280         if (n_eq == tab->n_var)
281                 return isl_mat_identity(tab->mat->ctx, tab->n_var);
282
283         eq = isl_mat_alloc(tab->mat->ctx, n_eq, tab->n_var);
284         if (!eq)
285                 return NULL;
286         for (i = 0, j = 0; i < tab->n_con; ++i) {
287                 if (tab->con[i].is_row)
288                         continue;
289                 if (tab->con[i].index >= 0 && tab->con[i].index >= tab->n_dead)
290                         continue;
291                 if (i < bset->n_eq)
292                         isl_seq_cpy(eq->row[j], bset->eq[i] + 1, tab->n_var);
293                 else
294                         isl_seq_cpy(eq->row[j],
295                                     bset->ineq[i - bset->n_eq] + 1, tab->n_var);
296                 ++j;
297         }
298         isl_assert(bset->ctx, j == n_eq, goto error);
299         return eq;
300 error:
301         isl_mat_free(eq);
302         return NULL;
303 }
304
305 /* Compute and return an initial basis for the bounded tableau "tab".
306  *
307  * If the tableau is either full-dimensional or zero-dimensional,
308  * the we simply return an identity matrix.
309  * Otherwise, we construct a basis whose first directions correspond
310  * to equalities.
311  */
312 static struct isl_mat *initial_basis(struct isl_tab *tab)
313 {
314         int n_eq;
315         struct isl_mat *eq;
316         struct isl_mat *Q;
317
318         n_eq = tab->n_var - tab->n_col + tab->n_dead;
319         if (tab->empty || n_eq == 0 || n_eq == tab->n_var)
320                 return isl_mat_identity(tab->mat->ctx, 1 + tab->n_var);
321
322         eq = tab_equalities(tab);
323         eq = isl_mat_left_hermite(eq, 0, NULL, &Q);
324         if (!eq)
325                 return NULL;
326         isl_mat_free(eq);
327
328         Q = isl_mat_lin_to_aff(Q);
329         return Q;
330 }
331
332 /* Given a tableau representing a set, find and return
333  * an integer point in the set, if there is any.
334  *
335  * We perform a depth first search
336  * for an integer point, by scanning all possible values in the range
337  * attained by a basis vector, where an initial basis may have been set
338  * by the calling function.  Otherwise an initial basis that exploits
339  * the equalities in the tableau is created.
340  * tab->n_zero is currently ignored and is clobbered by this function.
341  *
342  * The tableau is allowed to have unbounded direction, but then
343  * the calling function needs to set an initial basis, with the
344  * unbounded directions last and with tab->n_unbounded set
345  * to the number of unbounded directions.
346  * Furthermore, the calling functions needs to add shifted copies
347  * of all constraints involving unbounded directions to ensure
348  * that any feasible rational value in these directions can be rounded
349  * up to yield a feasible integer value.
350  * In particular, let B define the given basis x' = B x
351  * and let T be the inverse of B, i.e., X = T x'.
352  * Let a x + c >= 0 be a constraint of the set represented by the tableau,
353  * or a T x' + c >= 0 in terms of the given basis.  Assume that
354  * the bounded directions have an integer value, then we can safely
355  * round up the values for the unbounded directions if we make sure
356  * that x' not only satisfies the original constraint, but also
357  * the constraint "a T x' + c + s >= 0" with s the sum of all
358  * negative values in the last n_unbounded entries of "a T".
359  * The calling function therefore needs to add the constraint
360  * a x + c + s >= 0.  The current function then scans the first
361  * directions for an integer value and once those have been found,
362  * it can compute "T ceil(B x)" to yield an integer point in the set.
363  * Note that during the search, the first rows of B may be changed
364  * by a basis reduction, but the last n_unbounded rows of B remain
365  * unaltered and are also not mixed into the first rows.
366  *
367  * The search is implemented iteratively.  "level" identifies the current
368  * basis vector.  "init" is true if we want the first value at the current
369  * level and false if we want the next value.
370  *
371  * The initial basis is the identity matrix.  If the range in some direction
372  * contains more than one integer value, we perform basis reduction based
373  * on the value of ctx->gbr
374  *      - ISL_GBR_NEVER:        never perform basis reduction
375  *      - ISL_GBR_ONCE:         only perform basis reduction the first
376  *                              time such a range is encountered
377  *      - ISL_GBR_ALWAYS:       always perform basis reduction when
378  *                              such a range is encountered
379  *
380  * When ctx->gbr is set to ISL_GBR_ALWAYS, then we allow the basis
381  * reduction computation to return early.  That is, as soon as it
382  * finds a reasonable first direction.
383  */ 
384 struct isl_vec *isl_tab_sample(struct isl_tab *tab)
385 {
386         unsigned dim;
387         unsigned gbr;
388         struct isl_ctx *ctx;
389         struct isl_vec *sample;
390         struct isl_vec *min;
391         struct isl_vec *max;
392         enum isl_lp_result res;
393         int level;
394         int init;
395         int reduced;
396         struct isl_tab_undo **snap;
397
398         if (!tab)
399                 return NULL;
400         if (tab->empty)
401                 return isl_vec_alloc(tab->mat->ctx, 0);
402
403         if (!tab->basis)
404                 tab->basis = initial_basis(tab);
405         if (!tab->basis)
406                 return NULL;
407         isl_assert(tab->mat->ctx, tab->basis->n_row == tab->n_var + 1,
408                     return NULL);
409         isl_assert(tab->mat->ctx, tab->basis->n_col == tab->n_var + 1,
410                     return NULL);
411
412         ctx = tab->mat->ctx;
413         dim = tab->n_var;
414         gbr = ctx->gbr;
415
416         if (tab->n_unbounded == tab->n_var) {
417                 sample = isl_tab_get_sample_value(tab);
418                 sample = isl_mat_vec_product(isl_mat_copy(tab->basis), sample);
419                 sample = isl_vec_ceil(sample);
420                 sample = isl_mat_vec_inverse_product(isl_mat_copy(tab->basis),
421                                                         sample);
422                 return sample;
423         }
424
425         if (isl_tab_extend_cons(tab, dim + 1) < 0)
426                 return NULL;
427
428         min = isl_vec_alloc(ctx, dim);
429         max = isl_vec_alloc(ctx, dim);
430         snap = isl_alloc_array(ctx, struct isl_tab_undo *, dim);
431
432         if (!min || !max || !snap)
433                 goto error;
434
435         level = 0;
436         init = 1;
437         reduced = 0;
438
439         while (level >= 0) {
440                 int empty = 0;
441                 if (init) {
442                         res = isl_tab_min(tab, tab->basis->row[1 + level],
443                                     ctx->one, &min->el[level], NULL, 0);
444                         if (res == isl_lp_empty)
445                                 empty = 1;
446                         isl_assert(ctx, res != isl_lp_unbounded, goto error);
447                         if (res == isl_lp_error)
448                                 goto error;
449                         if (!empty && isl_tab_sample_is_integer(tab))
450                                 break;
451                         isl_seq_neg(tab->basis->row[1 + level] + 1,
452                                     tab->basis->row[1 + level] + 1, dim);
453                         res = isl_tab_min(tab, tab->basis->row[1 + level],
454                                     ctx->one, &max->el[level], NULL, 0);
455                         isl_seq_neg(tab->basis->row[1 + level] + 1,
456                                     tab->basis->row[1 + level] + 1, dim);
457                         isl_int_neg(max->el[level], max->el[level]);
458                         if (res == isl_lp_empty)
459                                 empty = 1;
460                         isl_assert(ctx, res != isl_lp_unbounded, goto error);
461                         if (res == isl_lp_error)
462                                 goto error;
463                         if (!empty && isl_tab_sample_is_integer(tab))
464                                 break;
465                         if (!empty && !reduced && ctx->gbr != ISL_GBR_NEVER &&
466                             isl_int_lt(min->el[level], max->el[level])) {
467                                 unsigned gbr_only_first;
468                                 if (ctx->gbr == ISL_GBR_ONCE)
469                                         ctx->gbr = ISL_GBR_NEVER;
470                                 tab->n_zero = level;
471                                 gbr_only_first = ctx->gbr_only_first;
472                                 ctx->gbr_only_first =
473                                         ctx->gbr == ISL_GBR_ALWAYS;
474                                 tab = isl_tab_compute_reduced_basis(tab);
475                                 ctx->gbr_only_first = gbr_only_first;
476                                 if (!tab || !tab->basis)
477                                         goto error;
478                                 reduced = 1;
479                                 continue;
480                         }
481                         reduced = 0;
482                         snap[level] = isl_tab_snap(tab);
483                 } else
484                         isl_int_add_ui(min->el[level], min->el[level], 1);
485
486                 if (empty || isl_int_gt(min->el[level], max->el[level])) {
487                         level--;
488                         init = 0;
489                         if (level >= 0)
490                                 isl_tab_rollback(tab, snap[level]);
491                         continue;
492                 }
493                 isl_int_neg(tab->basis->row[1 + level][0], min->el[level]);
494                 tab = isl_tab_add_valid_eq(tab, tab->basis->row[1 + level]);
495                 isl_int_set_si(tab->basis->row[1 + level][0], 0);
496                 if (level + tab->n_unbounded < dim - 1) {
497                         ++level;
498                         init = 1;
499                         continue;
500                 }
501                 break;
502         }
503
504         if (level >= 0) {
505                 sample = isl_tab_get_sample_value(tab);
506                 if (!sample)
507                         goto error;
508                 if (tab->n_unbounded && !isl_int_is_one(sample->el[0])) {
509                         sample = isl_mat_vec_product(isl_mat_copy(tab->basis),
510                                                      sample);
511                         sample = isl_vec_ceil(sample);
512                         sample = isl_mat_vec_inverse_product(
513                                         isl_mat_copy(tab->basis), sample);
514                 }
515         } else
516                 sample = isl_vec_alloc(ctx, 0);
517
518         ctx->gbr = gbr;
519         isl_vec_free(min);
520         isl_vec_free(max);
521         free(snap);
522         return sample;
523 error:
524         ctx->gbr = gbr;
525         isl_vec_free(min);
526         isl_vec_free(max);
527         free(snap);
528         return NULL;
529 }
530
531 /* Given a basic set that is known to be bounded, find and return
532  * an integer point in the basic set, if there is any.
533  *
534  * After handling some trivial cases, we construct a tableau
535  * and then use isl_tab_sample to find a sample, passing it
536  * the identity matrix as initial basis.
537  */ 
538 static struct isl_vec *sample_bounded(struct isl_basic_set *bset)
539 {
540         unsigned dim;
541         struct isl_ctx *ctx;
542         struct isl_vec *sample;
543         struct isl_tab *tab = NULL;
544
545         if (!bset)
546                 return NULL;
547
548         if (isl_basic_set_fast_is_empty(bset))
549                 return empty_sample(bset);
550
551         dim = isl_basic_set_total_dim(bset);
552         if (dim == 0)
553                 return zero_sample(bset);
554         if (dim == 1)
555                 return interval_sample(bset);
556         if (bset->n_eq > 0)
557                 return sample_eq(bset, sample_bounded);
558
559         ctx = bset->ctx;
560
561         tab = isl_tab_from_basic_set(bset);
562         if (!ISL_F_ISSET(bset, ISL_BASIC_SET_NO_IMPLICIT))
563                 tab = isl_tab_detect_implicit_equalities(tab);
564         if (!tab)
565                 goto error;
566
567         tab->bset = isl_basic_set_copy(bset);
568
569         sample = isl_tab_sample(tab);
570         if (!sample)
571                 goto error;
572
573         if (sample->size > 0) {
574                 isl_vec_free(bset->sample);
575                 bset->sample = isl_vec_copy(sample);
576         }
577
578         isl_basic_set_free(bset);
579         isl_tab_free(tab);
580         return sample;
581 error:
582         isl_basic_set_free(bset);
583         isl_tab_free(tab);
584         return NULL;
585 }
586
587 /* Given a basic set "bset" and a value "sample" for the first coordinates
588  * of bset, plug in these values and drop the corresponding coordinates.
589  *
590  * We do this by computing the preimage of the transformation
591  *
592  *           [ 1 0 ]
593  *      x =  [ s 0 ] x'
594  *           [ 0 I ]
595  *
596  * where [1 s] is the sample value and I is the identity matrix of the
597  * appropriate dimension.
598  */
599 static struct isl_basic_set *plug_in(struct isl_basic_set *bset,
600         struct isl_vec *sample)
601 {
602         int i;
603         unsigned total;
604         struct isl_mat *T;
605
606         if (!bset || !sample)
607                 goto error;
608
609         total = isl_basic_set_total_dim(bset);
610         T = isl_mat_alloc(bset->ctx, 1 + total, 1 + total - (sample->size - 1));
611         if (!T)
612                 goto error;
613
614         for (i = 0; i < sample->size; ++i) {
615                 isl_int_set(T->row[i][0], sample->el[i]);
616                 isl_seq_clr(T->row[i] + 1, T->n_col - 1);
617         }
618         for (i = 0; i < T->n_col - 1; ++i) {
619                 isl_seq_clr(T->row[sample->size + i], T->n_col);
620                 isl_int_set_si(T->row[sample->size + i][1 + i], 1);
621         }
622         isl_vec_free(sample);
623
624         bset = isl_basic_set_preimage(bset, T);
625         return bset;
626 error:
627         isl_basic_set_free(bset);
628         isl_vec_free(sample);
629         return NULL;
630 }
631
632 /* Given a basic set "bset", return any (possibly non-integer) point
633  * in the basic set.
634  */
635 static struct isl_vec *rational_sample(struct isl_basic_set *bset)
636 {
637         struct isl_tab *tab;
638         struct isl_vec *sample;
639
640         if (!bset)
641                 return NULL;
642
643         tab = isl_tab_from_basic_set(bset);
644         sample = isl_tab_get_sample_value(tab);
645         isl_tab_free(tab);
646
647         isl_basic_set_free(bset);
648
649         return sample;
650 }
651
652 /* Given a linear cone "cone" and a rational point "vec",
653  * construct a polyhedron with shifted copies of the constraints in "cone",
654  * i.e., a polyhedron with "cone" as its recession cone, such that each
655  * point x in this polyhedron is such that the unit box positioned at x
656  * lies entirely inside the affine cone 'vec + cone'.
657  * Any rational point in this polyhedron may therefore be rounded up
658  * to yield an integer point that lies inside said affine cone.
659  *
660  * Denote the constraints of cone by "<a_i, x> >= 0" and the rational
661  * point "vec" by v/d.
662  * Let b_i = <a_i, v>.  Then the affine cone 'vec + cone' is given
663  * by <a_i, x> - b/d >= 0.
664  * The polyhedron <a_i, x> - ceil{b/d} >= 0 is a subset of this affine cone.
665  * We prefer this polyhedron over the actual affine cone because it doesn't
666  * require a scaling of the constraints.
667  * If each of the vertices of the unit cube positioned at x lies inside
668  * this polyhedron, then the whole unit cube at x lies inside the affine cone.
669  * We therefore impose that x' = x + \sum e_i, for any selection of unit
670  * vectors lies inside the polyhedron, i.e.,
671  *
672  *      <a_i, x'> - ceil{b/d} = <a_i, x> + sum a_i - ceil{b/d} >= 0
673  *
674  * The most stringent of these constraints is the one that selects
675  * all negative a_i, so the polyhedron we are looking for has constraints
676  *
677  *      <a_i, x> + sum_{a_i < 0} a_i - ceil{b/d} >= 0
678  *
679  * Note that if cone were known to have only non-negative rays
680  * (which can be accomplished by a unimodular transformation),
681  * then we would only have to check the points x' = x + e_i
682  * and we only have to add the smallest negative a_i (if any)
683  * instead of the sum of all negative a_i.
684  */
685 static struct isl_basic_set *shift_cone(struct isl_basic_set *cone,
686         struct isl_vec *vec)
687 {
688         int i, j, k;
689         unsigned total;
690
691         struct isl_basic_set *shift = NULL;
692
693         if (!cone || !vec)
694                 goto error;
695
696         isl_assert(cone->ctx, cone->n_eq == 0, goto error);
697
698         total = isl_basic_set_total_dim(cone);
699
700         shift = isl_basic_set_alloc_dim(isl_basic_set_get_dim(cone),
701                                         0, 0, cone->n_ineq);
702
703         for (i = 0; i < cone->n_ineq; ++i) {
704                 k = isl_basic_set_alloc_inequality(shift);
705                 if (k < 0)
706                         goto error;
707                 isl_seq_cpy(shift->ineq[k] + 1, cone->ineq[i] + 1, total);
708                 isl_seq_inner_product(shift->ineq[k] + 1, vec->el + 1, total,
709                                       &shift->ineq[k][0]);
710                 isl_int_cdiv_q(shift->ineq[k][0],
711                                shift->ineq[k][0], vec->el[0]);
712                 isl_int_neg(shift->ineq[k][0], shift->ineq[k][0]);
713                 for (j = 0; j < total; ++j) {
714                         if (isl_int_is_nonneg(shift->ineq[k][1 + j]))
715                                 continue;
716                         isl_int_add(shift->ineq[k][0],
717                                     shift->ineq[k][0], shift->ineq[k][1 + j]);
718                 }
719         }
720
721         isl_basic_set_free(cone);
722         isl_vec_free(vec);
723
724         return isl_basic_set_finalize(shift);
725 error:
726         isl_basic_set_free(shift);
727         isl_basic_set_free(cone);
728         isl_vec_free(vec);
729         return NULL;
730 }
731
732 /* Given a rational point vec in a (transformed) basic set,
733  * such that cone is the recession cone of the original basic set,
734  * "round up" the rational point to an integer point.
735  *
736  * We first check if the rational point just happens to be integer.
737  * If not, we transform the cone in the same way as the basic set,
738  * pick a point x in this cone shifted to the rational point such that
739  * the whole unit cube at x is also inside this affine cone.
740  * Then we simply round up the coordinates of x and return the
741  * resulting integer point.
742  */
743 static struct isl_vec *round_up_in_cone(struct isl_vec *vec,
744         struct isl_basic_set *cone, struct isl_mat *U)
745 {
746         unsigned total;
747
748         if (!vec || !cone || !U)
749                 goto error;
750
751         isl_assert(vec->ctx, vec->size != 0, goto error);
752         if (isl_int_is_one(vec->el[0])) {
753                 isl_mat_free(U);
754                 isl_basic_set_free(cone);
755                 return vec;
756         }
757
758         total = isl_basic_set_total_dim(cone);
759         cone = isl_basic_set_preimage(cone, U);
760         cone = isl_basic_set_remove_dims(cone, 0, total - (vec->size - 1));
761
762         cone = shift_cone(cone, vec);
763
764         vec = rational_sample(cone);
765         vec = isl_vec_ceil(vec);
766         return vec;
767 error:
768         isl_mat_free(U);
769         isl_vec_free(vec);
770         isl_basic_set_free(cone);
771         return NULL;
772 }
773
774 /* Concatenate two integer vectors, i.e., two vectors with denominator
775  * (stored in element 0) equal to 1.
776  */
777 static struct isl_vec *vec_concat(struct isl_vec *vec1, struct isl_vec *vec2)
778 {
779         struct isl_vec *vec;
780
781         if (!vec1 || !vec2)
782                 goto error;
783         isl_assert(vec1->ctx, vec1->size > 0, goto error);
784         isl_assert(vec2->ctx, vec2->size > 0, goto error);
785         isl_assert(vec1->ctx, isl_int_is_one(vec1->el[0]), goto error);
786         isl_assert(vec2->ctx, isl_int_is_one(vec2->el[0]), goto error);
787
788         vec = isl_vec_alloc(vec1->ctx, vec1->size + vec2->size - 1);
789         if (!vec)
790                 goto error;
791
792         isl_seq_cpy(vec->el, vec1->el, vec1->size);
793         isl_seq_cpy(vec->el + vec1->size, vec2->el + 1, vec2->size - 1);
794
795         isl_vec_free(vec1);
796         isl_vec_free(vec2);
797
798         return vec;
799 error:
800         isl_vec_free(vec1);
801         isl_vec_free(vec2);
802         return NULL;
803 }
804
805 /* Drop all constraints in bset that involve any of the dimensions
806  * first to first+n-1.
807  */
808 static struct isl_basic_set *drop_constraints_involving
809         (struct isl_basic_set *bset, unsigned first, unsigned n)
810 {
811         int i;
812
813         if (!bset)
814                 return NULL;
815
816         bset = isl_basic_set_cow(bset);
817
818         for (i = bset->n_ineq - 1; i >= 0; --i) {
819                 if (isl_seq_first_non_zero(bset->ineq[i] + 1 + first, n) == -1)
820                         continue;
821                 isl_basic_set_drop_inequality(bset, i);
822         }
823
824         return bset;
825 }
826
827 /* Give a basic set "bset" with recession cone "cone", compute and
828  * return an integer point in bset, if any.
829  *
830  * If the recession cone is full-dimensional, then we know that
831  * bset contains an infinite number of integer points and it is
832  * fairly easy to pick one of them.
833  * If the recession cone is not full-dimensional, then we first
834  * transform bset such that the bounded directions appear as
835  * the first dimensions of the transformed basic set.
836  * We do this by using a unimodular transformation that transforms
837  * the equalities in the recession cone to equalities on the first
838  * dimensions.
839  *
840  * The transformed set is then projected onto its bounded dimensions.
841  * Note that to compute this projection, we can simply drop all constraints
842  * involving any of the unbounded dimensions since these constraints
843  * cannot be combined to produce a constraint on the bounded dimensions.
844  * To see this, assume that there is such a combination of constraints
845  * that produces a constraint on the bounded dimensions.  This means
846  * that some combination of the unbounded dimensions has both an upper
847  * bound and a lower bound in terms of the bounded dimensions, but then
848  * this combination would be a bounded direction too and would have been
849  * transformed into a bounded dimensions.
850  *
851  * We then compute a sample value in the bounded dimensions.
852  * If no such value can be found, then the original set did not contain
853  * any integer points and we are done.
854  * Otherwise, we plug in the value we found in the bounded dimensions,
855  * project out these bounded dimensions and end up with a set with
856  * a full-dimensional recession cone.
857  * A sample point in this set is computed by "rounding up" any
858  * rational point in the set.
859  *
860  * The sample points in the bounded and unbounded dimensions are
861  * then combined into a single sample point and transformed back
862  * to the original space.
863  */
864 __isl_give isl_vec *isl_basic_set_sample_with_cone(
865         __isl_take isl_basic_set *bset, __isl_take isl_basic_set *cone)
866 {
867         unsigned total;
868         unsigned cone_dim;
869         struct isl_mat *M, *U;
870         struct isl_vec *sample;
871         struct isl_vec *cone_sample;
872         struct isl_ctx *ctx;
873         struct isl_basic_set *bounded;
874
875         if (!bset || !cone)
876                 goto error;
877
878         ctx = bset->ctx;
879         total = isl_basic_set_total_dim(cone);
880         cone_dim = total - cone->n_eq;
881
882         M = isl_mat_sub_alloc(bset->ctx, cone->eq, 0, cone->n_eq, 1, total);
883         M = isl_mat_left_hermite(M, 0, &U, NULL);
884         if (!M)
885                 goto error;
886         isl_mat_free(M);
887
888         U = isl_mat_lin_to_aff(U);
889         bset = isl_basic_set_preimage(bset, isl_mat_copy(U));
890
891         bounded = isl_basic_set_copy(bset);
892         bounded = drop_constraints_involving(bounded, total - cone_dim, cone_dim);
893         bounded = isl_basic_set_drop_dims(bounded, total - cone_dim, cone_dim);
894         sample = sample_bounded(bounded);
895         if (!sample || sample->size == 0) {
896                 isl_basic_set_free(bset);
897                 isl_basic_set_free(cone);
898                 isl_mat_free(U);
899                 return sample;
900         }
901         bset = plug_in(bset, isl_vec_copy(sample));
902         cone_sample = rational_sample(bset);
903         cone_sample = round_up_in_cone(cone_sample, cone, isl_mat_copy(U));
904         sample = vec_concat(sample, cone_sample);
905         sample = isl_mat_vec_product(U, sample);
906         return sample;
907 error:
908         isl_basic_set_free(cone);
909         isl_basic_set_free(bset);
910         return NULL;
911 }
912
913 static void vec_sum_of_neg(struct isl_vec *v, isl_int *s)
914 {
915         int i;
916
917         isl_int_set_si(*s, 0);
918
919         for (i = 0; i < v->size; ++i)
920                 if (isl_int_is_neg(v->el[i]))
921                         isl_int_add(*s, *s, v->el[i]);
922 }
923
924 /* Given a tableau "tab", a tableau "tab_cone" that corresponds
925  * to the recession cone and the inverse of a new basis U = inv(B),
926  * with the unbounded directions in B last,
927  * add constraints to "tab" that ensure any rational value
928  * in the unbounded directions can be rounded up to an integer value.
929  *
930  * The new basis is given by x' = B x, i.e., x = U x'.
931  * For any rational value of the last tab->n_unbounded coordinates
932  * in the update tableau, the value that is obtained by rounding
933  * up this value should be contained in the original tableau.
934  * For any constraint "a x + c >= 0", we therefore need to add
935  * a constraint "a x + c + s >= 0", with s the sum of all negative
936  * entries in the last elements of "a U".
937  *
938  * Since we are not interested in the first entries of any of the "a U",
939  * we first drop the columns of U that correpond to bounded directions.
940  */
941 static int tab_shift_cone(struct isl_tab *tab,
942         struct isl_tab *tab_cone, struct isl_mat *U)
943 {
944         int i;
945         isl_int v;
946         struct isl_basic_set *bset = NULL;
947
948         if (tab && tab->n_unbounded == 0) {
949                 isl_mat_free(U);
950                 return 0;
951         }
952         isl_int_init(v);
953         if (!tab || !tab_cone || !U)
954                 goto error;
955         bset = tab_cone->bset;
956         U = isl_mat_drop_cols(U, 0, tab->n_var - tab->n_unbounded);
957         for (i = 0; i < bset->n_ineq; ++i) {
958                 struct isl_vec *row = NULL;
959                 if (isl_tab_is_equality(tab_cone, tab_cone->n_eq + i))
960                         continue;
961                 row = isl_vec_alloc(bset->ctx, tab_cone->n_var);
962                 if (!row)
963                         goto error;
964                 isl_seq_cpy(row->el, bset->ineq[i] + 1, tab_cone->n_var);
965                 row = isl_vec_mat_product(row, isl_mat_copy(U));
966                 if (!row)
967                         goto error;
968                 vec_sum_of_neg(row, &v);
969                 isl_vec_free(row);
970                 if (isl_int_is_zero(v))
971                         continue;
972                 tab = isl_tab_extend(tab, 1);
973                 isl_int_add(bset->ineq[i][0], bset->ineq[i][0], v);
974                 tab = isl_tab_add_ineq(tab, bset->ineq[i]);
975                 isl_int_sub(bset->ineq[i][0], bset->ineq[i][0], v);
976                 if (!tab)
977                         goto error;
978         }
979
980         isl_mat_free(U);
981         isl_int_clear(v);
982         return 0;
983 error:
984         isl_mat_free(U);
985         isl_int_clear(v);
986         return -1;
987 }
988
989 /* Compute and return an initial basis for the possibly
990  * unbounded tableau "tab".  "tab_cone" is a tableau
991  * for the corresponding recession cone.
992  * Additionally, add constraints to "tab" that ensure
993  * that any rational value for the unbounded directions
994  * can be rounded up to an integer value.
995  *
996  * If the tableau is bounded, i.e., if the recession cone
997  * is zero-dimensional, then we just use inital_basis.
998  * Otherwise, we construct a basis whose first directions
999  * correspond to equalities, followed by bounded directions,
1000  * i.e., equalities in the recession cone.
1001  * The remaining directions are then unbounded.
1002  */
1003 int isl_tab_set_initial_basis_with_cone(struct isl_tab *tab,
1004         struct isl_tab *tab_cone)
1005 {
1006         struct isl_mat *eq;
1007         struct isl_mat *cone_eq;
1008         struct isl_mat *U, *Q;
1009
1010         if (!tab || !tab_cone)
1011                 return -1;
1012
1013         if (tab_cone->n_col == tab_cone->n_dead) {
1014                 tab->basis = initial_basis(tab);
1015                 return tab->basis ? 0 : -1;
1016         }
1017
1018         eq = tab_equalities(tab);
1019         if (!eq)
1020                 return -1;
1021         tab->n_zero = eq->n_row;
1022         cone_eq = tab_equalities(tab_cone);
1023         eq = isl_mat_concat(eq, cone_eq);
1024         if (!eq)
1025                 return -1;
1026         tab->n_unbounded = tab->n_var - (eq->n_row - tab->n_zero);
1027         eq = isl_mat_left_hermite(eq, 0, &U, &Q);
1028         if (!eq)
1029                 return -1;
1030         isl_mat_free(eq);
1031         tab->basis = isl_mat_lin_to_aff(Q);
1032         if (tab_shift_cone(tab, tab_cone, U) < 0)
1033                 return -1;
1034         if (!tab->basis)
1035                 return -1;
1036         return 0;
1037 }
1038
1039 /* Compute and return a sample point in bset using generalized basis
1040  * reduction.  We first check if the input set has a non-trivial
1041  * recession cone.  If so, we perform some extra preprocessing in
1042  * sample_with_cone.  Otherwise, we directly perform generalized basis
1043  * reduction.
1044  */
1045 static struct isl_vec *gbr_sample(struct isl_basic_set *bset)
1046 {
1047         unsigned dim;
1048         struct isl_basic_set *cone;
1049
1050         dim = isl_basic_set_total_dim(bset);
1051
1052         cone = isl_basic_set_recession_cone(isl_basic_set_copy(bset));
1053
1054         if (cone->n_eq < dim)
1055                 return isl_basic_set_sample_with_cone(bset, cone);
1056
1057         isl_basic_set_free(cone);
1058         return sample_bounded(bset);
1059 }
1060
1061 static struct isl_vec *pip_sample(struct isl_basic_set *bset)
1062 {
1063         struct isl_mat *T;
1064         struct isl_ctx *ctx;
1065         struct isl_vec *sample;
1066
1067         bset = isl_basic_set_skew_to_positive_orthant(bset, &T);
1068         if (!bset)
1069                 return NULL;
1070
1071         ctx = bset->ctx;
1072         sample = isl_pip_basic_set_sample(bset);
1073
1074         if (sample && sample->size != 0)
1075                 sample = isl_mat_vec_product(T, sample);
1076         else
1077                 isl_mat_free(T);
1078
1079         return sample;
1080 }
1081
1082 static struct isl_vec *basic_set_sample(struct isl_basic_set *bset, int bounded)
1083 {
1084         struct isl_ctx *ctx;
1085         unsigned dim;
1086         if (!bset)
1087                 return NULL;
1088
1089         ctx = bset->ctx;
1090         if (isl_basic_set_fast_is_empty(bset))
1091                 return empty_sample(bset);
1092
1093         dim = isl_basic_set_n_dim(bset);
1094         isl_assert(ctx, isl_basic_set_n_param(bset) == 0, goto error);
1095         isl_assert(ctx, bset->n_div == 0, goto error);
1096
1097         if (bset->sample && bset->sample->size == 1 + dim) {
1098                 int contains = isl_basic_set_contains(bset, bset->sample);
1099                 if (contains < 0)
1100                         goto error;
1101                 if (contains) {
1102                         struct isl_vec *sample = isl_vec_copy(bset->sample);
1103                         isl_basic_set_free(bset);
1104                         return sample;
1105                 }
1106         }
1107         isl_vec_free(bset->sample);
1108         bset->sample = NULL;
1109
1110         if (bset->n_eq > 0)
1111                 return sample_eq(bset, bounded ? isl_basic_set_sample_bounded
1112                                                : isl_basic_set_sample_vec);
1113         if (dim == 0)
1114                 return zero_sample(bset);
1115         if (dim == 1)
1116                 return interval_sample(bset);
1117
1118         switch (bset->ctx->ilp_solver) {
1119         case ISL_ILP_PIP:
1120                 return pip_sample(bset);
1121         case ISL_ILP_GBR:
1122                 return bounded ? sample_bounded(bset) : gbr_sample(bset);
1123         }
1124         isl_assert(bset->ctx, 0, );
1125 error:
1126         isl_basic_set_free(bset);
1127         return NULL;
1128 }
1129
1130 __isl_give isl_vec *isl_basic_set_sample_vec(__isl_take isl_basic_set *bset)
1131 {
1132         return basic_set_sample(bset, 0);
1133 }
1134
1135 /* Compute an integer sample in "bset", where the caller guarantees
1136  * that "bset" is bounded.
1137  */
1138 struct isl_vec *isl_basic_set_sample_bounded(struct isl_basic_set *bset)
1139 {
1140         return basic_set_sample(bset, 1);
1141 }
1142
1143 __isl_give isl_basic_set *isl_basic_set_from_vec(__isl_take isl_vec *vec)
1144 {
1145         int i;
1146         int k;
1147         struct isl_basic_set *bset = NULL;
1148         struct isl_ctx *ctx;
1149         unsigned dim;
1150
1151         if (!vec)
1152                 return NULL;
1153         ctx = vec->ctx;
1154         isl_assert(ctx, vec->size != 0, goto error);
1155
1156         bset = isl_basic_set_alloc(ctx, 0, vec->size - 1, 0, vec->size - 1, 0);
1157         if (!bset)
1158                 goto error;
1159         dim = isl_basic_set_n_dim(bset);
1160         for (i = dim - 1; i >= 0; --i) {
1161                 k = isl_basic_set_alloc_equality(bset);
1162                 if (k < 0)
1163                         goto error;
1164                 isl_seq_clr(bset->eq[k], 1 + dim);
1165                 isl_int_neg(bset->eq[k][0], vec->el[1 + i]);
1166                 isl_int_set(bset->eq[k][1 + i], vec->el[0]);
1167         }
1168         bset->sample = vec;
1169
1170         return bset;
1171 error:
1172         isl_basic_set_free(bset);
1173         isl_vec_free(vec);
1174         return NULL;
1175 }
1176
1177 __isl_give isl_basic_map *isl_basic_map_sample(__isl_take isl_basic_map *bmap)
1178 {
1179         struct isl_basic_set *bset;
1180         struct isl_vec *sample_vec;
1181
1182         bset = isl_basic_map_underlying_set(isl_basic_map_copy(bmap));
1183         sample_vec = isl_basic_set_sample_vec(bset);
1184         if (!sample_vec)
1185                 goto error;
1186         if (sample_vec->size == 0) {
1187                 struct isl_basic_map *sample;
1188                 sample = isl_basic_map_empty_like(bmap);
1189                 isl_vec_free(sample_vec);
1190                 isl_basic_map_free(bmap);
1191                 return sample;
1192         }
1193         bset = isl_basic_set_from_vec(sample_vec);
1194         return isl_basic_map_overlying_set(bset, bmap);
1195 error:
1196         isl_basic_map_free(bmap);
1197         return NULL;
1198 }
1199
1200 __isl_give isl_basic_map *isl_map_sample(__isl_take isl_map *map)
1201 {
1202         int i;
1203         isl_basic_map *sample = NULL;
1204
1205         if (!map)
1206                 goto error;
1207
1208         for (i = 0; i < map->n; ++i) {
1209                 sample = isl_basic_map_sample(isl_basic_map_copy(map->p[i]));
1210                 if (!sample)
1211                         goto error;
1212                 if (!ISL_F_ISSET(sample, ISL_BASIC_MAP_EMPTY))
1213                         break;
1214                 isl_basic_map_free(sample);
1215         }
1216         if (i == map->n)
1217                 sample = isl_basic_map_empty_like_map(map);
1218         isl_map_free(map);
1219         return sample;
1220 error:
1221         isl_map_free(map);
1222         return NULL;
1223 }
1224
1225 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set)
1226 {
1227         return (isl_basic_set *) isl_map_sample((isl_map *)set);
1228 }