add isl output
[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 __isl_give isl_basic_set *isl_basic_set_read_from_file(isl_ctx *ctx,
131                 FILE *input, int nparam);
132 __isl_give isl_basic_set *isl_basic_set_read_from_str(isl_ctx *ctx,
133                 const char *str, int nparam);
134 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
135                 FILE *input, int nparam);
136 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
137                 const char *str, int nparam);
138 #define ISL_FORMAT_ISL                  0
139 #define ISL_FORMAT_POLYLIB              1
140 #define ISL_FORMAT_POLYLIB_CONSTRAINTS  2
141 void isl_basic_set_print(__isl_keep isl_basic_set *bset, FILE *out, int indent,
142         const char *prefix, const char *suffix, unsigned output_format);
143 void isl_set_print(__isl_keep struct isl_set *set, FILE *out, int indent,
144         unsigned output_format);
145 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
146                 enum isl_dim_type type, unsigned pos, isl_int value);
147 struct isl_basic_set *isl_basic_set_fix_si(struct isl_basic_set *bset,
148                 enum isl_dim_type type, unsigned pos, int value);
149
150 struct isl_basic_set *isl_basic_set_from_underlying_set(
151         struct isl_basic_set *bset, struct isl_basic_set *like);
152 struct isl_set *isl_set_from_underlying_set(
153         struct isl_set *set, struct isl_basic_set *like);
154 struct isl_set *isl_set_to_underlying_set(struct isl_set *set);
155
156 int isl_basic_set_is_equal(
157                 struct isl_basic_set *bset1, struct isl_basic_set *bset2);
158
159 __isl_give isl_set *isl_basic_set_partial_lexmin(
160                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
161                 __isl_give isl_set **empty);
162 __isl_give isl_set *isl_basic_set_partial_lexmax(
163                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
164                 __isl_give isl_set **empty);
165 __isl_give isl_set *isl_basic_set_lexmin(__isl_take isl_basic_set *bset);
166 __isl_give isl_set *isl_basic_set_lexmax(__isl_take isl_basic_set *bset);
167 __isl_give isl_set *isl_basic_set_union(
168                 __isl_take isl_basic_set *bset1,
169                 __isl_take isl_basic_set *bset2);
170
171 int isl_basic_set_compare_at(struct isl_basic_set *bset1,
172         struct isl_basic_set *bset2, int pos);
173 int isl_set_follows_at(__isl_keep isl_set *set1,
174         __isl_keep isl_set *set2, int pos);
175
176 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
177 int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
178 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
179
180 struct isl_set *isl_set_alloc(struct isl_ctx *ctx,
181                 unsigned nparam, unsigned dim, int n, unsigned flags);
182 struct isl_set *isl_set_extend(struct isl_set *base,
183                 unsigned nparam, unsigned dim);
184 __isl_give isl_set *isl_set_empty(__isl_take isl_dim *dim);
185 struct isl_set *isl_set_empty_like(struct isl_set *set);
186 __isl_give isl_set *isl_set_universe(__isl_take isl_dim *dim);
187 __isl_give isl_set *isl_set_universe_like(__isl_keep isl_set *model);
188 struct isl_set *isl_set_add(struct isl_set *set, struct isl_basic_set *bset);
189 struct isl_set *isl_set_finalize(struct isl_set *set);
190 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
191 void isl_set_free(__isl_take isl_set *set);
192 struct isl_set *isl_set_dup(struct isl_set *set);
193 __isl_give isl_set *isl_set_from_basic_set(__isl_take isl_basic_set *bset);
194 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set);
195 __isl_give isl_set *isl_set_detect_equalities(__isl_take isl_set *set);
196 __isl_give isl_basic_set *isl_set_affine_hull(__isl_take isl_set *set);
197 __isl_give isl_basic_set *isl_set_convex_hull(__isl_take isl_set *set);
198 struct isl_basic_set *isl_set_simple_hull(struct isl_set *set);
199 struct isl_basic_set *isl_set_bounded_simple_hull(struct isl_set *set);
200
201 struct isl_set *isl_set_union_disjoint(
202                         struct isl_set *set1, struct isl_set *set2);
203 __isl_give isl_set *isl_set_union(
204                 __isl_take isl_set *set1,
205                 __isl_take isl_set *set2);
206 struct isl_set *isl_set_product(struct isl_set *set1, struct isl_set *set2);
207 __isl_give isl_set *isl_set_intersect(
208                 __isl_take isl_set *set1,
209                 __isl_take isl_set *set2);
210 __isl_give isl_set *isl_set_subtract(
211                 __isl_take isl_set *set1,
212                 __isl_take isl_set *set2);
213 __isl_give isl_set *isl_set_apply(
214                 __isl_take isl_set *set,
215                 __isl_take isl_map *map);
216 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
217                 enum isl_dim_type type, unsigned pos, isl_int value);
218 struct isl_set *isl_set_fix_dim_si(struct isl_set *set,
219                 unsigned dim, int value);
220 struct isl_set *isl_set_lower_bound_dim(struct isl_set *set,
221                 unsigned dim, isl_int value);
222 __isl_give isl_basic_set *isl_basic_set_project_out(
223                 __isl_take isl_basic_set *bset,
224                 enum isl_dim_type type, unsigned first, unsigned n);
225 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
226                 enum isl_dim_type type, unsigned first, unsigned n);
227 struct isl_basic_set *isl_basic_set_remove_dims(struct isl_basic_set *bset,
228                 unsigned first, unsigned n);
229 struct isl_basic_set *isl_basic_set_remove_divs(struct isl_basic_set *bset);
230 struct isl_set *isl_set_eliminate_dims(struct isl_set *set,
231                 unsigned first, unsigned n);
232 __isl_give isl_set *isl_set_remove(__isl_take isl_set *bset,
233         enum isl_dim_type type, unsigned first, unsigned n);
234 struct isl_set *isl_set_remove_dims(struct isl_set *set,
235                 unsigned first, unsigned n);
236 struct isl_set *isl_set_remove_divs(struct isl_set *set);
237
238 void isl_set_dump(__isl_keep isl_set *set, FILE *out, int indent);
239 struct isl_set *isl_set_swap_vars(struct isl_set *set, unsigned n);
240 int isl_set_fast_is_empty(__isl_keep isl_set *set);
241 int isl_set_is_empty(__isl_keep isl_set *set);
242 int isl_set_is_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
243 int isl_set_is_strict_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
244 int isl_set_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
245
246 struct isl_set *isl_basic_set_compute_divs(struct isl_basic_set *bset);
247 struct isl_set *isl_set_compute_divs(struct isl_set *set);
248
249 struct isl_basic_set *isl_set_copy_basic_set(struct isl_set *set);
250 struct isl_set *isl_set_drop_basic_set(struct isl_set *set,
251                                                 struct isl_basic_set *bset);
252
253 int isl_basic_set_fast_dim_is_fixed(struct isl_basic_set *bset, unsigned dim,
254         isl_int *val);
255
256 int isl_set_fast_dim_is_fixed(struct isl_set *set, unsigned dim, isl_int *val);
257 int isl_set_fast_dim_has_fixed_lower_bound(struct isl_set *set,
258         unsigned dim, isl_int *val);
259
260 struct isl_basic_set *isl_basic_set_gist(struct isl_basic_set *bset,
261                                                 struct isl_basic_set *context);
262 struct isl_set *isl_set_gist(struct isl_set *set,
263         struct isl_basic_set *context);
264 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
265         int pos, isl_int *modulo, isl_int *residue);
266 int isl_set_dim_residue_class(struct isl_set *set,
267         int pos, isl_int *modulo, isl_int *residue);
268
269 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
270
271 int isl_set_fast_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
272 int isl_set_fast_is_disjoint(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
273
274 uint32_t isl_set_get_hash(struct isl_set *set);
275
276 int isl_set_dim_is_unique(struct isl_set *set, unsigned dim);
277
278 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
279         int (*fn)(__isl_take isl_basic_set *bset, void *user), void *user);
280
281 int isl_set_size(__isl_keep isl_set *set);
282
283 #if defined(__cplusplus)
284 }
285 #endif
286
287 #endif