isl_basic_map_free: return NULL

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

diff --git a/doc/user.pod b/doc/user.pod
index 6e359a9..df85dd1 100644 (file)
--- a/doc/user.pod
+++ b/doc/user.pod
@@ -168,6 +168,47 @@ A call C<isl_pw_aff_cond(a, b, c)> can be replaced by
 
 =back
 
+=head3 Changes since isl-0.10
+
+=over
+
+=item * The functions C<isl_set_dim_has_lower_bound> and
+C<isl_set_dim_has_upper_bound> have been renamed to
+C<isl_set_dim_has_any_lower_bound> and
+C<isl_set_dim_has_any_upper_bound>.
+
+=back
+
+=head1 License
+
+C<isl> is released under the MIT license.
+
+=over
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=back
+
+Note that C<isl> currently requires C<GMP>, which is released
+under the GNU Lesser General Public License (LGPL).  This means
+that code linked against C<isl> is also linked against LGPL code.
+
 =head1 Installation
 
 The source of C<isl> can be obtained either as a tarball
@@ -591,7 +632,7 @@ parameters is discouraged.
        __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
                unsigned nparam, unsigned dim);
        __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
-       void isl_space_free(__isl_take isl_space *space);
+       void *isl_space_free(__isl_take isl_space *space);
        unsigned isl_space_dim(__isl_keep isl_space *space,
                enum isl_dim_type type);
 
@@ -614,6 +655,22 @@ or whether it is a parameter space, use these functions:
        #include <isl/space.h>
        int isl_space_is_params(__isl_keep isl_space *space);
        int isl_space_is_set(__isl_keep isl_space *space);
+       int isl_space_is_map(__isl_keep isl_space *space);
+
+Spaces can be compared using the following functions:
+
+       #include <isl/space.h>
+       int isl_space_is_equal(__isl_keep isl_space *space1,
+               __isl_keep isl_space *space2);
+       int isl_space_is_domain(__isl_keep isl_space *space1,
+               __isl_keep isl_space *space2);
+       int isl_space_is_range(__isl_keep isl_space *space1,
+               __isl_keep isl_space *space2);
+
+C<isl_space_is_domain> checks whether the first argument is equal
+to the domain of the second argument.  This requires in particular that
+the first argument is a set space and that the second argument
+is a map space.
 
 It is often useful to create objects that live in the
 same space as some other object.  This can be accomplished
@@ -1226,7 +1283,7 @@ functions.
        void isl_basic_set_free(__isl_take isl_basic_set *bset);
        void *isl_set_free(__isl_take isl_set *set);
        void *isl_union_set_free(__isl_take isl_union_set *uset);
-       void isl_basic_map_free(__isl_take isl_basic_map *bmap);
+       void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
        void isl_map_free(__isl_take isl_map *map);
        void *isl_union_map_free(__isl_take isl_union_map *umap);
 
@@ -1593,9 +1650,9 @@ constraints.  Instead the following functions can be used.
 Similarly, the following functions can be used to check whether
 a given dimension is involved in any lower or upper bound.
 
-       int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
+       int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
                enum isl_dim_type type, unsigned pos);
-       int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
+       int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
                enum isl_dim_type type, unsigned pos);
 
 The identifiers or names of the domain and range spaces of a set
@@ -2883,6 +2940,9 @@ Lists can be created, copied, modified 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_drop(
+               __isl_take isl_set_list *list,
+               unsigned first, unsigned n);
        __isl_give isl_set_list *isl_set_list_set_set(
                __isl_take isl_set_list *list, int index,
                __isl_take isl_set *set);