add isl_basic_set_dims_get_sign
[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_give isl_dim *isl_basic_set_get_dim(__isl_keep isl_basic_set *bset);
89 __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
90
91 struct isl_basic_set *isl_basic_set_alloc(struct isl_ctx *ctx,
92                 unsigned nparam, unsigned dim, unsigned extra,
93                 unsigned n_eq, unsigned n_ineq);
94 struct isl_basic_set *isl_basic_set_extend(struct isl_basic_set *base,
95                 unsigned nparam, unsigned dim, unsigned extra,
96                 unsigned n_eq, unsigned n_ineq);
97 struct isl_basic_set *isl_basic_set_extend_constraints(
98                 struct isl_basic_set *base, unsigned n_eq, unsigned n_ineq);
99 struct isl_basic_set *isl_basic_set_finalize(struct isl_basic_set *bset);
100 void isl_basic_set_free(__isl_take isl_basic_set *bset);
101 __isl_give isl_basic_set *isl_basic_set_copy(__isl_keep isl_basic_set *bset);
102 struct isl_basic_set *isl_basic_set_dup(struct isl_basic_set *bset);
103 __isl_give isl_basic_set *isl_basic_set_empty(__isl_take isl_dim *dim);
104 struct isl_basic_set *isl_basic_set_empty_like(struct isl_basic_set *bset);
105 __isl_give isl_basic_set *isl_basic_set_universe(__isl_take isl_dim *dim);
106 struct isl_basic_set *isl_basic_set_universe_like(struct isl_basic_set *bset);
107 __isl_give isl_basic_set *isl_basic_set_universe_like_set(
108         __isl_keep isl_set *model);
109 struct isl_basic_set *isl_basic_set_interval(struct isl_ctx *ctx,
110         isl_int min, isl_int max);
111 struct isl_basic_set *isl_basic_set_positive_orthant(struct isl_dim *dims);
112 void isl_basic_set_dump(__isl_keep isl_basic_set *bset,
113                                 FILE *out, int indent);
114 struct isl_basic_set *isl_basic_set_swap_vars(
115                 struct isl_basic_set *bset, unsigned n);
116 __isl_give isl_basic_set *isl_basic_set_intersect(
117                 __isl_take isl_basic_set *bset1,
118                 __isl_take isl_basic_set *bset2);
119 __isl_give isl_basic_set *isl_basic_set_apply(
120                 __isl_take isl_basic_set *bset,
121                 __isl_take isl_basic_map *bmap);
122 __isl_give isl_basic_set *isl_basic_set_affine_hull(
123                 __isl_take isl_basic_set *bset);
124 __isl_give isl_basic_set *isl_basic_set_remove(__isl_take isl_basic_set *bset,
125         enum isl_dim_type type, unsigned first, unsigned n);
126 struct isl_basic_set *isl_basic_set_simplify(struct isl_basic_set *bset);
127 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
128                                                 __isl_take isl_basic_set *bset);
129 struct isl_basic_set *isl_basic_set_product(struct isl_basic_set_list *list);
130
131 __isl_give isl_basic_set *isl_basic_set_read_from_file(isl_ctx *ctx,
132                 FILE *input, int nparam);
133 __isl_give isl_basic_set *isl_basic_set_read_from_str(isl_ctx *ctx,
134                 const char *str, int nparam);
135 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
136                 FILE *input, int nparam);
137 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
138                 const char *str, int nparam);
139 __isl_give isl_printer *isl_printer_print_basic_set(
140         __isl_take isl_printer *printer, __isl_keep isl_basic_set *bset);
141 __isl_give isl_printer *isl_printer_print_set(__isl_take isl_printer *printer,
142         __isl_keep isl_set *map);
143 void isl_basic_set_print(__isl_keep isl_basic_set *bset, FILE *out, int indent,
144         const char *prefix, const char *suffix, unsigned output_format);
145 void isl_set_print(__isl_keep struct isl_set *set, FILE *out, int indent,
146         unsigned output_format);
147 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
148                 enum isl_dim_type type, unsigned pos, isl_int value);
149 struct isl_basic_set *isl_basic_set_fix_si(struct isl_basic_set *bset,
150                 enum isl_dim_type type, unsigned pos, int value);
151 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
152                 enum isl_dim_type type, unsigned pos, int value);
153 __isl_give isl_set *isl_set_lower_bound_si(__isl_take isl_set *set,
154                 enum isl_dim_type type, unsigned pos, int value);
155
156 struct isl_basic_set *isl_basic_set_from_underlying_set(
157         struct isl_basic_set *bset, struct isl_basic_set *like);
158 struct isl_set *isl_set_from_underlying_set(
159         struct isl_set *set, struct isl_basic_set *like);
160 struct isl_set *isl_set_to_underlying_set(struct isl_set *set);
161
162 int isl_basic_set_is_equal(
163                 struct isl_basic_set *bset1, struct isl_basic_set *bset2);
164
165 __isl_give isl_set *isl_basic_set_partial_lexmin(
166                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
167                 __isl_give isl_set **empty);
168 __isl_give isl_set *isl_basic_set_partial_lexmax(
169                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
170                 __isl_give isl_set **empty);
171 __isl_give isl_set *isl_set_partial_lexmin(
172                 __isl_take isl_set *set, __isl_take isl_set *dom,
173                 __isl_give isl_set **empty);
174 __isl_give isl_set *isl_set_partial_lexmax(
175                 __isl_take isl_set *set, __isl_take isl_set *dom,
176                 __isl_give isl_set **empty);
177 __isl_give isl_set *isl_basic_set_lexmin(__isl_take isl_basic_set *bset);
178 __isl_give isl_set *isl_basic_set_lexmax(__isl_take isl_basic_set *bset);
179 __isl_give isl_set *isl_set_lexmin(__isl_take isl_set *set);
180 __isl_give isl_set *isl_set_lexmax(__isl_take isl_set *set);
181 __isl_give isl_set *isl_basic_set_union(
182                 __isl_take isl_basic_set *bset1,
183                 __isl_take isl_basic_set *bset2);
184
185 int isl_basic_set_compare_at(struct isl_basic_set *bset1,
186         struct isl_basic_set *bset2, int pos);
187 int isl_set_follows_at(__isl_keep isl_set *set1,
188         __isl_keep isl_set *set2, int pos);
189
190 int isl_basic_set_dims_get_sign(__isl_keep isl_basic_set *bset,
191         enum isl_dim_type type, unsigned pos, unsigned n, int *signs);
192
193 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
194 int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
195 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
196
197 struct isl_set *isl_set_alloc(struct isl_ctx *ctx,
198                 unsigned nparam, unsigned dim, int n, unsigned flags);
199 struct isl_set *isl_set_extend(struct isl_set *base,
200                 unsigned nparam, unsigned dim);
201 __isl_give isl_set *isl_set_empty(__isl_take isl_dim *dim);
202 struct isl_set *isl_set_empty_like(struct isl_set *set);
203 __isl_give isl_set *isl_set_universe(__isl_take isl_dim *dim);
204 __isl_give isl_set *isl_set_universe_like(__isl_keep isl_set *model);
205 __isl_give isl_set *isl_set_add_basic_set(__isl_take isl_set *set,
206                                                 __isl_take isl_basic_set *bset);
207 struct isl_set *isl_set_finalize(struct isl_set *set);
208 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
209 void isl_set_free(__isl_take isl_set *set);
210 struct isl_set *isl_set_dup(struct isl_set *set);
211 __isl_give isl_set *isl_set_from_basic_set(__isl_take isl_basic_set *bset);
212 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set);
213 __isl_give isl_point *isl_set_sample_point(__isl_take isl_set *set);
214 __isl_give isl_set *isl_set_detect_equalities(__isl_take isl_set *set);
215 __isl_give isl_basic_set *isl_set_affine_hull(__isl_take isl_set *set);
216 __isl_give isl_basic_set *isl_set_convex_hull(__isl_take isl_set *set);
217 __isl_give isl_basic_set *isl_set_simple_hull(__isl_take isl_set *set);
218 struct isl_basic_set *isl_set_bounded_simple_hull(struct isl_set *set);
219 __isl_give isl_set *isl_set_recession_cone(__isl_take isl_set *set);
220
221 struct isl_set *isl_set_union_disjoint(
222                         struct isl_set *set1, struct isl_set *set2);
223 __isl_give isl_set *isl_set_union(
224                 __isl_take isl_set *set1,
225                 __isl_take isl_set *set2);
226 struct isl_set *isl_set_product(struct isl_set *set1, struct isl_set *set2);
227 __isl_give isl_set *isl_set_intersect(
228                 __isl_take isl_set *set1,
229                 __isl_take isl_set *set2);
230 __isl_give isl_set *isl_set_subtract(
231                 __isl_take isl_set *set1,
232                 __isl_take isl_set *set2);
233 __isl_give isl_set *isl_set_complement(__isl_take isl_set *set);
234 __isl_give isl_set *isl_set_apply(
235                 __isl_take isl_set *set,
236                 __isl_take isl_map *map);
237 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
238                 enum isl_dim_type type, unsigned pos, isl_int value);
239 struct isl_set *isl_set_fix_dim_si(struct isl_set *set,
240                 unsigned dim, int value);
241 struct isl_set *isl_set_lower_bound_dim(struct isl_set *set,
242                 unsigned dim, isl_int value);
243 __isl_give isl_basic_set *isl_basic_set_add(__isl_take isl_basic_set *bset,
244                 enum isl_dim_type type, unsigned n);
245 __isl_give isl_set *isl_set_add(__isl_take isl_set *set,
246                 enum isl_dim_type type, unsigned n);
247 __isl_give isl_basic_set *isl_basic_set_move_dims(__isl_take isl_basic_set *bset,
248         enum isl_dim_type dst_type, unsigned dst_pos,
249         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
250 __isl_give isl_set *isl_set_move_dims(__isl_take isl_set *set,
251         enum isl_dim_type dst_type, unsigned dst_pos,
252         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
253 __isl_give isl_basic_set *isl_basic_set_project_out(
254                 __isl_take isl_basic_set *bset,
255                 enum isl_dim_type type, unsigned first, unsigned n);
256 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
257                 enum isl_dim_type type, unsigned first, unsigned n);
258 struct isl_basic_set *isl_basic_set_remove_dims(struct isl_basic_set *bset,
259                 unsigned first, unsigned n);
260 struct isl_basic_set *isl_basic_set_remove_divs(struct isl_basic_set *bset);
261 struct isl_set *isl_set_eliminate_dims(struct isl_set *set,
262                 unsigned first, unsigned n);
263 __isl_give isl_set *isl_set_remove(__isl_take isl_set *bset,
264         enum isl_dim_type type, unsigned first, unsigned n);
265 struct isl_set *isl_set_remove_dims(struct isl_set *set,
266                 unsigned first, unsigned n);
267 struct isl_set *isl_set_remove_divs(struct isl_set *set);
268 __isl_give isl_set *isl_set_split_dims(__isl_take isl_set *set,
269         enum isl_dim_type type, unsigned first, unsigned n);
270
271 void isl_set_dump(__isl_keep isl_set *set, FILE *out, int indent);
272 struct isl_set *isl_set_swap_vars(struct isl_set *set, unsigned n);
273 int isl_set_fast_is_empty(__isl_keep isl_set *set);
274 int isl_set_fast_is_universe(__isl_keep isl_set *set);
275 int isl_set_is_empty(__isl_keep isl_set *set);
276 int isl_set_is_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
277 int isl_set_is_strict_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
278 int isl_set_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
279
280 __isl_give isl_set *isl_set_sum(__isl_take isl_set *set1,
281         __isl_take isl_set *set2);
282 __isl_give isl_set *isl_set_neg(__isl_take isl_set *set);
283
284 __isl_give isl_set *isl_set_make_disjoint(__isl_take isl_set *set);
285 struct isl_set *isl_basic_set_compute_divs(struct isl_basic_set *bset);
286 __isl_give isl_set *isl_set_compute_divs(__isl_take isl_set *set);
287 __isl_give isl_set *isl_set_align_divs(__isl_take isl_set *set);
288
289 struct isl_basic_set *isl_set_copy_basic_set(struct isl_set *set);
290 struct isl_set *isl_set_drop_basic_set(struct isl_set *set,
291                                                 struct isl_basic_set *bset);
292
293 int isl_basic_set_fast_dim_is_fixed(struct isl_basic_set *bset, unsigned dim,
294         isl_int *val);
295
296 int isl_set_fast_dim_is_fixed(struct isl_set *set, unsigned dim, isl_int *val);
297 int isl_set_fast_dim_has_fixed_lower_bound(struct isl_set *set,
298         unsigned dim, isl_int *val);
299 int isl_set_dim_is_bounded(__isl_keep isl_set *set,
300         enum isl_dim_type type, unsigned pos);
301
302 struct isl_basic_set *isl_basic_set_gist(struct isl_basic_set *bset,
303                                                 struct isl_basic_set *context);
304 __isl_give isl_set *isl_set_gist_basic_set(__isl_take isl_set *set,
305         __isl_take isl_basic_set *context);
306 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
307         __isl_take isl_set *context);
308 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
309         int pos, isl_int *modulo, isl_int *residue);
310 int isl_set_dim_residue_class(struct isl_set *set,
311         int pos, isl_int *modulo, isl_int *residue);
312
313 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
314
315 int isl_set_fast_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
316 int isl_set_fast_is_disjoint(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
317
318 uint32_t isl_set_get_hash(struct isl_set *set);
319
320 int isl_set_dim_is_unique(struct isl_set *set, unsigned dim);
321
322 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
323         int (*fn)(__isl_take isl_basic_set *bset, void *user), void *user);
324
325 int isl_set_foreach_point(__isl_keep isl_set *set,
326         int (*fn)(__isl_take isl_point *pnt, void *user), void *user);
327 int isl_set_count(__isl_keep isl_set *set, isl_int *count);
328
329 __isl_give isl_set *isl_set_from_point(__isl_take isl_point *pnt);
330 __isl_give isl_set *isl_set_box_from_points(__isl_take isl_point *pnt1,
331         __isl_take isl_point *pnt2);
332
333 __isl_give isl_set *isl_set_lift(__isl_take isl_set *set);
334
335 int isl_set_size(__isl_keep isl_set *set);
336
337 #if defined(__cplusplus)
338 }
339 #endif
340
341 #endif