doc: add some implementation details on parametric integer programming
[isl.git] / isl_map_private.h
blob031ba62e8f9fa39264ddd275bf792bccb70bc571
1 /*
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
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 #include <isl/set.h>
16 #include <isl/map.h>
17 #include <isl_reordering.h>
18 #include <isl/vec.h>
20 /* A "basic map" is a relation between two sets of variables,
21 * called the "in" and "out" variables.
22 * A "basic set" is a basic map with a zero-dimensional
23 * domain.
25 * It is implemented as a set with two extra fields:
26 * n_in is the number of in variables
27 * n_out is the number of out variables
28 * n_in + n_out should be equal to set.dim
30 struct isl_basic_map {
31 int ref;
32 #define ISL_BASIC_MAP_FINAL (1 << 0)
33 #define ISL_BASIC_MAP_EMPTY (1 << 1)
34 #define ISL_BASIC_MAP_NO_IMPLICIT (1 << 2)
35 #define ISL_BASIC_MAP_NO_REDUNDANT (1 << 3)
36 #define ISL_BASIC_MAP_RATIONAL (1 << 4)
37 #define ISL_BASIC_MAP_NORMALIZED (1 << 5)
38 #define ISL_BASIC_MAP_NORMALIZED_DIVS (1 << 6)
39 #define ISL_BASIC_MAP_ALL_EQUALITIES (1 << 7)
40 #define ISL_BASIC_SET_FINAL (1 << 0)
41 #define ISL_BASIC_SET_EMPTY (1 << 1)
42 #define ISL_BASIC_SET_NO_IMPLICIT (1 << 2)
43 #define ISL_BASIC_SET_NO_REDUNDANT (1 << 3)
44 #define ISL_BASIC_SET_RATIONAL (1 << 4)
45 #define ISL_BASIC_SET_NORMALIZED (1 << 5)
46 #define ISL_BASIC_SET_NORMALIZED_DIVS (1 << 6)
47 #define ISL_BASIC_SET_ALL_EQUALITIES (1 << 7)
48 unsigned flags;
50 struct isl_ctx *ctx;
52 struct isl_dim *dim;
53 unsigned extra;
55 unsigned n_eq;
56 unsigned n_ineq;
58 size_t c_size;
59 isl_int **eq;
60 isl_int **ineq;
62 unsigned n_div;
64 isl_int **div;
66 struct isl_vec *sample;
68 struct isl_blk block;
69 struct isl_blk block2;
72 /* A "map" is a (possibly disjoint) union of basic maps.
73 * A "set" is a (possibly disjoint) union of basic sets.
75 * Currently, the isl_set structure is identical to the isl_map structure
76 * and the library depends on this correspondence internally.
77 * However, users should not depend on this correspondence.
79 struct isl_map {
80 int ref;
81 #define ISL_MAP_DISJOINT (1 << 0)
82 #define ISL_MAP_NORMALIZED (1 << 1)
83 #define ISL_SET_DISJOINT (1 << 0)
84 #define ISL_SET_NORMALIZED (1 << 1)
85 unsigned flags;
87 struct isl_ctx *ctx;
89 struct isl_dim *dim;
91 int n;
93 size_t size;
94 struct isl_basic_map *p[1];
97 __isl_give isl_map *isl_map_realign(__isl_take isl_map *map,
98 __isl_take isl_reordering *r);
99 __isl_give isl_set *isl_set_realign(__isl_take isl_set *set,
100 __isl_take isl_reordering *r);
102 __isl_give isl_map *isl_map_reset(__isl_take isl_map *map,
103 enum isl_dim_type type);
105 __isl_give isl_basic_set *isl_basic_set_reset_dim(
106 __isl_take isl_basic_set *bset, __isl_take isl_dim *dim);
107 __isl_give isl_basic_map *isl_basic_map_reset_dim(
108 __isl_take isl_basic_map *bmap, __isl_take isl_dim *dim);
109 __isl_give isl_map *isl_map_reset_dim(__isl_take isl_map *map,
110 __isl_take isl_dim *dim);
112 unsigned isl_basic_map_offset(struct isl_basic_map *bmap,
113 enum isl_dim_type type);
115 int isl_map_compatible_domain(struct isl_map *map, struct isl_set *set);
116 int isl_basic_map_compatible_domain(struct isl_basic_map *bmap,
117 struct isl_basic_set *bset);
118 int isl_basic_map_compatible_range(struct isl_basic_map *bmap,
119 struct isl_basic_set *bset);
121 struct isl_basic_map *isl_basic_map_extend_dim(struct isl_basic_map *base,
122 struct isl_dim *dim, unsigned extra,
123 unsigned n_eq, unsigned n_ineq);
124 struct isl_basic_set *isl_basic_set_extend_dim(struct isl_basic_set *base,
125 struct isl_dim *dim, unsigned extra,
126 unsigned n_eq, unsigned n_ineq);
127 struct isl_basic_set *isl_basic_set_add_constraints(struct isl_basic_set *bset1,
128 struct isl_basic_set *bset2, unsigned pos);
130 struct isl_map *isl_map_grow(struct isl_map *map, int n);
131 struct isl_set *isl_set_grow(struct isl_set *set, int n);
133 int isl_basic_set_contains(struct isl_basic_set *bset, struct isl_vec *vec);
134 int isl_basic_map_contains(struct isl_basic_map *bmap, struct isl_vec *vec);
136 struct isl_basic_set *isl_basic_set_alloc_dim(struct isl_dim *dim,
137 unsigned extra, unsigned n_eq, unsigned n_ineq);
138 struct isl_set *isl_set_alloc_dim(struct isl_dim *dim, int n, unsigned flags);
139 struct isl_basic_map *isl_basic_map_alloc_dim(struct isl_dim *dim,
140 unsigned extra, unsigned n_eq, unsigned n_ineq);
141 struct isl_map *isl_map_alloc_dim(struct isl_dim *dim, int n, unsigned flags);
143 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
145 int isl_basic_map_alloc_equality(struct isl_basic_map *bmap);
146 int isl_basic_set_alloc_equality(struct isl_basic_set *bset);
147 int isl_basic_set_free_inequality(struct isl_basic_set *bset, unsigned n);
148 int isl_basic_map_free_equality(struct isl_basic_map *bmap, unsigned n);
149 int isl_basic_set_free_equality(struct isl_basic_set *bset, unsigned n);
150 int isl_basic_set_alloc_inequality(struct isl_basic_set *bset);
151 int isl_basic_map_alloc_inequality(struct isl_basic_map *bmap);
152 int isl_basic_map_free_inequality(struct isl_basic_map *bmap, unsigned n);
153 int isl_basic_map_alloc_div(struct isl_basic_map *bmap);
154 int isl_basic_set_alloc_div(struct isl_basic_set *bset);
155 int isl_basic_map_free_div(struct isl_basic_map *bmap, unsigned n);
156 int isl_basic_set_free_div(struct isl_basic_set *bset, unsigned n);
157 void isl_basic_map_inequality_to_equality(
158 struct isl_basic_map *bmap, unsigned pos);
159 int isl_basic_map_drop_equality(struct isl_basic_map *bmap, unsigned pos);
160 int isl_basic_set_drop_equality(struct isl_basic_set *bset, unsigned pos);
161 int isl_basic_set_drop_inequality(struct isl_basic_set *bset, unsigned pos);
162 int isl_basic_map_drop_inequality(struct isl_basic_map *bmap, unsigned pos);
163 __isl_give isl_basic_set *isl_basic_set_add_eq(__isl_take isl_basic_set *bset,
164 isl_int *eq);
165 __isl_give isl_basic_map *isl_basic_map_add_eq(__isl_take isl_basic_map *bmap,
166 isl_int *eq);
167 __isl_give isl_basic_set *isl_basic_set_add_ineq(__isl_take isl_basic_set *bset,
168 isl_int *ineq);
169 __isl_give isl_basic_map *isl_basic_map_add_ineq(__isl_take isl_basic_map *bmap,
170 isl_int *ineq);
172 int isl_inequality_negate(struct isl_basic_map *bmap, unsigned pos);
174 struct isl_basic_set *isl_basic_set_cow(struct isl_basic_set *bset);
175 struct isl_basic_map *isl_basic_map_cow(struct isl_basic_map *bmap);
176 struct isl_set *isl_set_cow(struct isl_set *set);
177 struct isl_map *isl_map_cow(struct isl_map *map);
179 struct isl_basic_map *isl_basic_map_set_to_empty(struct isl_basic_map *bmap);
180 struct isl_basic_set *isl_basic_set_set_to_empty(struct isl_basic_set *bset);
181 struct isl_basic_set *isl_basic_set_order_divs(struct isl_basic_set *bset);
182 void isl_basic_map_swap_div(struct isl_basic_map *bmap, int a, int b);
183 struct isl_basic_map *isl_basic_map_order_divs(struct isl_basic_map *bmap);
184 __isl_give isl_map *isl_map_order_divs(__isl_take isl_map *map);
185 struct isl_basic_map *isl_basic_map_align_divs(
186 struct isl_basic_map *dst, struct isl_basic_map *src);
187 struct isl_basic_set *isl_basic_set_align_divs(
188 struct isl_basic_set *dst, struct isl_basic_set *src);
189 struct isl_basic_map *isl_basic_map_gauss(
190 struct isl_basic_map *bmap, int *progress);
191 struct isl_basic_set *isl_basic_set_gauss(
192 struct isl_basic_set *bset, int *progress);
193 __isl_give isl_basic_set *isl_basic_set_sort_constraints(
194 __isl_take isl_basic_set *bset);
195 int isl_basic_map_fast_cmp(const __isl_keep isl_basic_map *bmap1,
196 const __isl_keep isl_basic_map *bmap2);
197 int isl_basic_set_fast_is_equal(__isl_keep isl_basic_set *bset1,
198 __isl_keep isl_basic_set *bset2);
199 int isl_basic_map_fast_is_equal(__isl_keep isl_basic_map *bmap1,
200 __isl_keep isl_basic_map *bmap2);
201 struct isl_basic_map *isl_basic_map_normalize_constraints(
202 struct isl_basic_map *bmap);
203 struct isl_basic_set *isl_basic_set_normalize_constraints(
204 struct isl_basic_set *bset);
205 struct isl_basic_map *isl_basic_map_implicit_equalities(
206 struct isl_basic_map *bmap);
207 struct isl_basic_set *isl_basic_map_underlying_set(struct isl_basic_map *bmap);
208 __isl_give isl_basic_set *isl_basic_set_underlying_set(
209 __isl_take isl_basic_set *bset);
210 struct isl_set *isl_map_underlying_set(struct isl_map *map);
211 struct isl_basic_map *isl_basic_map_overlying_set(struct isl_basic_set *bset,
212 struct isl_basic_map *like);
213 __isl_give isl_basic_set *isl_basic_set_drop_constraints_involving(
214 __isl_take isl_basic_set *bset, unsigned first, unsigned n);
215 __isl_give isl_basic_set *isl_basic_set_drop(__isl_take isl_basic_set *bset,
216 enum isl_dim_type type, unsigned first, unsigned n);
217 struct isl_basic_map *isl_basic_map_drop(struct isl_basic_map *bmap,
218 enum isl_dim_type type, unsigned first, unsigned n);
219 struct isl_set *isl_set_drop(struct isl_set *set,
220 enum isl_dim_type type, unsigned first, unsigned n);
221 struct isl_basic_set *isl_basic_set_drop_dims(
222 struct isl_basic_set *bset, unsigned first, unsigned n);
223 struct isl_set *isl_set_drop_dims(
224 struct isl_set *set, unsigned first, unsigned n);
225 struct isl_map *isl_map_drop_inputs(
226 struct isl_map *map, unsigned first, unsigned n);
227 struct isl_map *isl_map_drop(struct isl_map *map,
228 enum isl_dim_type type, unsigned first, unsigned n);
230 struct isl_map *isl_map_remove_empty_parts(struct isl_map *map);
231 struct isl_set *isl_set_remove_empty_parts(struct isl_set *set);
233 struct isl_set *isl_set_normalize(struct isl_set *set);
235 struct isl_set *isl_set_drop_vars(
236 struct isl_set *set, unsigned first, unsigned n);
238 struct isl_basic_map *isl_basic_map_eliminate_vars(
239 struct isl_basic_map *bmap, unsigned pos, unsigned n);
240 struct isl_basic_set *isl_basic_set_eliminate_vars(
241 struct isl_basic_set *bset, unsigned pos, unsigned n);
243 __isl_give isl_map *isl_map_eliminate(__isl_take isl_map *map,
244 enum isl_dim_type type, unsigned first, unsigned n);
245 __isl_give isl_set *isl_set_eliminate(__isl_take isl_set *set,
246 enum isl_dim_type type, unsigned first, unsigned n);
248 int isl_basic_set_constraint_is_redundant(struct isl_basic_set **bset,
249 isl_int *c, isl_int *opt_n, isl_int *opt_d);
251 int isl_basic_map_add_div_constraints(struct isl_basic_map *bmap, unsigned div);
252 struct isl_basic_map *isl_basic_map_drop_redundant_divs(
253 struct isl_basic_map *bmap);
254 struct isl_basic_set *isl_basic_set_drop_redundant_divs(
255 struct isl_basic_set *bset);
257 struct isl_basic_set *isl_basic_set_recession_cone(struct isl_basic_set *bset);
258 struct isl_basic_set *isl_basic_set_lineality_space(struct isl_basic_set *bset);
260 struct isl_basic_set *isl_basic_set_set_rational(struct isl_basic_set *bset);
261 __isl_give isl_basic_map *isl_basic_map_set_rational(
262 __isl_take isl_basic_map *bmap);
264 struct isl_mat;
266 struct isl_basic_set *isl_basic_set_preimage(struct isl_basic_set *bset,
267 struct isl_mat *mat);
268 struct isl_set *isl_set_preimage(struct isl_set *set, struct isl_mat *mat);
270 isl_int *isl_set_wrap_facet(__isl_keep isl_set *set,
271 isl_int *facet, isl_int *ridge);
273 int isl_basic_map_contains_point(__isl_keep isl_basic_map *bmap,
274 __isl_keep isl_point *point);
275 int isl_set_contains_point(__isl_keep isl_set *set, __isl_keep isl_point *point);
277 int isl_basic_set_vars_get_sign(__isl_keep isl_basic_set *bset,
278 unsigned first, unsigned n, int *signs);
279 int isl_set_foreach_orthant(__isl_keep isl_set *set,
280 int (*fn)(__isl_take isl_set *orthant, int *signs, void *user),
281 void *user);
283 int isl_basic_map_add_div_constraints_var(__isl_keep isl_basic_map *bmap,
284 unsigned pos, isl_int *div);
285 int isl_basic_set_add_div_constraints_var(__isl_keep isl_basic_set *bset,
286 unsigned pos, isl_int *div);
287 int isl_basic_map_is_div_constraint(__isl_keep isl_basic_map *bmap,
288 isl_int *constraint, unsigned div);
290 #endif