fc346b48238c686d359a7e0d2a4ce75f89331d2f
[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
16 #if defined(__cplusplus)
17 extern "C" {
18 #endif
19
20 /* A "basic set" is a basic map with a zero-dimensional
21  * domain.
22  */
23 struct isl_basic_set {
24         int ref;
25 #define ISL_BASIC_SET_FINAL             (1 << 0)
26 #define ISL_BASIC_SET_EMPTY             (1 << 1)
27 #define ISL_BASIC_SET_NO_IMPLICIT       (1 << 2)
28 #define ISL_BASIC_SET_NO_REDUNDANT      (1 << 3)
29 #define ISL_BASIC_SET_RATIONAL          (1 << 4)
30 #define ISL_BASIC_SET_NORMALIZED        (1 << 5)
31 #define ISL_BASIC_SET_NORMALIZED_DIVS   (1 << 6)
32 #define ISL_BASIC_SET_ALL_EQUALITIES    (1 << 7)
33         unsigned flags;
34
35         struct isl_ctx *ctx;
36
37         struct isl_dim *dim;
38         unsigned extra;
39
40         unsigned n_eq;
41         unsigned n_ineq;
42
43         size_t c_size;
44         isl_int **eq;
45         isl_int **ineq;
46
47         unsigned n_div;
48
49         isl_int **div;
50
51         struct isl_vec *sample;
52
53         struct isl_blk block;
54         struct isl_blk block2;
55 };
56
57 /* A "set" is a (possibly disjoint) union of basic sets.
58  *
59  * See the documentation of isl_map.
60  */
61 struct isl_set {
62         int ref;
63 #define ISL_SET_DISJOINT                (1 << 0)
64 #define ISL_SET_NORMALIZED              (1 << 1)
65         unsigned flags;
66
67         struct isl_ctx *ctx;
68
69         struct isl_dim *dim;
70
71         int n;
72
73         size_t size;
74         struct isl_basic_set *p[1];
75 };
76
77 unsigned isl_basic_set_n_dim(const struct isl_basic_set *bset);
78 unsigned isl_basic_set_n_param(const struct isl_basic_set *bset);
79 unsigned isl_basic_set_total_dim(const struct isl_basic_set *bset);
80 unsigned isl_basic_set_dim(const struct isl_basic_set *bset,
81                                 enum isl_dim_type type);
82
83 unsigned isl_set_n_dim(const struct isl_set *set);
84 unsigned isl_set_n_param(const struct isl_set *set);
85 unsigned isl_set_dim(const struct isl_set *set, enum isl_dim_type type);
86
87 struct isl_dim *isl_basic_set_get_dim(struct isl_basic_set *bset);
88 struct isl_dim *isl_set_get_dim(struct isl_set *set);
89
90 struct isl_basic_set *isl_basic_set_alloc(struct isl_ctx *ctx,
91                 unsigned nparam, unsigned dim, unsigned extra,
92                 unsigned n_eq, unsigned n_ineq);
93 struct isl_basic_set *isl_basic_set_extend(struct isl_basic_set *base,
94                 unsigned nparam, unsigned dim, unsigned extra,
95                 unsigned n_eq, unsigned n_ineq);
96 struct isl_basic_set *isl_basic_set_extend_constraints(
97                 struct isl_basic_set *base, unsigned n_eq, unsigned n_ineq);
98 struct isl_basic_set *isl_basic_set_finalize(struct isl_basic_set *bset);
99 void isl_basic_set_free(__isl_take isl_basic_set *bset);
100 __isl_give isl_basic_set *isl_basic_set_copy(__isl_keep isl_basic_set *bset);
101 struct isl_basic_set *isl_basic_set_dup(struct isl_basic_set *bset);
102 __isl_give isl_basic_set *isl_basic_set_empty(__isl_take isl_dim *dim);
103 struct isl_basic_set *isl_basic_set_empty_like(struct isl_basic_set *bset);
104 __isl_give isl_basic_set *isl_basic_set_universe(__isl_take isl_dim *dim);
105 struct isl_basic_set *isl_basic_set_universe_like(struct isl_basic_set *bset);
106 __isl_give isl_basic_set *isl_basic_set_universe_like_set(
107         __isl_keep isl_set *model);
108 struct isl_basic_set *isl_basic_set_interval(struct isl_ctx *ctx,
109         isl_int min, isl_int max);
110 struct isl_basic_set *isl_basic_set_positive_orthant(struct isl_dim *dims);
111 void isl_basic_set_dump(__isl_keep isl_basic_set *bset,
112                                 FILE *out, int indent);
113 struct isl_basic_set *isl_basic_set_swap_vars(
114                 struct isl_basic_set *bset, unsigned n);
115 __isl_give isl_basic_set *isl_basic_set_intersect(
116                 __isl_take isl_basic_set *bset1,
117                 __isl_take isl_basic_set *bset2);
118 __isl_give isl_basic_set *isl_basic_set_apply(
119                 __isl_take isl_basic_set *bset,
120                 __isl_take isl_basic_map *bmap);
121 __isl_give isl_basic_set *isl_basic_set_affine_hull(
122                 __isl_take isl_basic_set *bset);
123 __isl_give isl_basic_set *isl_basic_set_remove(__isl_take isl_basic_set *bset,
124         enum isl_dim_type type, unsigned first, unsigned n);
125 struct isl_basic_set *isl_basic_set_simplify(struct isl_basic_set *bset);
126 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
127                                                 __isl_take isl_basic_set *bset);
128 struct isl_basic_set *isl_basic_set_product(struct isl_basic_set_list *list);
129
130 #define ISL_FORMAT_POLYLIB              1
131 #define ISL_FORMAT_OMEGA                2
132 __isl_give isl_basic_set *isl_basic_set_read_from_file(isl_ctx *ctx,
133                 FILE *input, unsigned nparam, unsigned input_format);
134 __isl_give isl_basic_set *isl_basic_set_read_from_str(isl_ctx *ctx,
135                 const char *str, unsigned nparam, unsigned input_format);
136 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
137                 FILE *input, unsigned nparam, unsigned input_format);
138 #define ISL_FORMAT_POLYLIB_CONSTRAINTS  3
139 void isl_basic_set_print(__isl_keep isl_basic_set *bset, FILE *out, int indent,
140         const char *prefix, const char *suffix, unsigned output_format);
141 void isl_set_print(__isl_keep struct isl_set *set, FILE *out, int indent,
142         unsigned output_format);
143 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
144                 enum isl_dim_type type, unsigned pos, isl_int value);
145 struct isl_basic_set *isl_basic_set_fix_si(struct isl_basic_set *bset,
146                 enum isl_dim_type type, unsigned pos, int value);
147
148 struct isl_basic_set *isl_basic_set_from_underlying_set(
149         struct isl_basic_set *bset, struct isl_basic_set *like);
150 struct isl_set *isl_set_from_underlying_set(
151         struct isl_set *set, struct isl_basic_set *like);
152 struct isl_set *isl_set_to_underlying_set(struct isl_set *set);
153
154 int isl_basic_set_is_equal(
155                 struct isl_basic_set *bset1, struct isl_basic_set *bset2);
156
157 __isl_give isl_set *isl_basic_set_partial_lexmin(
158                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
159                 __isl_give isl_set **empty);
160 __isl_give isl_set *isl_basic_set_partial_lexmax(
161                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
162                 __isl_give isl_set **empty);
163 __isl_give isl_set *isl_basic_set_lexmin(__isl_take isl_basic_set *bset);
164 __isl_give isl_set *isl_basic_set_lexmax(__isl_take isl_basic_set *bset);
165 __isl_give isl_set *isl_basic_set_union(
166                 __isl_take isl_basic_set *bset1,
167                 __isl_take isl_basic_set *bset2);
168
169 int isl_basic_set_compare_at(struct isl_basic_set *bset1,
170         struct isl_basic_set *bset2, int pos);
171 int isl_set_follows_at(__isl_keep isl_set *set1,
172         __isl_keep isl_set *set2, int pos);
173
174 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
175 int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
176 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
177
178 struct isl_set *isl_set_alloc(struct isl_ctx *ctx,
179                 unsigned nparam, unsigned dim, int n, unsigned flags);
180 struct isl_set *isl_set_extend(struct isl_set *base,
181                 unsigned nparam, unsigned dim);
182 __isl_give isl_set *isl_set_empty(__isl_take isl_dim *dim);
183 struct isl_set *isl_set_empty_like(struct isl_set *set);
184 __isl_give isl_set *isl_set_universe(__isl_take isl_dim *dim);
185 __isl_give isl_set *isl_set_universe_like(__isl_keep isl_set *model);
186 struct isl_set *isl_set_add(struct isl_set *set, struct isl_basic_set *bset);
187 struct isl_set *isl_set_finalize(struct isl_set *set);
188 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
189 void isl_set_free(__isl_take isl_set *set);
190 struct isl_set *isl_set_dup(struct isl_set *set);
191 __isl_give isl_set *isl_set_from_basic_set(__isl_take isl_basic_set *bset);
192 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set);
193 __isl_give isl_set *isl_set_detect_equalities(__isl_take isl_set *set);
194 __isl_give isl_basic_set *isl_set_affine_hull(__isl_take isl_set *set);
195 __isl_give isl_basic_set *isl_set_convex_hull(__isl_take isl_set *set);
196 struct isl_basic_set *isl_set_simple_hull(struct isl_set *set);
197 struct isl_basic_set *isl_set_bounded_simple_hull(struct isl_set *set);
198
199 struct isl_set *isl_set_union_disjoint(
200                         struct isl_set *set1, struct isl_set *set2);
201 __isl_give isl_set *isl_set_union(
202                 __isl_take isl_set *set1,
203                 __isl_take isl_set *set2);
204 struct isl_set *isl_set_product(struct isl_set *set1, struct isl_set *set2);
205 __isl_give isl_set *isl_set_intersect(
206                 __isl_take isl_set *set1,
207                 __isl_take isl_set *set2);
208 __isl_give isl_set *isl_set_subtract(
209                 __isl_take isl_set *set1,
210                 __isl_take isl_set *set2);
211 __isl_give isl_set *isl_set_apply(
212                 __isl_take isl_set *set,
213                 __isl_take isl_map *map);
214 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
215                 enum isl_dim_type type, unsigned pos, isl_int value);
216 struct isl_set *isl_set_fix_dim_si(struct isl_set *set,
217                 unsigned dim, int value);
218 struct isl_set *isl_set_lower_bound_dim(struct isl_set *set,
219                 unsigned dim, isl_int value);
220 __isl_give isl_basic_set *isl_basic_set_project_out(
221                 __isl_take isl_basic_set *bset,
222                 enum isl_dim_type type, unsigned first, unsigned n);
223 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
224                 enum isl_dim_type type, unsigned first, unsigned n);
225 struct isl_basic_set *isl_basic_set_remove_dims(struct isl_basic_set *bset,
226                 unsigned first, unsigned n);
227 struct isl_basic_set *isl_basic_set_remove_divs(struct isl_basic_set *bset);
228 struct isl_set *isl_set_eliminate_dims(struct isl_set *set,
229                 unsigned first, unsigned n);
230 __isl_give isl_set *isl_set_remove(__isl_take isl_set *bset,
231         enum isl_dim_type type, unsigned first, unsigned n);
232 struct isl_set *isl_set_remove_dims(struct isl_set *set,
233                 unsigned first, unsigned n);
234 struct isl_set *isl_set_remove_divs(struct isl_set *set);
235
236 void isl_set_dump(__isl_keep isl_set *set, FILE *out, int indent);
237 struct isl_set *isl_set_swap_vars(struct isl_set *set, unsigned n);
238 int isl_set_fast_is_empty(__isl_keep isl_set *set);
239 int isl_set_is_empty(__isl_keep isl_set *set);
240 int isl_set_is_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
241 int isl_set_is_strict_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
242 int isl_set_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
243
244 struct isl_set *isl_basic_set_compute_divs(struct isl_basic_set *bset);
245 struct isl_set *isl_set_compute_divs(struct isl_set *set);
246
247 struct isl_basic_set *isl_set_copy_basic_set(struct isl_set *set);
248 struct isl_set *isl_set_drop_basic_set(struct isl_set *set,
249                                                 struct isl_basic_set *bset);
250
251 int isl_basic_set_fast_dim_is_fixed(struct isl_basic_set *bset, unsigned dim,
252         isl_int *val);
253
254 int isl_set_fast_dim_is_fixed(struct isl_set *set, unsigned dim, isl_int *val);
255 int isl_set_fast_dim_has_fixed_lower_bound(struct isl_set *set,
256         unsigned dim, isl_int *val);
257
258 struct isl_basic_set *isl_basic_set_gist(struct isl_basic_set *bset,
259                                                 struct isl_basic_set *context);
260 struct isl_set *isl_set_gist(struct isl_set *set,
261         struct isl_basic_set *context);
262 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
263         int pos, isl_int *modulo, isl_int *residue);
264 int isl_set_dim_residue_class(struct isl_set *set,
265         int pos, isl_int *modulo, isl_int *residue);
266
267 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
268
269 int isl_set_fast_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
270 int isl_set_fast_is_disjoint(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
271
272 uint32_t isl_set_get_hash(struct isl_set *set);
273
274 int isl_set_dim_is_unique(struct isl_set *set, unsigned dim);
275
276 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
277         int (*fn)(__isl_take isl_basic_set *bset, void *user), void *user);
278
279 int isl_set_size(__isl_keep isl_set *set);
280
281 #if defined(__cplusplus)
282 }
283 #endif
284
285 #endif