add some memory management annotations
[isl.git] / include / isl_dim.h
blob5e1f71feb226154fa89c1b8d35ea705a66c8a58e
1 #ifndef ISL_DIM_H
2 #define ISL_DIM_H
4 #include <isl_ctx.h>
6 #if defined(__cplusplus)
7 extern "C" {
8 #endif
10 struct isl_name;
11 struct isl_dim {
12 int ref;
14 struct isl_ctx *ctx;
16 unsigned nparam;
17 unsigned n_in; /* zero for sets */
18 unsigned n_out; /* dim for sets */
20 unsigned n_name;
21 struct isl_name **names;
23 typedef struct isl_dim isl_dim;
25 enum isl_dim_type {
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,
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);
42 struct isl_dim *isl_dim_set_name(struct isl_dim *dim,
43 enum isl_dim_type type, unsigned pos,
44 const char *name);
45 const char *isl_dim_get_name(struct isl_dim *dim,
46 enum isl_dim_type type, unsigned pos);
48 struct isl_dim *isl_dim_extend(struct isl_dim *dim,
49 unsigned nparam, unsigned n_in, unsigned n_out);
50 struct isl_dim *isl_dim_add(struct isl_dim *dim, enum isl_dim_type type,
51 unsigned n);
52 struct isl_dim *isl_dim_join(struct isl_dim *left, struct isl_dim *right);
53 struct isl_dim *isl_dim_product(struct isl_dim *left, struct isl_dim *right);
54 struct isl_dim *isl_dim_map(struct isl_dim *dim);
55 struct isl_dim *isl_dim_reverse(struct isl_dim *dim);
56 struct isl_dim *isl_dim_drop(struct isl_dim *dim, enum isl_dim_type type,
57 unsigned first, unsigned num);
58 struct isl_dim *isl_dim_drop_inputs(struct isl_dim *dim,
59 unsigned first, unsigned n);
60 struct isl_dim *isl_dim_drop_outputs(struct isl_dim *dim,
61 unsigned first, unsigned n);
62 struct isl_dim *isl_dim_domain(struct isl_dim *dim);
63 struct isl_dim *isl_dim_range(struct isl_dim *dim);
64 struct isl_dim *isl_dim_underlying(struct isl_dim *dim, unsigned n_div);
66 int isl_dim_equal(struct isl_dim *dim1, struct isl_dim *dim2);
67 int isl_dim_match(struct isl_dim *dim1, enum isl_dim_type dim1_type,
68 struct isl_dim *dim2, enum isl_dim_type dim2_type);
69 int isl_dim_compatible(struct isl_dim *dim1, struct isl_dim *dim2);
70 unsigned isl_dim_size(__isl_keep isl_dim *dim, enum isl_dim_type type);
71 unsigned isl_dim_total(struct isl_dim *dim);
73 #if defined(__cplusplus)
75 #endif
77 #endif