hide internal isl_basic_map functions
[isl.git] / isl_map_private.h
blobcf47574b513048c56a26f1e2aecec6f34b2e496f
1 /*
2 * Copyright 2008-2009 Katholieke Universiteit Leuven
4 * Use of this software is governed by the MIT license
6 * Written by Sven Verdoolaege, K.U.Leuven, Departement
7 * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
8 */
10 #ifndef ISL_MAP_PRIVATE_H
11 #define ISL_MAP_PRIVATE_H
13 #define isl_basic_set isl_basic_map
14 #define isl_set isl_map
15 #define isl_basic_set_list isl_basic_map_list
16 #define isl_set_list isl_map_list
17 #include <isl/list.h>
18 #include <isl/set.h>
19 #include <isl/map.h>
20 #include <isl_reordering.h>
21 #include <isl/vec.h>
22 #include <isl/hash.h>
23 #include <isl_blk.h>
25 /* A "basic map" is a relation between two sets of variables,
26 * called the "in" and "out" variables.
27 * A "basic set" is a basic map with a zero-dimensional
28 * domain.
30 * It is implemented as a set with two extra fields:
31 * n_in is the number of in variables
32 * n_out is the number of out variables
33 * n_in + n_out should be equal to set.dim
35 struct isl_basic_map {
36 int ref;
37 #define ISL_BASIC_MAP_FINAL (1 << 0)
38 #define ISL_BASIC_MAP_EMPTY (1 << 1)
39 #define ISL_BASIC_MAP_NO_IMPLICIT (1 << 2)
40 #define ISL_BASIC_MAP_NO_REDUNDANT (1 << 3)
41 #define ISL_BASIC_MAP_RATIONAL (1 << 4)
42 #define ISL_BASIC_MAP_NORMALIZED (1 << 5)
43 #define ISL_BASIC_MAP_NORMALIZED_DIVS (1 << 6)
44 #define ISL_BASIC_MAP_ALL_EQUALITIES (1 << 7)
45 #define ISL_BASIC_MAP_REDUCED_COEFFICIENTS (1 << 8)
46 #define ISL_BASIC_SET_FINAL (1 << 0)
47 #define ISL_BASIC_SET_EMPTY (1 << 1)
48 #define ISL_BASIC_SET_NO_IMPLICIT (1 << 2)
49 #define ISL_BASIC_SET_NO_REDUNDANT (1 << 3)
50 #define ISL_BASIC_SET_RATIONAL (1 << 4)
51 #define ISL_BASIC_SET_NORMALIZED (1 << 5)
52 #define ISL_BASIC_SET_NORMALIZED_DIVS (1 << 6)
53 #define ISL_BASIC_SET_ALL_EQUALITIES (1 << 7)
54 #define ISL_BASIC_SET_REDUCED_COEFFICIENTS (1 << 8)
55 unsigned flags;
57 struct isl_ctx *ctx;
59 isl_space *dim;
60 unsigned extra;
62 unsigned n_eq;
63 unsigned n_ineq;
65 size_t c_size;
66 isl_int **eq;
67 isl_int **ineq;
69 unsigned n_div;
71 isl_int **div;
73 struct isl_vec *sample;
75 struct isl_blk block;
76 struct isl_blk block2;
79 #undef EL
80 #define EL isl_basic_set
82 #include <isl_list_templ.h>
84 /* A "map" is a (possibly disjoint) union of basic maps.
85 * A "set" is a (possibly disjoint) union of basic sets.
87 * Currently, the isl_set structure is identical to the isl_map structure
88 * and the library depends on this correspondence internally.
89 * However, users should not depend on this correspondence.
91 struct isl_map {
92 int ref;
93 #define ISL_MAP_DISJOINT (1 << 0)
94 #define ISL_MAP_NORMALIZED (1 << 1)
95 #define ISL_SET_DISJOINT (1 << 0)
96 #define ISL_SET_NORMALIZED (1 << 1)
97 unsigned flags;
99 struct isl_ctx *ctx;
101 isl_space *dim;
103 int n;
105 size_t size;
106 struct isl_basic_map *p[1];
109 #undef EL
110 #define EL isl_set
112 #include <isl_list_templ.h>
114 __isl_give isl_basic_set *isl_basic_set_alloc(isl_ctx *ctx,
115 unsigned nparam, unsigned dim, unsigned extra,
116 unsigned n_eq, unsigned n_ineq);
117 __isl_give isl_basic_set *isl_basic_set_extend(__isl_take isl_basic_set *base,
118 unsigned nparam, unsigned dim, unsigned extra,
119 unsigned n_eq, unsigned n_ineq);
120 __isl_give isl_basic_set *isl_basic_set_extend_constraints(
121 __isl_take isl_basic_set *base, unsigned n_eq, unsigned n_ineq);
122 __isl_give isl_basic_set *isl_basic_set_finalize(
123 __isl_take isl_basic_set *bset);
124 __isl_give isl_basic_set *isl_basic_set_dup(__isl_keep isl_basic_set *bset);
125 __isl_give isl_basic_set *isl_basic_set_simplify(
126 __isl_take isl_basic_set *bset);
128 __isl_give isl_basic_map *isl_basic_map_alloc(isl_ctx *ctx,
129 unsigned nparam, unsigned in, unsigned out, unsigned extra,
130 unsigned n_eq, unsigned n_ineq);
131 __isl_give isl_basic_map *isl_basic_map_finalize(
132 __isl_take isl_basic_map *bmap);
133 __isl_give isl_basic_map *isl_basic_map_extend(__isl_take isl_basic_map *base,
134 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
135 unsigned n_eq, unsigned n_ineq);
136 __isl_give isl_basic_map *isl_basic_map_extend_constraints(
137 __isl_take isl_basic_map *base, unsigned n_eq, unsigned n_ineq);
138 __isl_give isl_basic_map *isl_basic_map_simplify(
139 __isl_take isl_basic_map *bmap);
141 __isl_give isl_basic_set *isl_basic_set_from_underlying_set(
142 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *like);
144 __isl_give isl_map *isl_map_realign(__isl_take isl_map *map,
145 __isl_take isl_reordering *r);
146 __isl_give isl_set *isl_set_realign(__isl_take isl_set *set,
147 __isl_take isl_reordering *r);
149 __isl_give isl_map *isl_map_reset(__isl_take isl_map *map,
150 enum isl_dim_type type);
152 __isl_give isl_basic_set *isl_basic_set_reset_space(
153 __isl_take isl_basic_set *bset, __isl_take isl_space *dim);
154 __isl_give isl_basic_map *isl_basic_map_reset_space(
155 __isl_take isl_basic_map *bmap, __isl_take isl_space *dim);
156 __isl_give isl_map *isl_map_reset_space(__isl_take isl_map *map,
157 __isl_take isl_space *dim);
159 unsigned isl_basic_map_offset(struct isl_basic_map *bmap,
160 enum isl_dim_type type);
161 unsigned isl_basic_set_offset(struct isl_basic_set *bset,
162 enum isl_dim_type type);
164 int isl_basic_map_may_be_set(__isl_keep isl_basic_map *bmap);
165 int isl_map_may_be_set(__isl_keep isl_map *map);
166 int isl_map_compatible_domain(struct isl_map *map, struct isl_set *set);
167 int isl_basic_map_compatible_domain(struct isl_basic_map *bmap,
168 struct isl_basic_set *bset);
169 int isl_basic_map_compatible_range(struct isl_basic_map *bmap,
170 struct isl_basic_set *bset);
172 struct isl_basic_map *isl_basic_map_extend_space(struct isl_basic_map *base,
173 __isl_take isl_space *dim, unsigned extra,
174 unsigned n_eq, unsigned n_ineq);
175 struct isl_basic_set *isl_basic_set_extend_space(struct isl_basic_set *base,
176 __isl_take isl_space *dim, unsigned extra,
177 unsigned n_eq, unsigned n_ineq);
178 struct isl_basic_set *isl_basic_set_add_constraints(struct isl_basic_set *bset1,
179 struct isl_basic_set *bset2, unsigned pos);
181 struct isl_map *isl_map_grow(struct isl_map *map, int n);
182 struct isl_set *isl_set_grow(struct isl_set *set, int n);
184 int isl_basic_set_contains(struct isl_basic_set *bset, struct isl_vec *vec);
185 int isl_basic_map_contains(struct isl_basic_map *bmap, struct isl_vec *vec);
187 __isl_give isl_basic_set *isl_basic_set_alloc_space(__isl_take isl_space *dim,
188 unsigned extra, unsigned n_eq, unsigned n_ineq);
189 __isl_give isl_set *isl_set_alloc_space(__isl_take isl_space *dim, int n,
190 unsigned flags);
191 __isl_give isl_basic_map *isl_basic_map_alloc_space(__isl_take isl_space *dim,
192 unsigned extra, unsigned n_eq, unsigned n_ineq);
193 __isl_give isl_map *isl_map_alloc_space(__isl_take isl_space *dim, int n,
194 unsigned flags);
196 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
198 int isl_basic_map_alloc_equality(struct isl_basic_map *bmap);
199 int isl_basic_set_alloc_equality(struct isl_basic_set *bset);
200 int isl_basic_set_free_inequality(struct isl_basic_set *bset, unsigned n);
201 int isl_basic_map_free_equality(struct isl_basic_map *bmap, unsigned n);
202 int isl_basic_set_free_equality(struct isl_basic_set *bset, unsigned n);
203 int isl_basic_set_alloc_inequality(struct isl_basic_set *bset);
204 int isl_basic_map_alloc_inequality(struct isl_basic_map *bmap);
205 int isl_basic_map_free_inequality(struct isl_basic_map *bmap, unsigned n);
206 int isl_basic_map_alloc_div(struct isl_basic_map *bmap);
207 int isl_basic_set_alloc_div(struct isl_basic_set *bset);
208 int isl_basic_map_free_div(struct isl_basic_map *bmap, unsigned n);
209 int isl_basic_set_free_div(struct isl_basic_set *bset, unsigned n);
210 void isl_basic_map_inequality_to_equality(
211 struct isl_basic_map *bmap, unsigned pos);
212 int isl_basic_map_drop_equality(struct isl_basic_map *bmap, unsigned pos);
213 int isl_basic_set_drop_equality(struct isl_basic_set *bset, unsigned pos);
214 int isl_basic_set_drop_inequality(struct isl_basic_set *bset, unsigned pos);
215 int isl_basic_map_drop_inequality(struct isl_basic_map *bmap, unsigned pos);
216 __isl_give isl_basic_set *isl_basic_set_add_eq(__isl_take isl_basic_set *bset,
217 isl_int *eq);
218 __isl_give isl_basic_map *isl_basic_map_add_eq(__isl_take isl_basic_map *bmap,
219 isl_int *eq);
220 __isl_give isl_basic_set *isl_basic_set_add_ineq(__isl_take isl_basic_set *bset,
221 isl_int *ineq);
222 __isl_give isl_basic_map *isl_basic_map_add_ineq(__isl_take isl_basic_map *bmap,
223 isl_int *ineq);
225 int isl_inequality_negate(struct isl_basic_map *bmap, unsigned pos);
227 struct isl_basic_set *isl_basic_set_cow(struct isl_basic_set *bset);
228 struct isl_basic_map *isl_basic_map_cow(struct isl_basic_map *bmap);
229 struct isl_set *isl_set_cow(struct isl_set *set);
230 struct isl_map *isl_map_cow(struct isl_map *map);
232 uint32_t isl_basic_map_get_hash(__isl_keep isl_basic_map *bmap);
234 struct isl_basic_map *isl_basic_map_set_to_empty(struct isl_basic_map *bmap);
235 struct isl_basic_set *isl_basic_set_set_to_empty(struct isl_basic_set *bset);
236 struct isl_basic_set *isl_basic_set_order_divs(struct isl_basic_set *bset);
237 void isl_basic_map_swap_div(struct isl_basic_map *bmap, int a, int b);
238 struct isl_basic_map *isl_basic_map_order_divs(struct isl_basic_map *bmap);
239 __isl_give isl_map *isl_map_order_divs(__isl_take isl_map *map);
240 struct isl_basic_map *isl_basic_map_align_divs(
241 struct isl_basic_map *dst, struct isl_basic_map *src);
242 struct isl_basic_set *isl_basic_set_align_divs(
243 struct isl_basic_set *dst, struct isl_basic_set *src);
244 __isl_give isl_map *isl_map_align_divs_to_basic_map_list(
245 __isl_take isl_map *map, __isl_keep isl_basic_map_list *list);
246 __isl_give isl_basic_map_list *isl_basic_map_list_align_divs_to_basic_map(
247 __isl_take isl_basic_map_list *list, __isl_keep isl_basic_map *bmap);
248 __isl_give isl_basic_map *isl_basic_map_sort_divs(
249 __isl_take isl_basic_map *bmap);
250 __isl_give isl_map *isl_map_sort_divs(__isl_take isl_map *map);
251 struct isl_basic_map *isl_basic_map_gauss(
252 struct isl_basic_map *bmap, int *progress);
253 struct isl_basic_set *isl_basic_set_gauss(
254 struct isl_basic_set *bset, int *progress);
255 __isl_give isl_basic_set *isl_basic_set_sort_constraints(
256 __isl_take isl_basic_set *bset);
257 int isl_basic_map_plain_cmp(const __isl_keep isl_basic_map *bmap1,
258 const __isl_keep isl_basic_map *bmap2);
259 int isl_basic_map_plain_is_equal(__isl_keep isl_basic_map *bmap1,
260 __isl_keep isl_basic_map *bmap2);
261 struct isl_basic_map *isl_basic_map_normalize_constraints(
262 struct isl_basic_map *bmap);
263 struct isl_basic_set *isl_basic_set_normalize_constraints(
264 struct isl_basic_set *bset);
265 struct isl_basic_map *isl_basic_map_implicit_equalities(
266 struct isl_basic_map *bmap);
267 struct isl_basic_set *isl_basic_map_underlying_set(struct isl_basic_map *bmap);
268 __isl_give isl_basic_set *isl_basic_set_underlying_set(
269 __isl_take isl_basic_set *bset);
270 __isl_give isl_basic_set_list *isl_basic_map_list_underlying_set(
271 __isl_take isl_basic_map_list *list);
272 struct isl_set *isl_map_underlying_set(struct isl_map *map);
273 struct isl_basic_map *isl_basic_map_overlying_set(struct isl_basic_set *bset,
274 struct isl_basic_map *like);
275 __isl_give isl_basic_set *isl_basic_set_drop_constraints_involving(
276 __isl_take isl_basic_set *bset, unsigned first, unsigned n);
277 __isl_give isl_basic_set *isl_basic_set_drop(__isl_take isl_basic_set *bset,
278 enum isl_dim_type type, unsigned first, unsigned n);
279 struct isl_basic_map *isl_basic_map_drop(struct isl_basic_map *bmap,
280 enum isl_dim_type type, unsigned first, unsigned n);
281 struct isl_set *isl_set_drop(struct isl_set *set,
282 enum isl_dim_type type, unsigned first, unsigned n);
283 struct isl_basic_set *isl_basic_set_drop_dims(
284 struct isl_basic_set *bset, unsigned first, unsigned n);
285 struct isl_set *isl_set_drop_dims(
286 struct isl_set *set, unsigned first, unsigned n);
287 struct isl_map *isl_map_drop_inputs(
288 struct isl_map *map, unsigned first, unsigned n);
289 struct isl_map *isl_map_drop(struct isl_map *map,
290 enum isl_dim_type type, unsigned first, unsigned n);
292 __isl_give isl_basic_map *isl_basic_map_remove_duplicate_constraints(
293 __isl_take isl_basic_map *bmap, int *progress, int detect_divs);
294 __isl_give isl_basic_map *isl_basic_map_detect_inequality_pairs(
295 __isl_take isl_basic_map *bmap, int *progress);
297 struct isl_map *isl_map_remove_empty_parts(struct isl_map *map);
298 struct isl_set *isl_set_remove_empty_parts(struct isl_set *set);
299 __isl_give isl_map *isl_map_remove_obvious_duplicates(__isl_take isl_map *map);
301 struct isl_set *isl_set_normalize(struct isl_set *set);
303 struct isl_set *isl_set_drop_vars(
304 struct isl_set *set, unsigned first, unsigned n);
306 struct isl_basic_map *isl_basic_map_eliminate_vars(
307 struct isl_basic_map *bmap, unsigned pos, unsigned n);
308 struct isl_basic_set *isl_basic_set_eliminate_vars(
309 struct isl_basic_set *bset, unsigned pos, unsigned n);
311 __isl_give isl_map *isl_map_eliminate(__isl_take isl_map *map,
312 enum isl_dim_type type, unsigned first, unsigned n);
313 __isl_give isl_set *isl_set_eliminate(__isl_take isl_set *set,
314 enum isl_dim_type type, unsigned first, unsigned n);
316 int isl_basic_set_constraint_is_redundant(struct isl_basic_set **bset,
317 isl_int *c, isl_int *opt_n, isl_int *opt_d);
319 int isl_basic_map_add_div_constraint(__isl_keep isl_basic_map *bmap,
320 unsigned div, int sign);
321 int isl_basic_map_add_div_constraints(struct isl_basic_map *bmap, unsigned div);
322 __isl_give isl_basic_map *isl_basic_map_add_known_div_constraints(
323 __isl_take isl_basic_map *bmap);
324 struct isl_basic_map *isl_basic_map_drop_redundant_divs(
325 struct isl_basic_map *bmap);
326 struct isl_basic_set *isl_basic_set_drop_redundant_divs(
327 struct isl_basic_set *bset);
329 struct isl_basic_set *isl_basic_set_recession_cone(struct isl_basic_set *bset);
330 struct isl_basic_set *isl_basic_set_lineality_space(struct isl_basic_set *bset);
332 struct isl_basic_set *isl_basic_set_set_rational(struct isl_basic_set *bset);
333 __isl_give isl_set *isl_set_set_rational(__isl_take isl_set *set);
334 __isl_give isl_basic_map *isl_basic_map_set_rational(
335 __isl_take isl_basic_map *bmap);
336 __isl_give isl_map *isl_map_set_rational(__isl_take isl_map *map);
338 int isl_map_has_rational(__isl_keep isl_map *map);
339 int isl_set_has_rational(__isl_keep isl_set *set);
341 struct isl_mat;
343 struct isl_basic_set *isl_basic_set_preimage(struct isl_basic_set *bset,
344 struct isl_mat *mat);
345 struct isl_set *isl_set_preimage(struct isl_set *set, struct isl_mat *mat);
347 __isl_give isl_basic_set *isl_basic_set_transform_dims(
348 __isl_take isl_basic_set *bset, enum isl_dim_type type, unsigned first,
349 __isl_take isl_mat *trans);
351 isl_int *isl_set_wrap_facet(__isl_keep isl_set *set,
352 isl_int *facet, isl_int *ridge);
354 int isl_basic_map_contains_point(__isl_keep isl_basic_map *bmap,
355 __isl_keep isl_point *point);
356 int isl_set_contains_point(__isl_keep isl_set *set, __isl_keep isl_point *point);
358 int isl_basic_set_vars_get_sign(__isl_keep isl_basic_set *bset,
359 unsigned first, unsigned n, int *signs);
360 int isl_set_foreach_orthant(__isl_keep isl_set *set,
361 int (*fn)(__isl_take isl_set *orthant, int *signs, void *user),
362 void *user);
364 int isl_basic_map_add_div_constraints_var(__isl_keep isl_basic_map *bmap,
365 unsigned pos, isl_int *div);
366 int isl_basic_set_add_div_constraints_var(__isl_keep isl_basic_set *bset,
367 unsigned pos, isl_int *div);
368 int isl_basic_map_is_div_constraint(__isl_keep isl_basic_map *bmap,
369 isl_int *constraint, unsigned div);
370 int isl_basic_set_is_div_constraint(__isl_keep isl_basic_set *bset,
371 isl_int *constraint, unsigned div);
373 __isl_give isl_basic_set *isl_basic_set_from_local_space(
374 __isl_take isl_local_space *ls);
375 __isl_give isl_basic_map *isl_basic_map_from_local_space(
376 __isl_take isl_local_space *ls);
377 __isl_give isl_basic_set *isl_basic_set_expand_divs(
378 __isl_take isl_basic_set *bset, __isl_take isl_mat *div, int *exp);
380 int isl_basic_map_divs_known(__isl_keep isl_basic_map *bmap);
381 __isl_give isl_mat *isl_basic_set_get_divs(__isl_keep isl_basic_set *bset);
382 __isl_give isl_mat *isl_basic_map_get_divs(__isl_keep isl_basic_map *bmap);
384 __isl_give isl_map *isl_map_inline_foreach_basic_map(__isl_take isl_map *map,
385 __isl_give isl_basic_map *(*fn)(__isl_take isl_basic_map *bmap));
387 __isl_give isl_map *isl_map_align_params_map_map_and(
388 __isl_take isl_map *map1, __isl_take isl_map *map2,
389 __isl_give isl_map *(*fn)(__isl_take isl_map *map1,
390 __isl_take isl_map *map2));
391 int isl_map_align_params_map_map_and_test(__isl_keep isl_map *map1,
392 __isl_keep isl_map *map2,
393 int (*fn)(__isl_keep isl_map *map1, __isl_keep isl_map *map2));
395 int isl_basic_map_foreach_lexopt(__isl_keep isl_basic_map *bmap, int max,
396 int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_aff_list *list,
397 void *user),
398 void *user);
399 int isl_basic_set_foreach_lexopt(__isl_keep isl_basic_set *bset, int max,
400 int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_aff_list *list,
401 void *user),
402 void *user);
404 __isl_give isl_set *isl_set_substitute(__isl_take isl_set *set,
405 enum isl_dim_type type, unsigned pos, __isl_keep isl_aff *subs);
407 __isl_give isl_set *isl_set_gist_params_basic_set(__isl_take isl_set *set,
408 __isl_take isl_basic_set *context);
410 int isl_map_compatible_range(__isl_keep isl_map *map, __isl_keep isl_set *set);
412 int isl_basic_map_plain_is_single_valued(__isl_keep isl_basic_map *bmap);
414 int isl_map_is_set(__isl_keep isl_map *map);
416 int isl_basic_set_plain_dim_is_fixed(__isl_keep isl_basic_set *bset,
417 unsigned dim, isl_int *val);
419 __isl_give isl_basic_map *isl_basic_map_plain_affine_hull(
420 __isl_take isl_basic_map *bmap);
422 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
423 int pos, isl_int *modulo, isl_int *residue);
424 int isl_set_dim_residue_class(struct isl_set *set,
425 int pos, isl_int *modulo, isl_int *residue);
427 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
428 enum isl_dim_type type, unsigned pos, isl_int value);
429 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
430 enum isl_dim_type type, unsigned pos, isl_int value);
431 int isl_map_plain_is_fixed(__isl_keep isl_map *map,
432 enum isl_dim_type type, unsigned pos, isl_int *val);
434 int isl_basic_map_output_defining_equality(__isl_keep isl_basic_map *bmap,
435 int pos);
437 __isl_give isl_basic_map *isl_basic_map_reduce_coefficients(
438 __isl_take isl_basic_map *bmap);
440 __isl_give isl_basic_map *isl_basic_map_shift_div(
441 __isl_take isl_basic_map *bmap, int div, isl_int shift);
443 __isl_give isl_basic_map_list *isl_map_get_basic_map_list(
444 __isl_keep isl_map *map);
446 __isl_give isl_map *isl_map_fixed_power(__isl_take isl_map *map, isl_int exp);
448 int isl_basic_set_count_upto(__isl_keep isl_basic_set *bset,
449 isl_int max, isl_int *count);
450 int isl_set_count_upto(__isl_keep isl_set *set, isl_int max, isl_int *count);
452 #endif