add *list_n_*

[platform/upstream/isl.git] / doc / user.pod

diff --git a/doc/user.pod b/doc/user.pod
index 2e3c026..e7e8980 100644 (file)
--- a/doc/user.pod
+++ b/doc/user.pod
@@ -1546,6 +1546,9 @@ per space.
 =item * Optimization
 
        #include <isl/ilp.h>
+       enum isl_lp_result isl_basic_set_max(
+               __isl_keep isl_basic_set *bset,
+               __isl_keep isl_aff *obj, isl_int *opt)
        enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
                __isl_keep isl_aff *obj, isl_int *opt);
 
@@ -1998,6 +2001,35 @@ In case of union relations, the optimum is computed per space.
        __isl_give isl_union_map *isl_union_map_lexmax(
                __isl_take isl_union_map *umap);
 
+=head2 Lists
+
+Lists are defined over several element types, including
+C<isl_basic_set> and C<isl_set>.
+Here we take lists of C<isl_set>s as an example.
+Lists can be created, copied and freed using the following functions.
+
+       #include <isl/list.h>
+       __isl_give isl_set_list *isl_set_list_alloc(
+               isl_ctx *ctx, int n);
+       __isl_give isl_set_list *isl_set_list_copy(
+               __isl_keep isl_set_list *list);
+       __isl_give isl_set_list *isl_set_list_add(
+               __isl_take isl_set_list *list,
+               __isl_take isl_set *el);
+       void isl_set_list_free(__isl_take isl_set_list *list);
+
+C<isl_set_list_alloc> creates an empty list with a capacity for
+C<n> elements.
+
+Lists can be inspected using the following functions.
+
+       #include <isl/list.h>
+       isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
+       int isl_set_list_n_set(__isl_keep isl_set_list *list);
+       int isl_set_list_foreach(__isl_keep isl_set_list *list,
+               int (*fn)(__isl_take struct isl_set *el, void *user),
+               void *user);
+
 =head2 Matrices
 
 Matrices can be created, copied and freed using the following functions.
@@ -2059,11 +2091,14 @@ a non-zero coefficient for the specified dimension.
                __isl_keep isl_constraint *constraint,
                enum isl_dim_type type, int pos);
 
-Conversely, an equality constraint can be constructed, equating
-the affine expression to zero, using
+Conversely, an equality constraint equating
+the affine expression to zero or an inequality constraint enforcing
+the affine expression to be non-negative, can be constructed using
 
        __isl_give isl_constraint *isl_equality_from_aff(
                __isl_take isl_aff *aff);
+       __isl_give isl_constraint *isl_inequality_from_aff(
+               __isl_take isl_aff *aff);
 
 The expression can be inspected using
 
@@ -2114,8 +2149,16 @@ the possibly rational constant or coefficient.
 Operations include
 
        #include <isl/aff.h>
+       __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
+               __isl_take isl_aff *aff2);
+       __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
+               __isl_take isl_aff *aff2);
        __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
        __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
+       __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
+               isl_int f);
+       __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
+               isl_int f);
 
 An expression can be printed using