split off type declarations for isl_map and isl_set to separate files
[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_type.h>
14 #include <isl/aff.h>
15 #include <isl/list.h>
16 #include <isl/mat.h>
17 #include <isl/point.h>
18 #include <isl/local_space.h>
19
20 #if defined(__cplusplus)
21 extern "C" {
22 #endif
23
24 unsigned isl_basic_set_n_dim(const struct isl_basic_set *bset);
25 unsigned isl_basic_set_n_param(const struct isl_basic_set *bset);
26 unsigned isl_basic_set_total_dim(const struct isl_basic_set *bset);
27 unsigned isl_basic_set_dim(const struct isl_basic_set *bset,
28                                 enum isl_dim_type type);
29
30 unsigned isl_set_n_dim(const struct isl_set *set);
31 unsigned isl_set_n_param(const struct isl_set *set);
32 unsigned isl_set_dim(const struct isl_set *set, enum isl_dim_type type);
33
34 isl_ctx *isl_basic_set_get_ctx(__isl_keep isl_basic_set *bset);
35 isl_ctx *isl_set_get_ctx(__isl_keep isl_set *set);
36 __isl_give isl_dim *isl_basic_set_get_dim(__isl_keep isl_basic_set *bset);
37 __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
38 __isl_give isl_set *isl_set_reset_dim(__isl_take isl_set *set,
39         __isl_take isl_dim *dim);
40
41 struct isl_div *isl_basic_set_div(struct isl_basic_set *bset, int pos);
42
43 __isl_give isl_local_space *isl_basic_set_get_local_space(
44         __isl_keep isl_basic_set *bset);
45
46 const char *isl_basic_set_get_tuple_name(__isl_keep isl_basic_set *bset);
47 const char *isl_set_get_tuple_name(__isl_keep isl_set *set);
48 __isl_give isl_set *isl_set_set_tuple_name(__isl_take isl_set *set,
49         const char *s);
50 const char *isl_basic_set_get_dim_name(__isl_keep isl_basic_set *bset,
51         enum isl_dim_type type, unsigned pos);
52 __isl_give isl_basic_set *isl_basic_set_set_dim_name(
53         __isl_take isl_basic_set *bset,
54         enum isl_dim_type type, unsigned pos, const char *s);
55 const char *isl_set_get_dim_name(__isl_keep isl_set *set,
56         enum isl_dim_type type, unsigned pos);
57 __isl_give isl_set *isl_set_set_dim_name(__isl_take isl_set *set,
58         enum isl_dim_type type, unsigned pos, const char *s);
59
60 int isl_basic_set_is_rational(__isl_keep isl_basic_set *bset);
61
62 struct isl_basic_set *isl_basic_set_alloc(struct isl_ctx *ctx,
63                 unsigned nparam, unsigned dim, unsigned extra,
64                 unsigned n_eq, unsigned n_ineq);
65 struct isl_basic_set *isl_basic_set_extend(struct isl_basic_set *base,
66                 unsigned nparam, unsigned dim, unsigned extra,
67                 unsigned n_eq, unsigned n_ineq);
68 struct isl_basic_set *isl_basic_set_extend_constraints(
69                 struct isl_basic_set *base, unsigned n_eq, unsigned n_ineq);
70 struct isl_basic_set *isl_basic_set_finalize(struct isl_basic_set *bset);
71 void isl_basic_set_free(__isl_take isl_basic_set *bset);
72 __isl_give isl_basic_set *isl_basic_set_copy(__isl_keep isl_basic_set *bset);
73 struct isl_basic_set *isl_basic_set_dup(struct isl_basic_set *bset);
74 __isl_give isl_basic_set *isl_basic_set_empty(__isl_take isl_dim *dim);
75 struct isl_basic_set *isl_basic_set_empty_like(struct isl_basic_set *bset);
76 __isl_give isl_basic_set *isl_basic_set_universe(__isl_take isl_dim *dim);
77 __isl_give isl_basic_set *isl_basic_set_nat_universe(__isl_take isl_dim *dim);
78 struct isl_basic_set *isl_basic_set_universe_like(struct isl_basic_set *bset);
79 __isl_give isl_basic_set *isl_basic_set_universe_like_set(
80         __isl_keep isl_set *model);
81 struct isl_basic_set *isl_basic_set_interval(struct isl_ctx *ctx,
82         isl_int min, isl_int max);
83 struct isl_basic_set *isl_basic_set_positive_orthant(struct isl_dim *dims);
84 void isl_basic_set_print_internal(__isl_keep isl_basic_set *bset,
85                                 FILE *out, int indent);
86 __isl_give isl_basic_set *isl_basic_set_intersect(
87                 __isl_take isl_basic_set *bset1,
88                 __isl_take isl_basic_set *bset2);
89 __isl_give isl_basic_set *isl_basic_set_apply(
90                 __isl_take isl_basic_set *bset,
91                 __isl_take isl_basic_map *bmap);
92 __isl_give isl_basic_set *isl_basic_set_affine_hull(
93                 __isl_take isl_basic_set *bset);
94 __isl_give isl_basic_set *isl_basic_set_remove_dims(
95         __isl_take isl_basic_set *bset,
96         enum isl_dim_type type, unsigned first, unsigned n);
97 struct isl_basic_set *isl_basic_set_simplify(struct isl_basic_set *bset);
98 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
99                                                 __isl_take isl_basic_set *bset);
100 __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
101         __isl_take isl_basic_set *bset);
102 __isl_give isl_basic_set *isl_basic_set_list_product(
103         __isl_take struct isl_basic_set_list *list);
104
105 __isl_give isl_basic_set *isl_basic_set_read_from_file(isl_ctx *ctx,
106                 FILE *input, int nparam);
107 __isl_give isl_basic_set *isl_basic_set_read_from_str(isl_ctx *ctx,
108                 const char *str, int nparam);
109 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
110                 FILE *input, int nparam);
111 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
112                 const char *str, int nparam);
113 void isl_basic_set_dump(__isl_keep isl_basic_set *bset);
114 void isl_set_dump(__isl_keep isl_set *set);
115 __isl_give isl_printer *isl_printer_print_basic_set(
116         __isl_take isl_printer *printer, __isl_keep isl_basic_set *bset);
117 __isl_give isl_printer *isl_printer_print_set(__isl_take isl_printer *printer,
118         __isl_keep isl_set *map);
119 void isl_basic_set_print(__isl_keep isl_basic_set *bset, FILE *out, int indent,
120         const char *prefix, const char *suffix, unsigned output_format);
121 void isl_set_print(__isl_keep struct isl_set *set, FILE *out, int indent,
122         unsigned output_format);
123 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
124                 enum isl_dim_type type, unsigned pos, isl_int value);
125 __isl_give isl_basic_set *isl_basic_set_fix_si(__isl_take isl_basic_set *bset,
126                 enum isl_dim_type type, unsigned pos, int value);
127 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
128                 enum isl_dim_type type, unsigned pos, int value);
129 __isl_give isl_set *isl_set_lower_bound_si(__isl_take isl_set *set,
130                 enum isl_dim_type type, unsigned pos, int value);
131
132 struct isl_basic_set *isl_basic_set_from_underlying_set(
133         struct isl_basic_set *bset, struct isl_basic_set *like);
134 struct isl_set *isl_set_from_underlying_set(
135         struct isl_set *set, struct isl_basic_set *like);
136 struct isl_set *isl_set_to_underlying_set(struct isl_set *set);
137
138 int isl_basic_set_is_equal(
139                 struct isl_basic_set *bset1, struct isl_basic_set *bset2);
140
141 __isl_give isl_set *isl_basic_set_partial_lexmin(
142                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
143                 __isl_give isl_set **empty);
144 __isl_give isl_set *isl_basic_set_partial_lexmax(
145                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
146                 __isl_give isl_set **empty);
147 __isl_give isl_set *isl_set_partial_lexmin(
148                 __isl_take isl_set *set, __isl_take isl_set *dom,
149                 __isl_give isl_set **empty);
150 __isl_give isl_set *isl_set_partial_lexmax(
151                 __isl_take isl_set *set, __isl_take isl_set *dom,
152                 __isl_give isl_set **empty);
153 __isl_give isl_set *isl_basic_set_lexmin(__isl_take isl_basic_set *bset);
154 __isl_give isl_set *isl_basic_set_lexmax(__isl_take isl_basic_set *bset);
155 __isl_give isl_set *isl_set_lexmin(__isl_take isl_set *set);
156 __isl_give isl_set *isl_set_lexmax(__isl_take isl_set *set);
157 __isl_give isl_set *isl_basic_set_union(
158                 __isl_take isl_basic_set *bset1,
159                 __isl_take isl_basic_set *bset2);
160
161 int isl_basic_set_compare_at(struct isl_basic_set *bset1,
162         struct isl_basic_set *bset2, int pos);
163 int isl_set_follows_at(__isl_keep isl_set *set1,
164         __isl_keep isl_set *set2, int pos);
165
166 int isl_basic_set_dims_get_sign(__isl_keep isl_basic_set *bset,
167         enum isl_dim_type type, unsigned pos, unsigned n, int *signs);
168
169 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
170 int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
171 int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
172 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
173 int isl_basic_set_is_bounded(__isl_keep isl_basic_set *bset);
174
175 struct isl_set *isl_set_alloc(struct isl_ctx *ctx,
176                 unsigned nparam, unsigned dim, int n, unsigned flags);
177 struct isl_set *isl_set_extend(struct isl_set *base,
178                 unsigned nparam, unsigned dim);
179 __isl_give isl_set *isl_set_empty(__isl_take isl_dim *dim);
180 struct isl_set *isl_set_empty_like(struct isl_set *set);
181 __isl_give isl_set *isl_set_universe(__isl_take isl_dim *dim);
182 __isl_give isl_set *isl_set_nat_universe(__isl_take isl_dim *dim);
183 __isl_give isl_set *isl_set_universe_like(__isl_keep isl_set *model);
184 __isl_give isl_set *isl_set_add_basic_set(__isl_take isl_set *set,
185                                                 __isl_take isl_basic_set *bset);
186 struct isl_set *isl_set_finalize(struct isl_set *set);
187 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
188 void isl_set_free(__isl_take isl_set *set);
189 struct isl_set *isl_set_dup(struct isl_set *set);
190 __isl_give isl_set *isl_set_from_basic_set(__isl_take isl_basic_set *bset);
191 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set);
192 __isl_give isl_point *isl_basic_set_sample_point(__isl_take isl_basic_set *bset);
193 __isl_give isl_point *isl_set_sample_point(__isl_take isl_set *set);
194 __isl_give isl_set *isl_set_detect_equalities(__isl_take isl_set *set);
195 __isl_give isl_basic_set *isl_set_affine_hull(__isl_take isl_set *set);
196 __isl_give isl_basic_set *isl_set_convex_hull(__isl_take isl_set *set);
197 __isl_give isl_basic_set *isl_set_polyhedral_hull(__isl_take isl_set *set);
198 __isl_give isl_basic_set *isl_set_simple_hull(__isl_take isl_set *set);
199 struct isl_basic_set *isl_set_bounded_simple_hull(struct isl_set *set);
200 __isl_give isl_set *isl_set_recession_cone(__isl_take isl_set *set);
201
202 struct isl_set *isl_set_union_disjoint(
203                         struct isl_set *set1, struct isl_set *set2);
204 __isl_give isl_set *isl_set_union(
205                 __isl_take isl_set *set1,
206                 __isl_take isl_set *set2);
207 __isl_give isl_set *isl_set_product(__isl_take isl_set *set1,
208         __isl_take isl_set *set2);
209 __isl_give isl_basic_set *isl_basic_set_flat_product(
210         __isl_take isl_basic_set *bset1, __isl_take isl_basic_set *bset2);
211 __isl_give isl_set *isl_set_flat_product(__isl_take isl_set *set1,
212         __isl_take isl_set *set2);
213 __isl_give isl_set *isl_set_intersect(
214                 __isl_take isl_set *set1,
215                 __isl_take isl_set *set2);
216 __isl_give isl_set *isl_set_subtract(
217                 __isl_take isl_set *set1,
218                 __isl_take isl_set *set2);
219 __isl_give isl_set *isl_set_complement(__isl_take isl_set *set);
220 __isl_give isl_set *isl_set_apply(
221                 __isl_take isl_set *set,
222                 __isl_take isl_map *map);
223 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
224                 enum isl_dim_type type, unsigned pos, isl_int value);
225 struct isl_set *isl_set_fix_dim_si(struct isl_set *set,
226                 unsigned dim, int value);
227 struct isl_set *isl_set_lower_bound_dim(struct isl_set *set,
228                 unsigned dim, isl_int value);
229 __isl_give isl_set *isl_set_insert(__isl_take isl_set *set,
230                 enum isl_dim_type type, unsigned pos, unsigned n);
231 __isl_give isl_basic_set *isl_basic_set_add(__isl_take isl_basic_set *bset,
232                 enum isl_dim_type type, unsigned n);
233 __isl_give isl_set *isl_set_add_dims(__isl_take isl_set *set,
234                 enum isl_dim_type type, unsigned n);
235 __isl_give isl_basic_set *isl_basic_set_move_dims(__isl_take isl_basic_set *bset,
236         enum isl_dim_type dst_type, unsigned dst_pos,
237         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
238 __isl_give isl_set *isl_set_move_dims(__isl_take isl_set *set,
239         enum isl_dim_type dst_type, unsigned dst_pos,
240         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
241 __isl_give isl_basic_set *isl_basic_set_project_out(
242                 __isl_take isl_basic_set *bset,
243                 enum isl_dim_type type, unsigned first, unsigned n);
244 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
245                 enum isl_dim_type type, unsigned first, unsigned n);
246 __isl_give isl_basic_set *isl_basic_set_remove_divs(
247         __isl_take isl_basic_set *bset);
248 __isl_give isl_set *isl_set_eliminate(__isl_take isl_set *set,
249         enum isl_dim_type type, unsigned first, unsigned n);
250 struct isl_set *isl_set_eliminate_dims(struct isl_set *set,
251                 unsigned first, unsigned n);
252 __isl_give isl_set *isl_set_remove_dims(__isl_take isl_set *bset,
253         enum isl_dim_type type, unsigned first, unsigned n);
254 __isl_give isl_set *isl_set_remove_divs_involving_dims(__isl_take isl_set *set,
255         enum isl_dim_type type, unsigned first, unsigned n);
256 __isl_give isl_set *isl_set_remove_unknown_divs(__isl_take isl_set *set);
257 __isl_give isl_set *isl_set_remove_divs(__isl_take isl_set *set);
258 __isl_give isl_set *isl_set_split_dims(__isl_take isl_set *set,
259         enum isl_dim_type type, unsigned first, unsigned n);
260
261 int isl_basic_set_involves_dims(__isl_keep isl_basic_set *bset,
262         enum isl_dim_type type, unsigned first, unsigned n);
263 int isl_set_involves_dims(__isl_keep isl_set *set,
264         enum isl_dim_type type, unsigned first, unsigned n);
265
266 void isl_set_print_internal(__isl_keep isl_set *set, FILE *out, int indent);
267 int isl_set_plain_is_empty(__isl_keep isl_set *set);
268 int isl_set_fast_is_empty(__isl_keep isl_set *set);
269 int isl_set_plain_is_universe(__isl_keep isl_set *set);
270 int isl_set_fast_is_universe(__isl_keep isl_set *set);
271 int isl_set_is_empty(__isl_keep isl_set *set);
272 int isl_set_is_bounded(__isl_keep isl_set *set);
273 int isl_set_is_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
274 int isl_set_is_strict_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
275 int isl_set_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
276 int isl_set_is_singleton(__isl_keep isl_set *set);
277 int isl_set_is_box(__isl_keep isl_set *set);
278 int isl_set_has_equal_dim(__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_basic_set *isl_basic_set_neg(__isl_take isl_basic_set *bset);
283 __isl_give isl_set *isl_set_neg(__isl_take isl_set *set);
284
285 __isl_give isl_set *isl_set_make_disjoint(__isl_take isl_set *set);
286 struct isl_set *isl_basic_set_compute_divs(struct isl_basic_set *bset);
287 __isl_give isl_set *isl_set_compute_divs(__isl_take isl_set *set);
288 __isl_give isl_set *isl_set_align_divs(__isl_take isl_set *set);
289
290 struct isl_basic_set *isl_set_copy_basic_set(struct isl_set *set);
291 struct isl_set *isl_set_drop_basic_set(struct isl_set *set,
292                                                 struct isl_basic_set *bset);
293
294 int isl_basic_set_plain_dim_is_fixed(__isl_keep isl_basic_set *bset,
295         unsigned dim, isl_int *val);
296
297 int isl_set_plain_dim_is_fixed(__isl_keep isl_set *set,
298         unsigned dim, isl_int *val);
299 int isl_set_fast_dim_is_fixed(__isl_keep isl_set *set,
300         unsigned dim, isl_int *val);
301 int isl_set_plain_dim_has_fixed_lower_bound(__isl_keep isl_set *set,
302         unsigned dim, isl_int *val);
303 int isl_set_dim_is_bounded(__isl_keep isl_set *set,
304         enum isl_dim_type type, unsigned pos);
305
306 __isl_give isl_basic_set *isl_basic_set_gist(__isl_take isl_basic_set *bset,
307                                             __isl_take isl_basic_set *context);
308 __isl_give isl_set *isl_set_gist_basic_set(__isl_take isl_set *set,
309         __isl_take isl_basic_set *context);
310 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
311         __isl_take isl_set *context);
312 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
313         int pos, isl_int *modulo, isl_int *residue);
314 int isl_set_dim_residue_class(struct isl_set *set,
315         int pos, isl_int *modulo, isl_int *residue);
316
317 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
318
319 int isl_set_plain_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
320 int isl_set_fast_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
321 int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
322         __isl_keep isl_set *set2);
323 int isl_set_fast_is_disjoint(__isl_keep isl_set *set1,
324         __isl_keep isl_set *set2);
325
326 uint32_t isl_set_get_hash(struct isl_set *set);
327
328 int isl_set_dim_is_unique(struct isl_set *set, unsigned dim);
329
330 int isl_set_n_basic_set(__isl_keep isl_set *set);
331 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
332         int (*fn)(__isl_take isl_basic_set *bset, void *user), void *user);
333
334 int isl_set_foreach_point(__isl_keep isl_set *set,
335         int (*fn)(__isl_take isl_point *pnt, void *user), void *user);
336 int isl_set_count(__isl_keep isl_set *set, isl_int *count);
337 int isl_basic_set_count_upto(__isl_keep isl_basic_set *bset,
338         isl_int max, isl_int *count);
339 int isl_set_count_upto(__isl_keep isl_set *set, isl_int max, isl_int *count);
340
341 __isl_give isl_basic_set *isl_basic_set_from_point(__isl_take isl_point *pnt);
342 __isl_give isl_set *isl_set_from_point(__isl_take isl_point *pnt);
343 __isl_give isl_basic_set *isl_basic_set_box_from_points(
344         __isl_take isl_point *pnt1, __isl_take isl_point *pnt2);
345 __isl_give isl_set *isl_set_box_from_points(__isl_take isl_point *pnt1,
346         __isl_take isl_point *pnt2);
347
348 __isl_give isl_basic_set *isl_basic_set_lift(__isl_take isl_basic_set *bset);
349 __isl_give isl_set *isl_set_lift(__isl_take isl_set *set);
350
351 __isl_give isl_map *isl_set_lex_le_set(__isl_take isl_set *set1,
352         __isl_take isl_set *set2);
353 __isl_give isl_map *isl_set_lex_lt_set(__isl_take isl_set *set1,
354         __isl_take isl_set *set2);
355 __isl_give isl_map *isl_set_lex_ge_set(__isl_take isl_set *set1,
356         __isl_take isl_set *set2);
357 __isl_give isl_map *isl_set_lex_gt_set(__isl_take isl_set *set1,
358         __isl_take isl_set *set2);
359
360 int isl_set_size(__isl_keep isl_set *set);
361
362 __isl_give isl_set *isl_set_align_params(__isl_take isl_set *set,
363         __isl_take isl_dim *model);
364
365 __isl_give isl_mat *isl_basic_set_equalities_matrix(
366         __isl_keep isl_basic_set *bset, enum isl_dim_type c1,
367         enum isl_dim_type c2, enum isl_dim_type c3, enum isl_dim_type c4);
368 __isl_give isl_mat *isl_basic_set_inequalities_matrix(
369         __isl_keep isl_basic_set *bset, enum isl_dim_type c1,
370         enum isl_dim_type c2, enum isl_dim_type c3, enum isl_dim_type c4);
371 __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
372         __isl_take isl_dim *dim,
373         __isl_take isl_mat *eq, __isl_take isl_mat *ineq, enum isl_dim_type c1,
374         enum isl_dim_type c2, enum isl_dim_type c3, enum isl_dim_type c4);
375
376 __isl_give isl_mat *isl_basic_set_reduced_basis(__isl_keep isl_basic_set *bset);
377
378 __isl_give isl_basic_set *isl_basic_set_coefficients(
379         __isl_take isl_basic_set *bset);
380 __isl_give isl_basic_set *isl_set_coefficients(__isl_take isl_set *set);
381 __isl_give isl_basic_set *isl_basic_set_solutions(
382         __isl_take isl_basic_set *bset);
383 __isl_give isl_basic_set *isl_set_solutions(__isl_take isl_set *set);
384
385 #if defined(__cplusplus)
386 }
387 #endif
388
389 #endif