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