add isl_schedule_plain_is_equal
[isl.git] / isl_schedule_tree.h
blob8eed4e654508799c3c30ca6e50e6400b7458ac0f
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 int isl_schedule_tree_plain_is_equal(__isl_keep isl_schedule_tree *tree1,
53 __isl_keep isl_schedule_tree *tree2);
55 __isl_give isl_schedule_tree *isl_schedule_tree_copy(
56 __isl_keep isl_schedule_tree *tree);
57 __isl_null isl_schedule_tree *isl_schedule_tree_free(
58 __isl_take isl_schedule_tree *tree);
60 __isl_give isl_schedule_tree *isl_schedule_tree_from_band(
61 __isl_take isl_schedule_band *band);
62 __isl_give isl_schedule_tree *isl_schedule_tree_from_domain(
63 __isl_take isl_union_set *domain);
64 __isl_give isl_schedule_tree *isl_schedule_tree_from_filter(
65 __isl_take isl_union_set *filter);
66 __isl_give isl_schedule_tree *isl_schedule_tree_from_children(
67 enum isl_schedule_node_type type,
68 __isl_take isl_schedule_tree_list *list);
70 __isl_give isl_space *isl_schedule_tree_band_get_space(
71 __isl_keep isl_schedule_tree *tree);
72 __isl_give isl_multi_union_pw_aff *isl_schedule_tree_band_get_partial_schedule(
73 __isl_keep isl_schedule_tree *tree);
74 __isl_give isl_union_set *isl_schedule_tree_domain_get_domain(
75 __isl_keep isl_schedule_tree *tree);
76 __isl_give isl_schedule_tree *isl_schedule_tree_domain_set_domain(
77 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
78 __isl_give isl_union_set *isl_schedule_tree_filter_get_filter(
79 __isl_keep isl_schedule_tree *tree);
80 __isl_give isl_schedule_tree *isl_schedule_tree_filter_set_filter(
81 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
83 __isl_give isl_schedule_tree *isl_schedule_tree_first_schedule_descendant(
84 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_tree *leaf);
85 __isl_give isl_union_map *isl_schedule_tree_get_subtree_schedule_union_map(
86 __isl_keep isl_schedule_tree *tree);
88 unsigned isl_schedule_tree_band_n_member(__isl_keep isl_schedule_tree *tree);
90 int isl_schedule_tree_band_member_get_coincident(
91 __isl_keep isl_schedule_tree *tree, int pos);
92 __isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_coincident(
93 __isl_take isl_schedule_tree *tree, int pos, int coincident);
94 int isl_schedule_tree_band_get_permutable(__isl_keep isl_schedule_tree *tree);
95 __isl_give isl_schedule_tree *isl_schedule_tree_band_set_permutable(
96 __isl_take isl_schedule_tree *tree, int permutable);
98 int isl_schedule_tree_has_children(__isl_keep isl_schedule_tree *tree);
99 int isl_schedule_tree_n_children(__isl_keep isl_schedule_tree *tree);
100 __isl_give isl_schedule_tree *isl_schedule_tree_get_child(
101 __isl_keep isl_schedule_tree *tree, int pos);
103 __isl_give isl_schedule_tree *isl_schedule_tree_insert_band(
104 __isl_take isl_schedule_tree *tree, __isl_take isl_schedule_band *band);
105 __isl_give isl_schedule_tree *isl_schedule_tree_insert_domain(
106 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
107 __isl_give isl_schedule_tree *isl_schedule_tree_insert_filter(
108 __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
110 __isl_give isl_schedule_tree *isl_schedule_tree_append_to_leaves(
111 __isl_take isl_schedule_tree *tree1,
112 __isl_take isl_schedule_tree *tree2);
114 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale(
115 __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
116 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale_down(
117 __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
118 __isl_give isl_schedule_tree *isl_schedule_tree_band_tile(
119 __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *sizes);
120 __isl_give isl_schedule_tree *isl_schedule_tree_band_split(
121 __isl_take isl_schedule_tree *tree, int pos);
123 __isl_give isl_schedule_tree *isl_schedule_tree_child(
124 __isl_take isl_schedule_tree *tree, int pos);
125 __isl_give isl_schedule_tree *isl_schedule_tree_reset_children(
126 __isl_take isl_schedule_tree *tree);
127 __isl_give isl_schedule_tree *isl_schedule_tree_replace_child(
128 __isl_take isl_schedule_tree *tree, int pos,
129 __isl_take isl_schedule_tree *new_child);
131 __isl_give isl_printer *isl_printer_print_schedule_tree(
132 __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree);
133 __isl_give isl_printer *isl_printer_print_schedule_tree_mark(
134 __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree,
135 int n_ancestor, int *child_pos);
137 #endif