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         isl_space *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         isl_space *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_space(
 107         __isl_take isl_basic_set *bset, __isl_take isl_space *dim);
 108 __isl_give isl_basic_map *isl_basic_map_reset_space(
 109         __isl_take isl_basic_map *bmap, __isl_take isl_space *dim);
 110 __isl_give isl_map *isl_map_reset_space(__isl_take isl_map *map,
 111         __isl_take isl_space *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_space(struct isl_basic_map *base,
 127                 __isl_take isl_space *dim, unsigned extra,
 128                 unsigned n_eq, unsigned n_ineq);
 129 struct isl_basic_set *isl_basic_set_extend_space(struct isl_basic_set *base,
 130                 __isl_take isl_space *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 __isl_give isl_basic_set *isl_basic_set_alloc_space(__isl_take isl_space *dim,
 142                 unsigned extra, unsigned n_eq, unsigned n_ineq);
 143 __isl_give isl_set *isl_set_alloc_space(__isl_take isl_space *dim, int n,
 144         unsigned flags);
 145 __isl_give isl_basic_map *isl_basic_map_alloc_space(__isl_take isl_space *dim,
 146                 unsigned extra, unsigned n_eq, unsigned n_ineq);
 147 __isl_give isl_map *isl_map_alloc_space(__isl_take isl_space *dim, int n,
 148         unsigned flags);
 149
 150 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
 151
 152 int isl_basic_map_alloc_equality(struct isl_basic_map *bmap);
 153 int isl_basic_set_alloc_equality(struct isl_basic_set *bset);
 154 int isl_basic_set_free_inequality(struct isl_basic_set *bset, unsigned n);
 155 int isl_basic_map_free_equality(struct isl_basic_map *bmap, unsigned n);
 156 int isl_basic_set_free_equality(struct isl_basic_set *bset, unsigned n);
 157 int isl_basic_set_alloc_inequality(struct isl_basic_set *bset);
 158 int isl_basic_map_alloc_inequality(struct isl_basic_map *bmap);
 159 int isl_basic_map_free_inequality(struct isl_basic_map *bmap, unsigned n);
 160 int isl_basic_map_alloc_div(struct isl_basic_map *bmap);
 161 int isl_basic_set_alloc_div(struct isl_basic_set *bset);
 162 int isl_basic_map_free_div(struct isl_basic_map *bmap, unsigned n);
 163 int isl_basic_set_free_div(struct isl_basic_set *bset, unsigned n);
 164 void isl_basic_map_inequality_to_equality(
 165                 struct isl_basic_map *bmap, unsigned pos);
 166 int isl_basic_map_drop_equality(struct isl_basic_map *bmap, unsigned pos);
 167 int isl_basic_set_drop_equality(struct isl_basic_set *bset, unsigned pos);
 168 int isl_basic_set_drop_inequality(struct isl_basic_set *bset, unsigned pos);
 169 int isl_basic_map_drop_inequality(struct isl_basic_map *bmap, unsigned pos);
 170 __isl_give isl_basic_set *isl_basic_set_add_eq(__isl_take isl_basic_set *bset,
 171         isl_int *eq);
 172 __isl_give isl_basic_map *isl_basic_map_add_eq(__isl_take isl_basic_map *bmap,
 173         isl_int *eq);
 174 __isl_give isl_basic_set *isl_basic_set_add_ineq(__isl_take isl_basic_set *bset,
 175         isl_int *ineq);
 176 __isl_give isl_basic_map *isl_basic_map_add_ineq(__isl_take isl_basic_map *bmap,
 177         isl_int *ineq);
 178
 179 int isl_inequality_negate(struct isl_basic_map *bmap, unsigned pos);
 180
 181 struct isl_basic_set *isl_basic_set_cow(struct isl_basic_set *bset);
 182 struct isl_basic_map *isl_basic_map_cow(struct isl_basic_map *bmap);
 183 struct isl_set *isl_set_cow(struct isl_set *set);
 184 struct isl_map *isl_map_cow(struct isl_map *map);
 185
 186 struct isl_basic_map *isl_basic_map_set_to_empty(struct isl_basic_map *bmap);
 187 struct isl_basic_set *isl_basic_set_set_to_empty(struct isl_basic_set *bset);
 188 struct isl_basic_set *isl_basic_set_order_divs(struct isl_basic_set *bset);
 189 void isl_basic_map_swap_div(struct isl_basic_map *bmap, int a, int b);
 190 struct isl_basic_map *isl_basic_map_order_divs(struct isl_basic_map *bmap);
 191 __isl_give isl_map *isl_map_order_divs(__isl_take isl_map *map);
 192 struct isl_basic_map *isl_basic_map_align_divs(
 193                 struct isl_basic_map *dst, struct isl_basic_map *src);
 194 struct isl_basic_set *isl_basic_set_align_divs(
 195                 struct isl_basic_set *dst, struct isl_basic_set *src);
 196 struct isl_basic_map *isl_basic_map_gauss(
 197         struct isl_basic_map *bmap, int *progress);
 198 struct isl_basic_set *isl_basic_set_gauss(
 199         struct isl_basic_set *bset, int *progress);
 200 __isl_give isl_basic_set *isl_basic_set_sort_constraints(
 201         __isl_take isl_basic_set *bset);
 202 int isl_basic_map_plain_cmp(const __isl_keep isl_basic_map *bmap1,
 203         const __isl_keep isl_basic_map *bmap2);
 204 int isl_set_plain_cmp(const __isl_keep isl_set *set1,
 205         const __isl_keep isl_set *set2);
 206 int isl_basic_set_plain_is_equal(__isl_keep isl_basic_set *bset1,
 207         __isl_keep isl_basic_set *bset2);
 208 int isl_basic_map_plain_is_equal(__isl_keep isl_basic_map *bmap1,
 209         __isl_keep isl_basic_map *bmap2);
 210 struct isl_basic_map *isl_basic_map_normalize_constraints(
 211         struct isl_basic_map *bmap);
 212 struct isl_basic_set *isl_basic_set_normalize_constraints(
 213         struct isl_basic_set *bset);
 214 struct isl_basic_map *isl_basic_map_implicit_equalities(
 215                                                 struct isl_basic_map *bmap);
 216 struct isl_basic_set *isl_basic_map_underlying_set(struct isl_basic_map *bmap);
 217 __isl_give isl_basic_set *isl_basic_set_underlying_set(
 218                 __isl_take isl_basic_set *bset);
 219 struct isl_set *isl_map_underlying_set(struct isl_map *map);
 220 struct isl_basic_map *isl_basic_map_overlying_set(struct isl_basic_set *bset,
 221         struct isl_basic_map *like);
 222 __isl_give isl_basic_set *isl_basic_set_drop_constraints_involving(
 223         __isl_take isl_basic_set *bset, unsigned first, unsigned n);
 224 __isl_give isl_basic_set *isl_basic_set_drop(__isl_take isl_basic_set *bset,
 225         enum isl_dim_type type, unsigned first, unsigned n);
 226 struct isl_basic_map *isl_basic_map_drop(struct isl_basic_map *bmap,
 227         enum isl_dim_type type, unsigned first, unsigned n);
 228 struct isl_set *isl_set_drop(struct isl_set *set,
 229         enum isl_dim_type type, unsigned first, unsigned n);
 230 struct isl_basic_set *isl_basic_set_drop_dims(
 231                 struct isl_basic_set *bset, unsigned first, unsigned n);
 232 struct isl_set *isl_set_drop_dims(
 233                 struct isl_set *set, unsigned first, unsigned n);
 234 struct isl_map *isl_map_drop_inputs(
 235                 struct isl_map *map, unsigned first, unsigned n);
 236 struct isl_map *isl_map_drop(struct isl_map *map,
 237         enum isl_dim_type type, unsigned first, unsigned n);
 238
 239 struct isl_map *isl_map_remove_empty_parts(struct isl_map *map);
 240 struct isl_set *isl_set_remove_empty_parts(struct isl_set *set);
 241
 242 struct isl_set *isl_set_normalize(struct isl_set *set);
 243
 244 struct isl_set *isl_set_drop_vars(
 245                 struct isl_set *set, unsigned first, unsigned n);
 246
 247 struct isl_basic_map *isl_basic_map_eliminate_vars(
 248         struct isl_basic_map *bmap, unsigned pos, unsigned n);
 249 struct isl_basic_set *isl_basic_set_eliminate_vars(
 250         struct isl_basic_set *bset, unsigned pos, unsigned n);
 251
 252 __isl_give isl_map *isl_map_eliminate(__isl_take isl_map *map,
 253         enum isl_dim_type type, unsigned first, unsigned n);
 254 __isl_give isl_set *isl_set_eliminate(__isl_take isl_set *set,
 255         enum isl_dim_type type, unsigned first, unsigned n);
 256
 257 int isl_basic_set_constraint_is_redundant(struct isl_basic_set **bset,
 258         isl_int *c, isl_int *opt_n, isl_int *opt_d);
 259
 260 int isl_basic_map_add_div_constraints(struct isl_basic_map *bmap, unsigned div);
 261 struct isl_basic_map *isl_basic_map_drop_redundant_divs(
 262         struct isl_basic_map *bmap);
 263 struct isl_basic_set *isl_basic_set_drop_redundant_divs(
 264         struct isl_basic_set *bset);
 265
 266 struct isl_basic_set *isl_basic_set_recession_cone(struct isl_basic_set *bset);
 267 struct isl_basic_set *isl_basic_set_lineality_space(struct isl_basic_set *bset);
 268
 269 struct isl_basic_set *isl_basic_set_set_rational(struct isl_basic_set *bset);
 270 __isl_give isl_basic_map *isl_basic_map_set_rational(
 271         __isl_take isl_basic_map *bmap);
 272 __isl_give isl_map *isl_map_set_rational(__isl_take isl_map *map);
 273
 274 struct isl_mat;
 275
 276 struct isl_basic_set *isl_basic_set_preimage(struct isl_basic_set *bset,
 277         struct isl_mat *mat);
 278 struct isl_set *isl_set_preimage(struct isl_set *set, struct isl_mat *mat);
 279
 280 __isl_give isl_basic_set *isl_basic_set_transform_dims(
 281         __isl_take isl_basic_set *bset, enum isl_dim_type type, unsigned first,
 282         __isl_take isl_mat *trans);
 283
 284 isl_int *isl_set_wrap_facet(__isl_keep isl_set *set,
 285         isl_int *facet, isl_int *ridge);
 286
 287 int isl_basic_map_contains_point(__isl_keep isl_basic_map *bmap,
 288         __isl_keep isl_point *point);
 289 int isl_set_contains_point(__isl_keep isl_set *set, __isl_keep isl_point *point);
 290
 291 int isl_basic_set_vars_get_sign(__isl_keep isl_basic_set *bset,
 292         unsigned first, unsigned n, int *signs);
 293 int isl_set_foreach_orthant(__isl_keep isl_set *set,
 294         int (*fn)(__isl_take isl_set *orthant, int *signs, void *user),
 295         void *user);
 296
 297 int isl_basic_map_add_div_constraints_var(__isl_keep isl_basic_map *bmap,
 298         unsigned pos, isl_int *div);
 299 int isl_basic_set_add_div_constraints_var(__isl_keep isl_basic_set *bset,
 300         unsigned pos, isl_int *div);
 301 int isl_basic_map_is_div_constraint(__isl_keep isl_basic_map *bmap,
 302         isl_int *constraint, unsigned div);
 303 int isl_basic_set_is_div_constraint(__isl_keep isl_basic_set *bset,
 304         isl_int *constraint, unsigned div);
 305
 306 __isl_give isl_basic_set *isl_basic_set_from_local_space(
 307         __isl_take isl_local_space *ls);
 308 __isl_give isl_basic_map *isl_basic_map_from_local_space(
 309         __isl_take isl_local_space *ls);
 310 __isl_give isl_basic_set *isl_basic_set_expand_divs(
 311         __isl_take isl_basic_set *bset, __isl_take isl_mat *div, int *exp);
 312
 313 int isl_basic_map_divs_known(__isl_keep isl_basic_map *bmap);
 314 __isl_give isl_mat *isl_basic_map_get_divs(__isl_keep isl_basic_map *bmap);
 315
 316 __isl_give isl_map *isl_map_inline_foreach_basic_map(__isl_take isl_map *map,
 317         __isl_give isl_basic_map *(*fn)(__isl_take isl_basic_map *bmap));
 318
 319 __isl_give isl_map *isl_map_align_params_map_map_and(
 320         __isl_take isl_map *map1, __isl_take isl_map *map2,
 321         __isl_give isl_map *(*fn)(__isl_take isl_map *map1,
 322                                     __isl_take isl_map *map2));
 323 int isl_map_align_params_map_map_and_test(__isl_keep isl_map *map1,
 324         __isl_keep isl_map *map2,
 325         int (*fn)(__isl_keep isl_map *map1, __isl_keep isl_map *map2));
 326
 327 int isl_basic_map_foreach_lexopt(__isl_keep isl_basic_map *bmap, int max,
 328         int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_aff_list *list,
 329                   void *user),
 330         void *user);
 331 int isl_basic_set_foreach_lexopt(__isl_keep isl_basic_set *bset, int max,
 332         int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_aff_list *list,
 333                   void *user),
 334         void *user);
 335
 336 __isl_give isl_set *isl_set_substitute(__isl_take isl_set *set,
 337         enum isl_dim_type type, unsigned pos, __isl_keep isl_aff *subs);
 338
 339 __isl_give isl_set *isl_set_gist_params_basic_set(__isl_take isl_set *set,
 340         __isl_take isl_basic_set *context);
 341
 342 int isl_map_compatible_range(__isl_keep isl_map *map, __isl_keep isl_set *set);
 343
 344 int isl_basic_map_plain_is_single_valued(__isl_keep isl_basic_map *bmap);
 345
 346 #endif