add isl_obj_schedule
[isl.git] / isl_schedule_tree.h
blob34a439b018357e201553ac2161c47052cdc826d1
1 #ifndef ISL_SCHEDLUE_TREE_H
2 #define ISL_SCHEDLUE_TREE_H
4 #include <isl_schedule_band.h>
5 #include <isl/schedule.h>
6 #include <isl/set.h>
7 #include <isl/union_set.h>
9 struct isl_schedule_tree;
10 typedef struct isl_schedule_tree isl_schedule_tree;
12 ISL_DECLARE_LIST(schedule_tree)
14 /* A schedule (sub)tree.
16 * The leaves of a tree are not explicitly represented inside
17 * the isl_schedule_tree. If a tree consists of only a leaf,
18 * then it is equal to the static object isl_schedule_tree_empty.
20 * ctx may be NULL if type is isl_schedule_node_leaf.
21 * In this case, ref has a negative value.
23 * The "band" field is valid when type is isl_schedule_node_band.
24 * The "domain" field is valid when type is isl_schedule_node_domain
25 * and introduces the statement instances scheduled by the tree.
26 * The "filter" field is valid when type is isl_schedule_node_filter
27 * and represents the statement instances selected by the node.
29 * The "children" field is valid for all types except
30 * isl_schedule_node_leaf. This field is NULL if there are
31 * no children (except for the implicit leaves).
33 struct isl_schedule_tree {
34 int ref;
35 isl_ctx *ctx;
36 enum isl_schedule_node_type type;
37 union {
38 isl_schedule_band *band;
39 isl_union_set *domain;
40 isl_union_set *filter;
42 isl_schedule_tree_list *children;
45 isl_ctx *isl_schedule_tree_get_ctx(__isl_keep isl_schedule_tree *tree);
46 enum isl_schedule_node_type isl_schedule_tree_get_type(
47 __isl_keep isl_schedule_tree *tree);
49 __isl_give isl_schedule_tree *isl_schedule_tree_leaf(isl_ctx *ctx);
50 int isl_schedule_tree_is_leaf(__isl_keep isl_schedule_tree *tree);
52 __isl_give isl_schedule_tree *isl_schedule_tree_copy(
53 __isl_keep isl_schedule_tree *tree);
54 __isl_null isl_schedule_tree *isl_schedule_tree_free(
55 __isl_take isl_schedule_tree *tree);
57 __isl_give isl_schedule_tree *isl_schedule_tree_from_band(
58 __isl_take isl_schedule_band *band);
59 __isl_give isl_schedule_tree *isl_schedule_tree_from_domain(
60 __isl_take isl_union_set *domain);
61 __isl_give isl_schedule_tree *isl_schedule_tree_from_filter(
62 __isl_take isl_union_set *filter);
63 __isl_give isl_schedule_tree *isl_schedule_tree_from_children(
64 enum isl_schedule_node_type type,
65 __isl_take isl_schedule_tree_list *list);
67 __isl_give isl_space *isl_schedule_tree_band_get_space(
68 __isl_keep isl_schedule_tree *tree);
69 __isl_give isl_multi_union_pw_aff *isl_schedule_tree_band_get_partial_schedule(
70 __isl_keep isl_schedule_tree *tree);
71 __isl_give isl_union_set *isl_schedule_tree_domain_get_domain(
72 __isl_keep isl_schedule_tree *tree);
73 __isl_give isl_schedule_tree *isl_schedule_tree_domain_set_domain(
74 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
75 __isl_give isl_union_set *isl_schedule_tree_filter_get_filter(
76 __isl_keep isl_schedule_tree *tree);
77 __isl_give isl_schedule_tree *isl_schedule_tree_filter_set_filter(
78 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
80 __isl_give isl_schedule_tree *isl_schedule_tree_first_schedule_descendant(
81 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_tree *leaf);
82 __isl_give isl_union_map *isl_schedule_tree_get_subtree_schedule_union_map(
83 __isl_keep isl_schedule_tree *tree);
85 unsigned isl_schedule_tree_band_n_member(__isl_keep isl_schedule_tree *tree);
87 int isl_schedule_tree_band_member_get_coincident(
88 __isl_keep isl_schedule_tree *tree, int pos);
89 __isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_coincident(
90 __isl_take isl_schedule_tree *tree, int pos, int coincident);
91 int isl_schedule_tree_band_get_permutable(__isl_keep isl_schedule_tree *tree);
92 __isl_give isl_schedule_tree *isl_schedule_tree_band_set_permutable(
93 __isl_take isl_schedule_tree *tree, int permutable);
95 int isl_schedule_tree_has_children(__isl_keep isl_schedule_tree *tree);
96 int isl_schedule_tree_n_children(__isl_keep isl_schedule_tree *tree);
97 __isl_give isl_schedule_tree *isl_schedule_tree_get_child(
98 __isl_keep isl_schedule_tree *tree, int pos);
100 __isl_give isl_schedule_tree *isl_schedule_tree_insert_band(
101 __isl_take isl_schedule_tree *tree, __isl_take isl_schedule_band *band);
102 __isl_give isl_schedule_tree *isl_schedule_tree_insert_domain(
103 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
104 __isl_give isl_schedule_tree *isl_schedule_tree_insert_filter(
105 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
107 __isl_give isl_schedule_tree *isl_schedule_tree_append_to_leaves(
108 __isl_take isl_schedule_tree *tree1,
109 __isl_take isl_schedule_tree *tree2);
111 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale(
112 __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
113 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale_down(
114 __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
115 __isl_give isl_schedule_tree *isl_schedule_tree_band_tile(
116 __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *sizes);
117 __isl_give isl_schedule_tree *isl_schedule_tree_band_split(
118 __isl_take isl_schedule_tree *tree, int pos);
120 __isl_give isl_schedule_tree *isl_schedule_tree_child(
121 __isl_take isl_schedule_tree *tree, int pos);
122 __isl_give isl_schedule_tree *isl_schedule_tree_reset_children(
123 __isl_take isl_schedule_tree *tree);
124 __isl_give isl_schedule_tree *isl_schedule_tree_replace_child(
125 __isl_take isl_schedule_tree *tree, int pos,
126 __isl_take isl_schedule_tree *new_child);
128 __isl_give isl_printer *isl_printer_print_schedule_tree(
129 __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree);
130 __isl_give isl_printer *isl_printer_print_schedule_tree_mark(
131 __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree,
132 int n_ancestor, int *child_pos);
134 #endif