privately export isl_basic_map_add_div_constraints_var
[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 #include <isl/set.h>
16 #include <isl/map.h>
17 #include <isl_reordering.h>
18 #include <isl/vec.h>
19
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.
24  *
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
29  */
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;
49
50         struct isl_ctx *ctx;
51
52         struct isl_dim *dim;
53         unsigned extra;
54
55         unsigned n_eq;
56         unsigned n_ineq;
57
58         size_t c_size;
59         isl_int **eq;
60         isl_int **ineq;
61
62         unsigned n_div;
63
64         isl_int **div;
65
66         struct isl_vec *sample;
67
68         struct isl_blk block;
69         struct isl_blk block2;
70 };
71
72 /* A "map" is a (possibly disjoint) union of basic maps.
73  * A "set" is a (possibly disjoint) union of basic sets.
74  *
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.
78  */
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;
86
87         struct isl_ctx *ctx;
88
89         struct isl_dim *dim;
90
91         int n;
92
93         size_t size;
94         struct isl_basic_map *p[1];
95 };
96
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);
101
102 __isl_give isl_map *isl_map_reset(__isl_take isl_map *map,
103         enum isl_dim_type type);
104
105 __isl_give isl_basic_map *isl_basic_map_reset_dim(
106         __isl_take isl_basic_map *bmap, __isl_take isl_dim *dim);
107 __isl_give isl_map *isl_map_reset_dim(__isl_take isl_map *map,
108         __isl_take isl_dim *dim);
109
110 unsigned isl_basic_map_offset(struct isl_basic_map *bmap,
111                                         enum isl_dim_type type);
112
113 int isl_map_compatible_domain(struct isl_map *map, struct isl_set *set);
114 int isl_basic_map_compatible_domain(struct isl_basic_map *bmap,
115                 struct isl_basic_set *bset);
116 int isl_basic_map_compatible_range(struct isl_basic_map *bmap,
117                 struct isl_basic_set *bset);
118
119 struct isl_basic_map *isl_basic_map_extend_dim(struct isl_basic_map *base,
120                 struct isl_dim *dim, unsigned extra,
121                 unsigned n_eq, unsigned n_ineq);
122 struct isl_basic_set *isl_basic_set_extend_dim(struct isl_basic_set *base,
123                 struct isl_dim *dim, unsigned extra,
124                 unsigned n_eq, unsigned n_ineq);
125 struct isl_basic_set *isl_basic_set_add_constraints(struct isl_basic_set *bset1,
126                 struct isl_basic_set *bset2, unsigned pos);
127
128 struct isl_map *isl_map_grow(struct isl_map *map, int n);
129 struct isl_set *isl_set_grow(struct isl_set *set, int n);
130
131 int isl_basic_set_contains(struct isl_basic_set *bset, struct isl_vec *vec);
132 int isl_basic_map_contains(struct isl_basic_map *bmap, struct isl_vec *vec);
133
134 struct isl_basic_set *isl_basic_set_alloc_dim(struct isl_dim *dim,
135                 unsigned extra, unsigned n_eq, unsigned n_ineq);
136 struct isl_set *isl_set_alloc_dim(struct isl_dim *dim, int n, unsigned flags);
137 struct isl_basic_map *isl_basic_map_alloc_dim(struct isl_dim *dim,
138                 unsigned extra, unsigned n_eq, unsigned n_ineq);
139 struct isl_map *isl_map_alloc_dim(struct isl_dim *dim, int n, unsigned flags);
140
141 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
142
143 int isl_basic_map_alloc_equality(struct isl_basic_map *bmap);
144 int isl_basic_set_alloc_equality(struct isl_basic_set *bset);
145 int isl_basic_set_free_inequality(struct isl_basic_set *bset, unsigned n);
146 int isl_basic_map_free_equality(struct isl_basic_map *bmap, unsigned n);
147 int isl_basic_set_free_equality(struct isl_basic_set *bset, unsigned n);
148 int isl_basic_set_alloc_inequality(struct isl_basic_set *bset);
149 int isl_basic_map_alloc_inequality(struct isl_basic_map *bmap);
150 int isl_basic_map_free_inequality(struct isl_basic_map *bmap, unsigned n);
151 int isl_basic_map_alloc_div(struct isl_basic_map *bmap);
152 int isl_basic_set_alloc_div(struct isl_basic_set *bset);
153 int isl_basic_map_free_div(struct isl_basic_map *bmap, unsigned n);
154 int isl_basic_set_free_div(struct isl_basic_set *bset, unsigned n);
155 void isl_basic_map_inequality_to_equality(
156                 struct isl_basic_map *bmap, unsigned pos);
157 int isl_basic_map_drop_equality(struct isl_basic_map *bmap, unsigned pos);
158 int isl_basic_set_drop_equality(struct isl_basic_set *bset, unsigned pos);
159 int isl_basic_set_drop_inequality(struct isl_basic_set *bset, unsigned pos);
160 int isl_basic_map_drop_inequality(struct isl_basic_map *bmap, unsigned pos);
161 __isl_give isl_basic_set *isl_basic_set_add_eq(__isl_take isl_basic_set *bset,
162         isl_int *eq);
163 __isl_give isl_basic_map *isl_basic_map_add_eq(__isl_take isl_basic_map *bmap,
164         isl_int *eq);
165 __isl_give isl_basic_set *isl_basic_set_add_ineq(__isl_take isl_basic_set *bset,
166         isl_int *ineq);
167 __isl_give isl_basic_map *isl_basic_map_add_ineq(__isl_take isl_basic_map *bmap,
168         isl_int *ineq);
169
170 int isl_inequality_negate(struct isl_basic_map *bmap, unsigned pos);
171
172 struct isl_basic_set *isl_basic_set_cow(struct isl_basic_set *bset);
173 struct isl_basic_map *isl_basic_map_cow(struct isl_basic_map *bmap);
174 struct isl_set *isl_set_cow(struct isl_set *set);
175 struct isl_map *isl_map_cow(struct isl_map *map);
176
177 struct isl_basic_map *isl_basic_map_set_to_empty(struct isl_basic_map *bmap);
178 struct isl_basic_set *isl_basic_set_set_to_empty(struct isl_basic_set *bset);
179 struct isl_basic_set *isl_basic_set_order_divs(struct isl_basic_set *bset);
180 void isl_basic_map_swap_div(struct isl_basic_map *bmap, int a, int b);
181 struct isl_basic_map *isl_basic_map_order_divs(struct isl_basic_map *bmap);
182 __isl_give isl_map *isl_map_order_divs(__isl_take isl_map *map);
183 struct isl_basic_map *isl_basic_map_align_divs(
184                 struct isl_basic_map *dst, struct isl_basic_map *src);
185 struct isl_basic_set *isl_basic_set_align_divs(
186                 struct isl_basic_set *dst, struct isl_basic_set *src);
187 struct isl_basic_map *isl_basic_map_gauss(
188         struct isl_basic_map *bmap, int *progress);
189 struct isl_basic_set *isl_basic_set_gauss(
190         struct isl_basic_set *bset, int *progress);
191 __isl_give isl_basic_set *isl_basic_set_sort_constraints(
192         __isl_take isl_basic_set *bset);
193 int isl_basic_map_fast_cmp(const __isl_keep isl_basic_map *bmap1,
194         const __isl_keep isl_basic_map *bmap2);
195 int isl_basic_set_fast_is_equal(__isl_keep isl_basic_set *bset1,
196         __isl_keep isl_basic_set *bset2);
197 int isl_basic_map_fast_is_equal(__isl_keep isl_basic_map *bmap1,
198         __isl_keep isl_basic_map *bmap2);
199 struct isl_basic_map *isl_basic_map_normalize_constraints(
200         struct isl_basic_map *bmap);
201 struct isl_basic_set *isl_basic_set_normalize_constraints(
202         struct isl_basic_set *bset);
203 struct isl_basic_map *isl_basic_map_implicit_equalities(
204                                                 struct isl_basic_map *bmap);
205 struct isl_basic_set *isl_basic_map_underlying_set(struct isl_basic_map *bmap);
206 __isl_give isl_basic_set *isl_basic_set_underlying_set(
207                 __isl_take isl_basic_set *bset);
208 struct isl_set *isl_map_underlying_set(struct isl_map *map);
209 struct isl_basic_map *isl_basic_map_overlying_set(struct isl_basic_set *bset,
210         struct isl_basic_map *like);
211 __isl_give isl_basic_set *isl_basic_set_drop_constraints_involving(
212         __isl_take isl_basic_set *bset, unsigned first, unsigned n);
213 __isl_give isl_basic_set *isl_basic_set_drop(__isl_take isl_basic_set *bset,
214         enum isl_dim_type type, unsigned first, unsigned n);
215 struct isl_basic_map *isl_basic_map_drop(struct isl_basic_map *bmap,
216         enum isl_dim_type type, unsigned first, unsigned n);
217 struct isl_set *isl_set_drop(struct isl_set *set,
218         enum isl_dim_type type, unsigned first, unsigned n);
219 struct isl_basic_set *isl_basic_set_drop_dims(
220                 struct isl_basic_set *bset, unsigned first, unsigned n);
221 struct isl_set *isl_set_drop_dims(
222                 struct isl_set *set, unsigned first, unsigned n);
223 struct isl_map *isl_map_drop_inputs(
224                 struct isl_map *map, unsigned first, unsigned n);
225 struct isl_map *isl_map_drop(struct isl_map *map,
226         enum isl_dim_type type, unsigned first, unsigned n);
227
228 struct isl_map *isl_map_remove_empty_parts(struct isl_map *map);
229 struct isl_set *isl_set_remove_empty_parts(struct isl_set *set);
230
231 struct isl_set *isl_set_normalize(struct isl_set *set);
232
233 struct isl_set *isl_set_drop_vars(
234                 struct isl_set *set, unsigned first, unsigned n);
235
236 struct isl_basic_map *isl_basic_map_eliminate_vars(
237         struct isl_basic_map *bmap, unsigned pos, unsigned n);
238 struct isl_basic_set *isl_basic_set_eliminate_vars(
239         struct isl_basic_set *bset, unsigned pos, unsigned n);
240
241 __isl_give isl_map *isl_map_eliminate(__isl_take isl_map *map,
242         enum isl_dim_type type, unsigned first, unsigned n);
243 __isl_give isl_set *isl_set_eliminate(__isl_take isl_set *set,
244         enum isl_dim_type type, unsigned first, unsigned n);
245
246 int isl_basic_set_constraint_is_redundant(struct isl_basic_set **bset,
247         isl_int *c, isl_int *opt_n, isl_int *opt_d);
248
249 int isl_basic_map_add_div_constraints(struct isl_basic_map *bmap, unsigned div);
250 struct isl_basic_map *isl_basic_map_drop_redundant_divs(
251         struct isl_basic_map *bmap);
252 struct isl_basic_set *isl_basic_set_drop_redundant_divs(
253         struct isl_basic_set *bset);
254
255 struct isl_basic_set *isl_basic_set_recession_cone(struct isl_basic_set *bset);
256 struct isl_basic_set *isl_basic_set_lineality_space(struct isl_basic_set *bset);
257
258 struct isl_basic_set *isl_basic_set_set_rational(struct isl_basic_set *bset);
259 __isl_give isl_basic_map *isl_basic_map_set_rational(
260         __isl_take isl_basic_map *bmap);
261
262 struct isl_mat;
263
264 struct isl_basic_set *isl_basic_set_preimage(struct isl_basic_set *bset,
265         struct isl_mat *mat);
266 struct isl_set *isl_set_preimage(struct isl_set *set, struct isl_mat *mat);
267
268 isl_int *isl_set_wrap_facet(__isl_keep isl_set *set,
269         isl_int *facet, isl_int *ridge);
270
271 int isl_basic_map_contains_point(__isl_keep isl_basic_map *bmap,
272         __isl_keep isl_point *point);
273 int isl_set_contains_point(__isl_keep isl_set *set, __isl_keep isl_point *point);
274
275 int isl_basic_set_vars_get_sign(__isl_keep isl_basic_set *bset,
276         unsigned first, unsigned n, int *signs);
277 int isl_set_foreach_orthant(__isl_keep isl_set *set,
278         int (*fn)(__isl_take isl_set *orthant, int *signs, void *user),
279         void *user);
280
281 int isl_basic_map_add_div_constraints_var(__isl_keep isl_basic_map *bmap,
282         unsigned pos, isl_int *div);
283 int isl_basic_set_add_div_constraints_var(__isl_keep isl_basic_set *bset,
284         unsigned pos, isl_int *div);
285 int isl_basic_map_is_div_constraint(__isl_keep isl_basic_map *bmap,
286         isl_int *constraint, unsigned div);
287
288 #endif