add isl_multi_aff_identity

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

diff --git a/doc/user.pod b/doc/user.pod
index 7f501ef..1f5e0b4 100644 (file)
--- a/doc/user.pod
+++ b/doc/user.pod
@@ -1659,6 +1659,8 @@ read off using the following functions.
        const char *isl_basic_map_get_dim_name(
                __isl_keep isl_basic_map *bmap,
                enum isl_dim_type type, unsigned pos);
        const char *isl_basic_map_get_dim_name(
                __isl_keep isl_basic_map *bmap,
                enum isl_dim_type type, unsigned pos);

+       int isl_map_has_dim_name(__isl_keep isl_map *map,
+               enum isl_dim_type type, unsigned pos);

        const char *isl_map_get_dim_name(
                __isl_keep isl_map *map,
                enum isl_dim_type type, unsigned pos);
        const char *isl_map_get_dim_name(
                __isl_keep isl_map *map,
                enum isl_dim_type type, unsigned pos);


@@ -2810,9 +2812,9 @@ returning a basic set or relation.
 =head2 Lists
 
 Lists are defined over several element types, including
 =head2 Lists
 
 Lists are defined over several element types, including

-C<isl_aff>, C<isl_pw_aff>, C<isl_basic_set> and C<isl_set>.
+C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_basic_set> and C<isl_set>.

 Here we take lists of C<isl_set>s as an example.
 Here we take lists of C<isl_set>s as an example.

-Lists can be created, copied and freed using the following functions.
+Lists can be created, copied, modified and freed using the following functions.

 
        #include <isl/list.h>
        __isl_give isl_set_list *isl_set_list_from_set(
 
        #include <isl/list.h>
        __isl_give isl_set_list *isl_set_list_from_set(


@@ -2824,6 +2826,9 @@ Lists can be created, copied and freed using the following functions.
        __isl_give isl_set_list *isl_set_list_add(
                __isl_take isl_set_list *list,
                __isl_take isl_set *el);
        __isl_give isl_set_list *isl_set_list_add(
                __isl_take isl_set_list *list,
                __isl_take isl_set *el);

+       __isl_give isl_set_list *isl_set_list_set_set(
+               __isl_take isl_set_list *list, int index,
+               __isl_take isl_set *set);

        __isl_give isl_set_list *isl_set_list_concat(
                __isl_take isl_set_list *list1,
                __isl_take isl_set_list *list2);
        __isl_give isl_set_list *isl_set_list_concat(
                __isl_take isl_set_list *list1,
                __isl_take isl_set_list *list2);


@@ -3003,6 +3008,9 @@ The expression can be inspected using
        __isl_give isl_id *isl_pw_aff_get_dim_id(
                __isl_keep isl_pw_aff *pa,
                enum isl_dim_type type, unsigned pos);
        __isl_give isl_id *isl_pw_aff_get_dim_id(
                __isl_keep isl_pw_aff *pa,
                enum isl_dim_type type, unsigned pos);

+       __isl_give isl_id *isl_pw_aff_get_tuple_id(
+               __isl_keep isl_pw_aff *pa,
+               enum isl_dim_type type);

        int isl_aff_get_constant(__isl_keep isl_aff *aff,
                isl_int *v);
        int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
        int isl_aff_get_constant(__isl_keep isl_aff *aff,
                isl_int *v);
        int isl_aff_get_coefficient(__isl_keep isl_aff *aff,


@@ -3064,6 +3072,10 @@ It can be modified using
                __isl_take isl_aff *aff, isl_int v);
        __isl_give isl_aff *isl_aff_add_constant_si(
                __isl_take isl_aff *aff, int v);
                __isl_take isl_aff *aff, isl_int v);
        __isl_give isl_aff *isl_aff_add_constant_si(
                __isl_take isl_aff *aff, int v);

+       __isl_give isl_aff *isl_aff_add_constant_num(
+               __isl_take isl_aff *aff, isl_int v);
+       __isl_give isl_aff *isl_aff_add_constant_num_si(
+               __isl_take isl_aff *aff, int v);

        __isl_give isl_aff *isl_aff_add_coefficient(
                __isl_take isl_aff *aff,
                enum isl_dim_type type, int pos, isl_int v);
        __isl_give isl_aff *isl_aff_add_coefficient(
                __isl_take isl_aff *aff,
                enum isl_dim_type type, int pos, isl_int v);


@@ -3094,6 +3106,8 @@ Note that the C<set_constant> and C<set_coefficient> functions
 set the I<numerator> of the constant or coefficient, while
 C<add_constant> and C<add_coefficient> add an integer value to
 the possibly rational constant or coefficient.
 set the I<numerator> of the constant or coefficient, while
 C<add_constant> and C<add_coefficient> add an integer value to
 the possibly rational constant or coefficient.

+The C<add_constant_num> functions add an integer value to
+the numerator.

 
 To check whether an affine expressions is obviously zero
 or obviously equal to some other affine expression, use
 
 To check whether an affine expressions is obviously zero
 or obviously equal to some other affine expression, use


@@ -3198,6 +3212,8 @@ When multiplying two affine expressions, at least one of the two needs
 to be a constant.
 
        #include <isl/aff.h>
 to be a constant.
 
        #include <isl/aff.h>

+       __isl_give isl_basic_set *isl_aff_neg_basic_set(
+               __isl_take isl_aff *aff);

        __isl_give isl_basic_set *isl_aff_le_basic_set(
                __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
        __isl_give isl_basic_set *isl_aff_ge_basic_set(
        __isl_give isl_basic_set *isl_aff_le_basic_set(
                __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
        __isl_give isl_basic_set *isl_aff_ge_basic_set(


@@ -3240,6 +3256,9 @@ to be a constant.
                __isl_take isl_pw_aff_list *list1,
                __isl_take isl_pw_aff_list *list2);
 
                __isl_take isl_pw_aff_list *list1,
                __isl_take isl_pw_aff_list *list2);
 

+The function C<isl_aff_neg_basic_set> returns a basic set
+containing those elements in the domain space
+of C<aff> where C<aff> is negative.

 The function C<isl_aff_ge_basic_set> returns a basic set
 containing those elements in the shared space
 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
 The function C<isl_aff_ge_basic_set> returns a basic set
 containing those elements in the shared space
 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.


@@ -3335,6 +3354,8 @@ can be created using the following functions.
                __isl_take isl_space *space);
        __isl_give isl_multi_aff *isl_multi_aff_zero(
                __isl_take isl_space *space);
                __isl_take isl_space *space);
        __isl_give isl_multi_aff *isl_multi_aff_zero(
                __isl_take isl_space *space);

+       __isl_give isl_multi_aff *isl_multi_aff_identity(
+               __isl_take isl_space *space);

        __isl_give isl_pw_multi_aff *
        isl_pw_multi_aff_from_multi_aff(
                __isl_take isl_multi_aff *ma);
        __isl_give isl_pw_multi_aff *
        isl_pw_multi_aff_from_multi_aff(
                __isl_take isl_multi_aff *ma);


@@ -3409,6 +3430,9 @@ The expression can be inspected using
        const char *isl_multi_aff_get_tuple_name(
                __isl_keep isl_multi_aff *multi,
                enum isl_dim_type type);
        const char *isl_multi_aff_get_tuple_name(
                __isl_keep isl_multi_aff *multi,
                enum isl_dim_type type);

+       int isl_pw_multi_aff_has_tuple_name(
+               __isl_keep isl_pw_multi_aff *pma,
+               enum isl_dim_type type);

        const char *isl_pw_multi_aff_get_tuple_name(
                __isl_keep isl_pw_multi_aff *pma,
                enum isl_dim_type type);
        const char *isl_pw_multi_aff_get_tuple_name(
                __isl_keep isl_pw_multi_aff *pma,
                enum isl_dim_type type);