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