X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fuser.pod;h=df85dd135e3e29d54de3f3386e5c2ac429423f8a;hb=b4ecaa0b8be9556b5f469c5dbf2016ee07b045e5;hp=2202066170446bb25e5714ba637f46ffb57e700e;hpb=f74bc2ad87ec6ef7b1a79b8a2ae4242f7586c3a7;p=platform%2Fupstream%2Fisl.git diff --git a/doc/user.pod b/doc/user.pod index 2202066..df85dd1 100644 --- a/doc/user.pod +++ b/doc/user.pod @@ -168,6 +168,47 @@ A call C can be replaced by =back +=head3 Changes since isl-0.10 + +=over + +=item * The functions C and +C have been renamed to +C and +C. + +=back + +=head1 License + +C 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 currently requires C, which is released +under the GNU Lesser General Public License (LGPL). This means +that code linked against C is also linked against LGPL code. + =head1 Installation The source of C 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 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 + 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 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 @@ -673,6 +730,8 @@ of the original object. __isl_keep isl_pw_aff *pwaff); __isl_give isl_space *isl_pw_aff_get_space( __isl_keep isl_pw_aff *pwaff); + __isl_give isl_space *isl_multi_aff_get_domain_space( + __isl_keep isl_multi_aff *maff); __isl_give isl_space *isl_multi_aff_get_space( __isl_keep isl_multi_aff *maff); __isl_give isl_space *isl_pw_multi_aff_get_domain_space( @@ -1002,7 +1061,7 @@ be created. __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx, FILE *file); __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx); - void isl_printer_free(__isl_take isl_printer *printer); + void *isl_printer_free(__isl_take isl_printer *printer); __isl_give char *isl_printer_get_str( __isl_keep isl_printer *printer); @@ -1184,10 +1243,14 @@ using the following functions. Sets and relations can be converted to union sets and relations using the following functions. - __isl_give isl_union_map *isl_union_map_from_map( - __isl_take isl_map *map); + __isl_give isl_union_set *isl_union_set_from_basic_set( + __isl_take isl_basic_set *bset); + __isl_give isl_union_map *isl_union_map_from_basic_map( + __isl_take isl_basic_map *bmap); __isl_give isl_union_set *isl_union_set_from_set( __isl_take isl_set *set); + __isl_give isl_union_map *isl_union_map_from_map( + __isl_take isl_map *map); The inverse conversions below can only be used if the input union set or relation is known to contain elements in exactly one @@ -1218,9 +1281,9 @@ functions. __isl_give isl_union_map *isl_union_map_copy( __isl_keep isl_union_map *umap); void isl_basic_set_free(__isl_take isl_basic_set *bset); - void isl_set_free(__isl_take isl_set *set); + 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); @@ -1400,6 +1463,27 @@ using the following functions, which compute an overapproximation. __isl_give isl_map *isl_map_remove_divs( __isl_take isl_map *map); +It is also possible to only remove those divs that are defined +in terms of a given range of dimensions or only those for which +no explicit representation is known. + + __isl_give isl_basic_set * + isl_basic_set_remove_divs_involving_dims( + __isl_take isl_basic_set *bset, + enum isl_dim_type type, + unsigned first, unsigned n); + __isl_give isl_set *isl_set_remove_divs_involving_dims( + __isl_take isl_set *set, enum isl_dim_type type, + unsigned first, unsigned n); + __isl_give isl_map *isl_map_remove_divs_involving_dims( + __isl_take isl_map *map, enum isl_dim_type type, + unsigned first, unsigned n); + + __isl_give isl_set *isl_set_remove_unknown_divs( + __isl_take isl_set *set); + __isl_give isl_map *isl_map_remove_unknown_divs( + __isl_take isl_map *map); + To iterate over all the sets or maps in a union set or map, use int isl_union_set_foreach_set(__isl_keep isl_union_set *uset, @@ -1566,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 @@ -1604,6 +1688,8 @@ or relation can be read off or set using the following functions. __isl_give isl_basic_map *isl_basic_map_set_tuple_name( __isl_take isl_basic_map *bmap, enum isl_dim_type type, const char *s); + int isl_map_has_tuple_name(__isl_keep isl_map *map, + enum isl_dim_type type); const char *isl_map_get_tuple_name( __isl_keep isl_map *map, enum isl_dim_type type); @@ -1914,6 +2000,10 @@ that maps (a wrapped version of) the input relation to its domain or range. =item * Elimination + __isl_give isl_basic_set *isl_basic_set_eliminate( + __isl_take isl_basic_set *bset, + enum isl_dim_type type, + unsigned first, unsigned n); __isl_give isl_set *isl_set_eliminate( __isl_take isl_set *set, enum isl_dim_type type, unsigned first, unsigned n); @@ -2375,9 +2465,15 @@ with the original range as range of this nested relation. =item * Aligning parameters + __isl_give isl_basic_set *isl_basic_set_align_params( + __isl_take isl_basic_set *bset, + __isl_take isl_space *model); __isl_give isl_set *isl_set_align_params( __isl_take isl_set *set, __isl_take isl_space *model); + __isl_give isl_basic_map *isl_basic_map_align_params( + __isl_take isl_basic_map *bmap, + __isl_take isl_space *model); __isl_give isl_map *isl_map_align_params( __isl_take isl_map *map, __isl_take isl_space *model); @@ -2395,6 +2491,14 @@ All parameters need to be named. __isl_give isl_map *isl_map_add_dims( __isl_take isl_map *map, enum isl_dim_type type, unsigned n); + __isl_give isl_basic_set *isl_basic_set_insert_dims( + __isl_take isl_basic_set *bset, + enum isl_dim_type type, unsigned pos, + unsigned n); + __isl_give isl_basic_map *isl_basic_map_insert_dims( + __isl_take isl_basic_map *bmap, + enum isl_dim_type type, unsigned pos, + unsigned n); __isl_give isl_set *isl_set_insert_dims( __isl_take isl_set *set, enum isl_dim_type type, unsigned pos, unsigned n); @@ -2586,12 +2690,18 @@ a parametric set as well. __isl_give isl_basic_map *isl_basic_map_range_product( __isl_take isl_basic_map *bmap1, __isl_take isl_basic_map *bmap2); + __isl_give isl_basic_map *isl_basic_map_product( + __isl_take isl_basic_map *bmap1, + __isl_take isl_basic_map *bmap2); __isl_give isl_map *isl_map_domain_product( __isl_take isl_map *map1, __isl_take isl_map *map2); __isl_give isl_map *isl_map_range_product( __isl_take isl_map *map1, __isl_take isl_map *map2); + __isl_give isl_union_map *isl_union_map_domain_product( + __isl_take isl_union_map *umap1, + __isl_take isl_union_map *umap2); __isl_give isl_union_map *isl_union_map_range_product( __isl_take isl_union_map *umap1, __isl_take isl_union_map *umap2); @@ -2808,13 +2918,17 @@ returning a basic set or relation. __isl_take isl_basic_map *bmap, __isl_take isl_basic_set *dom, __isl_give isl_set **empty); + __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff( + __isl_take isl_map *map); + __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff( + __isl_take isl_map *map); =head2 Lists Lists are defined over several element types, including -C, C, C and C. +C, C, C, C and C. Here we take lists of Cs 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_give isl_set_list *isl_set_list_from_set( @@ -2826,6 +2940,12 @@ 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_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); __isl_give isl_set_list *isl_set_list_concat( __isl_take isl_set_list *list1, __isl_take isl_set_list *list2); @@ -3069,6 +3189,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_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); @@ -3099,6 +3223,8 @@ Note that the C and C functions set the I of the constant or coefficient, while C and C add an integer value to the possibly rational constant or coefficient. +The C 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 @@ -3203,6 +3329,8 @@ When multiplying two affine expressions, at least one of the two needs to be a constant. #include + __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( @@ -3245,6 +3373,9 @@ to be a constant. __isl_take isl_pw_aff_list *list1, __isl_take isl_pw_aff_list *list2); +The function C returns a basic set +containing those elements in the domain space +of C where C is negative. The function C returns a basic set containing those elements in the shared space of C and C where C is greater than or equal to C. @@ -3340,6 +3471,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_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); @@ -3457,6 +3590,9 @@ It can be modified using __isl_give isl_multi_aff *isl_multi_aff_drop_dims( __isl_take isl_multi_aff *maff, enum isl_dim_type type, unsigned first, unsigned n); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims( + __isl_take isl_pw_multi_aff *pma, + enum isl_dim_type type, unsigned first, unsigned n); To check whether two multiple affine expressions are obviously equal to each other, use @@ -3470,6 +3606,12 @@ obviously equal to each other, use Operations include #include + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin( + __isl_take isl_pw_multi_aff *pma1, + __isl_take isl_pw_multi_aff *pma2); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax( + __isl_take isl_pw_multi_aff *pma1, + __isl_take isl_pw_multi_aff *pma2); __isl_give isl_multi_aff *isl_multi_aff_add( __isl_take isl_multi_aff *maff1, __isl_take isl_multi_aff *maff2); @@ -3496,6 +3638,12 @@ Operations include __isl_give isl_local_space **ls); __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce( __isl_take isl_pw_multi_aff *pma); + __isl_give isl_multi_aff *isl_multi_aff_align_params( + __isl_take isl_multi_aff *multi, + __isl_take isl_space *model); + __isl_give isl_pw_multi_aff * + isl_pw_multi_aff_project_domain_on_params( + __isl_take isl_pw_multi_aff *pma); __isl_give isl_multi_aff *isl_multi_aff_gist_params( __isl_take isl_multi_aff *maff, __isl_take isl_set *context); @@ -3515,10 +3663,16 @@ Operations include __isl_give isl_multi_aff *isl_multi_aff_flat_range_product( __isl_take isl_multi_aff *ma1, __isl_take isl_multi_aff *ma2); + __isl_give isl_multi_aff *isl_multi_aff_product( + __isl_take isl_multi_aff *ma1, + __isl_take isl_multi_aff *ma2); __isl_give isl_pw_multi_aff * isl_pw_multi_aff_flat_range_product( __isl_take isl_pw_multi_aff *pma1, __isl_take isl_pw_multi_aff *pma2); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product( + __isl_take isl_pw_multi_aff *pma1, + __isl_take isl_pw_multi_aff *pma2); __isl_give isl_union_pw_multi_aff * isl_union_pw_multi_aff_flat_range_product( __isl_take isl_union_pw_multi_aff *upma1, @@ -3528,6 +3682,18 @@ If the C argument of C is not C, then it is assigned the local space that lies at the basis of the lifting applied. + __isl_give isl_set *isl_multi_aff_lex_le_set( + __isl_take isl_multi_aff *ma1, + __isl_take isl_multi_aff *ma2); + __isl_give isl_set *isl_multi_aff_lex_ge_set( + __isl_take isl_multi_aff *ma1, + __isl_take isl_multi_aff *ma2); + +The function C returns a set +containing those elements in the shared domain space +where C is lexicographically smaller than or +equal to C. + An expression can be read from input using #include