X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fuser.pod;h=59d086d8926ab7c730a93e679b277090aef33651;hb=6e524e26c4b66f743d78bbc0070f654b36d966cd;hp=8dd6fd38114177e7407756d72a6f39ec28e58688;hpb=85b7bb84a5e9a0706d929837fdf3e6045bb367bb;p=platform%2Fupstream%2Fisl.git diff --git a/doc/user.pod b/doc/user.pod index 8dd6fd3..59d086d 100644 --- a/doc/user.pod +++ b/doc/user.pod @@ -598,6 +598,12 @@ 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_space( + __isl_keep isl_multi_aff *maff); + __isl_give isl_space *isl_pw_multi_aff_get_domain_space( + __isl_keep isl_pw_multi_aff *pma); + __isl_give isl_space *isl_pw_multi_aff_get_space( + __isl_keep isl_pw_multi_aff *pma); #include __isl_give isl_space *isl_point_get_space( @@ -634,12 +640,14 @@ arguments may have different parameters (as long as they are named), in which case the result will have as parameters the union of the parameters of the arguments. -Given the identifier of a dimension (typically a parameter), +Given the identifier or name of a dimension (typically a parameter), its position can be obtained from the following function. #include int isl_space_find_dim_by_id(__isl_keep isl_space *space, enum isl_dim_type type, __isl_keep isl_id *id); + int isl_space_find_dim_by_name(__isl_keep isl_space *space, + enum isl_dim_type type, const char *name); The identifiers or names of entire spaces may be set or read off using the following functions. @@ -737,7 +745,7 @@ A new local space can be created from a space using __isl_give isl_local_space *isl_local_space_from_space( __isl_take isl_space *space); -They can be inspected, copied and freed using the following functions. +They can be inspected, modified, copied and freed using the following functions. #include isl_ctx *isl_local_space_get_ctx( @@ -751,6 +759,10 @@ They can be inspected, copied and freed using the following functions. __isl_give isl_local_space *isl_local_space_set_dim_name( __isl_take isl_local_space *ls, enum isl_dim_type type, unsigned pos, const char *s); + __isl_give isl_local_space *isl_local_space_set_dim_id( + __isl_take isl_local_space *ls, + enum isl_dim_type type, unsigned pos, + __isl_take isl_id *id); __isl_give isl_space *isl_local_space_get_space( __isl_keep isl_local_space *ls); __isl_give isl_aff *isl_local_space_get_div( @@ -771,6 +783,9 @@ using the following functions. __isl_take isl_local_space *ls); __isl_give isl_local_space *isl_local_space_from_domain( __isl_take isl_local_space *ls); + __isl_give isl_local_space *isl_local_space_intersect( + __isl_take isl_local_space *ls1, + __isl_take isl_local_space *ls2); __isl_give isl_local_space *isl_local_space_add_dims( __isl_take isl_local_space *ls, enum isl_dim_type type, unsigned n); @@ -1193,8 +1208,10 @@ of C, C, C, C and C for relations. A (basic) set or relation can also be constructed from a (piecewise) -affine expression -or a list of affine expressions (See L<"Piecewise Quasi Affine Expressions">). +(multiple) affine expression +or a list of affine expressions +(See L<"Piecewise Quasi Affine Expressions"> and +L<"Piecewise Multiple Quasi Affine Expressions">). __isl_give isl_basic_map *isl_basic_map_from_aff( __isl_take isl_aff *aff); @@ -1205,6 +1222,12 @@ or a list of affine expressions (See L<"Piecewise Quasi Affine Expressions">). __isl_give isl_basic_map *isl_basic_map_from_aff_list( __isl_take isl_space *domain_space, __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_set *isl_set_from_pw_multi_aff( + __isl_take isl_pw_multi_aff *pma); + __isl_give isl_map *isl_map_from_pw_multi_aff( + __isl_take isl_pw_multi_aff *pma); The C argument describes the domain of the resulting basic relation. It is required because the C may consist @@ -1461,6 +1484,9 @@ read off using the following functions. __isl_give isl_id *isl_set_get_dim_id( __isl_keep isl_set *set, enum isl_dim_type type, unsigned pos); + int isl_basic_map_has_dim_id( + __isl_keep isl_basic_map *bmap, + enum isl_dim_type type, unsigned pos); __isl_give isl_map *isl_map_set_dim_id( __isl_take isl_map *map, enum isl_dim_type type, unsigned pos, __isl_take isl_id *id); @@ -1474,6 +1500,8 @@ read off using the following functions. enum isl_dim_type type, __isl_keep isl_id *id); int isl_map_find_dim_by_id(__isl_keep isl_map *map, enum isl_dim_type type, __isl_keep isl_id *id); + int isl_map_find_dim_by_name(__isl_keep isl_map *map, + enum isl_dim_type type, const char *name); const char *isl_constraint_get_dim_name( __isl_keep isl_constraint *constraint, @@ -1551,6 +1579,9 @@ is already known to be empty. __isl_keep isl_basic_map *bmap, enum isl_dim_type type, unsigned pos, isl_int *val); + int isl_set_plain_is_fixed(__isl_keep isl_set *set, + enum isl_dim_type type, unsigned pos, + isl_int *val); int isl_map_plain_is_fixed(__isl_keep isl_map *map, enum isl_dim_type type, unsigned pos, isl_int *val); @@ -1714,6 +1745,10 @@ that maps (a wrapped version of) the input relation to its domain or range. __isl_give isl_set *isl_set_eliminate( __isl_take isl_set *set, enum isl_dim_type type, unsigned first, unsigned n); + __isl_give isl_basic_map *isl_basic_map_eliminate( + __isl_take isl_basic_map *bmap, + enum isl_dim_type type, + unsigned first, unsigned n); Eliminate the coefficients for the given dimensions from the constraints, without removing the dimensions. @@ -1917,9 +1952,12 @@ C, C or C. __isl_take isl_set *set, int pos); __isl_give isl_pw_aff *isl_set_dim_max( __isl_take isl_set *set, int pos); + __isl_give isl_pw_aff *isl_map_dim_max( + __isl_take isl_map *map, int pos); -Compute the minimum or maximum of the given set dimension as a function of the -parameters, but independently of the other set dimensions. +Compute the minimum or maximum of the given set or output dimension +as a function of the parameters (and input dimensions), but independently +of the other set or output dimensions. For lexicographic optimization, see L<"Lexicographic Optimization">. =item * Dual @@ -2050,6 +2088,15 @@ existentially quantified variables. __isl_give isl_union_set *isl_union_set_lift( __isl_take isl_union_set *uset); +Given a local space that contains the existentially quantified +variables of a set, a basic relation that, when applied to +a basic set, has essentially the same effect as C, +can be constructed using the following function. + + #include + __isl_give isl_basic_map *isl_local_space_lifting( + __isl_take isl_local_space *ls); + =item * Internal Product __isl_give isl_basic_map *isl_basic_map_zip( @@ -2430,6 +2477,36 @@ 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); +The following functions return their result in the form of +a piecewise multi-affine expression +(See L<"Piecewise Multiple Quasi Affine Expressions">), +but are otherwise equivalent to the corresponding functions +returning a basic set or relation. + + __isl_give isl_pw_multi_aff * + isl_basic_map_lexmin_pw_multi_aff( + __isl_take isl_basic_map *bmap); + __isl_give isl_pw_multi_aff * + isl_basic_set_partial_lexmin_pw_multi_aff( + __isl_take isl_basic_set *bset, + __isl_take isl_basic_set *dom, + __isl_give isl_set **empty); + __isl_give isl_pw_multi_aff * + isl_basic_set_partial_lexmax_pw_multi_aff( + __isl_take isl_basic_set *bset, + __isl_take isl_basic_set *dom, + __isl_give isl_set **empty); + __isl_give isl_pw_multi_aff * + isl_basic_map_partial_lexmin_pw_multi_aff( + __isl_take isl_basic_map *bmap, + __isl_take isl_basic_set *dom, + __isl_give isl_set **empty); + __isl_give isl_pw_multi_aff * + isl_basic_map_partial_lexmax_pw_multi_aff( + __isl_take isl_basic_map *bmap, + __isl_take isl_basic_set *dom, + __isl_give isl_set **empty); + =head2 Lists Lists are defined over several element types, including @@ -2582,6 +2659,12 @@ The expression can be inspected using __isl_keep isl_aff *aff); const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff, enum isl_dim_type type, unsigned pos); + const char *isl_pw_aff_get_dim_name( + __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); int isl_aff_get_constant(__isl_keep isl_aff *aff, isl_int *v); int isl_aff_get_coefficient(__isl_keep isl_aff *aff, @@ -2614,10 +2697,17 @@ It can be modified using #include __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id( __isl_take isl_pw_aff *pwaff, - __isl_take isl_id *id); + enum isl_dim_type type, __isl_take isl_id *id); __isl_give isl_aff *isl_aff_set_dim_name( __isl_take isl_aff *aff, enum isl_dim_type type, unsigned pos, const char *s); + __isl_give isl_aff *isl_aff_set_dim_id( + __isl_take isl_aff *aff, enum isl_dim_type type, + unsigned pos, __isl_take isl_id *id); + __isl_give isl_pw_aff *isl_pw_aff_set_dim_id( + __isl_take isl_pw_aff *pma, + enum isl_dim_type type, unsigned pos, + __isl_take isl_id *id); __isl_give isl_aff *isl_aff_set_constant( __isl_take isl_aff *aff, isl_int v); __isl_give isl_aff *isl_aff_set_constant_si( @@ -2673,6 +2763,9 @@ or obviously equal to some other affine expression, use int isl_aff_plain_is_zero(__isl_keep isl_aff *aff); int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1, __isl_keep isl_aff *aff2); + int isl_pw_aff_plain_is_equal( + __isl_keep isl_pw_aff *pwaff1, + __isl_keep isl_pw_aff *pwaff2); Operations include @@ -2737,6 +2830,9 @@ Operations include __isl_give isl_set *isl_pw_aff_domain( __isl_take isl_pw_aff *pwaff); + __isl_give isl_pw_aff *isl_pw_aff_intersect_domain( + __isl_take isl_pw_aff *pa, + __isl_take isl_set *set); __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1, __isl_take isl_aff *aff2); @@ -2837,6 +2933,14 @@ the maximum of those of C and C. If only one of C or C is defined on a given cell, then the associated expression is the defined one. +An expression can be read from input using + + #include + __isl_give isl_aff *isl_aff_read_from_str( + isl_ctx *ctx, const char *str); + __isl_give isl_pw_aff *isl_pw_aff_read_from_str( + isl_ctx *ctx, const char *str); + An expression can be printed using #include @@ -2847,6 +2951,146 @@ An expression can be printed using __isl_take isl_printer *p, __isl_keep isl_pw_aff *pwaff); +=head2 Piecewise Multiple Quasi Affine Expressions + +An C object represents a sequence of +zero or more affine expressions, all defined on the same domain space. + +An C can be constructed from a C using the +following function. + + #include + __isl_give isl_multi_aff *isl_multi_aff_from_aff_list( + __isl_take isl_space *space, + __isl_take isl_aff_list *list); + +An empty piecewise multiple quasi affine expression (one with no cells) or +a piecewise multiple quasi affine expression with a single cell can +be created using the following functions. + + #include + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty( + __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); + +A piecewise multiple quasi affine expression can also be initialized +from an C or C, provided the C is a singleton +and the C is single-valued. + + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set( + __isl_take isl_set *set); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map( + __isl_take isl_map *map); + +Multiple quasi affine expressions can be copied and freed using + + #include + __isl_give isl_multi_aff *isl_multi_aff_copy( + __isl_keep isl_multi_aff *maff); + void *isl_multi_aff_free(__isl_take isl_multi_aff *maff); + + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy( + __isl_keep isl_pw_multi_aff *pma); + void *isl_pw_multi_aff_free( + __isl_take isl_pw_multi_aff *pma); + +The expression can be inspected using + + #include + isl_ctx *isl_multi_aff_get_ctx( + __isl_keep isl_multi_aff *maff); + isl_ctx *isl_pw_multi_aff_get_ctx( + __isl_keep isl_pw_multi_aff *pma); + unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff, + enum isl_dim_type type); + unsigned isl_pw_multi_aff_dim( + __isl_keep isl_pw_multi_aff *pma, + enum isl_dim_type type); + __isl_give isl_aff *isl_multi_aff_get_aff( + __isl_keep isl_multi_aff *multi, int pos); + const char *isl_pw_multi_aff_get_dim_name( + __isl_keep isl_pw_multi_aff *pma, + enum isl_dim_type type, unsigned pos); + __isl_give isl_id *isl_pw_multi_aff_get_dim_id( + __isl_keep isl_pw_multi_aff *pma, + enum isl_dim_type type, unsigned pos); + const char *isl_multi_aff_get_tuple_name( + __isl_keep isl_multi_aff *multi, + 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); + int isl_pw_multi_aff_has_tuple_id( + __isl_keep isl_pw_multi_aff *pma, + enum isl_dim_type type); + __isl_give isl_id *isl_pw_multi_aff_get_tuple_id( + __isl_keep isl_pw_multi_aff *pma, + enum isl_dim_type type); + + int isl_pw_multi_aff_foreach_piece( + __isl_keep isl_pw_multi_aff *pma, + int (*fn)(__isl_take isl_set *set, + __isl_take isl_multi_aff *maff, + void *user), void *user); + +It can be modified using + + #include + __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); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id( + __isl_take isl_pw_multi_aff *pma, + enum isl_dim_type type, __isl_take isl_id *id); + +To check whether two multiple affine expressions are +obviously equal to each other, use + + int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1, + __isl_keep isl_multi_aff *maff2); + int isl_pw_multi_aff_plain_is_equal( + __isl_keep isl_pw_multi_aff *pma1, + __isl_keep isl_pw_multi_aff *pma2); + +Operations include + + #include + __isl_give isl_multi_aff *isl_multi_aff_add( + __isl_take isl_multi_aff *maff1, + __isl_take isl_multi_aff *maff2); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add( + __isl_take isl_pw_multi_aff *pma1, + __isl_take isl_pw_multi_aff *pma2); + __isl_give isl_multi_aff *isl_multi_aff_scale( + __isl_take isl_multi_aff *maff, + isl_int f); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain( + __isl_take isl_pw_multi_aff *pma, + __isl_take isl_set *set); + __isl_give isl_multi_aff *isl_multi_aff_gist( + __isl_take isl_multi_aff *maff, + __isl_take isl_set *context); + +An expression can be read from input using + + #include + __isl_give isl_multi_aff *isl_multi_aff_read_from_str( + isl_ctx *ctx, const char *str); + __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str( + isl_ctx *ctx, const char *str); + +An expression can be printed using + + #include + __isl_give isl_printer *isl_printer_print_multi_aff( + __isl_take isl_printer *p, + __isl_keep isl_multi_aff *maff); + __isl_give isl_printer *isl_printer_print_pw_multi_aff( + __isl_take isl_printer *p, + __isl_keep isl_pw_multi_aff *pma); + =head2 Points Points are elements of a set. They can be used to construct