Merge branch 'maint'
[platform/upstream/isl.git] / include / isl / dim.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_DIM_H
11 #define ISL_DIM_H
12
13 #include <isl/ctx.h>
14 #include <isl/printer.h>
15
16 #if defined(__cplusplus)
17 extern "C" {
18 #endif
19
20 struct isl_dim;
21 typedef struct isl_dim isl_dim;
22
23 enum isl_dim_type {
24         isl_dim_cst,
25         isl_dim_param,
26         isl_dim_in,
27         isl_dim_out,
28         isl_dim_set = isl_dim_out,
29         isl_dim_div,
30         isl_dim_all
31 };
32
33 isl_ctx *isl_dim_get_ctx(__isl_keep isl_dim *dim);
34 __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
35                         unsigned nparam, unsigned n_in, unsigned n_out);
36 __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
37                         unsigned nparam, unsigned dim);
38 __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
39 struct isl_dim *isl_dim_cow(struct isl_dim *dim);
40 void isl_dim_free(__isl_take isl_dim *dim);
41
42 __isl_give isl_dim *isl_dim_set_tuple_name(__isl_take isl_dim *dim,
43         enum isl_dim_type type, const char *s);
44 const char *isl_dim_get_tuple_name(__isl_keep isl_dim *dim,
45                                  enum isl_dim_type type);
46
47 __isl_give isl_dim *isl_dim_set_name(__isl_take isl_dim *dim,
48                                  enum isl_dim_type type, unsigned pos,
49                                  __isl_keep const char *name);
50 __isl_keep const char *isl_dim_get_name(__isl_keep isl_dim *dim,
51                                  enum isl_dim_type type, unsigned pos);
52
53 struct isl_dim *isl_dim_extend(struct isl_dim *dim,
54                         unsigned nparam, unsigned n_in, unsigned n_out);
55 __isl_give isl_dim *isl_dim_add(__isl_take isl_dim *dim, enum isl_dim_type type,
56                 unsigned n);
57 __isl_give isl_dim *isl_dim_move(__isl_take isl_dim *dim,
58         enum isl_dim_type dst_type, unsigned dst_pos,
59         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
60 __isl_give isl_dim *isl_dim_insert(__isl_take isl_dim *dim,
61         enum isl_dim_type type, unsigned pos, unsigned n);
62 __isl_give isl_dim *isl_dim_join(__isl_take isl_dim *left,
63         __isl_take isl_dim *right);
64 struct isl_dim *isl_dim_product(struct isl_dim *left, struct isl_dim *right);
65 __isl_give isl_dim *isl_dim_range_product(__isl_take isl_dim *left,
66         __isl_take isl_dim *right);
67 __isl_give isl_dim *isl_dim_map_from_set(__isl_take isl_dim *dim);
68 __isl_give isl_dim *isl_dim_reverse(__isl_take isl_dim *dim);
69 __isl_give isl_dim *isl_dim_drop(__isl_take isl_dim *dim,
70         enum isl_dim_type type, unsigned first, unsigned num);
71 struct isl_dim *isl_dim_drop_inputs(struct isl_dim *dim,
72                 unsigned first, unsigned n);
73 struct isl_dim *isl_dim_drop_outputs(struct isl_dim *dim,
74                 unsigned first, unsigned n);
75 __isl_give isl_dim *isl_dim_domain(__isl_take isl_dim *dim);
76 __isl_give isl_dim *isl_dim_from_domain(__isl_take isl_dim *dim);
77 __isl_give isl_dim *isl_dim_range(__isl_take isl_dim *dim);
78 __isl_give isl_dim *isl_dim_from_range(__isl_take isl_dim *dim);
79 struct isl_dim *isl_dim_underlying(struct isl_dim *dim, unsigned n_div);
80
81 __isl_give isl_dim *isl_dim_align_params(__isl_take isl_dim *dim1,
82         __isl_take isl_dim *dim2);
83
84 int isl_dim_is_wrapping(__isl_keep isl_dim *dim);
85 __isl_give isl_dim *isl_dim_wrap(__isl_take isl_dim *dim);
86 __isl_give isl_dim *isl_dim_unwrap(__isl_take isl_dim *dim);
87
88 int isl_dim_can_zip(__isl_keep isl_dim *dim);
89 __isl_give isl_dim *isl_dim_zip(__isl_take isl_dim *dim);
90
91 int isl_dim_equal(struct isl_dim *dim1, struct isl_dim *dim2);
92 int isl_dim_match(struct isl_dim *dim1, enum isl_dim_type dim1_type,
93                 struct isl_dim *dim2, enum isl_dim_type dim2_type);
94 int isl_dim_tuple_match(__isl_keep isl_dim *dim1, enum isl_dim_type dim1_type,
95                         __isl_keep isl_dim *dim2, enum isl_dim_type dim2_type);
96 int isl_dim_compatible(struct isl_dim *dim1, struct isl_dim *dim2);
97 unsigned isl_dim_size(__isl_keep isl_dim *dim, enum isl_dim_type type);
98 unsigned isl_dim_total(struct isl_dim *dim);
99
100 __isl_give isl_printer *isl_printer_print_dim(__isl_take isl_printer *p,
101         __isl_keep isl_dim *dim);
102 void isl_dim_dump(__isl_keep isl_dim *dim);
103
104 #if defined(__cplusplus)
105 }
106 #endif
107
108 #endif