2 * Copyright 2008-2009 Katholieke Universiteit Leuven
4 * Use of this software is governed by the GNU LGPLv2.1 license
6 * Written by Sven Verdoolaege, K.U.Leuven, Departement
7 * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
21 #include <isl_printer.h>
23 #if defined(__cplusplus)
29 * All structures are reference counted to allow reuse without duplication.
30 * A *_copy operation will increase the reference count, while a *_free
31 * operation will decrease the reference count and only actually release
32 * the structures when the reference count drops to zero.
34 * Functions that return an isa structure will in general _destroy_
35 * all argument isa structures (the obvious execption begin the _copy
36 * functions). A pointer passed to such a function may therefore
37 * never be used after the function call. If you want to keep a
38 * reference to the old structure(s), use the appropriate _copy function.
41 /* A "basic map" is a relation between two sets of variables,
42 * called the "in" and "out" variables.
44 * It is implemented as a set with two extra fields:
45 * n_in is the number of in variables
46 * n_out is the number of out variables
47 * n_in + n_out should be equal to set.dim
50 struct isl_basic_map {
52 #define ISL_BASIC_MAP_FINAL (1 << 0)
53 #define ISL_BASIC_MAP_EMPTY (1 << 1)
54 #define ISL_BASIC_MAP_NO_IMPLICIT (1 << 2)
55 #define ISL_BASIC_MAP_NO_REDUNDANT (1 << 3)
56 #define ISL_BASIC_MAP_RATIONAL (1 << 4)
57 #define ISL_BASIC_MAP_NORMALIZED (1 << 5)
58 #define ISL_BASIC_MAP_NORMALIZED_DIVS (1 << 6)
59 #define ISL_BASIC_MAP_ALL_EQUALITIES (1 << 7)
78 struct isl_vec *sample;
81 struct isl_blk block2;
83 typedef struct isl_basic_map isl_basic_map;
85 typedef struct isl_basic_set isl_basic_set;
87 /* A "map" is a (disjoint) union of basic maps.
89 * Currently, the isl_set structure is identical to the isl_map structure
90 * and the library depends on this correspondence internally.
91 * However, users should not depend on this correspondence.
95 #define ISL_MAP_DISJOINT (1 << 0)
96 #define ISL_MAP_NORMALIZED (1 << 1)
106 struct isl_basic_map *p[1];
108 typedef struct isl_map isl_map;
110 typedef struct isl_set isl_set;
112 unsigned isl_basic_map_n_in(const struct isl_basic_map *bmap);
113 unsigned isl_basic_map_n_out(const struct isl_basic_map *bmap);
114 unsigned isl_basic_map_n_param(const struct isl_basic_map *bmap);
115 unsigned isl_basic_map_n_div(const struct isl_basic_map *bmap);
116 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
117 unsigned isl_basic_map_dim(const struct isl_basic_map *bmap,
118 enum isl_dim_type type);
120 unsigned isl_map_n_in(const struct isl_map *map);
121 unsigned isl_map_n_out(const struct isl_map *map);
122 unsigned isl_map_n_param(const struct isl_map *map);
123 unsigned isl_map_dim(const struct isl_map *map, enum isl_dim_type type);
125 isl_ctx *isl_basic_map_get_ctx(__isl_keep isl_basic_map *bmap);
126 isl_ctx *isl_map_get_ctx(__isl_keep isl_map *map);
127 __isl_give isl_dim *isl_basic_map_get_dim(__isl_keep isl_basic_map *bmap);
128 __isl_give isl_dim *isl_map_get_dim(__isl_keep isl_map *map);
130 __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
131 __isl_take isl_basic_map *bmap, enum isl_dim_type type, const char *s);
132 __isl_give isl_map *isl_map_set_tuple_name(__isl_take isl_map *map,
133 enum isl_dim_type type, const char *s);
134 __isl_give isl_basic_map *isl_basic_map_set_dim_name(
135 __isl_take isl_basic_map *bmap,
136 enum isl_dim_type type, unsigned pos, const char *s);
137 __isl_give isl_map *isl_map_set_dim_name(__isl_take isl_map *map,
138 enum isl_dim_type type, unsigned pos, const char *s);
140 int isl_basic_map_is_rational(__isl_keep isl_basic_map *bmap);
142 struct isl_basic_map *isl_basic_map_alloc(struct isl_ctx *ctx,
143 unsigned nparam, unsigned in, unsigned out, unsigned extra,
144 unsigned n_eq, unsigned n_ineq);
145 __isl_give isl_basic_map *isl_basic_map_identity(__isl_take isl_dim *set_dim);
146 struct isl_basic_map *isl_basic_map_identity_like(struct isl_basic_map *model);
147 struct isl_basic_map *isl_basic_map_finalize(struct isl_basic_map *bmap);
148 void isl_basic_map_free(__isl_take isl_basic_map *bmap);
149 __isl_give isl_basic_map *isl_basic_map_copy(__isl_keep isl_basic_map *bmap);
150 struct isl_basic_map *isl_basic_map_extend(struct isl_basic_map *base,
151 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
152 unsigned n_eq, unsigned n_ineq);
153 struct isl_basic_map *isl_basic_map_extend_constraints(
154 struct isl_basic_map *base, unsigned n_eq, unsigned n_ineq);
155 struct isl_basic_map *isl_basic_map_equal(
156 struct isl_dim *dim, unsigned n_equal);
157 struct isl_basic_map *isl_basic_map_less_at(struct isl_dim *dim, unsigned pos);
158 struct isl_basic_map *isl_basic_map_more_at(struct isl_dim *dim, unsigned pos);
159 __isl_give isl_basic_map *isl_basic_map_empty(__isl_take isl_dim *dim);
160 struct isl_basic_map *isl_basic_map_empty_like(struct isl_basic_map *model);
161 struct isl_basic_map *isl_basic_map_empty_like_map(struct isl_map *model);
162 __isl_give isl_basic_map *isl_basic_map_universe(__isl_take isl_dim *dim);
163 __isl_give isl_basic_map *isl_basic_map_universe_like(
164 __isl_keep isl_basic_map *bmap);
165 __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
166 __isl_take isl_basic_map *bmap);
167 __isl_give isl_basic_map *isl_map_simple_hull(__isl_take isl_map *map);
169 __isl_give isl_basic_map *isl_basic_map_intersect_domain(
170 __isl_take isl_basic_map *bmap,
171 __isl_take isl_basic_set *bset);
172 __isl_give isl_basic_map *isl_basic_map_intersect_range(
173 __isl_take isl_basic_map *bmap,
174 __isl_take isl_basic_set *bset);
175 __isl_give isl_basic_map *isl_basic_map_intersect(
176 __isl_take isl_basic_map *bmap1,
177 __isl_take isl_basic_map *bmap2);
178 __isl_give isl_map *isl_basic_map_union(
179 __isl_take isl_basic_map *bmap1,
180 __isl_take isl_basic_map *bmap2);
181 __isl_give isl_basic_map *isl_basic_map_apply_domain(
182 __isl_take isl_basic_map *bmap1,
183 __isl_take isl_basic_map *bmap2);
184 __isl_give isl_basic_map *isl_basic_map_apply_range(
185 __isl_take isl_basic_map *bmap1,
186 __isl_take isl_basic_map *bmap2);
187 __isl_give isl_basic_map *isl_basic_map_affine_hull(
188 __isl_take isl_basic_map *bmap);
189 __isl_give isl_basic_map *isl_basic_map_reverse(__isl_take isl_basic_map *bmap);
190 __isl_give isl_basic_set *isl_basic_map_domain(__isl_take isl_basic_map *bmap);
191 __isl_give isl_basic_set *isl_basic_map_range(__isl_take isl_basic_map *bmap);
192 struct isl_basic_map *isl_basic_map_remove(struct isl_basic_map *bmap,
193 enum isl_dim_type type, unsigned first, unsigned n);
194 struct isl_basic_map *isl_basic_map_from_basic_set(struct isl_basic_set *bset,
195 struct isl_dim *dim);
196 struct isl_basic_set *isl_basic_set_from_basic_map(struct isl_basic_map *bmap);
197 __isl_give isl_basic_map *isl_basic_map_sample(__isl_take isl_basic_map *bmap);
198 struct isl_basic_map *isl_basic_map_simplify(struct isl_basic_map *bmap);
199 struct isl_basic_map *isl_basic_map_detect_equalities(
200 struct isl_basic_map *bmap);
201 __isl_give isl_basic_map *isl_basic_map_read_from_file(isl_ctx *ctx,
202 FILE *input, int nparam);
203 __isl_give isl_basic_map *isl_basic_map_read_from_str(isl_ctx *ctx,
204 const char *str, int nparam);
205 __isl_give isl_map *isl_map_read_from_file(struct isl_ctx *ctx,
206 FILE *input, int nparam);
207 __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
208 const char *str, int nparam);
209 void isl_basic_map_print(__isl_keep isl_basic_map *bmap, FILE *out, int indent,
210 const char *prefix, const char *suffix, unsigned output_format);
211 void isl_map_print(__isl_keep isl_map *map, FILE *out, int indent,
212 unsigned output_format);
213 __isl_give isl_printer *isl_printer_print_basic_map(
214 __isl_take isl_printer *printer, __isl_keep isl_basic_map *bmap);
215 __isl_give isl_printer *isl_printer_print_map(__isl_take isl_printer *printer,
216 __isl_keep isl_map *map);
217 struct isl_basic_map *isl_basic_map_fix_si(struct isl_basic_map *bmap,
218 enum isl_dim_type type, unsigned pos, int value);
219 __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
220 __isl_take isl_basic_map *bmap,
221 enum isl_dim_type type, unsigned pos, int value);
223 struct isl_basic_map *isl_basic_map_sum(
224 struct isl_basic_map *bmap1, struct isl_basic_map *bmap2);
225 struct isl_basic_map *isl_basic_map_neg(struct isl_basic_map *bmap);
226 struct isl_basic_map *isl_basic_map_floordiv(struct isl_basic_map *bmap,
229 struct isl_map *isl_map_sum(struct isl_map *map1, struct isl_map *map2);
230 struct isl_map *isl_map_neg(struct isl_map *map);
231 struct isl_map *isl_map_floordiv(struct isl_map *map, isl_int d);
233 int isl_basic_map_is_equal(
234 __isl_keep isl_basic_map *bmap1,
235 __isl_keep isl_basic_map *bmap2);
237 __isl_give isl_map *isl_basic_map_partial_lexmax(
238 __isl_take isl_basic_map *bmap, __isl_take isl_basic_set *dom,
239 __isl_give isl_set **empty);
240 __isl_give isl_map *isl_basic_map_partial_lexmin(
241 __isl_take isl_basic_map *bmap, __isl_take isl_basic_set *dom,
242 __isl_give isl_set **empty);
243 __isl_give isl_map *isl_map_partial_lexmax(
244 __isl_take isl_map *map, __isl_take isl_set *dom,
245 __isl_give isl_set **empty);
246 __isl_give isl_map *isl_map_partial_lexmin(
247 __isl_take isl_map *map, __isl_take isl_set *dom,
248 __isl_give isl_set **empty);
249 __isl_give isl_map *isl_basic_map_lexmin(__isl_take isl_basic_map *bmap);
250 __isl_give isl_map *isl_basic_map_lexmax(__isl_take isl_basic_map *bmap);
251 __isl_give isl_map *isl_map_lexmin(__isl_take isl_map *map);
252 __isl_give isl_map *isl_map_lexmax(__isl_take isl_map *map);
253 int isl_basic_map_foreach_lexmin(__isl_keep isl_basic_map *bmap,
254 int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_mat *map,
258 void isl_basic_map_dump(__isl_keep isl_basic_map *bmap, FILE *out, int indent);
260 struct isl_basic_map *isl_map_copy_basic_map(struct isl_map *map);
261 __isl_give isl_map *isl_map_drop_basic_map(__isl_take isl_map *map,
262 __isl_keep isl_basic_map *bmap);
264 int isl_basic_map_fast_is_fixed(struct isl_basic_map *bmap,
265 enum isl_dim_type type, unsigned pos, isl_int *val);
267 int isl_basic_map_image_is_bounded(__isl_keep isl_basic_map *bmap);
268 int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
269 int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
270 int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
271 int isl_basic_map_is_subset(__isl_keep isl_basic_map *bmap1,
272 __isl_keep isl_basic_map *bmap2);
273 int isl_basic_map_is_strict_subset(__isl_keep isl_basic_map *bmap1,
274 __isl_keep isl_basic_map *bmap2);
276 struct isl_map *isl_map_alloc(struct isl_ctx *ctx,
277 unsigned nparam, unsigned in, unsigned out, int n,
279 __isl_give isl_map *isl_map_universe(__isl_take isl_dim *dim);
280 __isl_give isl_map *isl_map_empty(__isl_take isl_dim *dim);
281 struct isl_map *isl_map_empty_like(struct isl_map *model);
282 struct isl_map *isl_map_empty_like_basic_map(struct isl_basic_map *model);
283 struct isl_map *isl_map_dup(struct isl_map *map);
284 __isl_give isl_map *isl_map_add_basic_map(__isl_take isl_map *map,
285 __isl_take isl_basic_map *bmap);
286 __isl_give isl_map *isl_map_identity(__isl_take isl_dim *set_dim);
287 struct isl_map *isl_map_identity_like(struct isl_map *model);
288 struct isl_map *isl_map_identity_like_basic_map(struct isl_basic_map *model);
289 __isl_give isl_map *isl_map_lex_lt_first(__isl_take isl_dim *dim, unsigned n);
290 __isl_give isl_map *isl_map_lex_le_first(__isl_take isl_dim *dim, unsigned n);
291 __isl_give isl_map *isl_map_lex_lt(__isl_take isl_dim *set_dim);
292 __isl_give isl_map *isl_map_lex_le(__isl_take isl_dim *set_dim);
293 __isl_give isl_map *isl_map_lex_gt_first(__isl_take isl_dim *dim, unsigned n);
294 __isl_give isl_map *isl_map_lex_ge_first(__isl_take isl_dim *dim, unsigned n);
295 __isl_give isl_map *isl_map_lex_gt(__isl_take isl_dim *set_dim);
296 __isl_give isl_map *isl_map_lex_ge(__isl_take isl_dim *set_dim);
297 struct isl_map *isl_map_finalize(struct isl_map *map);
298 void isl_map_free(__isl_take isl_map *map);
299 __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
300 struct isl_map *isl_map_extend(struct isl_map *base,
301 unsigned nparam, unsigned n_in, unsigned n_out);
302 __isl_give isl_map *isl_map_reverse(__isl_take isl_map *map);
303 __isl_give isl_map *isl_map_union(
304 __isl_take isl_map *map1,
305 __isl_take isl_map *map2);
306 struct isl_map *isl_map_union_disjoint(
307 struct isl_map *map1, struct isl_map *map2);
308 __isl_give isl_map *isl_map_intersect_domain(
309 __isl_take isl_map *map,
310 __isl_take isl_set *set);
311 __isl_give isl_map *isl_map_intersect_range(
312 __isl_take isl_map *map,
313 __isl_take isl_set *set);
314 __isl_give isl_map *isl_map_apply_domain(
315 __isl_take isl_map *map1,
316 __isl_take isl_map *map2);
317 __isl_give isl_map *isl_map_apply_range(
318 __isl_take isl_map *map1,
319 __isl_take isl_map *map2);
320 struct isl_map *isl_map_product(struct isl_map *map1, struct isl_map *map2);
321 __isl_give isl_map *isl_map_flat_product(__isl_take isl_map *map1,
322 __isl_take isl_map *map2);
323 __isl_give isl_map *isl_map_intersect(__isl_take isl_map *map1,
324 __isl_take isl_map *map2);
325 __isl_give isl_map *isl_map_subtract(
326 __isl_take isl_map *map1,
327 __isl_take isl_map *map2);
328 struct isl_map *isl_map_fix_input_si(struct isl_map *map,
329 unsigned input, int value);
330 struct isl_map *isl_map_fix_si(struct isl_map *map,
331 enum isl_dim_type type, unsigned pos, int value);
332 __isl_give isl_map *isl_map_lower_bound_si(__isl_take isl_map *map,
333 enum isl_dim_type type, unsigned pos, int value);
334 __isl_give isl_basic_set *isl_basic_map_deltas(__isl_take isl_basic_map *bmap);
335 __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
336 struct isl_map *isl_map_detect_equalities(struct isl_map *map);
337 __isl_give isl_basic_map *isl_map_affine_hull(__isl_take isl_map *map);
338 __isl_give isl_basic_map *isl_map_convex_hull(__isl_take isl_map *map);
339 __isl_give isl_basic_map *isl_basic_map_add(__isl_take isl_basic_map *bmap,
340 enum isl_dim_type type, unsigned n);
341 __isl_give isl_map *isl_map_add(__isl_take isl_map *map,
342 enum isl_dim_type type, unsigned n);
343 __isl_give isl_map *isl_map_insert(__isl_take isl_map *map,
344 enum isl_dim_type type, unsigned pos, unsigned n);
345 __isl_give isl_basic_map *isl_basic_map_move_dims(
346 __isl_take isl_basic_map *bmap,
347 enum isl_dim_type dst_type, unsigned dst_pos,
348 enum isl_dim_type src_type, unsigned src_pos, unsigned n);
349 __isl_give isl_map *isl_map_move_dims(__isl_take isl_map *map,
350 enum isl_dim_type dst_type, unsigned dst_pos,
351 enum isl_dim_type src_type, unsigned src_pos, unsigned n);
352 __isl_give isl_basic_map *isl_basic_map_project_out(
353 __isl_take isl_basic_map *bmap,
354 enum isl_dim_type type, unsigned first, unsigned n);
355 __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
356 enum isl_dim_type type, unsigned first, unsigned n);
357 struct isl_map *isl_map_remove(struct isl_map *map,
358 enum isl_dim_type type, unsigned first, unsigned n);
359 struct isl_map *isl_map_remove_inputs(struct isl_map *map,
360 unsigned first, unsigned n);
362 int isl_basic_set_is_wrapping(__isl_keep isl_basic_set *bset);
363 int isl_set_is_wrapping(__isl_keep isl_set *set);
364 __isl_give isl_basic_set *isl_basic_map_wrap(__isl_take isl_basic_map *bmap);
365 __isl_give isl_set *isl_map_wrap(__isl_take isl_map *map);
366 __isl_give isl_basic_map *isl_basic_set_unwrap(__isl_take isl_basic_set *bset);
367 __isl_give isl_map *isl_set_unwrap(__isl_take isl_set *set);
368 __isl_give isl_map *isl_map_flatten(__isl_take isl_map *map);
369 __isl_give isl_set *isl_map_domain(__isl_take isl_map *bmap);
370 __isl_give isl_set *isl_map_range(__isl_take isl_map *map);
371 __isl_give isl_map *isl_map_from_basic_map(__isl_take isl_basic_map *bmap);
372 __isl_give isl_map *isl_map_from_domain(__isl_take isl_set *set);
373 __isl_give isl_basic_map *isl_basic_map_from_range(
374 __isl_take isl_basic_set *bset);
375 struct isl_map *isl_map_from_range(struct isl_set *set);
376 __isl_give isl_map *isl_map_from_domain_and_range(__isl_take isl_set *domain,
377 __isl_take isl_set *range);
378 struct isl_map *isl_map_from_set(struct isl_set *set, struct isl_dim *dim);
379 struct isl_set *isl_set_from_map(struct isl_map *map);
380 __isl_give isl_basic_map *isl_map_sample(__isl_take isl_map *map);
382 int isl_map_fast_is_empty(__isl_keep isl_map *map);
383 int isl_map_fast_is_universe(__isl_keep isl_map *map);
384 int isl_map_is_empty(__isl_keep isl_map *map);
385 int isl_map_is_subset(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
386 int isl_map_is_strict_subset(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
387 int isl_map_is_equal(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
388 int isl_map_is_single_valued(__isl_keep isl_map *map);
389 int isl_map_is_bijective(__isl_keep isl_map *map);
390 int isl_map_is_translation(__isl_keep isl_map *map);
391 int isl_map_has_equal_dim(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
393 __isl_give isl_map *isl_map_make_disjoint(__isl_take isl_map *map);
394 __isl_give isl_map *isl_basic_map_compute_divs(__isl_take isl_basic_map *bmap);
395 __isl_give isl_map *isl_map_compute_divs(__isl_take isl_map *map);
396 __isl_give isl_map *isl_map_align_divs(__isl_take isl_map *map);
398 void isl_map_dump(__isl_keep isl_map *map, FILE *out, int indent);
400 int isl_map_fast_input_is_fixed(struct isl_map *map,
401 unsigned in, isl_int *val);
402 int isl_map_fast_is_fixed(struct isl_map *map,
403 enum isl_dim_type type, unsigned pos, isl_int *val);
405 __isl_give isl_basic_map *isl_basic_map_gist(__isl_take isl_basic_map *bmap,
406 __isl_take isl_basic_map *context);
407 __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
408 __isl_take isl_map *context);
409 __isl_give isl_map *isl_map_gist_basic_map(__isl_take isl_map *map,
410 __isl_take isl_basic_map *context);
412 __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
414 int isl_map_fast_is_equal(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
416 int isl_map_foreach_basic_map(__isl_keep isl_map *map,
417 int (*fn)(__isl_take isl_basic_map *bmap, void *user), void *user);
419 __isl_give isl_map *isl_set_lifting(__isl_take isl_set *set);
421 __isl_give isl_map *isl_map_power(__isl_take isl_map *map, unsigned param,
423 __isl_give isl_map *isl_map_reaching_path_lengths(__isl_take isl_map *map,
425 __isl_give isl_map *isl_map_transitive_closure(__isl_take isl_map *map,
428 __isl_give isl_map *isl_map_lex_le_map(__isl_take isl_map *map1,
429 __isl_take isl_map *map2);
430 __isl_give isl_map *isl_map_lex_lt_map(__isl_take isl_map *map1,
431 __isl_take isl_map *map2);
432 __isl_give isl_map *isl_map_lex_ge_map(__isl_take isl_map *map1,
433 __isl_take isl_map *map2);
434 __isl_give isl_map *isl_map_lex_gt_map(__isl_take isl_map *map1,
435 __isl_take isl_map *map2);
437 __isl_give isl_mat *isl_basic_map_equalities_matrix(
438 __isl_keep isl_basic_map *bmap, enum isl_dim_type c1,
439 enum isl_dim_type c2, enum isl_dim_type c3,
440 enum isl_dim_type c4, enum isl_dim_type c5);
441 __isl_give isl_mat *isl_basic_map_inequalities_matrix(
442 __isl_keep isl_basic_map *bmap, enum isl_dim_type c1,
443 enum isl_dim_type c2, enum isl_dim_type c3,
444 enum isl_dim_type c4, enum isl_dim_type c5);
445 __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
446 __isl_take isl_dim *dim,
447 __isl_take isl_mat *eq, __isl_take isl_mat *ineq, enum isl_dim_type c1,
448 enum isl_dim_type c2, enum isl_dim_type c3,
449 enum isl_dim_type c4, enum isl_dim_type c5);
451 #if defined(__cplusplus)