00372b7ba98a196dac35ff593c2e9c910955b31d
[platform/upstream/isl.git] / include / isl_set.h
1 /*
2  * Copyright 2008-2009 Katholieke Universiteit Leuven
3  *
4  * Use of this software is governed by the GNU LGPLv2.1 license
5  *
6  * Written by Sven Verdoolaege, K.U.Leuven, Departement
7  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
8  */
9
10 #ifndef ISL_SET_H
11 #define ISL_SET_H
12
13 #include "isl_map.h"
14 #include "isl_list.h"
15 #include <isl_point.h>
16
17 #if defined(__cplusplus)
18 extern "C" {
19 #endif
20
21 /* A "basic set" is a basic map with a zero-dimensional
22  * domain.
23  */
24 struct isl_basic_set {
25         int ref;
26 #define ISL_BASIC_SET_FINAL             (1 << 0)
27 #define ISL_BASIC_SET_EMPTY             (1 << 1)
28 #define ISL_BASIC_SET_NO_IMPLICIT       (1 << 2)
29 #define ISL_BASIC_SET_NO_REDUNDANT      (1 << 3)
30 #define ISL_BASIC_SET_RATIONAL          (1 << 4)
31 #define ISL_BASIC_SET_NORMALIZED        (1 << 5)
32 #define ISL_BASIC_SET_NORMALIZED_DIVS   (1 << 6)
33 #define ISL_BASIC_SET_ALL_EQUALITIES    (1 << 7)
34         unsigned flags;
35
36         struct isl_ctx *ctx;
37
38         struct isl_dim *dim;
39         unsigned extra;
40
41         unsigned n_eq;
42         unsigned n_ineq;
43
44         size_t c_size;
45         isl_int **eq;
46         isl_int **ineq;
47
48         unsigned n_div;
49
50         isl_int **div;
51
52         struct isl_vec *sample;
53
54         struct isl_blk block;
55         struct isl_blk block2;
56 };
57
58 /* A "set" is a (possibly disjoint) union of basic sets.
59  *
60  * See the documentation of isl_map.
61  */
62 struct isl_set {
63         int ref;
64 #define ISL_SET_DISJOINT                (1 << 0)
65 #define ISL_SET_NORMALIZED              (1 << 1)
66         unsigned flags;
67
68         struct isl_ctx *ctx;
69
70         struct isl_dim *dim;
71
72         int n;
73
74         size_t size;
75         struct isl_basic_set *p[1];
76 };
77
78 unsigned isl_basic_set_n_dim(const struct isl_basic_set *bset);
79 unsigned isl_basic_set_n_param(const struct isl_basic_set *bset);
80 unsigned isl_basic_set_total_dim(const struct isl_basic_set *bset);
81 unsigned isl_basic_set_dim(const struct isl_basic_set *bset,
82                                 enum isl_dim_type type);
83
84 unsigned isl_set_n_dim(const struct isl_set *set);
85 unsigned isl_set_n_param(const struct isl_set *set);
86 unsigned isl_set_dim(const struct isl_set *set, enum isl_dim_type type);
87
88 isl_ctx *isl_basic_set_get_ctx(__isl_keep isl_basic_set *bset);
89 isl_ctx *isl_set_get_ctx(__isl_keep isl_set *set);
90 __isl_give isl_dim *isl_basic_set_get_dim(__isl_keep isl_basic_set *bset);
91 __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
92
93 __isl_give isl_set *isl_set_set_tuple_name(__isl_take isl_set *set,
94         const char *s);
95 __isl_give isl_basic_set *isl_basic_set_set_dim_name(
96         __isl_take isl_basic_set *bset,
97         enum isl_dim_type type, unsigned pos, const char *s);
98 __isl_give isl_set *isl_set_set_dim_name(__isl_take isl_set *set,
99         enum isl_dim_type type, unsigned pos, const char *s);
100
101 struct isl_basic_set *isl_basic_set_alloc(struct isl_ctx *ctx,
102                 unsigned nparam, unsigned dim, unsigned extra,
103                 unsigned n_eq, unsigned n_ineq);
104 struct isl_basic_set *isl_basic_set_extend(struct isl_basic_set *base,
105                 unsigned nparam, unsigned dim, unsigned extra,
106                 unsigned n_eq, unsigned n_ineq);
107 struct isl_basic_set *isl_basic_set_extend_constraints(
108                 struct isl_basic_set *base, unsigned n_eq, unsigned n_ineq);
109 struct isl_basic_set *isl_basic_set_finalize(struct isl_basic_set *bset);
110 void isl_basic_set_free(__isl_take isl_basic_set *bset);
111 __isl_give isl_basic_set *isl_basic_set_copy(__isl_keep isl_basic_set *bset);
112 struct isl_basic_set *isl_basic_set_dup(struct isl_basic_set *bset);
113 __isl_give isl_basic_set *isl_basic_set_empty(__isl_take isl_dim *dim);
114 struct isl_basic_set *isl_basic_set_empty_like(struct isl_basic_set *bset);
115 __isl_give isl_basic_set *isl_basic_set_universe(__isl_take isl_dim *dim);
116 struct isl_basic_set *isl_basic_set_universe_like(struct isl_basic_set *bset);
117 __isl_give isl_basic_set *isl_basic_set_universe_like_set(
118         __isl_keep isl_set *model);
119 struct isl_basic_set *isl_basic_set_interval(struct isl_ctx *ctx,
120         isl_int min, isl_int max);
121 struct isl_basic_set *isl_basic_set_positive_orthant(struct isl_dim *dims);
122 void isl_basic_set_dump(__isl_keep isl_basic_set *bset,
123                                 FILE *out, int indent);
124 struct isl_basic_set *isl_basic_set_swap_vars(
125                 struct isl_basic_set *bset, unsigned n);
126 __isl_give isl_basic_set *isl_basic_set_intersect(
127                 __isl_take isl_basic_set *bset1,
128                 __isl_take isl_basic_set *bset2);
129 __isl_give isl_basic_set *isl_basic_set_apply(
130                 __isl_take isl_basic_set *bset,
131                 __isl_take isl_basic_map *bmap);
132 __isl_give isl_basic_set *isl_basic_set_affine_hull(
133                 __isl_take isl_basic_set *bset);
134 __isl_give isl_basic_set *isl_basic_set_remove(__isl_take isl_basic_set *bset,
135         enum isl_dim_type type, unsigned first, unsigned n);
136 struct isl_basic_set *isl_basic_set_simplify(struct isl_basic_set *bset);
137 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
138                                                 __isl_take isl_basic_set *bset);
139 struct isl_basic_set *isl_basic_set_product(struct isl_basic_set_list *list);
140
141 __isl_give isl_basic_set *isl_basic_set_read_from_file(isl_ctx *ctx,
142                 FILE *input, int nparam);
143 __isl_give isl_basic_set *isl_basic_set_read_from_str(isl_ctx *ctx,
144                 const char *str, int nparam);
145 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
146                 FILE *input, int nparam);
147 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
148                 const char *str, int nparam);
149 __isl_give isl_printer *isl_printer_print_basic_set(
150         __isl_take isl_printer *printer, __isl_keep isl_basic_set *bset);
151 __isl_give isl_printer *isl_printer_print_set(__isl_take isl_printer *printer,
152         __isl_keep isl_set *map);
153 void isl_basic_set_print(__isl_keep isl_basic_set *bset, FILE *out, int indent,
154         const char *prefix, const char *suffix, unsigned output_format);
155 void isl_set_print(__isl_keep struct isl_set *set, FILE *out, int indent,
156         unsigned output_format);
157 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
158                 enum isl_dim_type type, unsigned pos, isl_int value);
159 struct isl_basic_set *isl_basic_set_fix_si(struct isl_basic_set *bset,
160                 enum isl_dim_type type, unsigned pos, int value);
161 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
162                 enum isl_dim_type type, unsigned pos, int value);
163 __isl_give isl_set *isl_set_lower_bound_si(__isl_take isl_set *set,
164                 enum isl_dim_type type, unsigned pos, int value);
165
166 struct isl_basic_set *isl_basic_set_from_underlying_set(
167         struct isl_basic_set *bset, struct isl_basic_set *like);
168 struct isl_set *isl_set_from_underlying_set(
169         struct isl_set *set, struct isl_basic_set *like);
170 struct isl_set *isl_set_to_underlying_set(struct isl_set *set);
171
172 int isl_basic_set_is_equal(
173                 struct isl_basic_set *bset1, struct isl_basic_set *bset2);
174
175 __isl_give isl_set *isl_basic_set_partial_lexmin(
176                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
177                 __isl_give isl_set **empty);
178 __isl_give isl_set *isl_basic_set_partial_lexmax(
179                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
180                 __isl_give isl_set **empty);
181 __isl_give isl_set *isl_set_partial_lexmin(
182                 __isl_take isl_set *set, __isl_take isl_set *dom,
183                 __isl_give isl_set **empty);
184 __isl_give isl_set *isl_set_partial_lexmax(
185                 __isl_take isl_set *set, __isl_take isl_set *dom,
186                 __isl_give isl_set **empty);
187 __isl_give isl_set *isl_basic_set_lexmin(__isl_take isl_basic_set *bset);
188 __isl_give isl_set *isl_basic_set_lexmax(__isl_take isl_basic_set *bset);
189 __isl_give isl_set *isl_set_lexmin(__isl_take isl_set *set);
190 __isl_give isl_set *isl_set_lexmax(__isl_take isl_set *set);
191 __isl_give isl_set *isl_basic_set_union(
192                 __isl_take isl_basic_set *bset1,
193                 __isl_take isl_basic_set *bset2);
194
195 int isl_basic_set_compare_at(struct isl_basic_set *bset1,
196         struct isl_basic_set *bset2, int pos);
197 int isl_set_follows_at(__isl_keep isl_set *set1,
198         __isl_keep isl_set *set2, int pos);
199
200 int isl_basic_set_dims_get_sign(__isl_keep isl_basic_set *bset,
201         enum isl_dim_type type, unsigned pos, unsigned n, int *signs);
202
203 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
204 int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
205 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
206 int isl_basic_set_is_bounded(__isl_keep isl_basic_set *bset);
207
208 struct isl_set *isl_set_alloc(struct isl_ctx *ctx,
209                 unsigned nparam, unsigned dim, int n, unsigned flags);
210 struct isl_set *isl_set_extend(struct isl_set *base,
211                 unsigned nparam, unsigned dim);
212 __isl_give isl_set *isl_set_empty(__isl_take isl_dim *dim);
213 struct isl_set *isl_set_empty_like(struct isl_set *set);
214 __isl_give isl_set *isl_set_universe(__isl_take isl_dim *dim);
215 __isl_give isl_set *isl_set_universe_like(__isl_keep isl_set *model);
216 __isl_give isl_set *isl_set_add_basic_set(__isl_take isl_set *set,
217                                                 __isl_take isl_basic_set *bset);
218 struct isl_set *isl_set_finalize(struct isl_set *set);
219 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
220 void isl_set_free(__isl_take isl_set *set);
221 struct isl_set *isl_set_dup(struct isl_set *set);
222 __isl_give isl_set *isl_set_from_basic_set(__isl_take isl_basic_set *bset);
223 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set);
224 __isl_give isl_point *isl_set_sample_point(__isl_take isl_set *set);
225 __isl_give isl_set *isl_set_detect_equalities(__isl_take isl_set *set);
226 __isl_give isl_basic_set *isl_set_affine_hull(__isl_take isl_set *set);
227 __isl_give isl_basic_set *isl_set_convex_hull(__isl_take isl_set *set);
228 __isl_give isl_basic_set *isl_set_simple_hull(__isl_take isl_set *set);
229 struct isl_basic_set *isl_set_bounded_simple_hull(struct isl_set *set);
230 __isl_give isl_set *isl_set_recession_cone(__isl_take isl_set *set);
231
232 struct isl_set *isl_set_union_disjoint(
233                         struct isl_set *set1, struct isl_set *set2);
234 __isl_give isl_set *isl_set_union(
235                 __isl_take isl_set *set1,
236                 __isl_take isl_set *set2);
237 struct isl_set *isl_set_product(struct isl_set *set1, struct isl_set *set2);
238 __isl_give isl_set *isl_set_flat_product(__isl_take isl_set *set1,
239         __isl_take isl_set *set2);
240 __isl_give isl_set *isl_set_intersect(
241                 __isl_take isl_set *set1,
242                 __isl_take isl_set *set2);
243 __isl_give isl_set *isl_set_subtract(
244                 __isl_take isl_set *set1,
245                 __isl_take isl_set *set2);
246 __isl_give isl_set *isl_set_complement(__isl_take isl_set *set);
247 __isl_give isl_set *isl_set_apply(
248                 __isl_take isl_set *set,
249                 __isl_take isl_map *map);
250 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
251                 enum isl_dim_type type, unsigned pos, isl_int value);
252 struct isl_set *isl_set_fix_dim_si(struct isl_set *set,
253                 unsigned dim, int value);
254 struct isl_set *isl_set_lower_bound_dim(struct isl_set *set,
255                 unsigned dim, isl_int value);
256 __isl_give isl_set *isl_set_insert(__isl_take isl_set *set,
257                 enum isl_dim_type type, unsigned pos, unsigned n);
258 __isl_give isl_basic_set *isl_basic_set_add(__isl_take isl_basic_set *bset,
259                 enum isl_dim_type type, unsigned n);
260 __isl_give isl_set *isl_set_add(__isl_take isl_set *set,
261                 enum isl_dim_type type, unsigned n);
262 __isl_give isl_basic_set *isl_basic_set_move_dims(__isl_take isl_basic_set *bset,
263         enum isl_dim_type dst_type, unsigned dst_pos,
264         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
265 __isl_give isl_set *isl_set_move_dims(__isl_take isl_set *set,
266         enum isl_dim_type dst_type, unsigned dst_pos,
267         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
268 __isl_give isl_basic_set *isl_basic_set_project_out(
269                 __isl_take isl_basic_set *bset,
270                 enum isl_dim_type type, unsigned first, unsigned n);
271 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
272                 enum isl_dim_type type, unsigned first, unsigned n);
273 struct isl_basic_set *isl_basic_set_remove_dims(struct isl_basic_set *bset,
274                 unsigned first, unsigned n);
275 __isl_give isl_basic_set *isl_basic_set_remove_divs(
276         __isl_take isl_basic_set *bset);
277 struct isl_set *isl_set_eliminate_dims(struct isl_set *set,
278                 unsigned first, unsigned n);
279 __isl_give isl_set *isl_set_remove(__isl_take isl_set *bset,
280         enum isl_dim_type type, unsigned first, unsigned n);
281 struct isl_set *isl_set_remove_dims(struct isl_set *set,
282                 unsigned first, unsigned n);
283 __isl_give isl_set *isl_set_remove_divs(__isl_take isl_set *set);
284 __isl_give isl_set *isl_set_split_dims(__isl_take isl_set *set,
285         enum isl_dim_type type, unsigned first, unsigned n);
286
287 void isl_set_dump(__isl_keep isl_set *set, FILE *out, int indent);
288 struct isl_set *isl_set_swap_vars(struct isl_set *set, unsigned n);
289 int isl_set_fast_is_empty(__isl_keep isl_set *set);
290 int isl_set_fast_is_universe(__isl_keep isl_set *set);
291 int isl_set_is_empty(__isl_keep isl_set *set);
292 int isl_set_is_bounded(__isl_keep isl_set *set);
293 int isl_set_is_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
294 int isl_set_is_strict_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
295 int isl_set_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
296 int isl_set_is_singleton(__isl_keep isl_set *set);
297 int isl_set_is_box(__isl_keep isl_set *set);
298 int isl_set_has_equal_dim(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
299
300 __isl_give isl_set *isl_set_sum(__isl_take isl_set *set1,
301         __isl_take isl_set *set2);
302 __isl_give isl_set *isl_set_neg(__isl_take isl_set *set);
303
304 __isl_give isl_set *isl_set_make_disjoint(__isl_take isl_set *set);
305 struct isl_set *isl_basic_set_compute_divs(struct isl_basic_set *bset);
306 __isl_give isl_set *isl_set_compute_divs(__isl_take isl_set *set);
307 __isl_give isl_set *isl_set_align_divs(__isl_take isl_set *set);
308
309 struct isl_basic_set *isl_set_copy_basic_set(struct isl_set *set);
310 struct isl_set *isl_set_drop_basic_set(struct isl_set *set,
311                                                 struct isl_basic_set *bset);
312
313 int isl_basic_set_fast_dim_is_fixed(struct isl_basic_set *bset, unsigned dim,
314         isl_int *val);
315
316 int isl_set_fast_dim_is_fixed(struct isl_set *set, unsigned dim, isl_int *val);
317 int isl_set_fast_dim_has_fixed_lower_bound(struct isl_set *set,
318         unsigned dim, isl_int *val);
319 int isl_set_dim_is_bounded(__isl_keep isl_set *set,
320         enum isl_dim_type type, unsigned pos);
321
322 __isl_give isl_basic_set *isl_basic_set_gist(__isl_take isl_basic_set *bset,
323                                             __isl_take isl_basic_set *context);
324 __isl_give isl_set *isl_set_gist_basic_set(__isl_take isl_set *set,
325         __isl_take isl_basic_set *context);
326 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
327         __isl_take isl_set *context);
328 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
329         int pos, isl_int *modulo, isl_int *residue);
330 int isl_set_dim_residue_class(struct isl_set *set,
331         int pos, isl_int *modulo, isl_int *residue);
332
333 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
334
335 int isl_set_fast_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
336 int isl_set_fast_is_disjoint(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
337
338 uint32_t isl_set_get_hash(struct isl_set *set);
339
340 int isl_set_dim_is_unique(struct isl_set *set, unsigned dim);
341
342 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
343         int (*fn)(__isl_take isl_basic_set *bset, void *user), void *user);
344
345 int isl_set_foreach_point(__isl_keep isl_set *set,
346         int (*fn)(__isl_take isl_point *pnt, void *user), void *user);
347 int isl_set_count(__isl_keep isl_set *set, isl_int *count);
348 int isl_set_count_upto(__isl_keep isl_set *set, isl_int max, isl_int *count);
349
350 __isl_give isl_set *isl_set_from_point(__isl_take isl_point *pnt);
351 __isl_give isl_set *isl_set_box_from_points(__isl_take isl_point *pnt1,
352         __isl_take isl_point *pnt2);
353
354 __isl_give isl_set *isl_set_lift(__isl_take isl_set *set);
355
356 __isl_give isl_map *isl_set_lex_le_set(__isl_take isl_set *set1,
357         __isl_take isl_set *set2);
358 __isl_give isl_map *isl_set_lex_lt_set(__isl_take isl_set *set1,
359         __isl_take isl_set *set2);
360 __isl_give isl_map *isl_set_lex_ge_set(__isl_take isl_set *set1,
361         __isl_take isl_set *set2);
362 __isl_give isl_map *isl_set_lex_gt_set(__isl_take isl_set *set1,
363         __isl_take isl_set *set2);
364
365 int isl_set_size(__isl_keep isl_set *set);
366
367 __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
368         __isl_take isl_dim *dim,
369         __isl_take isl_mat *eq, __isl_take isl_mat *ineq, enum isl_dim_type c1,
370         enum isl_dim_type c2, enum isl_dim_type c3, enum isl_dim_type c4);
371
372 #if defined(__cplusplus)
373 }
374 #endif
375
376 #endif