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         unsigned flags;
  45
  46         struct isl_ctx *ctx;
  47
  48         unsigned nparam;
  49         unsigned n_in;
  50         unsigned n_out;
  51         unsigned extra;
  52
  53         unsigned n_eq;
  54         unsigned n_ineq;
  55
  56         size_t c_size;
  57         isl_int **eq;
  58         isl_int **ineq;
  59
  60         unsigned n_div;
  61
  62         isl_int **div;
  63
  64         struct isl_vec *sample;
  65
  66         struct isl_blk block;
  67         struct isl_blk block2;
  68 };
  69 struct isl_basic_set;
  70
  71 /* A "map" is a (disjoint) union of basic maps.
  72  *
  73  * Currently, the isl_set structure is identical to the isl_map structure
  74  * and the library depends on this correspondence internally.
  75  * However, users should not depend on this correspondence.
  76  */
  77 struct isl_map {
  78         int ref;
  79 #define ISL_MAP_DISJOINT                (1 << 0)
  80         unsigned flags;
  81
  82         struct isl_ctx *ctx;
  83
  84         unsigned nparam;
  85         unsigned n_in;
  86         unsigned n_out;
  87
  88         int n;
  89
  90         size_t size;
  91         struct isl_basic_map *p[0];
  92 };
  93 struct isl_set;
  94
  95 struct isl_basic_map *isl_basic_map_alloc(struct isl_ctx *ctx,
  96                 unsigned nparam, unsigned in, unsigned out, unsigned extra,
  97                 unsigned n_eq, unsigned n_ineq);
  98 struct isl_basic_map *isl_basic_map_identity(struct isl_ctx *ctx,
  99                 unsigned nparam, unsigned dim);
 100 struct isl_basic_map *isl_basic_map_finalize(struct isl_basic_map *bmap);
 101 void isl_basic_map_free(struct isl_basic_map *bmap);
 102 struct isl_basic_map *isl_basic_map_copy(struct isl_basic_map *bmap);
 103 struct isl_basic_map *isl_basic_map_extend(struct isl_basic_map *base,
 104                 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
 105                 unsigned n_eq, unsigned n_ineq);
 106 struct isl_basic_map *isl_basic_map_equal(struct isl_ctx *ctx,
 107                 unsigned nparam, unsigned in, unsigned out, unsigned n_equal);
 108 struct isl_basic_map *isl_basic_map_less_at(struct isl_ctx *ctx,
 109                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 110 struct isl_basic_map *isl_basic_map_more_at(struct isl_ctx *ctx,
 111                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 112 struct isl_basic_map *isl_basic_map_empty(struct isl_ctx *ctx,
 113                 unsigned nparam, unsigned in, unsigned out);
 114 struct isl_basic_map *isl_basic_map_universe(struct isl_ctx *ctx,
 115                 unsigned nparam, unsigned in, unsigned out);
 116
 117 struct isl_basic_map *isl_basic_map_intersect_domain(
 118                 struct isl_basic_map *bmap,
 119                 struct isl_basic_set *bset);
 120 struct isl_basic_map *isl_basic_map_intersect(
 121                 struct isl_basic_map *bmap1,
 122                 struct isl_basic_map *bmap2);
 123 struct isl_map *isl_basic_map_union(
 124                 struct isl_basic_map *bmap1,
 125                 struct isl_basic_map *bmap2);
 126 struct isl_basic_map *isl_basic_map_apply_domain(
 127                 struct isl_basic_map *bmap1,
 128                 struct isl_basic_map *bmap2);
 129 struct isl_basic_map *isl_basic_map_apply_range(
 130                 struct isl_basic_map *bmap1,
 131                 struct isl_basic_map *bmap2);
 132 struct isl_basic_map *isl_basic_map_reverse(struct isl_basic_map *bmap);
 133 struct isl_basic_set *isl_basic_map_domain(struct isl_basic_map *bmap);
 134 struct isl_basic_set *isl_basic_map_range(struct isl_basic_map *bmap);
 135 struct isl_basic_map *isl_basic_map_from_basic_set(struct isl_basic_set *bset,
 136                 unsigned n_in, unsigned n_out);
 137 struct isl_basic_set *isl_basic_set_from_basic_map(struct isl_basic_map *bmap);
 138 struct isl_basic_map *isl_basic_map_simplify(struct isl_basic_map *bmap);
 139 #define ISL_FORMAT_POLYLIB      1
 140 #define ISL_FORMAT_OMEGA        2
 141 struct isl_basic_map *isl_basic_map_read_from_file(struct isl_ctx *ctx,
 142                 FILE *input, unsigned nparam, unsigned input_format);
 143
 144 struct isl_map *isl_basic_map_lexmax(
 145                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 146                 struct isl_set **empty);
 147 struct isl_map *isl_basic_map_lexmin(
 148                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 149                 struct isl_set **empty);
 150
 151 void isl_basic_map_dump(struct isl_basic_map *bmap, FILE *out, int indent);
 152
 153 int isl_basic_map_is_universe(struct isl_basic_map *bmap);
 154 int isl_basic_map_is_empty(struct isl_basic_map *bmap);
 155 int isl_basic_map_is_subset(struct isl_basic_map *bmap1,
 156                 struct isl_basic_map *bmap2);
 157 int isl_basic_map_is_strict_subset(struct isl_basic_map *bmap1,
 158                 struct isl_basic_map *bmap2);
 159
 160 struct isl_map *isl_map_alloc(struct isl_ctx *ctx,
 161                 unsigned nparam, unsigned in, unsigned out, int n,
 162                 unsigned flags);
 163 struct isl_map *isl_map_empty(struct isl_ctx *ctx,
 164                 unsigned nparam, unsigned in, unsigned out);
 165 struct isl_map *isl_map_dup(struct isl_map *map);
 166 struct isl_map *isl_map_add(struct isl_map *map, struct isl_basic_map *bmap);
 167 struct isl_map *isl_map_identity(struct isl_ctx *ctx,
 168                 unsigned nparam, unsigned dim);
 169 struct isl_map *isl_map_finalize(struct isl_map *map);
 170 void isl_map_free(struct isl_map *map);
 171 struct isl_map *isl_map_copy(struct isl_map *map);
 172 struct isl_map *isl_map_extend(struct isl_map *base,
 173                 unsigned nparam, unsigned n_in, unsigned n_out);
 174 struct isl_map *isl_map_reverse(struct isl_map *map);
 175 struct isl_map *isl_map_union(struct isl_map *map1, struct isl_map *map2);
 176 struct isl_map *isl_map_union_disjoint(
 177                         struct isl_map *map1, struct isl_map *map2);
 178 struct isl_map *isl_map_intersect_domain(
 179                 struct isl_map *map,
 180                 struct isl_set *set);
 181 struct isl_map *isl_map_intersect_range(
 182                 struct isl_map *map,
 183                 struct isl_set *set);
 184 struct isl_map *isl_map_apply_domain(
 185                 struct isl_map *map1,
 186                 struct isl_map *map2);
 187 struct isl_map *isl_map_apply_range(
 188                 struct isl_map *map1,
 189                 struct isl_map *map2);
 190 struct isl_map *isl_map_intersect(struct isl_map *map1, struct isl_map *map2);
 191 struct isl_map *isl_map_subtract(struct isl_map *map1, struct isl_map *map2);
 192 struct isl_map *isl_map_fix_input_si(struct isl_map *map,
 193                 unsigned input, int value);
 194 struct isl_basic_set *isl_basic_map_deltas(struct isl_basic_map *bmap);
 195 struct isl_set *isl_map_range(struct isl_map *map);
 196 struct isl_basic_map *isl_map_affine_hull(struct isl_map *map);
 197
 198 struct isl_set *isl_map_domain(struct isl_map *bmap);
 199 struct isl_map *isl_map_from_basic_map(struct isl_basic_map *bmap);
 200 struct isl_map *isl_map_from_set(struct isl_set *set,
 201                 unsigned n_in, unsigned n_out);
 202
 203 int isl_map_is_empty(struct isl_map *map);
 204 int isl_map_is_subset(struct isl_map *map1, struct isl_map *map2);
 205 int isl_map_is_equal(struct isl_map *map1, struct isl_map *map2);
 206
 207 void isl_map_dump(struct isl_map *map, FILE *out, int indent);
 208
 209 #if defined(__cplusplus)
 210 }
 211 #endif
 212
 213 #endif