dump isl_ast_expr and isl_ast_node objects in block format
[isl.git] / isl_range.c
bloba23a6332b037cf3f5d4e0d823a405b8a5141a7f0
1 #include <isl_ctx_private.h>
2 #include <isl_constraint_private.h>
3 #include <isl/set.h>
4 #include <isl_polynomial_private.h>
5 #include <isl_morph.h>
6 #include <isl_range.h>
8 struct range_data {
9 struct isl_bound *bound;
10 int *signs;
11 int sign;
12 int test_monotonicity;
13 int monotonicity;
14 int tight;
15 isl_qpolynomial *poly;
16 isl_pw_qpolynomial_fold *pwf;
17 isl_pw_qpolynomial_fold *pwf_tight;
20 static isl_stat propagate_on_domain(__isl_take isl_basic_set *bset,
21 __isl_take isl_qpolynomial *poly, struct range_data *data);
23 /* Check whether the polynomial "poly" has sign "sign" over "bset",
24 * i.e., if sign == 1, check that the lower bound on the polynomial
25 * is non-negative and if sign == -1, check that the upper bound on
26 * the polynomial is non-positive.
28 static int has_sign(__isl_keep isl_basic_set *bset,
29 __isl_keep isl_qpolynomial *poly, int sign, int *signs)
31 struct range_data data_m;
32 unsigned nparam;
33 isl_space *dim;
34 isl_val *opt;
35 int r;
36 enum isl_fold type;
38 nparam = isl_basic_set_dim(bset, isl_dim_param);
40 bset = isl_basic_set_copy(bset);
41 poly = isl_qpolynomial_copy(poly);
43 bset = isl_basic_set_move_dims(bset, isl_dim_set, 0,
44 isl_dim_param, 0, nparam);
45 poly = isl_qpolynomial_move_dims(poly, isl_dim_in, 0,
46 isl_dim_param, 0, nparam);
48 dim = isl_qpolynomial_get_space(poly);
49 dim = isl_space_params(dim);
50 dim = isl_space_from_domain(dim);
51 dim = isl_space_add_dims(dim, isl_dim_out, 1);
53 data_m.test_monotonicity = 0;
54 data_m.signs = signs;
55 data_m.sign = -sign;
56 type = data_m.sign < 0 ? isl_fold_min : isl_fold_max;
57 data_m.pwf = isl_pw_qpolynomial_fold_zero(dim, type);
58 data_m.tight = 0;
59 data_m.pwf_tight = NULL;
61 if (propagate_on_domain(bset, poly, &data_m) < 0)
62 goto error;
64 if (sign > 0)
65 opt = isl_pw_qpolynomial_fold_min(data_m.pwf);
66 else
67 opt = isl_pw_qpolynomial_fold_max(data_m.pwf);
69 if (!opt)
70 r = -1;
71 else if (isl_val_is_nan(opt) ||
72 isl_val_is_infty(opt) ||
73 isl_val_is_neginfty(opt))
74 r = 0;
75 else
76 r = sign * isl_val_sgn(opt) >= 0;
78 isl_val_free(opt);
80 return r;
81 error:
82 isl_pw_qpolynomial_fold_free(data_m.pwf);
83 return -1;
86 /* Return 1 if poly is monotonically increasing in the last set variable,
87 * -1 if poly is monotonically decreasing in the last set variable,
88 * 0 if no conclusion,
89 * -2 on error.
91 * We simply check the sign of p(x+1)-p(x)
93 static int monotonicity(__isl_keep isl_basic_set *bset,
94 __isl_keep isl_qpolynomial *poly, struct range_data *data)
96 isl_ctx *ctx;
97 isl_space *dim;
98 isl_qpolynomial *sub = NULL;
99 isl_qpolynomial *diff = NULL;
100 int result = 0;
101 int s;
102 unsigned nvar;
104 ctx = isl_qpolynomial_get_ctx(poly);
105 dim = isl_qpolynomial_get_domain_space(poly);
107 nvar = isl_basic_set_dim(bset, isl_dim_set);
109 sub = isl_qpolynomial_var_on_domain(isl_space_copy(dim), isl_dim_set, nvar - 1);
110 sub = isl_qpolynomial_add(sub,
111 isl_qpolynomial_rat_cst_on_domain(dim, ctx->one, ctx->one));
113 diff = isl_qpolynomial_substitute(isl_qpolynomial_copy(poly),
114 isl_dim_in, nvar - 1, 1, &sub);
115 diff = isl_qpolynomial_sub(diff, isl_qpolynomial_copy(poly));
117 s = has_sign(bset, diff, 1, data->signs);
118 if (s < 0)
119 goto error;
120 if (s)
121 result = 1;
122 else {
123 s = has_sign(bset, diff, -1, data->signs);
124 if (s < 0)
125 goto error;
126 if (s)
127 result = -1;
130 isl_qpolynomial_free(diff);
131 isl_qpolynomial_free(sub);
133 return result;
134 error:
135 isl_qpolynomial_free(diff);
136 isl_qpolynomial_free(sub);
137 return -2;
140 /* Return a positive ("sign" > 0) or negative ("sign" < 0) infinite polynomial
141 * with domain space "space".
143 static __isl_give isl_qpolynomial *signed_infty(__isl_take isl_space *space,
144 int sign)
146 if (sign > 0)
147 return isl_qpolynomial_infty_on_domain(space);
148 else
149 return isl_qpolynomial_neginfty_on_domain(space);
152 static __isl_give isl_qpolynomial *bound2poly(__isl_take isl_constraint *bound,
153 __isl_take isl_space *space, unsigned pos, int sign)
155 if (!bound)
156 return signed_infty(space, sign);
157 isl_space_free(space);
158 return isl_qpolynomial_from_constraint(bound, isl_dim_set, pos);
161 static int bound_is_integer(__isl_take isl_constraint *bound, unsigned pos)
163 isl_int c;
164 int is_int;
166 if (!bound)
167 return 1;
169 isl_int_init(c);
170 isl_constraint_get_coefficient(bound, isl_dim_set, pos, &c);
171 is_int = isl_int_is_one(c) || isl_int_is_negone(c);
172 isl_int_clear(c);
174 return is_int;
177 struct isl_fixed_sign_data {
178 int *signs;
179 int sign;
180 isl_qpolynomial *poly;
183 /* Add term "term" to data->poly if it has sign data->sign.
184 * The sign is determined based on the signs of the parameters
185 * and variables in data->signs. The integer divisions, if
186 * any, are assumed to be non-negative.
188 static isl_stat collect_fixed_sign_terms(__isl_take isl_term *term, void *user)
190 struct isl_fixed_sign_data *data = (struct isl_fixed_sign_data *)user;
191 isl_int n;
192 int i;
193 int sign;
194 unsigned nparam;
195 unsigned nvar;
197 if (!term)
198 return isl_stat_error;
200 nparam = isl_term_dim(term, isl_dim_param);
201 nvar = isl_term_dim(term, isl_dim_set);
203 isl_int_init(n);
205 isl_term_get_num(term, &n);
207 sign = isl_int_sgn(n);
208 for (i = 0; i < nparam; ++i) {
209 if (data->signs[i] > 0)
210 continue;
211 if (isl_term_get_exp(term, isl_dim_param, i) % 2)
212 sign = -sign;
214 for (i = 0; i < nvar; ++i) {
215 if (data->signs[nparam + i] > 0)
216 continue;
217 if (isl_term_get_exp(term, isl_dim_set, i) % 2)
218 sign = -sign;
221 if (sign == data->sign) {
222 isl_qpolynomial *t = isl_qpolynomial_from_term(term);
224 data->poly = isl_qpolynomial_add(data->poly, t);
225 } else
226 isl_term_free(term);
228 isl_int_clear(n);
230 return isl_stat_ok;
233 /* Construct and return a polynomial that consists of the terms
234 * in "poly" that have sign "sign". The integer divisions, if
235 * any, are assumed to be non-negative.
237 __isl_give isl_qpolynomial *isl_qpolynomial_terms_of_sign(
238 __isl_keep isl_qpolynomial *poly, int *signs, int sign)
240 isl_space *space;
241 struct isl_fixed_sign_data data = { signs, sign };
243 space = isl_qpolynomial_get_domain_space(poly);
244 data.poly = isl_qpolynomial_zero_on_domain(space);
246 if (isl_qpolynomial_foreach_term(poly, collect_fixed_sign_terms, &data) < 0)
247 goto error;
249 return data.poly;
250 error:
251 isl_qpolynomial_free(data.poly);
252 return NULL;
255 /* Helper function to add a guarded polynomial to either pwf_tight or pwf,
256 * depending on whether the result has been determined to be tight.
258 static isl_stat add_guarded_poly(__isl_take isl_basic_set *bset,
259 __isl_take isl_qpolynomial *poly, struct range_data *data)
261 enum isl_fold type = data->sign < 0 ? isl_fold_min : isl_fold_max;
262 isl_set *set;
263 isl_qpolynomial_fold *fold;
264 isl_pw_qpolynomial_fold *pwf;
266 bset = isl_basic_set_params(bset);
267 poly = isl_qpolynomial_project_domain_on_params(poly);
269 fold = isl_qpolynomial_fold_alloc(type, poly);
270 set = isl_set_from_basic_set(bset);
271 pwf = isl_pw_qpolynomial_fold_alloc(type, set, fold);
272 if (data->tight)
273 data->pwf_tight = isl_pw_qpolynomial_fold_fold(
274 data->pwf_tight, pwf);
275 else
276 data->pwf = isl_pw_qpolynomial_fold_fold(data->pwf, pwf);
278 return isl_stat_ok;
281 /* Plug in "sub" for the variable at position "pos" in "poly".
283 * If "sub" is an infinite polynomial and if the variable actually
284 * appears in "poly", then calling isl_qpolynomial_substitute
285 * to perform the substitution may result in a NaN result.
286 * In such cases, return positive or negative infinity instead,
287 * depending on whether an upper bound or a lower bound is being computed,
288 * and mark the result as not being tight.
290 static __isl_give isl_qpolynomial *plug_in_at_pos(
291 __isl_take isl_qpolynomial *poly, int pos,
292 __isl_take isl_qpolynomial *sub, struct range_data *data)
294 isl_bool involves, infty;
296 involves = isl_qpolynomial_involves_dims(poly, isl_dim_in, pos, 1);
297 if (involves < 0)
298 goto error;
299 if (!involves) {
300 isl_qpolynomial_free(sub);
301 return poly;
304 infty = isl_qpolynomial_is_infty(sub);
305 if (infty >= 0 && !infty)
306 infty = isl_qpolynomial_is_neginfty(sub);
307 if (infty < 0)
308 goto error;
309 if (infty) {
310 isl_space *space = isl_qpolynomial_get_domain_space(poly);
311 data->tight = 0;
312 isl_qpolynomial_free(poly);
313 isl_qpolynomial_free(sub);
314 return signed_infty(space, data->sign);
317 poly = isl_qpolynomial_substitute(poly, isl_dim_in, pos, 1, &sub);
318 isl_qpolynomial_free(sub);
320 return poly;
321 error:
322 isl_qpolynomial_free(poly);
323 isl_qpolynomial_free(sub);
324 return NULL;
327 /* Given a lower and upper bound on the final variable and constraints
328 * on the remaining variables where these bounds are active,
329 * eliminate the variable from data->poly based on these bounds.
330 * If the polynomial has been determined to be monotonic
331 * in the variable, then simply plug in the appropriate bound.
332 * If the current polynomial is tight and if this bound is integer,
333 * then the result is still tight. In all other cases, the results
334 * may not be tight.
335 * Otherwise, plug in the largest bound (in absolute value) in
336 * the positive terms (if an upper bound is wanted) or the negative terms
337 * (if a lower bounded is wanted) and the other bound in the other terms.
339 * If all variables have been eliminated, then record the result.
340 * Ohterwise, recurse on the next variable.
342 static isl_stat propagate_on_bound_pair(__isl_take isl_constraint *lower,
343 __isl_take isl_constraint *upper, __isl_take isl_basic_set *bset,
344 void *user)
346 struct range_data *data = (struct range_data *)user;
347 int save_tight = data->tight;
348 isl_qpolynomial *poly;
349 isl_stat r;
350 unsigned nvar;
352 nvar = isl_basic_set_dim(bset, isl_dim_set);
354 if (data->monotonicity) {
355 isl_qpolynomial *sub;
356 isl_space *dim = isl_qpolynomial_get_domain_space(data->poly);
357 if (data->monotonicity * data->sign > 0) {
358 if (data->tight)
359 data->tight = bound_is_integer(upper, nvar);
360 sub = bound2poly(upper, dim, nvar, 1);
361 isl_constraint_free(lower);
362 } else {
363 if (data->tight)
364 data->tight = bound_is_integer(lower, nvar);
365 sub = bound2poly(lower, dim, nvar, -1);
366 isl_constraint_free(upper);
368 poly = isl_qpolynomial_copy(data->poly);
369 poly = plug_in_at_pos(poly, nvar, sub, data);
370 poly = isl_qpolynomial_drop_dims(poly, isl_dim_in, nvar, 1);
371 } else {
372 isl_qpolynomial *l, *u;
373 isl_qpolynomial *pos, *neg;
374 isl_space *dim = isl_qpolynomial_get_domain_space(data->poly);
375 unsigned nparam = isl_basic_set_dim(bset, isl_dim_param);
376 int sign = data->sign * data->signs[nparam + nvar];
378 data->tight = 0;
380 u = bound2poly(upper, isl_space_copy(dim), nvar, 1);
381 l = bound2poly(lower, dim, nvar, -1);
383 pos = isl_qpolynomial_terms_of_sign(data->poly, data->signs, sign);
384 neg = isl_qpolynomial_terms_of_sign(data->poly, data->signs, -sign);
386 pos = plug_in_at_pos(pos, nvar, u, data);
387 neg = plug_in_at_pos(neg, nvar, l, data);
389 poly = isl_qpolynomial_add(pos, neg);
390 poly = isl_qpolynomial_drop_dims(poly, isl_dim_in, nvar, 1);
393 if (isl_basic_set_dim(bset, isl_dim_set) == 0)
394 r = add_guarded_poly(bset, poly, data);
395 else
396 r = propagate_on_domain(bset, poly, data);
398 data->tight = save_tight;
400 return r;
403 /* Recursively perform range propagation on the polynomial "poly"
404 * defined over the basic set "bset" and collect the results in "data".
406 static isl_stat propagate_on_domain(__isl_take isl_basic_set *bset,
407 __isl_take isl_qpolynomial *poly, struct range_data *data)
409 isl_ctx *ctx;
410 isl_qpolynomial *save_poly = data->poly;
411 int save_monotonicity = data->monotonicity;
412 unsigned d;
414 if (!bset || !poly)
415 goto error;
417 ctx = isl_basic_set_get_ctx(bset);
418 d = isl_basic_set_dim(bset, isl_dim_set);
419 isl_assert(ctx, d >= 1, goto error);
421 if (isl_qpolynomial_is_cst(poly, NULL, NULL)) {
422 bset = isl_basic_set_project_out(bset, isl_dim_set, 0, d);
423 poly = isl_qpolynomial_drop_dims(poly, isl_dim_in, 0, d);
424 return add_guarded_poly(bset, poly, data);
427 if (data->test_monotonicity)
428 data->monotonicity = monotonicity(bset, poly, data);
429 else
430 data->monotonicity = 0;
431 if (data->monotonicity < -1)
432 goto error;
434 data->poly = poly;
435 if (isl_basic_set_foreach_bound_pair(bset, isl_dim_set, d - 1,
436 &propagate_on_bound_pair, data) < 0)
437 goto error;
439 isl_basic_set_free(bset);
440 isl_qpolynomial_free(poly);
441 data->monotonicity = save_monotonicity;
442 data->poly = save_poly;
444 return isl_stat_ok;
445 error:
446 isl_basic_set_free(bset);
447 isl_qpolynomial_free(poly);
448 data->monotonicity = save_monotonicity;
449 data->poly = save_poly;
450 return isl_stat_error;
453 static isl_stat basic_guarded_poly_bound(__isl_take isl_basic_set *bset,
454 void *user)
456 struct range_data *data = (struct range_data *)user;
457 isl_ctx *ctx;
458 unsigned nparam = isl_basic_set_dim(bset, isl_dim_param);
459 unsigned dim = isl_basic_set_dim(bset, isl_dim_set);
460 isl_stat r;
462 data->signs = NULL;
464 ctx = isl_basic_set_get_ctx(bset);
465 data->signs = isl_alloc_array(ctx, int,
466 isl_basic_set_dim(bset, isl_dim_all));
468 if (isl_basic_set_dims_get_sign(bset, isl_dim_set, 0, dim,
469 data->signs + nparam) < 0)
470 goto error;
471 if (isl_basic_set_dims_get_sign(bset, isl_dim_param, 0, nparam,
472 data->signs) < 0)
473 goto error;
475 r = propagate_on_domain(bset, isl_qpolynomial_copy(data->poly), data);
477 free(data->signs);
479 return r;
480 error:
481 free(data->signs);
482 isl_basic_set_free(bset);
483 return isl_stat_error;
486 static int qpolynomial_bound_on_domain_range(__isl_take isl_basic_set *bset,
487 __isl_take isl_qpolynomial *poly, struct range_data *data)
489 unsigned nparam = isl_basic_set_dim(bset, isl_dim_param);
490 unsigned nvar = isl_basic_set_dim(bset, isl_dim_set);
491 isl_set *set = NULL;
493 if (!bset)
494 goto error;
496 if (nvar == 0)
497 return add_guarded_poly(bset, poly, data);
499 set = isl_set_from_basic_set(bset);
500 set = isl_set_split_dims(set, isl_dim_param, 0, nparam);
501 set = isl_set_split_dims(set, isl_dim_set, 0, nvar);
503 data->poly = poly;
505 data->test_monotonicity = 1;
506 if (isl_set_foreach_basic_set(set, &basic_guarded_poly_bound, data) < 0)
507 goto error;
509 isl_set_free(set);
510 isl_qpolynomial_free(poly);
512 return 0;
513 error:
514 isl_set_free(set);
515 isl_qpolynomial_free(poly);
516 return -1;
519 int isl_qpolynomial_bound_on_domain_range(__isl_take isl_basic_set *bset,
520 __isl_take isl_qpolynomial *poly, struct isl_bound *bound)
522 struct range_data data;
523 int r;
525 data.pwf = bound->pwf;
526 data.pwf_tight = bound->pwf_tight;
527 data.tight = bound->check_tight;
528 if (bound->type == isl_fold_min)
529 data.sign = -1;
530 else
531 data.sign = 1;
533 r = qpolynomial_bound_on_domain_range(bset, poly, &data);
535 bound->pwf = data.pwf;
536 bound->pwf_tight = data.pwf_tight;
538 return r;