isl_map_private.h

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  *
   4  * Use of this software is governed by the MIT 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 #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>
  24
  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.
  29  *
  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
  34  */
  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;
  56
  57         struct isl_ctx *ctx;
  58
  59         isl_space *dim;
  60         unsigned extra;
  61
  62         unsigned n_eq;
  63         unsigned n_ineq;
  64
  65         size_t c_size;
  66         isl_int **eq;
  67         isl_int **ineq;
  68
  69         unsigned n_div;
  70
  71         isl_int **div;
  72
  73         struct isl_vec *sample;
  74
  75         struct isl_blk block;
  76         struct isl_blk block2;
  77 };
  78
  79 #undef EL
  80 #define EL isl_basic_set
  81
  82 #include <isl_list_templ.h>
  83
  84 /* A "map" is a (possibly disjoint) union of basic maps.
  85  * A "set" is a (possibly disjoint) union of basic sets.
  86  *
  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.
  90  */
  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;
  98
  99         struct isl_ctx *ctx;
 100
 101         isl_space *dim;
 102
 103         int n;
 104
 105         size_t size;
 106         struct isl_basic_map *p[1];
 107 };
 108
 109 #undef EL
 110 #define EL isl_set
 111
 112 #include <isl_list_templ.h>
 113
 114 __isl_give isl_map *isl_map_realign(__isl_take isl_map *map,
 115         __isl_take isl_reordering *r);
 116 __isl_give isl_set *isl_set_realign(__isl_take isl_set *set,
 117         __isl_take isl_reordering *r);
 118
 119 __isl_give isl_map *isl_map_reset(__isl_take isl_map *map,
 120         enum isl_dim_type type);
 121
 122 __isl_give isl_basic_set *isl_basic_set_reset_space(
 123         __isl_take isl_basic_set *bset, __isl_take isl_space *dim);
 124 __isl_give isl_basic_map *isl_basic_map_reset_space(
 125         __isl_take isl_basic_map *bmap, __isl_take isl_space *dim);
 126 __isl_give isl_map *isl_map_reset_space(__isl_take isl_map *map,
 127         __isl_take isl_space *dim);
 128
 129 unsigned isl_basic_map_offset(struct isl_basic_map *bmap,
 130                                         enum isl_dim_type type);
 131 unsigned isl_basic_set_offset(struct isl_basic_set *bset,
 132                                         enum isl_dim_type type);
 133
 134 int isl_basic_map_may_be_set(__isl_keep isl_basic_map *bmap);
 135 int isl_map_may_be_set(__isl_keep isl_map *map);
 136 int isl_map_compatible_domain(struct isl_map *map, struct isl_set *set);
 137 int isl_basic_map_compatible_domain(struct isl_basic_map *bmap,
 138                 struct isl_basic_set *bset);
 139 int isl_basic_map_compatible_range(struct isl_basic_map *bmap,
 140                 struct isl_basic_set *bset);
 141
 142 struct isl_basic_map *isl_basic_map_extend_space(struct isl_basic_map *base,
 143                 __isl_take isl_space *dim, unsigned extra,
 144                 unsigned n_eq, unsigned n_ineq);
 145 struct isl_basic_set *isl_basic_set_extend_space(struct isl_basic_set *base,
 146                 __isl_take isl_space *dim, unsigned extra,
 147                 unsigned n_eq, unsigned n_ineq);
 148 struct isl_basic_set *isl_basic_set_add_constraints(struct isl_basic_set *bset1,
 149                 struct isl_basic_set *bset2, unsigned pos);
 150
 151 struct isl_map *isl_map_grow(struct isl_map *map, int n);
 152 struct isl_set *isl_set_grow(struct isl_set *set, int n);
 153
 154 int isl_basic_set_contains(struct isl_basic_set *bset, struct isl_vec *vec);
 155 int isl_basic_map_contains(struct isl_basic_map *bmap, struct isl_vec *vec);
 156
 157 __isl_give isl_basic_set *isl_basic_set_alloc_space(__isl_take isl_space *dim,
 158                 unsigned extra, unsigned n_eq, unsigned n_ineq);
 159 __isl_give isl_set *isl_set_alloc_space(__isl_take isl_space *dim, int n,
 160         unsigned flags);
 161 __isl_give isl_basic_map *isl_basic_map_alloc_space(__isl_take isl_space *dim,
 162                 unsigned extra, unsigned n_eq, unsigned n_ineq);
 163 __isl_give isl_map *isl_map_alloc_space(__isl_take isl_space *dim, int n,
 164         unsigned flags);
 165
 166 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
 167
 168 int isl_basic_map_alloc_equality(struct isl_basic_map *bmap);
 169 int isl_basic_set_alloc_equality(struct isl_basic_set *bset);
 170 int isl_basic_set_free_inequality(struct isl_basic_set *bset, unsigned n);
 171 int isl_basic_map_free_equality(struct isl_basic_map *bmap, unsigned n);
 172 int isl_basic_set_free_equality(struct isl_basic_set *bset, unsigned n);
 173 int isl_basic_set_alloc_inequality(struct isl_basic_set *bset);
 174 int isl_basic_map_alloc_inequality(struct isl_basic_map *bmap);
 175 int isl_basic_map_free_inequality(struct isl_basic_map *bmap, unsigned n);
 176 int isl_basic_map_alloc_div(struct isl_basic_map *bmap);
 177 int isl_basic_set_alloc_div(struct isl_basic_set *bset);
 178 int isl_basic_map_free_div(struct isl_basic_map *bmap, unsigned n);
 179 int isl_basic_set_free_div(struct isl_basic_set *bset, unsigned n);
 180 void isl_basic_map_inequality_to_equality(
 181                 struct isl_basic_map *bmap, unsigned pos);
 182 int isl_basic_map_drop_equality(struct isl_basic_map *bmap, unsigned pos);
 183 int isl_basic_set_drop_equality(struct isl_basic_set *bset, unsigned pos);
 184 int isl_basic_set_drop_inequality(struct isl_basic_set *bset, unsigned pos);
 185 int isl_basic_map_drop_inequality(struct isl_basic_map *bmap, unsigned pos);
 186 __isl_give isl_basic_set *isl_basic_set_add_eq(__isl_take isl_basic_set *bset,
 187         isl_int *eq);
 188 __isl_give isl_basic_map *isl_basic_map_add_eq(__isl_take isl_basic_map *bmap,
 189         isl_int *eq);
 190 __isl_give isl_basic_set *isl_basic_set_add_ineq(__isl_take isl_basic_set *bset,
 191         isl_int *ineq);
 192 __isl_give isl_basic_map *isl_basic_map_add_ineq(__isl_take isl_basic_map *bmap,
 193         isl_int *ineq);
 194
 195 int isl_inequality_negate(struct isl_basic_map *bmap, unsigned pos);
 196
 197 struct isl_basic_set *isl_basic_set_cow(struct isl_basic_set *bset);
 198 struct isl_basic_map *isl_basic_map_cow(struct isl_basic_map *bmap);
 199 struct isl_set *isl_set_cow(struct isl_set *set);
 200 struct isl_map *isl_map_cow(struct isl_map *map);
 201
 202 uint32_t isl_basic_map_get_hash(__isl_keep isl_basic_map *bmap);
 203
 204 struct isl_basic_map *isl_basic_map_set_to_empty(struct isl_basic_map *bmap);
 205 struct isl_basic_set *isl_basic_set_set_to_empty(struct isl_basic_set *bset);
 206 struct isl_basic_set *isl_basic_set_order_divs(struct isl_basic_set *bset);
 207 void isl_basic_map_swap_div(struct isl_basic_map *bmap, int a, int b);
 208 struct isl_basic_map *isl_basic_map_order_divs(struct isl_basic_map *bmap);
 209 __isl_give isl_map *isl_map_order_divs(__isl_take isl_map *map);
 210 struct isl_basic_map *isl_basic_map_align_divs(
 211                 struct isl_basic_map *dst, struct isl_basic_map *src);
 212 struct isl_basic_set *isl_basic_set_align_divs(
 213                 struct isl_basic_set *dst, struct isl_basic_set *src);
 214 __isl_give isl_map *isl_map_align_divs_to_basic_map_list(
 215         __isl_take isl_map *map, __isl_keep isl_basic_map_list *list);
 216 __isl_give isl_basic_map_list *isl_basic_map_list_align_divs_to_basic_map(
 217         __isl_take isl_basic_map_list *list, __isl_keep isl_basic_map *bmap);
 218 __isl_give isl_basic_map *isl_basic_map_sort_divs(
 219         __isl_take isl_basic_map *bmap);
 220 __isl_give isl_map *isl_map_sort_divs(__isl_take isl_map *map);
 221 struct isl_basic_map *isl_basic_map_gauss(
 222         struct isl_basic_map *bmap, int *progress);
 223 struct isl_basic_set *isl_basic_set_gauss(
 224         struct isl_basic_set *bset, int *progress);
 225 __isl_give isl_basic_set *isl_basic_set_sort_constraints(
 226         __isl_take isl_basic_set *bset);
 227 int isl_basic_map_plain_cmp(const __isl_keep isl_basic_map *bmap1,
 228         const __isl_keep isl_basic_map *bmap2);
 229 int isl_basic_map_plain_is_equal(__isl_keep isl_basic_map *bmap1,
 230         __isl_keep isl_basic_map *bmap2);
 231 struct isl_basic_map *isl_basic_map_normalize_constraints(
 232         struct isl_basic_map *bmap);
 233 struct isl_basic_set *isl_basic_set_normalize_constraints(
 234         struct isl_basic_set *bset);
 235 struct isl_basic_map *isl_basic_map_implicit_equalities(
 236                                                 struct isl_basic_map *bmap);
 237 struct isl_basic_set *isl_basic_map_underlying_set(struct isl_basic_map *bmap);
 238 __isl_give isl_basic_set *isl_basic_set_underlying_set(
 239                 __isl_take isl_basic_set *bset);
 240 __isl_give isl_basic_set_list *isl_basic_map_list_underlying_set(
 241         __isl_take isl_basic_map_list *list);
 242 struct isl_set *isl_map_underlying_set(struct isl_map *map);
 243 struct isl_basic_map *isl_basic_map_overlying_set(struct isl_basic_set *bset,
 244         struct isl_basic_map *like);
 245 __isl_give isl_basic_set *isl_basic_set_drop_constraints_involving(
 246         __isl_take isl_basic_set *bset, unsigned first, unsigned n);
 247 __isl_give isl_basic_set *isl_basic_set_drop(__isl_take isl_basic_set *bset,
 248         enum isl_dim_type type, unsigned first, unsigned n);
 249 struct isl_basic_map *isl_basic_map_drop(struct isl_basic_map *bmap,
 250         enum isl_dim_type type, unsigned first, unsigned n);
 251 struct isl_set *isl_set_drop(struct isl_set *set,
 252         enum isl_dim_type type, unsigned first, unsigned n);
 253 struct isl_basic_set *isl_basic_set_drop_dims(
 254                 struct isl_basic_set *bset, unsigned first, unsigned n);
 255 struct isl_set *isl_set_drop_dims(
 256                 struct isl_set *set, unsigned first, unsigned n);
 257 struct isl_map *isl_map_drop_inputs(
 258                 struct isl_map *map, unsigned first, unsigned n);
 259 struct isl_map *isl_map_drop(struct isl_map *map,
 260         enum isl_dim_type type, unsigned first, unsigned n);
 261
 262 __isl_give isl_basic_map *isl_basic_map_remove_duplicate_constraints(
 263         __isl_take isl_basic_map *bmap, int *progress, int detect_divs);
 264 __isl_give isl_basic_map *isl_basic_map_detect_inequality_pairs(
 265         __isl_take isl_basic_map *bmap, int *progress);
 266
 267 struct isl_map *isl_map_remove_empty_parts(struct isl_map *map);
 268 struct isl_set *isl_set_remove_empty_parts(struct isl_set *set);
 269 __isl_give isl_map *isl_map_remove_obvious_duplicates(__isl_take isl_map *map);
 270
 271 struct isl_set *isl_set_normalize(struct isl_set *set);
 272
 273 struct isl_set *isl_set_drop_vars(
 274                 struct isl_set *set, unsigned first, unsigned n);
 275
 276 struct isl_basic_map *isl_basic_map_eliminate_vars(
 277         struct isl_basic_map *bmap, unsigned pos, unsigned n);
 278 struct isl_basic_set *isl_basic_set_eliminate_vars(
 279         struct isl_basic_set *bset, unsigned pos, unsigned n);
 280
 281 __isl_give isl_map *isl_map_eliminate(__isl_take isl_map *map,
 282         enum isl_dim_type type, unsigned first, unsigned n);
 283 __isl_give isl_set *isl_set_eliminate(__isl_take isl_set *set,
 284         enum isl_dim_type type, unsigned first, unsigned n);
 285
 286 int isl_basic_set_constraint_is_redundant(struct isl_basic_set **bset,
 287         isl_int *c, isl_int *opt_n, isl_int *opt_d);
 288
 289 int isl_basic_map_add_div_constraint(__isl_keep isl_basic_map *bmap,
 290         unsigned div, int sign);
 291 int isl_basic_map_add_div_constraints(struct isl_basic_map *bmap, unsigned div);
 292 __isl_give isl_basic_map *isl_basic_map_add_known_div_constraints(
 293         __isl_take isl_basic_map *bmap);
 294 struct isl_basic_map *isl_basic_map_drop_redundant_divs(
 295         struct isl_basic_map *bmap);
 296 struct isl_basic_set *isl_basic_set_drop_redundant_divs(
 297         struct isl_basic_set *bset);
 298
 299 struct isl_basic_set *isl_basic_set_recession_cone(struct isl_basic_set *bset);
 300 struct isl_basic_set *isl_basic_set_lineality_space(struct isl_basic_set *bset);
 301
 302 struct isl_basic_set *isl_basic_set_set_rational(struct isl_basic_set *bset);
 303 __isl_give isl_set *isl_set_set_rational(__isl_take isl_set *set);
 304 __isl_give isl_basic_map *isl_basic_map_set_rational(
 305         __isl_take isl_basic_map *bmap);
 306 __isl_give isl_map *isl_map_set_rational(__isl_take isl_map *map);
 307
 308 int isl_map_has_rational(__isl_keep isl_map *map);
 309 int isl_set_has_rational(__isl_keep isl_set *set);
 310
 311 struct isl_mat;
 312
 313 struct isl_basic_set *isl_basic_set_preimage(struct isl_basic_set *bset,
 314         struct isl_mat *mat);
 315 struct isl_set *isl_set_preimage(struct isl_set *set, struct isl_mat *mat);
 316
 317 __isl_give isl_basic_set *isl_basic_set_transform_dims(
 318         __isl_take isl_basic_set *bset, enum isl_dim_type type, unsigned first,
 319         __isl_take isl_mat *trans);
 320
 321 isl_int *isl_set_wrap_facet(__isl_keep isl_set *set,
 322         isl_int *facet, isl_int *ridge);
 323
 324 int isl_basic_map_contains_point(__isl_keep isl_basic_map *bmap,
 325         __isl_keep isl_point *point);
 326 int isl_set_contains_point(__isl_keep isl_set *set, __isl_keep isl_point *point);
 327
 328 int isl_basic_set_vars_get_sign(__isl_keep isl_basic_set *bset,
 329         unsigned first, unsigned n, int *signs);
 330 int isl_set_foreach_orthant(__isl_keep isl_set *set,
 331         int (*fn)(__isl_take isl_set *orthant, int *signs, void *user),
 332         void *user);
 333
 334 int isl_basic_map_add_div_constraints_var(__isl_keep isl_basic_map *bmap,
 335         unsigned pos, isl_int *div);
 336 int isl_basic_set_add_div_constraints_var(__isl_keep isl_basic_set *bset,
 337         unsigned pos, isl_int *div);
 338 int isl_basic_map_is_div_constraint(__isl_keep isl_basic_map *bmap,
 339         isl_int *constraint, unsigned div);
 340 int isl_basic_set_is_div_constraint(__isl_keep isl_basic_set *bset,
 341         isl_int *constraint, unsigned div);
 342
 343 __isl_give isl_basic_set *isl_basic_set_from_local_space(
 344         __isl_take isl_local_space *ls);
 345 __isl_give isl_basic_map *isl_basic_map_from_local_space(
 346         __isl_take isl_local_space *ls);
 347 __isl_give isl_basic_set *isl_basic_set_expand_divs(
 348         __isl_take isl_basic_set *bset, __isl_take isl_mat *div, int *exp);
 349
 350 int isl_basic_map_divs_known(__isl_keep isl_basic_map *bmap);
 351 __isl_give isl_mat *isl_basic_set_get_divs(__isl_keep isl_basic_set *bset);
 352 __isl_give isl_mat *isl_basic_map_get_divs(__isl_keep isl_basic_map *bmap);
 353
 354 __isl_give isl_map *isl_map_inline_foreach_basic_map(__isl_take isl_map *map,
 355         __isl_give isl_basic_map *(*fn)(__isl_take isl_basic_map *bmap));
 356
 357 __isl_give isl_map *isl_map_align_params_map_map_and(
 358         __isl_take isl_map *map1, __isl_take isl_map *map2,
 359         __isl_give isl_map *(*fn)(__isl_take isl_map *map1,
 360                                     __isl_take isl_map *map2));
 361 int isl_map_align_params_map_map_and_test(__isl_keep isl_map *map1,
 362         __isl_keep isl_map *map2,
 363         int (*fn)(__isl_keep isl_map *map1, __isl_keep isl_map *map2));
 364
 365 int isl_basic_map_foreach_lexopt(__isl_keep isl_basic_map *bmap, int max,
 366         int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_aff_list *list,
 367                   void *user),
 368         void *user);
 369 int isl_basic_set_foreach_lexopt(__isl_keep isl_basic_set *bset, int max,
 370         int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_aff_list *list,
 371                   void *user),
 372         void *user);
 373
 374 __isl_give isl_set *isl_set_substitute(__isl_take isl_set *set,
 375         enum isl_dim_type type, unsigned pos, __isl_keep isl_aff *subs);
 376
 377 __isl_give isl_set *isl_set_gist_params_basic_set(__isl_take isl_set *set,
 378         __isl_take isl_basic_set *context);
 379
 380 int isl_map_compatible_range(__isl_keep isl_map *map, __isl_keep isl_set *set);
 381
 382 int isl_basic_map_plain_is_single_valued(__isl_keep isl_basic_map *bmap);
 383
 384 int isl_map_is_set(__isl_keep isl_map *map);
 385
 386 int isl_basic_set_plain_dim_is_fixed(__isl_keep isl_basic_set *bset,
 387         unsigned dim, isl_int *val);
 388
 389 __isl_give isl_basic_map *isl_basic_map_plain_affine_hull(
 390         __isl_take isl_basic_map *bmap);
 391
 392 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
 393         int pos, isl_int *modulo, isl_int *residue);
 394 int isl_set_dim_residue_class(struct isl_set *set,
 395         int pos, isl_int *modulo, isl_int *residue);
 396
 397 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
 398         enum isl_dim_type type, unsigned pos, isl_int value);
 399 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
 400         enum isl_dim_type type, unsigned pos, isl_int value);
 401 int isl_map_plain_is_fixed(__isl_keep isl_map *map,
 402         enum isl_dim_type type, unsigned pos, isl_int *val);
 403
 404 int isl_basic_map_output_defining_equality(__isl_keep isl_basic_map *bmap,
 405         int pos);
 406
 407 __isl_give isl_basic_map *isl_basic_map_reduce_coefficients(
 408         __isl_take isl_basic_map *bmap);
 409
 410 __isl_give isl_basic_map *isl_basic_map_shift_div(
 411         __isl_take isl_basic_map *bmap, int div, isl_int shift);
 412
 413 __isl_give isl_basic_map_list *isl_map_get_basic_map_list(
 414         __isl_keep isl_map *map);
 415
 416 __isl_give isl_map *isl_map_fixed_power(__isl_take isl_map *map, isl_int exp);
 417
 418 int isl_basic_set_count_upto(__isl_keep isl_basic_set *bset,
 419         isl_int max, isl_int *count);
 420 int isl_set_count_upto(__isl_keep isl_set *set, isl_int max, isl_int *count);
 421
 422 #endif