add isl_map_flat_domain_product
[platform/upstream/isl.git] / include / isl / space.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_SPACE_H
11 #define ISL_SPACE_H
12
13 #include <isl/ctx.h>
14 #include <isl/id.h>
15 #include <isl/printer.h>
16
17 #if defined(__cplusplus)
18 extern "C" {
19 #endif
20
21 struct isl_space;
22 typedef struct isl_space isl_space;
23
24 enum isl_dim_type {
25         isl_dim_cst,
26         isl_dim_param,
27         isl_dim_in,
28         isl_dim_out,
29         isl_dim_set = isl_dim_out,
30         isl_dim_div,
31         isl_dim_all
32 };
33
34 isl_ctx *isl_space_get_ctx(__isl_keep isl_space *dim);
35 __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
36                         unsigned nparam, unsigned n_in, unsigned n_out);
37 __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
38                         unsigned nparam, unsigned dim);
39 __isl_give isl_space *isl_space_copy(__isl_keep isl_space *dim);
40 void isl_space_free(__isl_take isl_space *dim);
41
42 __isl_give isl_space *isl_space_set_tuple_name(__isl_take isl_space *dim,
43         enum isl_dim_type type, const char *s);
44 const char *isl_space_get_tuple_name(__isl_keep isl_space *dim,
45                                  enum isl_dim_type type);
46 __isl_give isl_space *isl_space_set_tuple_id(__isl_take isl_space *dim,
47         enum isl_dim_type type, __isl_take isl_id *id);
48 __isl_give isl_space *isl_space_reset_tuple_id(__isl_take isl_space *dim,
49         enum isl_dim_type type);
50 int isl_space_has_tuple_id(__isl_keep isl_space *dim, enum isl_dim_type type);
51 __isl_give isl_id *isl_space_get_tuple_id(__isl_keep isl_space *dim,
52         enum isl_dim_type type);
53
54 __isl_give isl_space *isl_space_set_dim_id(__isl_take isl_space *dim,
55         enum isl_dim_type type, unsigned pos, __isl_take isl_id *id);
56 int isl_space_has_dim_id(__isl_keep isl_space *dim,
57         enum isl_dim_type type, unsigned pos);
58 __isl_give isl_id *isl_space_get_dim_id(__isl_keep isl_space *dim,
59         enum isl_dim_type type, unsigned pos);
60
61 int isl_space_find_dim_by_id(__isl_keep isl_space *dim, enum isl_dim_type type,
62         __isl_keep isl_id *id);
63
64 __isl_give isl_space *isl_space_set_dim_name(__isl_take isl_space *dim,
65                                  enum isl_dim_type type, unsigned pos,
66                                  __isl_keep const char *name);
67 __isl_keep const char *isl_space_get_dim_name(__isl_keep isl_space *dim,
68                                  enum isl_dim_type type, unsigned pos);
69
70 __isl_give isl_space *isl_space_extend(__isl_take isl_space *dim,
71                         unsigned nparam, unsigned n_in, unsigned n_out);
72 __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *dim, enum isl_dim_type type,
73                 unsigned n);
74 __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *dim,
75         enum isl_dim_type dst_type, unsigned dst_pos,
76         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
77 __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *dim,
78         enum isl_dim_type type, unsigned pos, unsigned n);
79 __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
80         __isl_take isl_space *right);
81 __isl_give isl_space *isl_space_product(__isl_take isl_space *left,
82         __isl_take isl_space *right);
83 __isl_give isl_space *isl_space_domain_product(__isl_take isl_space *left,
84         __isl_take isl_space *right);
85 __isl_give isl_space *isl_space_range_product(__isl_take isl_space *left,
86         __isl_take isl_space *right);
87 __isl_give isl_space *isl_space_map_from_set(__isl_take isl_space *dim);
88 __isl_give isl_space *isl_space_reverse(__isl_take isl_space *dim);
89 __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *dim,
90         enum isl_dim_type type, unsigned first, unsigned num);
91 __isl_give isl_space *isl_space_drop_inputs(__isl_take isl_space *dim,
92                 unsigned first, unsigned n);
93 __isl_give isl_space *isl_space_drop_outputs(__isl_take isl_space *dim,
94                 unsigned first, unsigned n);
95 __isl_give isl_space *isl_space_domain(__isl_take isl_space *dim);
96 __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *dim);
97 __isl_give isl_space *isl_space_range(__isl_take isl_space *dim);
98 __isl_give isl_space *isl_space_from_range(__isl_take isl_space *dim);
99 __isl_give isl_space *isl_space_params(__isl_take isl_space *space);
100
101 __isl_give isl_space *isl_space_align_params(__isl_take isl_space *dim1,
102         __isl_take isl_space *dim2);
103
104 int isl_space_is_wrapping(__isl_keep isl_space *dim);
105 __isl_give isl_space *isl_space_wrap(__isl_take isl_space *dim);
106 __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *dim);
107
108 int isl_space_can_zip(__isl_keep isl_space *dim);
109 __isl_give isl_space *isl_space_zip(__isl_take isl_space *dim);
110
111 int isl_space_is_equal(__isl_keep isl_space *dim1, __isl_keep isl_space *dim2);
112 int isl_space_match(__isl_keep isl_space *dim1, enum isl_dim_type dim1_type,
113         __isl_keep isl_space *dim2, enum isl_dim_type dim2_type);
114 int isl_space_tuple_match(__isl_keep isl_space *dim1, enum isl_dim_type dim1_type,
115                         __isl_keep isl_space *dim2, enum isl_dim_type dim2_type);
116 int isl_space_compatible(__isl_keep isl_space *dim1,
117         __isl_keep isl_space *dim2);
118 unsigned isl_space_dim(__isl_keep isl_space *dim, enum isl_dim_type type);
119
120 __isl_give isl_printer *isl_printer_print_space(__isl_take isl_printer *p,
121         __isl_keep isl_space *dim);
122 void isl_space_dump(__isl_keep isl_space *dim);
123
124 #if defined(__cplusplus)
125 }
126 #endif
127
128 #endif