include/isl_map.h

   1 #ifndef ISL_MAP_H
   2 #define ISL_MAP_H
   3
   4 #include <stdio.h>
   5
   6 #include <isl_int.h>
   7 #include <isl_ctx.h>
   8 #include <isl_blk.h>
   9
  10 #if defined(__cplusplus)
  11 extern "C" {
  12 #endif
  13
  14 /* General notes:
  15  *
  16  * All structures are reference counted to allow reuse without duplication.
  17  * A *_copy operation will increase the reference count, while a *_free
  18  * operation will decrease the reference count and only actually release
  19  * the structures when the reference count drops to zero.
  20  *
  21  * Functions that return an isa structure will in general _destroy_
  22  * all argument isa structures (the obvious execption begin the _copy
  23  * functions).  A pointer passed to such a function may therefore
  24  * never be used after the function call.  If you want to keep a
  25  * reference to the old structure(s), use the appropriate _copy function.
  26  */
  27
  28 /* A "basic map" is a relation between two sets of variables,
  29  * called the "in" and "out" variables.
  30  *
  31  * It is implemented as a set with two extra fields:
  32  * n_in is the number of in variables
  33  * n_out is the number of out variables
  34  * n_in + n_out should be equal to set.dim
  35  */
  36 struct isl_vec;
  37 struct isl_basic_map {
  38         int ref;
  39 #define ISL_BASIC_MAP_FINAL             (1 << 0)
  40 #define ISL_BASIC_MAP_EMPTY             (1 << 1)
  41 #define ISL_BASIC_MAP_NO_IMPLICIT       (1 << 2)
  42 #define ISL_BASIC_MAP_NO_REDUNDANT      (1 << 3)
  43 #define ISL_BASIC_MAP_RATIONAL          (1 << 4)
  44 #define ISL_BASIC_MAP_NORMALIZED        (1 << 5)
  45         unsigned flags;
  46
  47         struct isl_ctx *ctx;
  48
  49         unsigned nparam;
  50         unsigned n_in;
  51         unsigned n_out;
  52         unsigned extra;
  53
  54         unsigned n_eq;
  55         unsigned n_ineq;
  56
  57         size_t c_size;
  58         isl_int **eq;
  59         isl_int **ineq;
  60
  61         unsigned n_div;
  62
  63         isl_int **div;
  64
  65         struct isl_vec *sample;
  66
  67         struct isl_blk block;
  68         struct isl_blk block2;
  69 };
  70 struct isl_basic_set;
  71
  72 /* A "map" is a (disjoint) union of basic maps.
  73  *
  74  * Currently, the isl_set structure is identical to the isl_map structure
  75  * and the library depends on this correspondence internally.
  76  * However, users should not depend on this correspondence.
  77  */
  78 struct isl_map {
  79         int ref;
  80 #define ISL_MAP_DISJOINT                (1 << 0)
  81 #define ISL_MAP_NORMALIZED              (1 << 1)
  82         unsigned flags;
  83
  84         struct isl_ctx *ctx;
  85
  86         unsigned nparam;
  87         unsigned n_in;
  88         unsigned n_out;
  89
  90         int n;
  91
  92         size_t size;
  93         struct isl_basic_map *p[0];
  94 };
  95 struct isl_set;
  96
  97 struct isl_basic_map *isl_basic_map_alloc(struct isl_ctx *ctx,
  98                 unsigned nparam, unsigned in, unsigned out, unsigned extra,
  99                 unsigned n_eq, unsigned n_ineq);
 100 struct isl_basic_map *isl_basic_map_identity(struct isl_ctx *ctx,
 101                 unsigned nparam, unsigned dim);
 102 struct isl_basic_map *isl_basic_map_finalize(struct isl_basic_map *bmap);
 103 void isl_basic_map_free(struct isl_basic_map *bmap);
 104 struct isl_basic_map *isl_basic_map_copy(struct isl_basic_map *bmap);
 105 struct isl_basic_map *isl_basic_map_extend(struct isl_basic_map *base,
 106                 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
 107                 unsigned n_eq, unsigned n_ineq);
 108 struct isl_basic_map *isl_basic_map_equal(struct isl_ctx *ctx,
 109                 unsigned nparam, unsigned in, unsigned out, unsigned n_equal);
 110 struct isl_basic_map *isl_basic_map_less_at(struct isl_ctx *ctx,
 111                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 112 struct isl_basic_map *isl_basic_map_more_at(struct isl_ctx *ctx,
 113                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 114 struct isl_basic_map *isl_basic_map_empty(struct isl_ctx *ctx,
 115                 unsigned nparam, unsigned in, unsigned out);
 116 struct isl_basic_map *isl_basic_map_universe(struct isl_ctx *ctx,
 117                 unsigned nparam, unsigned in, unsigned out);
 118 struct isl_basic_map *isl_basic_map_convex_hull(struct isl_basic_map *bmap);
 119
 120 struct isl_basic_map *isl_basic_map_intersect_domain(
 121                 struct isl_basic_map *bmap,
 122                 struct isl_basic_set *bset);
 123 struct isl_basic_map *isl_basic_map_intersect(
 124                 struct isl_basic_map *bmap1,
 125                 struct isl_basic_map *bmap2);
 126 struct isl_map *isl_basic_map_union(
 127                 struct isl_basic_map *bmap1,
 128                 struct isl_basic_map *bmap2);
 129 struct isl_basic_map *isl_basic_map_apply_domain(
 130                 struct isl_basic_map *bmap1,
 131                 struct isl_basic_map *bmap2);
 132 struct isl_basic_map *isl_basic_map_apply_range(
 133                 struct isl_basic_map *bmap1,
 134                 struct isl_basic_map *bmap2);
 135 struct isl_basic_map *isl_basic_map_reverse(struct isl_basic_map *bmap);
 136 struct isl_basic_set *isl_basic_map_domain(struct isl_basic_map *bmap);
 137 struct isl_basic_set *isl_basic_map_range(struct isl_basic_map *bmap);
 138 struct isl_basic_map *isl_basic_map_from_basic_set(struct isl_basic_set *bset,
 139                 unsigned n_in, unsigned n_out);
 140 struct isl_basic_set *isl_basic_set_from_basic_map(struct isl_basic_map *bmap);
 141 struct isl_basic_map *isl_basic_map_simplify(struct isl_basic_map *bmap);
 142 #define ISL_FORMAT_POLYLIB      1
 143 #define ISL_FORMAT_OMEGA        2
 144 struct isl_basic_map *isl_basic_map_read_from_file(struct isl_ctx *ctx,
 145                 FILE *input, unsigned nparam, unsigned input_format);
 146
 147 struct isl_map *isl_basic_map_lexmax(
 148                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 149                 struct isl_set **empty);
 150 struct isl_map *isl_basic_map_lexmin(
 151                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 152                 struct isl_set **empty);
 153
 154 void isl_basic_map_dump(struct isl_basic_map *bmap, FILE *out, int indent);
 155
 156 int isl_basic_map_is_universe(struct isl_basic_map *bmap);
 157 int isl_basic_map_is_empty(struct isl_basic_map *bmap);
 158 int isl_basic_map_is_subset(struct isl_basic_map *bmap1,
 159                 struct isl_basic_map *bmap2);
 160 int isl_basic_map_is_strict_subset(struct isl_basic_map *bmap1,
 161                 struct isl_basic_map *bmap2);
 162
 163 struct isl_map *isl_map_alloc(struct isl_ctx *ctx,
 164                 unsigned nparam, unsigned in, unsigned out, int n,
 165                 unsigned flags);
 166 struct isl_map *isl_map_empty(struct isl_ctx *ctx,
 167                 unsigned nparam, unsigned in, unsigned out);
 168 struct isl_map *isl_map_dup(struct isl_map *map);
 169 struct isl_map *isl_map_add(struct isl_map *map, struct isl_basic_map *bmap);
 170 struct isl_map *isl_map_identity(struct isl_ctx *ctx,
 171                 unsigned nparam, unsigned dim);
 172 struct isl_map *isl_map_finalize(struct isl_map *map);
 173 void isl_map_free(struct isl_map *map);
 174 struct isl_map *isl_map_copy(struct isl_map *map);
 175 struct isl_map *isl_map_extend(struct isl_map *base,
 176                 unsigned nparam, unsigned n_in, unsigned n_out);
 177 struct isl_map *isl_map_reverse(struct isl_map *map);
 178 struct isl_map *isl_map_union(struct isl_map *map1, struct isl_map *map2);
 179 struct isl_map *isl_map_union_disjoint(
 180                         struct isl_map *map1, struct isl_map *map2);
 181 struct isl_map *isl_map_intersect_domain(
 182                 struct isl_map *map,
 183                 struct isl_set *set);
 184 struct isl_map *isl_map_intersect_range(
 185                 struct isl_map *map,
 186                 struct isl_set *set);
 187 struct isl_map *isl_map_apply_domain(
 188                 struct isl_map *map1,
 189                 struct isl_map *map2);
 190 struct isl_map *isl_map_apply_range(
 191                 struct isl_map *map1,
 192                 struct isl_map *map2);
 193 struct isl_map *isl_map_intersect(struct isl_map *map1, struct isl_map *map2);
 194 struct isl_map *isl_map_subtract(struct isl_map *map1, struct isl_map *map2);
 195 struct isl_map *isl_map_fix_input_si(struct isl_map *map,
 196                 unsigned input, int value);
 197 struct isl_basic_set *isl_basic_map_deltas(struct isl_basic_map *bmap);
 198 struct isl_set *isl_map_deltas(struct isl_map *map);
 199 struct isl_set *isl_map_range(struct isl_map *map);
 200 struct isl_basic_map *isl_map_affine_hull(struct isl_map *map);
 201 struct isl_map *isl_map_remove_inputs(struct isl_map *map,
 202         unsigned first, unsigned n);
 203
 204 struct isl_set *isl_map_domain(struct isl_map *bmap);
 205 struct isl_map *isl_map_from_basic_map(struct isl_basic_map *bmap);
 206 struct isl_map *isl_map_from_set(struct isl_set *set,
 207                 unsigned n_in, unsigned n_out);
 208 struct isl_set *isl_set_from_map(struct isl_map *map);
 209
 210 int isl_map_is_empty(struct isl_map *map);
 211 int isl_map_is_subset(struct isl_map *map1, struct isl_map *map2);
 212 int isl_map_is_equal(struct isl_map *map1, struct isl_map *map2);
 213
 214 void isl_map_dump(struct isl_map *map, FILE *out, int indent);
 215
 216 int isl_map_fast_input_is_fixed(struct isl_map *map,
 217                 unsigned in, isl_int *val);
 218
 219 int isl_map_fast_is_equal(struct isl_map *map1, struct isl_map *map2);
 220
 221 #if defined(__cplusplus)
 222 }
 223 #endif
 224
 225 #endif