export isl_multi_aff_set_aff
[platform/upstream/isl.git] / doc / user.pod
index 53371c5..593572f 100644 (file)
@@ -160,6 +160,12 @@ dimension manipulation on the result.
 =item * The C<schedule_split_parallel> option has been replaced
 by the C<schedule_split_scaled> option.
 
+=item * The first argument of C<isl_pw_aff_cond> is now
+an C<isl_pw_aff> instead of an C<isl_set>.
+A call C<isl_pw_aff_cond(a, b, c)> can be replaced by
+
+       isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
+
 =back
 
 =head1 Installation
@@ -676,11 +682,15 @@ using the following functions.
        __isl_give isl_id *isl_space_get_dim_id(
                __isl_keep isl_space *space,
                enum isl_dim_type type, unsigned pos);
-       __isl_give isl_space *isl_space_set_dim_name(__isl_take isl_space *space,
-                                enum isl_dim_type type, unsigned pos,
-                                __isl_keep const char *name);
-       __isl_keep const char *isl_space_get_dim_name(__isl_keep isl_space *space,
-                                enum isl_dim_type type, unsigned pos);
+       __isl_give isl_space *isl_space_set_dim_name(
+               __isl_take isl_space *space,
+                enum isl_dim_type type, unsigned pos,
+                __isl_keep const char *name);
+       int isl_space_has_dim_name(__isl_keep isl_space *space,
+               enum isl_dim_type type, unsigned pos);
+       __isl_keep const char *isl_space_get_dim_name(
+               __isl_keep isl_space *space,
+               enum isl_dim_type type, unsigned pos);
 
 Note that C<isl_space_get_name> returns a pointer to some internal
 data structure, so the result can only be used while the
@@ -1283,6 +1293,8 @@ L<"Piecewise Multiple Quasi Affine Expressions">).
                __isl_take isl_aff_list *list);
        __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
                __isl_take isl_multi_aff *maff)
+       __isl_give isl_map *isl_map_from_multi_aff(
+               __isl_take isl_multi_aff *maff)
        __isl_give isl_set *isl_set_from_pw_multi_aff(
                __isl_take isl_pw_multi_aff *pma);
        __isl_give isl_map *isl_map_from_pw_multi_aff(
@@ -1573,6 +1585,8 @@ read off using the following functions.
        const char *isl_basic_set_get_dim_name(
                __isl_keep isl_basic_set *bset,
                enum isl_dim_type type, unsigned pos);
+       int isl_set_has_dim_name(__isl_keep isl_set *set,
+               enum isl_dim_type type, unsigned pos);
        const char *isl_set_get_dim_name(
                __isl_keep isl_set *set,
                enum isl_dim_type type, unsigned pos);
@@ -1620,6 +1634,8 @@ is already known to be empty.
 
 =item * Single-valuedness
 
+       int isl_map_plain_is_single_valued(
+               __isl_keep isl_map *map);
        int isl_map_is_single_valued(__isl_keep isl_map *map);
        int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
 
@@ -1713,6 +1729,9 @@ i.e., whether both domain and range are nested relations.
 
 =item * Subset
 
+       int isl_basic_set_is_subset(
+               __isl_keep isl_basic_set *bset1,
+               __isl_keep isl_basic_set *bset2);
        int isl_set_is_subset(__isl_keep isl_set *set1,
                __isl_keep isl_set *set2);
        int isl_set_is_strict_subset(
@@ -1753,6 +1772,8 @@ i.e., whether both domain and range are nested relations.
 
        __isl_give isl_set *isl_set_complement(
                __isl_take isl_set *set);
+       __isl_give isl_map *isl_map_complement(
+               __isl_take isl_map *map);
 
 =item * Inverse map
 
@@ -1852,12 +1873,20 @@ dimension has the fixed given value.
        __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
                __isl_take isl_basic_map *bmap,
                enum isl_dim_type type, unsigned pos, int value);
+       __isl_give isl_set *isl_set_lower_bound(
+               __isl_take isl_set *set,
+               enum isl_dim_type type, unsigned pos,
+               isl_int value);
        __isl_give isl_set *isl_set_lower_bound_si(
                __isl_take isl_set *set,
                enum isl_dim_type type, unsigned pos, int value);
        __isl_give isl_map *isl_map_lower_bound_si(
                __isl_take isl_map *map,
                enum isl_dim_type type, unsigned pos, int value);
+       __isl_give isl_set *isl_set_upper_bound(
+               __isl_take isl_set *set,
+               enum isl_dim_type type, unsigned pos,
+               isl_int value);
        __isl_give isl_set *isl_set_upper_bound_si(
                __isl_take isl_set *set,
                enum isl_dim_type type, unsigned pos, int value);
@@ -1866,7 +1895,7 @@ dimension has the fixed given value.
                enum isl_dim_type type, unsigned pos, int value);
 
 Intersect the set or relation with the half-space where the given
-dimension has a value bounded the fixed given value.
+dimension has a value bounded by the fixed given value.
 
        __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
                enum isl_dim_type type1, int pos1,
@@ -1928,6 +1957,17 @@ basic set or relation.
        __isl_give isl_union_map *isl_union_map_coalesce(
                __isl_take isl_union_map *umap);
 
+One of the methods for combining pairs of basic sets or relations
+can result in coefficients that are much larger than those that appear
+in the constraints of the input.  By default, the coefficients are
+not allowed to grow larger, but this can be changed by unsetting
+the following option.
+
+       int isl_options_set_coalesce_bounded_wrapping(
+               isl_ctx *ctx, int val);
+       int isl_options_get_coalesce_bounded_wrapping(
+               isl_ctx *ctx);
+
 =item * Detecting equalities
 
        __isl_give isl_basic_set *isl_basic_set_detect_equalities(
@@ -2022,6 +2062,20 @@ that contains the whole input set or relation.
 In case of union sets and relations, the polyhedral hull is computed
 per space.
 
+=item * Feasibility
+
+       __isl_give isl_basic_set *isl_basic_set_sample(
+               __isl_take isl_basic_set *bset);
+       __isl_give isl_basic_set *isl_set_sample(
+               __isl_take isl_set *set);
+       __isl_give isl_basic_map *isl_basic_map_sample(
+               __isl_take isl_basic_map *bmap);
+       __isl_give isl_basic_map *isl_map_sample(
+               __isl_take isl_map *map);
+
+If the input (basic) set or relation is non-empty, then return
+a singleton subset of the input.  Otherwise, return an empty set.
+
 =item * Optimization
 
        #include <isl/ilp.h>
@@ -2080,6 +2134,15 @@ dualization algorithms or skip the elimination step.
 
 =item * Power
 
+       __isl_give isl_map *isl_map_fixed_power(
+               __isl_take isl_map *map, isl_int exp);
+       __isl_give isl_union_map *isl_union_map_fixed_power(
+               __isl_take isl_union_map *umap, isl_int exp);
+
+Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
+If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
+of C<map> is computed.
+
        __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
                int *exact);
        __isl_give isl_union_map *isl_union_map_power(
@@ -2676,6 +2739,35 @@ Lists can be printed using
                __isl_take isl_printer *p,
                __isl_keep isl_set_list *list);
 
+=head2 Vectors
+
+Vectors can be created, copied and freed using the following functions.
+
+       #include <isl/vec.h>
+       __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
+               unsigned size);
+       __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
+       void isl_vec_free(__isl_take isl_vec *vec);
+
+Note that the elements of a newly created vector may have arbitrary values.
+The elements can be changed and inspected using the following functions.
+
+       isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
+       int isl_vec_size(__isl_keep isl_vec *vec);
+       int isl_vec_get_element(__isl_keep isl_vec *vec,
+               int pos, isl_int *v);
+       __isl_give isl_vec *isl_vec_set_element(
+               __isl_take isl_vec *vec, int pos, isl_int v);
+       __isl_give isl_vec *isl_vec_set_element_si(
+               __isl_take isl_vec *vec, int pos, int v);
+       __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
+               isl_int v);
+       __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
+               int v);
+
+C<isl_vec_get_element> will return a negative value if anything went wrong.
+In that case, the value of C<*v> is undefined.
+
 =head2 Matrices
 
 Matrices can be created, copied and freed using the following functions.
@@ -2737,6 +2829,13 @@ be created using the following functions.
        __isl_give isl_pw_aff *isl_pw_aff_from_aff(
                __isl_take isl_aff *aff);
 
+A piecewise quasi affine expression that is equal to 1 on a set
+and 0 outside the set can be created using the following function.
+
+       #include <isl/aff.h>
+       __isl_give isl_pw_aff *isl_set_indicator_function(
+               __isl_take isl_set *set);
+
 Quasi affine expressions can be copied and freed using
 
        #include <isl/aff.h>
@@ -2801,6 +2900,7 @@ The expression can be inspected using
        __isl_give isl_aff *isl_aff_get_div(
                __isl_keep isl_aff *aff, int pos);
 
+       int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
        int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
                int (*fn)(__isl_take isl_set *set,
                          __isl_take isl_aff *aff,
@@ -3051,14 +3151,14 @@ of C<pwaff> where C<pwaff> is non-negative.
 
        #include <isl/aff.h>
        __isl_give isl_pw_aff *isl_pw_aff_cond(
-               __isl_take isl_set *cond,
+               __isl_take isl_pw_aff *cond,
                __isl_take isl_pw_aff *pwaff_true,
                __isl_take isl_pw_aff *pwaff_false);
 
 The function C<isl_pw_aff_cond> performs a conditional operator
 and returns an expression that is equal to C<pwaff_true>
-for elements in C<cond> and equal to C<pwaff_false> for elements
-not in C<cond>.
+for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
+where C<cond> is zero.
 
        #include <isl/aff.h>
        __isl_give isl_pw_aff *isl_pw_aff_union_min(
@@ -3109,13 +3209,17 @@ following function.
                __isl_take isl_space *space,
                __isl_take isl_aff_list *list);
 
-An empty piecewise multiple quasi affine expression (one with no cells) or
+An empty piecewise multiple quasi affine expression (one with no cells),
+the zero piecewise multiple quasi affine expression (with value zero
+for each output dimension) or
 a piecewise multiple quasi affine expression with a single cell can
 be created using the following functions.
 
        #include <isl/aff.h>
        __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
                __isl_take isl_space *space);
+       __isl_give isl_multi_aff *isl_multi_aff_zero(
+               __isl_take isl_space *space);
        __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
                __isl_take isl_set *set,
                __isl_take isl_multi_aff *maff);
@@ -3185,6 +3289,9 @@ The expression can be inspected using
 It can be modified using
 
        #include <isl/aff.h>
+       __isl_give isl_multi_aff *isl_multi_aff_set_aff(
+               __isl_take isl_multi_aff *multi, int pos,
+               __isl_take isl_aff *aff);
        __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
                __isl_take isl_multi_aff *maff,
                enum isl_dim_type type, unsigned pos, const char *s);
@@ -3488,7 +3595,7 @@ functions.
 
        __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
                __isl_keep isl_union_pw_qpolynomial *upwqp);
-       void isl_union_pw_qpolynomial_free(
+       void *isl_union_pw_qpolynomial_free(
                __isl_take isl_union_pw_qpolynomial *upwqp);
 
 =head3 Inspecting (Piecewise) Quasipolynomials
@@ -3747,7 +3854,7 @@ following functions.
                __isl_take isl_qpolynomial_fold *fold);
        void *isl_pw_qpolynomial_fold_free(
                __isl_take isl_pw_qpolynomial_fold *pwf);
-       void isl_union_pw_qpolynomial_fold_free(
+       void *isl_union_pw_qpolynomial_fold_free(
                __isl_take isl_union_pw_qpolynomial_fold *upwf);
 
 =head3 Printing Piecewise Quasipolynomial Reductions
@@ -4065,7 +4172,7 @@ the following operation.  Given a relation between sink iterations
 and potential soure iterations from a particular source domain,
 what is the last potential source iteration corresponding to each
 sink iteration.  It can sometimes be convenient to adjust
-the set of potential source iterations before each such operation.
+the set of potential source iterations before or after each such operation.
 The prototypical example is fuzzy array dataflow analysis,
 where we need to analyze if, based on data-dependent constraints,
 the sink iteration can ever be executed without one or more of
@@ -4077,29 +4184,63 @@ function.
 
        #include <isl/flow.h>
 
-       typedef __isl_give isl_set *(*isl_access_restrict_sources)(
-               __isl_take isl_map *source_map,
-               void *sink_user, void *source_user);
-       __isl_give isl_access_info *
-       isl_access_info_set_restrict_sources(
+       typedef __isl_give isl_restriction *(*isl_access_restrict)(
+               __isl_keep isl_map *source_map,
+               __isl_keep isl_set *sink, void *source_user,
+               void *user);
+       __isl_give isl_access_info *isl_access_info_set_restrict(
                __isl_take isl_access_info *acc,
-               isl_access_restrict_sources fn);
+               isl_access_restrict fn, void *user);
 
-The function C<isl_access_info_set_restrict_sources> should be called
-before C<isl_access_info_compute_flow> and registers a callback function
+The function C<isl_access_info_set_restrict> should be called
+before calling C<isl_access_info_compute_flow> and registers a callback function
 that will be called any time C<isl> is about to compute the last
 potential source.  The first argument is the (reverse) proto-dependence,
 mapping sink iterations to potential source iterations.
-The other two arguments are the tokens corresponding to the sink
-and the source.  The callback is expected to return a set
-that restricts the source iterations.  The potential source iterations
-will be intersected with this set.  If no restrictions are required
-for a given C<source_map>, then the callback should return
+The second argument represents the sink iterations for which
+we want to compute the last source iteration.
+The third argument is the token corresponding to the source
+and the final argument is the token passed to C<isl_access_info_set_restrict>.
+The callback is expected to return a restriction on either the input or
+the output of the operation computing the last potential source.
+If the input needs to be restricted then restrictions are needed
+for both the source and the sink iterations.  The sink iterations
+and the potential source iterations will be intersected with these sets.
+If the output needs to be restricted then only a restriction on the source
+iterations is required.
+If any error occurs, the callback should return C<NULL>.
+An C<isl_restriction> object can be created and freed using the following
+functions.
 
-       isl_set_universe(
-           isl_space_range(isl_map_get_space(source_map)));
+       #include <isl/flow.h>
 
-If any error occurs, the callback should return C<NULL>.
+       __isl_give isl_restriction *isl_restriction_input(
+               __isl_take isl_set *source_restr,
+               __isl_take isl_set *sink_restr);
+       __isl_give isl_restriction *isl_restriction_output(
+               __isl_take isl_set *source_restr);
+       __isl_give isl_restriction *isl_restriction_none(
+               __isl_keep isl_map *source_map);
+       __isl_give isl_restriction *isl_restriction_empty(
+               __isl_keep isl_map *source_map);
+       void *isl_restriction_free(
+               __isl_take isl_restriction *restr);
+
+C<isl_restriction_none> and C<isl_restriction_empty> are special
+cases of C<isl_restriction_input>.  C<isl_restriction_none>
+is essentially equivalent to
+
+       isl_restriction_input(isl_set_universe(
+           isl_space_range(isl_map_get_space(source_map))),
+                           isl_set_universe(
+           isl_space_domain(isl_map_get_space(source_map))));
+
+whereas C<isl_restriction_empty> is essentially equivalent to
+
+       isl_restriction_input(isl_set_empty(
+           isl_space_range(isl_map_get_space(source_map))),
+                           isl_set_universe(
+           isl_space_domain(isl_map_get_space(source_map))));
 
 =head2 Scheduling
 
@@ -4206,6 +4347,10 @@ A representation of the band can be printed using
 =head3 Options
 
        #include <isl/schedule.h>
+       int isl_options_set_schedule_max_coefficient(
+               isl_ctx *ctx, int val);
+       int isl_options_get_schedule_max_coefficient(
+               isl_ctx *ctx);
        int isl_options_set_schedule_max_constant_term(
                isl_ctx *ctx, int val);
        int isl_options_get_schedule_max_constant_term(
@@ -4230,6 +4375,15 @@ A representation of the band can be printed using
 
 =over
 
+=item * schedule_max_coefficient
+
+This option enforces that the coefficients for variable and parameter
+dimensions in the calculated schedule are not larger than the specified value.
+This option can significantly increase the speed of the scheduling calculation
+and may also prevent fusing of unrelated dimensions. A value of -1 means that
+this option does not introduce bounds on the variable or parameter
+coefficients.
+
 =item * schedule_max_constant_term
 
 This option enforces that the constant coefficients in the calculated schedule