rename isl_pw_aff_add to isl_pw_aff_union_add
[isl.git] / doc / user.pod
blobaccd9b1f4ba2a654a99f966ced07d0eda6312452
1 =head1 Introduction
3 C<isl> is a thread-safe C library for manipulating
4 sets and relations of integer points bounded by affine constraints.
5 The descriptions of the sets and relations may involve
6 both parameters and existentially quantified variables.
7 All computations are performed in exact integer arithmetic
8 using C<GMP>.
9 The C<isl> library offers functionality that is similar
10 to that offered by the C<Omega> and C<Omega+> libraries,
11 but the underlying algorithms are in most cases completely different.
13 The library is by no means complete and some fairly basic
14 functionality is still missing.
15 Still, even in its current form, the library has been successfully
16 used as a backend polyhedral library for the polyhedral
17 scanner C<CLooG> and as part of an equivalence checker of
18 static affine programs.
19 For bug reports, feature requests and questions,
20 visit the the discussion group at
21 L<http://groups.google.com/group/isl-development>.
23 =head2 Backward Incompatible Changes
25 =head3 Changes since isl-0.02
27 =over
29 =item * The old printing functions have been deprecated
30 and replaced by C<isl_printer> functions, see L<Input and Output>.
32 =item * Most functions related to dependence analysis have acquired
33 an extra C<must> argument.  To obtain the old behavior, this argument
34 should be given the value 1.  See L<Dependence Analysis>.
36 =back
38 =head3 Changes since isl-0.03
40 =over
42 =item * The function C<isl_pw_qpolynomial_fold_add> has been
43 renamed to C<isl_pw_qpolynomial_fold_fold>.
44 Similarly, C<isl_union_pw_qpolynomial_fold_add> has been
45 renamed to C<isl_union_pw_qpolynomial_fold_fold>.
47 =back
49 =head3 Changes since isl-0.04
51 =over
53 =item * All header files have been renamed from C<isl_header.h>
54 to C<isl/header.h>.
56 =back
58 =head3 Changes since isl-0.05
60 =over
62 =item * The functions C<isl_printer_print_basic_set> and
63 C<isl_printer_print_basic_map> no longer print a newline.
65 =item * The functions C<isl_flow_get_no_source>
66 and C<isl_union_map_compute_flow> now return
67 the accesses for which no source could be found instead of
68 the iterations where those accesses occur.
70 =item * The functions C<isl_basic_map_identity> and
71 C<isl_map_identity> now take a B<map> space as input.  An old call
72 C<isl_map_identity(space)> can be rewritten to
73 C<isl_map_identity(isl_space_map_from_set(space))>.
75 =item * The function C<isl_map_power> no longer takes
76 a parameter position as input.  Instead, the exponent
77 is now expressed as the domain of the resulting relation.
79 =back
81 =head3 Changes since isl-0.06
83 =over
85 =item * The format of C<isl_printer_print_qpolynomial>'s
86 C<ISL_FORMAT_ISL> output has changed.
87 Use C<ISL_FORMAT_C> to obtain the old output.
89 =item * The C<*_fast_*> functions have been renamed to C<*_plain_*>.
90 Some of the old names have been kept for backward compatibility,
91 but they will be removed in the future.
93 =back
95 =head3 Changes since isl-0.07
97 =over
99 =item * The function C<isl_pw_aff_max> has been renamed to
100 C<isl_pw_aff_union_max>.
101 Similarly, the function C<isl_pw_aff_add> has been renamed to
102 C<isl_pw_aff_union_add>.
104 =item * The C<isl_dim> type has been renamed to C<isl_space>
105 along with the associated functions.
106 Some of the old names have been kept for backward compatibility,
107 but they will be removed in the future.
109 =item * Spaces of maps, sets and parameter domains are now
110 treated differently.  The distinction between map spaces and set spaces
111 has always been made on a conceptual level, but proper use of such spaces
112 was never checked.  Furthermore, up until isl-0.07 there was no way
113 of explicitly creating a parameter space.  These can now be created
114 directly using C<isl_space_params_alloc> or from other spaces using
115 C<isl_space_params>.
117 =item * The space in which C<isl_aff>, C<isl_pw_aff>, C<isl_qpolynomial>,
118 C<isl_pw_qpolynomial>, C<isl_qpolynomial_fold> and C<isl_pw_qpolynomial_fold>
119 objects live is now a map space
120 instead of a set space.  This means, for example, that the dimensions
121 of the domain of an C<isl_aff> are now considered to be of type
122 C<isl_dim_in> instead of C<isl_dim_set>.  Extra functions have been
123 added to obtain the domain space.  Some of the constructors still
124 take a domain space and have therefore been renamed.
126 =item * The functions C<isl_equality_alloc> and C<isl_inequality_alloc>
127 now take an C<isl_local_space> instead of an C<isl_space>.
128 An C<isl_local_space> can be created from an C<isl_space>
129 using C<isl_local_space_from_space>.
131 =item * The C<isl_div> type has been removed.  Functions that used
132 to return an C<isl_div> now return an C<isl_aff>.
133 Note that the space of an C<isl_aff> is that of relation.
134 When replacing a call to C<isl_div_get_coefficient> by a call to
135 C<isl_aff_get_coefficient> any C<isl_dim_set> argument needs
136 to be replaced by C<isl_dim_in>.
137 A call to C<isl_aff_from_div> can be replaced by a call
138 to C<isl_aff_floor>.
139 A call to C<isl_qpolynomial_div(div)> call be replaced by
140 the nested call
142         isl_qpolynomial_from_aff(isl_aff_floor(div))
144 The function C<isl_constraint_div> has also been renamed
145 to C<isl_constraint_get_div>.
147 =item * The C<nparam> argument has been removed from
148 C<isl_map_read_from_str> and similar functions.
149 When reading input in the original PolyLib format,
150 the result will have no parameters.
151 If parameters are expected, the caller may want to perform
152 dimension manipulation on the result.
154 =back
156 =head1 Installation
158 The source of C<isl> can be obtained either as a tarball
159 or from the git repository.  Both are available from
160 L<http://freshmeat.net/projects/isl/>.
161 The installation process depends on how you obtained
162 the source.
164 =head2 Installation from the git repository
166 =over
168 =item 1 Clone or update the repository
170 The first time the source is obtained, you need to clone
171 the repository.
173         git clone git://repo.or.cz/isl.git
175 To obtain updates, you need to pull in the latest changes
177         git pull
179 =item 2 Generate C<configure>
181         ./autogen.sh
183 =back
185 After performing the above steps, continue
186 with the L<Common installation instructions>.
188 =head2 Common installation instructions
190 =over
192 =item 1 Obtain C<GMP>
194 Building C<isl> requires C<GMP>, including its headers files.
195 Your distribution may not provide these header files by default
196 and you may need to install a package called C<gmp-devel> or something
197 similar.  Alternatively, C<GMP> can be built from
198 source, available from L<http://gmplib.org/>.
200 =item 2 Configure
202 C<isl> uses the standard C<autoconf> C<configure> script.
203 To run it, just type
205         ./configure
207 optionally followed by some configure options.
208 A complete list of options can be obtained by running
210         ./configure --help
212 Below we discuss some of the more common options.
214 C<isl> can optionally use C<piplib>, but no
215 C<piplib> functionality is currently used by default.
216 The C<--with-piplib> option can
217 be used to specify which C<piplib>
218 library to use, either an installed version (C<system>),
219 an externally built version (C<build>)
220 or no version (C<no>).  The option C<build> is mostly useful
221 in C<configure> scripts of larger projects that bundle both C<isl>
222 and C<piplib>.
224 =over
226 =item C<--prefix>
228 Installation prefix for C<isl>
230 =item C<--with-gmp-prefix>
232 Installation prefix for C<GMP> (architecture-independent files).
234 =item C<--with-gmp-exec-prefix>
236 Installation prefix for C<GMP> (architecture-dependent files).
238 =item C<--with-piplib>
240 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
242 =item C<--with-piplib-prefix>
244 Installation prefix for C<system> C<piplib> (architecture-independent files).
246 =item C<--with-piplib-exec-prefix>
248 Installation prefix for C<system> C<piplib> (architecture-dependent files).
250 =item C<--with-piplib-builddir>
252 Location where C<build> C<piplib> was built.
254 =back
256 =item 3 Compile
258         make
260 =item 4 Install (optional)
262         make install
264 =back
266 =head1 Library
268 =head2 Initialization
270 All manipulations of integer sets and relations occur within
271 the context of an C<isl_ctx>.
272 A given C<isl_ctx> can only be used within a single thread.
273 All arguments of a function are required to have been allocated
274 within the same context.
275 There are currently no functions available for moving an object
276 from one C<isl_ctx> to another C<isl_ctx>.  This means that
277 there is currently no way of safely moving an object from one
278 thread to another, unless the whole C<isl_ctx> is moved.
280 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
281 freed using C<isl_ctx_free>.
282 All objects allocated within an C<isl_ctx> should be freed
283 before the C<isl_ctx> itself is freed.
285         isl_ctx *isl_ctx_alloc();
286         void isl_ctx_free(isl_ctx *ctx);
288 =head2 Integers
290 All operations on integers, mainly the coefficients
291 of the constraints describing the sets and relations,
292 are performed in exact integer arithmetic using C<GMP>.
293 However, to allow future versions of C<isl> to optionally
294 support fixed integer arithmetic, all calls to C<GMP>
295 are wrapped inside C<isl> specific macros.
296 The basic type is C<isl_int> and the operations below
297 are available on this type.
298 The meanings of these operations are essentially the same
299 as their C<GMP> C<mpz_> counterparts.
300 As always with C<GMP> types, C<isl_int>s need to be
301 initialized with C<isl_int_init> before they can be used
302 and they need to be released with C<isl_int_clear>
303 after the last use.
304 The user should not assume that an C<isl_int> is represented
305 as a C<mpz_t>, but should instead explicitly convert between
306 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
307 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
309 =over
311 =item isl_int_init(i)
313 =item isl_int_clear(i)
315 =item isl_int_set(r,i)
317 =item isl_int_set_si(r,i)
319 =item isl_int_set_gmp(r,g)
321 =item isl_int_get_gmp(i,g)
323 =item isl_int_abs(r,i)
325 =item isl_int_neg(r,i)
327 =item isl_int_swap(i,j)
329 =item isl_int_swap_or_set(i,j)
331 =item isl_int_add_ui(r,i,j)
333 =item isl_int_sub_ui(r,i,j)
335 =item isl_int_add(r,i,j)
337 =item isl_int_sub(r,i,j)
339 =item isl_int_mul(r,i,j)
341 =item isl_int_mul_ui(r,i,j)
343 =item isl_int_addmul(r,i,j)
345 =item isl_int_submul(r,i,j)
347 =item isl_int_gcd(r,i,j)
349 =item isl_int_lcm(r,i,j)
351 =item isl_int_divexact(r,i,j)
353 =item isl_int_cdiv_q(r,i,j)
355 =item isl_int_fdiv_q(r,i,j)
357 =item isl_int_fdiv_r(r,i,j)
359 =item isl_int_fdiv_q_ui(r,i,j)
361 =item isl_int_read(r,s)
363 =item isl_int_print(out,i,width)
365 =item isl_int_sgn(i)
367 =item isl_int_cmp(i,j)
369 =item isl_int_cmp_si(i,si)
371 =item isl_int_eq(i,j)
373 =item isl_int_ne(i,j)
375 =item isl_int_lt(i,j)
377 =item isl_int_le(i,j)
379 =item isl_int_gt(i,j)
381 =item isl_int_ge(i,j)
383 =item isl_int_abs_eq(i,j)
385 =item isl_int_abs_ne(i,j)
387 =item isl_int_abs_lt(i,j)
389 =item isl_int_abs_gt(i,j)
391 =item isl_int_abs_ge(i,j)
393 =item isl_int_is_zero(i)
395 =item isl_int_is_one(i)
397 =item isl_int_is_negone(i)
399 =item isl_int_is_pos(i)
401 =item isl_int_is_neg(i)
403 =item isl_int_is_nonpos(i)
405 =item isl_int_is_nonneg(i)
407 =item isl_int_is_divisible_by(i,j)
409 =back
411 =head2 Sets and Relations
413 C<isl> uses six types of objects for representing sets and relations,
414 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
415 C<isl_union_set> and C<isl_union_map>.
416 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
417 can be described as a conjunction of affine constraints, while
418 C<isl_set> and C<isl_map> represent unions of
419 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
420 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
421 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
422 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
423 where spaces are considered different if they have a different number
424 of dimensions and/or different names (see L<"Spaces">).
425 The difference between sets and relations (maps) is that sets have
426 one set of variables, while relations have two sets of variables,
427 input variables and output variables.
429 =head2 Memory Management
431 Since a high-level operation on sets and/or relations usually involves
432 several substeps and since the user is usually not interested in
433 the intermediate results, most functions that return a new object
434 will also release all the objects passed as arguments.
435 If the user still wants to use one or more of these arguments
436 after the function call, she should pass along a copy of the
437 object rather than the object itself.
438 The user is then responsible for making sure that the original
439 object gets used somewhere else or is explicitly freed.
441 The arguments and return values of all documented functions are
442 annotated to make clear which arguments are released and which
443 arguments are preserved.  In particular, the following annotations
444 are used
446 =over
448 =item C<__isl_give>
450 C<__isl_give> means that a new object is returned.
451 The user should make sure that the returned pointer is
452 used exactly once as a value for an C<__isl_take> argument.
453 In between, it can be used as a value for as many
454 C<__isl_keep> arguments as the user likes.
455 There is one exception, and that is the case where the
456 pointer returned is C<NULL>.  Is this case, the user
457 is free to use it as an C<__isl_take> argument or not.
459 =item C<__isl_take>
461 C<__isl_take> means that the object the argument points to
462 is taken over by the function and may no longer be used
463 by the user as an argument to any other function.
464 The pointer value must be one returned by a function
465 returning an C<__isl_give> pointer.
466 If the user passes in a C<NULL> value, then this will
467 be treated as an error in the sense that the function will
468 not perform its usual operation.  However, it will still
469 make sure that all the other C<__isl_take> arguments
470 are released.
472 =item C<__isl_keep>
474 C<__isl_keep> means that the function will only use the object
475 temporarily.  After the function has finished, the user
476 can still use it as an argument to other functions.
477 A C<NULL> value will be treated in the same way as
478 a C<NULL> value for an C<__isl_take> argument.
480 =back
482 =head2 Identifiers
484 Identifiers are used to identify both individual dimensions
485 and tuples of dimensions.  They consist of a name and an optional
486 pointer.  Identifiers with the same name but different pointer values
487 are considered to be distinct.
488 Identifiers can be constructed, copied, freed, inspected and printed
489 using the following functions.
491         #include <isl/id.h>
492         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
493                 __isl_keep const char *name, void *user);
494         __isl_give isl_id *isl_id_copy(isl_id *id);
495         void *isl_id_free(__isl_take isl_id *id);
497         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
498         void *isl_id_get_user(__isl_keep isl_id *id);
499         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
501         __isl_give isl_printer *isl_printer_print_id(
502                 __isl_take isl_printer *p, __isl_keep isl_id *id);
504 Note that C<isl_id_get_name> returns a pointer to some internal
505 data structure, so the result can only be used while the
506 corresponding C<isl_id> is alive.
508 =head2 Spaces
510 Whenever a new set or relation is created from scratch,
511 the space in which it lives needs to be specified using an C<isl_space>.
513         #include <isl/space.h>
514         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
515                 unsigned nparam, unsigned n_in, unsigned n_out);
516         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
517                 unsigned nparam);
518         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
519                 unsigned nparam, unsigned dim);
520         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
521         void isl_space_free(__isl_take isl_space *space);
522         unsigned isl_space_dim(__isl_keep isl_space *space,
523                 enum isl_dim_type type);
525 The space used for creating a parameter domain
526 needs to be created using C<isl_space_params_alloc>.
527 For other sets, the space
528 needs to be created using C<isl_space_set_alloc>, while
529 for a relation, the space
530 needs to be created using C<isl_space_alloc>.
531 C<isl_space_dim> can be used
532 to find out the number of dimensions of each type in
533 a space, where type may be
534 C<isl_dim_param>, C<isl_dim_in> (only for relations),
535 C<isl_dim_out> (only for relations), C<isl_dim_set>
536 (only for sets) or C<isl_dim_all>.
538 To check whether a given space is that of a set or a map
539 or whether it is a parameter space, use these functions:
541         #include <isl/space.h>
542         int isl_space_is_params(__isl_keep isl_space *space);
543         int isl_space_is_set(__isl_keep isl_space *space);
545 It is often useful to create objects that live in the
546 same space as some other object.  This can be accomplished
547 by creating the new objects
548 (see L<Creating New Sets and Relations> or
549 L<Creating New (Piecewise) Quasipolynomials>) based on the space
550 of the original object.
552         #include <isl/set.h>
553         __isl_give isl_space *isl_basic_set_get_space(
554                 __isl_keep isl_basic_set *bset);
555         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
557         #include <isl/union_set.h>
558         __isl_give isl_space *isl_union_set_get_space(
559                 __isl_keep isl_union_set *uset);
561         #include <isl/map.h>
562         __isl_give isl_space *isl_basic_map_get_space(
563                 __isl_keep isl_basic_map *bmap);
564         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
566         #include <isl/union_map.h>
567         __isl_give isl_space *isl_union_map_get_space(
568                 __isl_keep isl_union_map *umap);
570         #include <isl/constraint.h>
571         __isl_give isl_space *isl_constraint_get_space(
572                 __isl_keep isl_constraint *constraint);
574         #include <isl/polynomial.h>
575         __isl_give isl_space *isl_qpolynomial_get_domain_space(
576                 __isl_keep isl_qpolynomial *qp);
577         __isl_give isl_space *isl_qpolynomial_get_space(
578                 __isl_keep isl_qpolynomial *qp);
579         __isl_give isl_space *isl_qpolynomial_fold_get_space(
580                 __isl_keep isl_qpolynomial_fold *fold);
581         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
582                 __isl_keep isl_pw_qpolynomial *pwqp);
583         __isl_give isl_space *isl_pw_qpolynomial_get_space(
584                 __isl_keep isl_pw_qpolynomial *pwqp);
585         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
586                 __isl_keep isl_pw_qpolynomial_fold *pwf);
587         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
588                 __isl_keep isl_pw_qpolynomial_fold *pwf);
589         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
590                 __isl_keep isl_union_pw_qpolynomial *upwqp);
591         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
592                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
594         #include <isl/aff.h>
595         __isl_give isl_space *isl_aff_get_domain_space(
596                 __isl_keep isl_aff *aff);
597         __isl_give isl_space *isl_aff_get_space(
598                 __isl_keep isl_aff *aff);
599         __isl_give isl_space *isl_pw_aff_get_domain_space(
600                 __isl_keep isl_pw_aff *pwaff);
601         __isl_give isl_space *isl_pw_aff_get_space(
602                 __isl_keep isl_pw_aff *pwaff);
603         __isl_give isl_space *isl_multi_aff_get_space(
604                 __isl_keep isl_multi_aff *maff);
605         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
606                 __isl_keep isl_pw_multi_aff *pma);
607         __isl_give isl_space *isl_pw_multi_aff_get_space(
608                 __isl_keep isl_pw_multi_aff *pma);
610         #include <isl/point.h>
611         __isl_give isl_space *isl_point_get_space(
612                 __isl_keep isl_point *pnt);
614 The identifiers or names of the individual dimensions may be set or read off
615 using the following functions.
617         #include <isl/space.h>
618         __isl_give isl_space *isl_space_set_dim_id(
619                 __isl_take isl_space *space,
620                 enum isl_dim_type type, unsigned pos,
621                 __isl_take isl_id *id);
622         int isl_space_has_dim_id(__isl_keep isl_space *space,
623                 enum isl_dim_type type, unsigned pos);
624         __isl_give isl_id *isl_space_get_dim_id(
625                 __isl_keep isl_space *space,
626                 enum isl_dim_type type, unsigned pos);
627         __isl_give isl_space *isl_space_set_dim_name(__isl_take isl_space *space,
628                                  enum isl_dim_type type, unsigned pos,
629                                  __isl_keep const char *name);
630         __isl_keep const char *isl_space_get_dim_name(__isl_keep isl_space *space,
631                                  enum isl_dim_type type, unsigned pos);
633 Note that C<isl_space_get_name> returns a pointer to some internal
634 data structure, so the result can only be used while the
635 corresponding C<isl_space> is alive.
636 Also note that every function that operates on two sets or relations
637 requires that both arguments have the same parameters.  This also
638 means that if one of the arguments has named parameters, then the
639 other needs to have named parameters too and the names need to match.
640 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
641 arguments may have different parameters (as long as they are named),
642 in which case the result will have as parameters the union of the parameters of
643 the arguments.
645 Given the identifier or name of a dimension (typically a parameter),
646 its position can be obtained from the following function.
648         #include <isl/space.h>
649         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
650                 enum isl_dim_type type, __isl_keep isl_id *id);
651         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
652                 enum isl_dim_type type, const char *name);
654 The identifiers or names of entire spaces may be set or read off
655 using the following functions.
657         #include <isl/space.h>
658         __isl_give isl_space *isl_space_set_tuple_id(
659                 __isl_take isl_space *space,
660                 enum isl_dim_type type, __isl_take isl_id *id);
661         __isl_give isl_space *isl_space_reset_tuple_id(
662                 __isl_take isl_space *space, enum isl_dim_type type);
663         int isl_space_has_tuple_id(__isl_keep isl_space *space,
664                 enum isl_dim_type type);
665         __isl_give isl_id *isl_space_get_tuple_id(
666                 __isl_keep isl_space *space, enum isl_dim_type type);
667         __isl_give isl_space *isl_space_set_tuple_name(
668                 __isl_take isl_space *space,
669                 enum isl_dim_type type, const char *s);
670         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
671                 enum isl_dim_type type);
673 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
674 or C<isl_dim_set>.  As with C<isl_space_get_name>,
675 the C<isl_space_get_tuple_name> function returns a pointer to some internal
676 data structure.
677 Binary operations require the corresponding spaces of their arguments
678 to have the same name.
680 Spaces can be nested.  In particular, the domain of a set or
681 the domain or range of a relation can be a nested relation.
682 The following functions can be used to construct and deconstruct
683 such nested spaces.
685         #include <isl/space.h>
686         int isl_space_is_wrapping(__isl_keep isl_space *space);
687         __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
688         __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
690 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
691 be the space of a set, while that of
692 C<isl_space_wrap> should be the space of a relation.
693 Conversely, the output of C<isl_space_unwrap> is the space
694 of a relation, while that of C<isl_space_wrap> is the space of a set.
696 Spaces can be created from other spaces
697 using the following functions.
699         __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
700         __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
701         __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
702         __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
703         __isl_give isl_space *isl_space_params(
704                 __isl_take isl_space *space);
705         __isl_give isl_space *isl_space_set_from_params(
706                 __isl_take isl_space *space);
707         __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
708         __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
709                 __isl_take isl_space *right);
710         __isl_give isl_space *isl_space_align_params(
711                 __isl_take isl_space *space1, __isl_take isl_space *space2)
712         __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
713                 enum isl_dim_type type, unsigned pos, unsigned n);
714         __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
715                 enum isl_dim_type type, unsigned n);
716         __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
717                 enum isl_dim_type type, unsigned first, unsigned n);
718         __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
719                 enum isl_dim_type dst_type, unsigned dst_pos,
720                 enum isl_dim_type src_type, unsigned src_pos,
721                 unsigned n);
722         __isl_give isl_space *isl_space_map_from_set(
723                 __isl_take isl_space *space);
724         __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
726 Note that if dimensions are added or removed from a space, then
727 the name and the internal structure are lost.
729 =head2 Local Spaces
731 A local space is essentially a space with
732 zero or more existentially quantified variables.
733 The local space of a basic set or relation can be obtained
734 using the following functions.
736         #include <isl/set.h>
737         __isl_give isl_local_space *isl_basic_set_get_local_space(
738                 __isl_keep isl_basic_set *bset);
740         #include <isl/map.h>
741         __isl_give isl_local_space *isl_basic_map_get_local_space(
742                 __isl_keep isl_basic_map *bmap);
744 A new local space can be created from a space using
746         #include <isl/local_space.h>
747         __isl_give isl_local_space *isl_local_space_from_space(
748                 __isl_take isl_space *space);
750 They can be inspected, modified, copied and freed using the following functions.
752         #include <isl/local_space.h>
753         isl_ctx *isl_local_space_get_ctx(
754                 __isl_keep isl_local_space *ls);
755         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
756         int isl_local_space_dim(__isl_keep isl_local_space *ls,
757                 enum isl_dim_type type);
758         const char *isl_local_space_get_dim_name(
759                 __isl_keep isl_local_space *ls,
760                 enum isl_dim_type type, unsigned pos);
761         __isl_give isl_local_space *isl_local_space_set_dim_name(
762                 __isl_take isl_local_space *ls,
763                 enum isl_dim_type type, unsigned pos, const char *s);
764         __isl_give isl_local_space *isl_local_space_set_dim_id(
765                 __isl_take isl_local_space *ls,
766                 enum isl_dim_type type, unsigned pos,
767                 __isl_take isl_id *id);
768         __isl_give isl_space *isl_local_space_get_space(
769                 __isl_keep isl_local_space *ls);
770         __isl_give isl_aff *isl_local_space_get_div(
771                 __isl_keep isl_local_space *ls, int pos);
772         __isl_give isl_local_space *isl_local_space_copy(
773                 __isl_keep isl_local_space *ls);
774         void *isl_local_space_free(__isl_take isl_local_space *ls);
776 Two local spaces can be compared using
778         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
779                 __isl_keep isl_local_space *ls2);
781 Local spaces can be created from other local spaces
782 using the following functions.
784         __isl_give isl_local_space *isl_local_space_domain(
785                 __isl_take isl_local_space *ls);
786         __isl_give isl_local_space *isl_local_space_from_domain(
787                 __isl_take isl_local_space *ls);
788         __isl_give isl_local_space *isl_local_space_intersect(
789                 __isl_take isl_local_space *ls1,
790                 __isl_take isl_local_space *ls2);
791         __isl_give isl_local_space *isl_local_space_add_dims(
792                 __isl_take isl_local_space *ls,
793                 enum isl_dim_type type, unsigned n);
794         __isl_give isl_local_space *isl_local_space_insert_dims(
795                 __isl_take isl_local_space *ls,
796                 enum isl_dim_type type, unsigned first, unsigned n);
797         __isl_give isl_local_space *isl_local_space_drop_dims(
798                 __isl_take isl_local_space *ls,
799                 enum isl_dim_type type, unsigned first, unsigned n);
801 =head2 Input and Output
803 C<isl> supports its own input/output format, which is similar
804 to the C<Omega> format, but also supports the C<PolyLib> format
805 in some cases.
807 =head3 C<isl> format
809 The C<isl> format is similar to that of C<Omega>, but has a different
810 syntax for describing the parameters and allows for the definition
811 of an existentially quantified variable as the integer division
812 of an affine expression.
813 For example, the set of integers C<i> between C<0> and C<n>
814 such that C<i % 10 <= 6> can be described as
816         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
817                                 i - 10 a <= 6) }
819 A set or relation can have several disjuncts, separated
820 by the keyword C<or>.  Each disjunct is either a conjunction
821 of constraints or a projection (C<exists>) of a conjunction
822 of constraints.  The constraints are separated by the keyword
823 C<and>.
825 =head3 C<PolyLib> format
827 If the represented set is a union, then the first line
828 contains a single number representing the number of disjuncts.
829 Otherwise, a line containing the number C<1> is optional.
831 Each disjunct is represented by a matrix of constraints.
832 The first line contains two numbers representing
833 the number of rows and columns,
834 where the number of rows is equal to the number of constraints
835 and the number of columns is equal to two plus the number of variables.
836 The following lines contain the actual rows of the constraint matrix.
837 In each row, the first column indicates whether the constraint
838 is an equality (C<0>) or inequality (C<1>).  The final column
839 corresponds to the constant term.
841 If the set is parametric, then the coefficients of the parameters
842 appear in the last columns before the constant column.
843 The coefficients of any existentially quantified variables appear
844 between those of the set variables and those of the parameters.
846 =head3 Extended C<PolyLib> format
848 The extended C<PolyLib> format is nearly identical to the
849 C<PolyLib> format.  The only difference is that the line
850 containing the number of rows and columns of a constraint matrix
851 also contains four additional numbers:
852 the number of output dimensions, the number of input dimensions,
853 the number of local dimensions (i.e., the number of existentially
854 quantified variables) and the number of parameters.
855 For sets, the number of ``output'' dimensions is equal
856 to the number of set dimensions, while the number of ``input''
857 dimensions is zero.
859 =head3 Input
861         #include <isl/set.h>
862         __isl_give isl_basic_set *isl_basic_set_read_from_file(
863                 isl_ctx *ctx, FILE *input);
864         __isl_give isl_basic_set *isl_basic_set_read_from_str(
865                 isl_ctx *ctx, const char *str);
866         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
867                 FILE *input);
868         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
869                 const char *str);
871         #include <isl/map.h>
872         __isl_give isl_basic_map *isl_basic_map_read_from_file(
873                 isl_ctx *ctx, FILE *input);
874         __isl_give isl_basic_map *isl_basic_map_read_from_str(
875                 isl_ctx *ctx, const char *str);
876         __isl_give isl_map *isl_map_read_from_file(
877                 isl_ctx *ctx, FILE *input);
878         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
879                 const char *str);
881         #include <isl/union_set.h>
882         __isl_give isl_union_set *isl_union_set_read_from_file(
883                 isl_ctx *ctx, FILE *input);
884         __isl_give isl_union_set *isl_union_set_read_from_str(
885                 isl_ctx *ctx, const char *str);
887         #include <isl/union_map.h>
888         __isl_give isl_union_map *isl_union_map_read_from_file(
889                 isl_ctx *ctx, FILE *input);
890         __isl_give isl_union_map *isl_union_map_read_from_str(
891                 isl_ctx *ctx, const char *str);
893 The input format is autodetected and may be either the C<PolyLib> format
894 or the C<isl> format.
896 =head3 Output
898 Before anything can be printed, an C<isl_printer> needs to
899 be created.
901         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
902                 FILE *file);
903         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
904         void isl_printer_free(__isl_take isl_printer *printer);
905         __isl_give char *isl_printer_get_str(
906                 __isl_keep isl_printer *printer);
908 The behavior of the printer can be modified in various ways
910         __isl_give isl_printer *isl_printer_set_output_format(
911                 __isl_take isl_printer *p, int output_format);
912         __isl_give isl_printer *isl_printer_set_indent(
913                 __isl_take isl_printer *p, int indent);
914         __isl_give isl_printer *isl_printer_indent(
915                 __isl_take isl_printer *p, int indent);
916         __isl_give isl_printer *isl_printer_set_prefix(
917                 __isl_take isl_printer *p, const char *prefix);
918         __isl_give isl_printer *isl_printer_set_suffix(
919                 __isl_take isl_printer *p, const char *suffix);
921 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
922 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
923 and defaults to C<ISL_FORMAT_ISL>.
924 Each line in the output is indented by C<indent> (set by
925 C<isl_printer_set_indent>) spaces
926 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
927 In the C<PolyLib> format output,
928 the coefficients of the existentially quantified variables
929 appear between those of the set variables and those
930 of the parameters.
931 The function C<isl_printer_indent> increases the indentation
932 by the specified amount (which may be negative).
934 To actually print something, use
936         #include <isl/set.h>
937         __isl_give isl_printer *isl_printer_print_basic_set(
938                 __isl_take isl_printer *printer,
939                 __isl_keep isl_basic_set *bset);
940         __isl_give isl_printer *isl_printer_print_set(
941                 __isl_take isl_printer *printer,
942                 __isl_keep isl_set *set);
944         #include <isl/map.h>
945         __isl_give isl_printer *isl_printer_print_basic_map(
946                 __isl_take isl_printer *printer,
947                 __isl_keep isl_basic_map *bmap);
948         __isl_give isl_printer *isl_printer_print_map(
949                 __isl_take isl_printer *printer,
950                 __isl_keep isl_map *map);
952         #include <isl/union_set.h>
953         __isl_give isl_printer *isl_printer_print_union_set(
954                 __isl_take isl_printer *p,
955                 __isl_keep isl_union_set *uset);
957         #include <isl/union_map.h>
958         __isl_give isl_printer *isl_printer_print_union_map(
959                 __isl_take isl_printer *p,
960                 __isl_keep isl_union_map *umap);
962 When called on a file printer, the following function flushes
963 the file.  When called on a string printer, the buffer is cleared.
965         __isl_give isl_printer *isl_printer_flush(
966                 __isl_take isl_printer *p);
968 =head2 Creating New Sets and Relations
970 C<isl> has functions for creating some standard sets and relations.
972 =over
974 =item * Empty sets and relations
976         __isl_give isl_basic_set *isl_basic_set_empty(
977                 __isl_take isl_space *space);
978         __isl_give isl_basic_map *isl_basic_map_empty(
979                 __isl_take isl_space *space);
980         __isl_give isl_set *isl_set_empty(
981                 __isl_take isl_space *space);
982         __isl_give isl_map *isl_map_empty(
983                 __isl_take isl_space *space);
984         __isl_give isl_union_set *isl_union_set_empty(
985                 __isl_take isl_space *space);
986         __isl_give isl_union_map *isl_union_map_empty(
987                 __isl_take isl_space *space);
989 For C<isl_union_set>s and C<isl_union_map>s, the space
990 is only used to specify the parameters.
992 =item * Universe sets and relations
994         __isl_give isl_basic_set *isl_basic_set_universe(
995                 __isl_take isl_space *space);
996         __isl_give isl_basic_map *isl_basic_map_universe(
997                 __isl_take isl_space *space);
998         __isl_give isl_set *isl_set_universe(
999                 __isl_take isl_space *space);
1000         __isl_give isl_map *isl_map_universe(
1001                 __isl_take isl_space *space);
1002         __isl_give isl_union_set *isl_union_set_universe(
1003                 __isl_take isl_union_set *uset);
1004         __isl_give isl_union_map *isl_union_map_universe(
1005                 __isl_take isl_union_map *umap);
1007 The sets and relations constructed by the functions above
1008 contain all integer values, while those constructed by the
1009 functions below only contain non-negative values.
1011         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1012                 __isl_take isl_space *space);
1013         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1014                 __isl_take isl_space *space);
1015         __isl_give isl_set *isl_set_nat_universe(
1016                 __isl_take isl_space *space);
1017         __isl_give isl_map *isl_map_nat_universe(
1018                 __isl_take isl_space *space);
1020 =item * Identity relations
1022         __isl_give isl_basic_map *isl_basic_map_identity(
1023                 __isl_take isl_space *space);
1024         __isl_give isl_map *isl_map_identity(
1025                 __isl_take isl_space *space);
1027 The number of input and output dimensions in C<space> needs
1028 to be the same.
1030 =item * Lexicographic order
1032         __isl_give isl_map *isl_map_lex_lt(
1033                 __isl_take isl_space *set_space);
1034         __isl_give isl_map *isl_map_lex_le(
1035                 __isl_take isl_space *set_space);
1036         __isl_give isl_map *isl_map_lex_gt(
1037                 __isl_take isl_space *set_space);
1038         __isl_give isl_map *isl_map_lex_ge(
1039                 __isl_take isl_space *set_space);
1040         __isl_give isl_map *isl_map_lex_lt_first(
1041                 __isl_take isl_space *space, unsigned n);
1042         __isl_give isl_map *isl_map_lex_le_first(
1043                 __isl_take isl_space *space, unsigned n);
1044         __isl_give isl_map *isl_map_lex_gt_first(
1045                 __isl_take isl_space *space, unsigned n);
1046         __isl_give isl_map *isl_map_lex_ge_first(
1047                 __isl_take isl_space *space, unsigned n);
1049 The first four functions take a space for a B<set>
1050 and return relations that express that the elements in the domain
1051 are lexicographically less
1052 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1053 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1054 than the elements in the range.
1055 The last four functions take a space for a map
1056 and return relations that express that the first C<n> dimensions
1057 in the domain are lexicographically less
1058 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1059 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1060 than the first C<n> dimensions in the range.
1062 =back
1064 A basic set or relation can be converted to a set or relation
1065 using the following functions.
1067         __isl_give isl_set *isl_set_from_basic_set(
1068                 __isl_take isl_basic_set *bset);
1069         __isl_give isl_map *isl_map_from_basic_map(
1070                 __isl_take isl_basic_map *bmap);
1072 Sets and relations can be converted to union sets and relations
1073 using the following functions.
1075         __isl_give isl_union_map *isl_union_map_from_map(
1076                 __isl_take isl_map *map);
1077         __isl_give isl_union_set *isl_union_set_from_set(
1078                 __isl_take isl_set *set);
1080 The inverse conversions below can only be used if the input
1081 union set or relation is known to contain elements in exactly one
1082 space.
1084         __isl_give isl_set *isl_set_from_union_set(
1085                 __isl_take isl_union_set *uset);
1086         __isl_give isl_map *isl_map_from_union_map(
1087                 __isl_take isl_union_map *umap);
1089 A zero-dimensional set can be constructed on a given parameter domain
1090 using the following function.
1092         __isl_give isl_set *isl_set_from_params(
1093                 __isl_take isl_set *set);
1095 Sets and relations can be copied and freed again using the following
1096 functions.
1098         __isl_give isl_basic_set *isl_basic_set_copy(
1099                 __isl_keep isl_basic_set *bset);
1100         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1101         __isl_give isl_union_set *isl_union_set_copy(
1102                 __isl_keep isl_union_set *uset);
1103         __isl_give isl_basic_map *isl_basic_map_copy(
1104                 __isl_keep isl_basic_map *bmap);
1105         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1106         __isl_give isl_union_map *isl_union_map_copy(
1107                 __isl_keep isl_union_map *umap);
1108         void isl_basic_set_free(__isl_take isl_basic_set *bset);
1109         void isl_set_free(__isl_take isl_set *set);
1110         void *isl_union_set_free(__isl_take isl_union_set *uset);
1111         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
1112         void isl_map_free(__isl_take isl_map *map);
1113         void *isl_union_map_free(__isl_take isl_union_map *umap);
1115 Other sets and relations can be constructed by starting
1116 from a universe set or relation, adding equality and/or
1117 inequality constraints and then projecting out the
1118 existentially quantified variables, if any.
1119 Constraints can be constructed, manipulated and
1120 added to (or removed from) (basic) sets and relations
1121 using the following functions.
1123         #include <isl/constraint.h>
1124         __isl_give isl_constraint *isl_equality_alloc(
1125                 __isl_take isl_local_space *ls);
1126         __isl_give isl_constraint *isl_inequality_alloc(
1127                 __isl_take isl_local_space *ls);
1128         __isl_give isl_constraint *isl_constraint_set_constant(
1129                 __isl_take isl_constraint *constraint, isl_int v);
1130         __isl_give isl_constraint *isl_constraint_set_constant_si(
1131                 __isl_take isl_constraint *constraint, int v);
1132         __isl_give isl_constraint *isl_constraint_set_coefficient(
1133                 __isl_take isl_constraint *constraint,
1134                 enum isl_dim_type type, int pos, isl_int v);
1135         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1136                 __isl_take isl_constraint *constraint,
1137                 enum isl_dim_type type, int pos, int v);
1138         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1139                 __isl_take isl_basic_map *bmap,
1140                 __isl_take isl_constraint *constraint);
1141         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1142                 __isl_take isl_basic_set *bset,
1143                 __isl_take isl_constraint *constraint);
1144         __isl_give isl_map *isl_map_add_constraint(
1145                 __isl_take isl_map *map,
1146                 __isl_take isl_constraint *constraint);
1147         __isl_give isl_set *isl_set_add_constraint(
1148                 __isl_take isl_set *set,
1149                 __isl_take isl_constraint *constraint);
1150         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1151                 __isl_take isl_basic_set *bset,
1152                 __isl_take isl_constraint *constraint);
1154 For example, to create a set containing the even integers
1155 between 10 and 42, you would use the following code.
1157         isl_space *space;
1158         isl_local_space *ls;
1159         isl_constraint *c;
1160         isl_basic_set *bset;
1162         space = isl_space_set_alloc(ctx, 0, 2);
1163         bset = isl_basic_set_universe(isl_space_copy(space));
1164         ls = isl_local_space_from_space(space);
1166         c = isl_equality_alloc(isl_local_space_copy(ls));
1167         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1168         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1169         bset = isl_basic_set_add_constraint(bset, c);
1171         c = isl_inequality_alloc(isl_local_space_copy(ls));
1172         c = isl_constraint_set_constant_si(c, -10);
1173         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1174         bset = isl_basic_set_add_constraint(bset, c);
1176         c = isl_inequality_alloc(ls);
1177         c = isl_constraint_set_constant_si(c, 42);
1178         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1179         bset = isl_basic_set_add_constraint(bset, c);
1181         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1183 Or, alternatively,
1185         isl_basic_set *bset;
1186         bset = isl_basic_set_read_from_str(ctx,
1187                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1189 A basic set or relation can also be constructed from two matrices
1190 describing the equalities and the inequalities.
1192         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1193                 __isl_take isl_space *space,
1194                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1195                 enum isl_dim_type c1,
1196                 enum isl_dim_type c2, enum isl_dim_type c3,
1197                 enum isl_dim_type c4);
1198         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1199                 __isl_take isl_space *space,
1200                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1201                 enum isl_dim_type c1,
1202                 enum isl_dim_type c2, enum isl_dim_type c3,
1203                 enum isl_dim_type c4, enum isl_dim_type c5);
1205 The C<isl_dim_type> arguments indicate the order in which
1206 different kinds of variables appear in the input matrices
1207 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1208 C<isl_dim_set> and C<isl_dim_div> for sets and
1209 of C<isl_dim_cst>, C<isl_dim_param>,
1210 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1212 A (basic) set or relation can also be constructed from a (piecewise)
1213 (multiple) affine expression
1214 or a list of affine expressions
1215 (See L<"Piecewise Quasi Affine Expressions"> and
1216 L<"Piecewise Multiple Quasi Affine Expressions">).
1218         __isl_give isl_basic_map *isl_basic_map_from_aff(
1219                 __isl_take isl_aff *aff);
1220         __isl_give isl_set *isl_set_from_pw_aff(
1221                 __isl_take isl_pw_aff *pwaff);
1222         __isl_give isl_map *isl_map_from_pw_aff(
1223                 __isl_take isl_pw_aff *pwaff);
1224         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1225                 __isl_take isl_space *domain_space,
1226                 __isl_take isl_aff_list *list);
1227         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1228                 __isl_take isl_multi_aff *maff)
1229         __isl_give isl_set *isl_set_from_pw_multi_aff(
1230                 __isl_take isl_pw_multi_aff *pma);
1231         __isl_give isl_map *isl_map_from_pw_multi_aff(
1232                 __isl_take isl_pw_multi_aff *pma);
1234 The C<domain_dim> argument describes the domain of the resulting
1235 basic relation.  It is required because the C<list> may consist
1236 of zero affine expressions.
1238 =head2 Inspecting Sets and Relations
1240 Usually, the user should not have to care about the actual constraints
1241 of the sets and maps, but should instead apply the abstract operations
1242 explained in the following sections.
1243 Occasionally, however, it may be required to inspect the individual
1244 coefficients of the constraints.  This section explains how to do so.
1245 In these cases, it may also be useful to have C<isl> compute
1246 an explicit representation of the existentially quantified variables.
1248         __isl_give isl_set *isl_set_compute_divs(
1249                 __isl_take isl_set *set);
1250         __isl_give isl_map *isl_map_compute_divs(
1251                 __isl_take isl_map *map);
1252         __isl_give isl_union_set *isl_union_set_compute_divs(
1253                 __isl_take isl_union_set *uset);
1254         __isl_give isl_union_map *isl_union_map_compute_divs(
1255                 __isl_take isl_union_map *umap);
1257 This explicit representation defines the existentially quantified
1258 variables as integer divisions of the other variables, possibly
1259 including earlier existentially quantified variables.
1260 An explicitly represented existentially quantified variable therefore
1261 has a unique value when the values of the other variables are known.
1262 If, furthermore, the same existentials, i.e., existentials
1263 with the same explicit representations, should appear in the
1264 same order in each of the disjuncts of a set or map, then the user should call
1265 either of the following functions.
1267         __isl_give isl_set *isl_set_align_divs(
1268                 __isl_take isl_set *set);
1269         __isl_give isl_map *isl_map_align_divs(
1270                 __isl_take isl_map *map);
1272 Alternatively, the existentially quantified variables can be removed
1273 using the following functions, which compute an overapproximation.
1275         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1276                 __isl_take isl_basic_set *bset);
1277         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1278                 __isl_take isl_basic_map *bmap);
1279         __isl_give isl_set *isl_set_remove_divs(
1280                 __isl_take isl_set *set);
1281         __isl_give isl_map *isl_map_remove_divs(
1282                 __isl_take isl_map *map);
1284 To iterate over all the sets or maps in a union set or map, use
1286         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1287                 int (*fn)(__isl_take isl_set *set, void *user),
1288                 void *user);
1289         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1290                 int (*fn)(__isl_take isl_map *map, void *user),
1291                 void *user);
1293 The number of sets or maps in a union set or map can be obtained
1294 from
1296         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1297         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1299 To extract the set or map in a given space from a union, use
1301         __isl_give isl_set *isl_union_set_extract_set(
1302                 __isl_keep isl_union_set *uset,
1303                 __isl_take isl_space *space);
1304         __isl_give isl_map *isl_union_map_extract_map(
1305                 __isl_keep isl_union_map *umap,
1306                 __isl_take isl_space *space);
1308 To iterate over all the basic sets or maps in a set or map, use
1310         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1311                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1312                 void *user);
1313         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1314                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1315                 void *user);
1317 The callback function C<fn> should return 0 if successful and
1318 -1 if an error occurs.  In the latter case, or if any other error
1319 occurs, the above functions will return -1.
1321 It should be noted that C<isl> does not guarantee that
1322 the basic sets or maps passed to C<fn> are disjoint.
1323 If this is required, then the user should call one of
1324 the following functions first.
1326         __isl_give isl_set *isl_set_make_disjoint(
1327                 __isl_take isl_set *set);
1328         __isl_give isl_map *isl_map_make_disjoint(
1329                 __isl_take isl_map *map);
1331 The number of basic sets in a set can be obtained
1332 from
1334         int isl_set_n_basic_set(__isl_keep isl_set *set);
1336 To iterate over the constraints of a basic set or map, use
1338         #include <isl/constraint.h>
1340         int isl_basic_map_foreach_constraint(
1341                 __isl_keep isl_basic_map *bmap,
1342                 int (*fn)(__isl_take isl_constraint *c, void *user),
1343                 void *user);
1344         void *isl_constraint_free(__isl_take isl_constraint *c);
1346 Again, the callback function C<fn> should return 0 if successful and
1347 -1 if an error occurs.  In the latter case, or if any other error
1348 occurs, the above functions will return -1.
1349 The constraint C<c> represents either an equality or an inequality.
1350 Use the following function to find out whether a constraint
1351 represents an equality.  If not, it represents an inequality.
1353         int isl_constraint_is_equality(
1354                 __isl_keep isl_constraint *constraint);
1356 The coefficients of the constraints can be inspected using
1357 the following functions.
1359         void isl_constraint_get_constant(
1360                 __isl_keep isl_constraint *constraint, isl_int *v);
1361         void isl_constraint_get_coefficient(
1362                 __isl_keep isl_constraint *constraint,
1363                 enum isl_dim_type type, int pos, isl_int *v);
1364         int isl_constraint_involves_dims(
1365                 __isl_keep isl_constraint *constraint,
1366                 enum isl_dim_type type, unsigned first, unsigned n);
1368 The explicit representations of the existentially quantified
1369 variables can be inspected using the following function.
1370 Note that the user is only allowed to use this function
1371 if the inspected set or map is the result of a call
1372 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1373 The existentially quantified variable is equal to the floor
1374 of the returned affine expression.  The affine expression
1375 itself can be inspected using the functions in
1376 L<"Piecewise Quasi Affine Expressions">.
1378         __isl_give isl_aff *isl_constraint_get_div(
1379                 __isl_keep isl_constraint *constraint, int pos);
1381 To obtain the constraints of a basic set or map in matrix
1382 form, use the following functions.
1384         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1385                 __isl_keep isl_basic_set *bset,
1386                 enum isl_dim_type c1, enum isl_dim_type c2,
1387                 enum isl_dim_type c3, enum isl_dim_type c4);
1388         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1389                 __isl_keep isl_basic_set *bset,
1390                 enum isl_dim_type c1, enum isl_dim_type c2,
1391                 enum isl_dim_type c3, enum isl_dim_type c4);
1392         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1393                 __isl_keep isl_basic_map *bmap,
1394                 enum isl_dim_type c1,
1395                 enum isl_dim_type c2, enum isl_dim_type c3,
1396                 enum isl_dim_type c4, enum isl_dim_type c5);
1397         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1398                 __isl_keep isl_basic_map *bmap,
1399                 enum isl_dim_type c1,
1400                 enum isl_dim_type c2, enum isl_dim_type c3,
1401                 enum isl_dim_type c4, enum isl_dim_type c5);
1403 The C<isl_dim_type> arguments dictate the order in which
1404 different kinds of variables appear in the resulting matrix
1405 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1406 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1408 The number of parameters, input, output or set dimensions can
1409 be obtained using the following functions.
1411         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1412                 enum isl_dim_type type);
1413         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1414                 enum isl_dim_type type);
1415         unsigned isl_set_dim(__isl_keep isl_set *set,
1416                 enum isl_dim_type type);
1417         unsigned isl_map_dim(__isl_keep isl_map *map,
1418                 enum isl_dim_type type);
1420 To check whether the description of a set or relation depends
1421 on one or more given dimensions, it is not necessary to iterate over all
1422 constraints.  Instead the following functions can be used.
1424         int isl_basic_set_involves_dims(
1425                 __isl_keep isl_basic_set *bset,
1426                 enum isl_dim_type type, unsigned first, unsigned n);
1427         int isl_set_involves_dims(__isl_keep isl_set *set,
1428                 enum isl_dim_type type, unsigned first, unsigned n);
1429         int isl_basic_map_involves_dims(
1430                 __isl_keep isl_basic_map *bmap,
1431                 enum isl_dim_type type, unsigned first, unsigned n);
1432         int isl_map_involves_dims(__isl_keep isl_map *map,
1433                 enum isl_dim_type type, unsigned first, unsigned n);
1435 Similarly, the following functions can be used to check whether
1436 a given dimension is involved in any lower or upper bound.
1438         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1439                 enum isl_dim_type type, unsigned pos);
1440         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1441                 enum isl_dim_type type, unsigned pos);
1443 The identifiers or names of the domain and range spaces of a set
1444 or relation can be read off or set using the following functions.
1446         __isl_give isl_set *isl_set_set_tuple_id(
1447                 __isl_take isl_set *set, __isl_take isl_id *id);
1448         __isl_give isl_set *isl_set_reset_tuple_id(
1449                 __isl_take isl_set *set);
1450         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1451         __isl_give isl_id *isl_set_get_tuple_id(
1452                 __isl_keep isl_set *set);
1453         __isl_give isl_map *isl_map_set_tuple_id(
1454                 __isl_take isl_map *map, enum isl_dim_type type,
1455                 __isl_take isl_id *id);
1456         __isl_give isl_map *isl_map_reset_tuple_id(
1457                 __isl_take isl_map *map, enum isl_dim_type type);
1458         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1459                 enum isl_dim_type type);
1460         __isl_give isl_id *isl_map_get_tuple_id(
1461                 __isl_keep isl_map *map, enum isl_dim_type type);
1463         const char *isl_basic_set_get_tuple_name(
1464                 __isl_keep isl_basic_set *bset);
1465         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1466                 __isl_take isl_basic_set *set, const char *s);
1467         const char *isl_set_get_tuple_name(
1468                 __isl_keep isl_set *set);
1469         const char *isl_basic_map_get_tuple_name(
1470                 __isl_keep isl_basic_map *bmap,
1471                 enum isl_dim_type type);
1472         const char *isl_map_get_tuple_name(
1473                 __isl_keep isl_map *map,
1474                 enum isl_dim_type type);
1476 As with C<isl_space_get_tuple_name>, the value returned points to
1477 an internal data structure.
1478 The identifiers, positions or names of individual dimensions can be
1479 read off using the following functions.
1481         __isl_give isl_set *isl_set_set_dim_id(
1482                 __isl_take isl_set *set, enum isl_dim_type type,
1483                 unsigned pos, __isl_take isl_id *id);
1484         int isl_set_has_dim_id(__isl_keep isl_set *set,
1485                 enum isl_dim_type type, unsigned pos);
1486         __isl_give isl_id *isl_set_get_dim_id(
1487                 __isl_keep isl_set *set, enum isl_dim_type type,
1488                 unsigned pos);
1489         int isl_basic_map_has_dim_id(
1490                 __isl_keep isl_basic_map *bmap,
1491                 enum isl_dim_type type, unsigned pos);
1492         __isl_give isl_map *isl_map_set_dim_id(
1493                 __isl_take isl_map *map, enum isl_dim_type type,
1494                 unsigned pos, __isl_take isl_id *id);
1495         int isl_map_has_dim_id(__isl_keep isl_map *map,
1496                 enum isl_dim_type type, unsigned pos);
1497         __isl_give isl_id *isl_map_get_dim_id(
1498                 __isl_keep isl_map *map, enum isl_dim_type type,
1499                 unsigned pos);
1501         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1502                 enum isl_dim_type type, __isl_keep isl_id *id);
1503         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1504                 enum isl_dim_type type, __isl_keep isl_id *id);
1505         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1506                 enum isl_dim_type type, const char *name);
1508         const char *isl_constraint_get_dim_name(
1509                 __isl_keep isl_constraint *constraint,
1510                 enum isl_dim_type type, unsigned pos);
1511         const char *isl_basic_set_get_dim_name(
1512                 __isl_keep isl_basic_set *bset,
1513                 enum isl_dim_type type, unsigned pos);
1514         const char *isl_set_get_dim_name(
1515                 __isl_keep isl_set *set,
1516                 enum isl_dim_type type, unsigned pos);
1517         const char *isl_basic_map_get_dim_name(
1518                 __isl_keep isl_basic_map *bmap,
1519                 enum isl_dim_type type, unsigned pos);
1520         const char *isl_map_get_dim_name(
1521                 __isl_keep isl_map *map,
1522                 enum isl_dim_type type, unsigned pos);
1524 These functions are mostly useful to obtain the identifiers, positions
1525 or names of the parameters.  Identifiers of individual dimensions are
1526 essentially only useful for printing.  They are ignored by all other
1527 operations and may not be preserved across those operations.
1529 =head2 Properties
1531 =head3 Unary Properties
1533 =over
1535 =item * Emptiness
1537 The following functions test whether the given set or relation
1538 contains any integer points.  The ``plain'' variants do not perform
1539 any computations, but simply check if the given set or relation
1540 is already known to be empty.
1542         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1543         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1544         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1545         int isl_set_is_empty(__isl_keep isl_set *set);
1546         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1547         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1548         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1549         int isl_map_plain_is_empty(__isl_keep isl_map *map);
1550         int isl_map_is_empty(__isl_keep isl_map *map);
1551         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1553 =item * Universality
1555         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1556         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1557         int isl_set_plain_is_universe(__isl_keep isl_set *set);
1559 =item * Single-valuedness
1561         int isl_map_is_single_valued(__isl_keep isl_map *map);
1562         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1564 =item * Injectivity
1566         int isl_map_plain_is_injective(__isl_keep isl_map *map);
1567         int isl_map_is_injective(__isl_keep isl_map *map);
1568         int isl_union_map_plain_is_injective(
1569                 __isl_keep isl_union_map *umap);
1570         int isl_union_map_is_injective(
1571                 __isl_keep isl_union_map *umap);
1573 =item * Bijectivity
1575         int isl_map_is_bijective(__isl_keep isl_map *map);
1576         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1578 =item * Position
1580         int isl_basic_map_plain_is_fixed(
1581                 __isl_keep isl_basic_map *bmap,
1582                 enum isl_dim_type type, unsigned pos,
1583                 isl_int *val);
1584         int isl_set_plain_is_fixed(__isl_keep isl_set *set,
1585                 enum isl_dim_type type, unsigned pos,
1586                 isl_int *val);
1587         int isl_map_plain_is_fixed(__isl_keep isl_map *map,
1588                 enum isl_dim_type type, unsigned pos,
1589                 isl_int *val);
1591 Check if the relation obviously lies on a hyperplane where the given dimension
1592 has a fixed value and if so, return that value in C<*val>.
1594 =item * Space
1596 To check whether a set is a parameter domain, use this function:
1598         int isl_set_is_params(__isl_keep isl_set *set);
1600 =item * Wrapping
1602 The following functions check whether the domain of the given
1603 (basic) set is a wrapped relation.
1605         int isl_basic_set_is_wrapping(
1606                 __isl_keep isl_basic_set *bset);
1607         int isl_set_is_wrapping(__isl_keep isl_set *set);
1609 =item * Internal Product
1611         int isl_basic_map_can_zip(
1612                 __isl_keep isl_basic_map *bmap);
1613         int isl_map_can_zip(__isl_keep isl_map *map);
1615 Check whether the product of domain and range of the given relation
1616 can be computed,
1617 i.e., whether both domain and range are nested relations.
1619 =back
1621 =head3 Binary Properties
1623 =over
1625 =item * Equality
1627         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
1628                 __isl_keep isl_set *set2);
1629         int isl_set_is_equal(__isl_keep isl_set *set1,
1630                 __isl_keep isl_set *set2);
1631         int isl_union_set_is_equal(
1632                 __isl_keep isl_union_set *uset1,
1633                 __isl_keep isl_union_set *uset2);
1634         int isl_basic_map_is_equal(
1635                 __isl_keep isl_basic_map *bmap1,
1636                 __isl_keep isl_basic_map *bmap2);
1637         int isl_map_is_equal(__isl_keep isl_map *map1,
1638                 __isl_keep isl_map *map2);
1639         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
1640                 __isl_keep isl_map *map2);
1641         int isl_union_map_is_equal(
1642                 __isl_keep isl_union_map *umap1,
1643                 __isl_keep isl_union_map *umap2);
1645 =item * Disjointness
1647         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
1648                 __isl_keep isl_set *set2);
1650 =item * Subset
1652         int isl_set_is_subset(__isl_keep isl_set *set1,
1653                 __isl_keep isl_set *set2);
1654         int isl_set_is_strict_subset(
1655                 __isl_keep isl_set *set1,
1656                 __isl_keep isl_set *set2);
1657         int isl_union_set_is_subset(
1658                 __isl_keep isl_union_set *uset1,
1659                 __isl_keep isl_union_set *uset2);
1660         int isl_union_set_is_strict_subset(
1661                 __isl_keep isl_union_set *uset1,
1662                 __isl_keep isl_union_set *uset2);
1663         int isl_basic_map_is_subset(
1664                 __isl_keep isl_basic_map *bmap1,
1665                 __isl_keep isl_basic_map *bmap2);
1666         int isl_basic_map_is_strict_subset(
1667                 __isl_keep isl_basic_map *bmap1,
1668                 __isl_keep isl_basic_map *bmap2);
1669         int isl_map_is_subset(
1670                 __isl_keep isl_map *map1,
1671                 __isl_keep isl_map *map2);
1672         int isl_map_is_strict_subset(
1673                 __isl_keep isl_map *map1,
1674                 __isl_keep isl_map *map2);
1675         int isl_union_map_is_subset(
1676                 __isl_keep isl_union_map *umap1,
1677                 __isl_keep isl_union_map *umap2);
1678         int isl_union_map_is_strict_subset(
1679                 __isl_keep isl_union_map *umap1,
1680                 __isl_keep isl_union_map *umap2);
1682 =back
1684 =head2 Unary Operations
1686 =over
1688 =item * Complement
1690         __isl_give isl_set *isl_set_complement(
1691                 __isl_take isl_set *set);
1693 =item * Inverse map
1695         __isl_give isl_basic_map *isl_basic_map_reverse(
1696                 __isl_take isl_basic_map *bmap);
1697         __isl_give isl_map *isl_map_reverse(
1698                 __isl_take isl_map *map);
1699         __isl_give isl_union_map *isl_union_map_reverse(
1700                 __isl_take isl_union_map *umap);
1702 =item * Projection
1704         __isl_give isl_basic_set *isl_basic_set_project_out(
1705                 __isl_take isl_basic_set *bset,
1706                 enum isl_dim_type type, unsigned first, unsigned n);
1707         __isl_give isl_basic_map *isl_basic_map_project_out(
1708                 __isl_take isl_basic_map *bmap,
1709                 enum isl_dim_type type, unsigned first, unsigned n);
1710         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
1711                 enum isl_dim_type type, unsigned first, unsigned n);
1712         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
1713                 enum isl_dim_type type, unsigned first, unsigned n);
1714         __isl_give isl_basic_set *isl_basic_set_params(
1715                 __isl_take isl_basic_set *bset);
1716         __isl_give isl_basic_set *isl_basic_map_domain(
1717                 __isl_take isl_basic_map *bmap);
1718         __isl_give isl_basic_set *isl_basic_map_range(
1719                 __isl_take isl_basic_map *bmap);
1720         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
1721         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
1722         __isl_give isl_set *isl_map_domain(
1723                 __isl_take isl_map *bmap);
1724         __isl_give isl_set *isl_map_range(
1725                 __isl_take isl_map *map);
1726         __isl_give isl_union_set *isl_union_map_domain(
1727                 __isl_take isl_union_map *umap);
1728         __isl_give isl_union_set *isl_union_map_range(
1729                 __isl_take isl_union_map *umap);
1731         __isl_give isl_basic_map *isl_basic_map_domain_map(
1732                 __isl_take isl_basic_map *bmap);
1733         __isl_give isl_basic_map *isl_basic_map_range_map(
1734                 __isl_take isl_basic_map *bmap);
1735         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
1736         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
1737         __isl_give isl_union_map *isl_union_map_domain_map(
1738                 __isl_take isl_union_map *umap);
1739         __isl_give isl_union_map *isl_union_map_range_map(
1740                 __isl_take isl_union_map *umap);
1742 The functions above construct a (basic, regular or union) relation
1743 that maps (a wrapped version of) the input relation to its domain or range.
1745 =item * Elimination
1747         __isl_give isl_set *isl_set_eliminate(
1748                 __isl_take isl_set *set, enum isl_dim_type type,
1749                 unsigned first, unsigned n);
1750         __isl_give isl_basic_map *isl_basic_map_eliminate(
1751                 __isl_take isl_basic_map *bmap,
1752                 enum isl_dim_type type,
1753                 unsigned first, unsigned n);
1755 Eliminate the coefficients for the given dimensions from the constraints,
1756 without removing the dimensions.
1758 =item * Slicing
1760         __isl_give isl_basic_set *isl_basic_set_fix(
1761                 __isl_take isl_basic_set *bset,
1762                 enum isl_dim_type type, unsigned pos,
1763                 isl_int value);
1764         __isl_give isl_basic_set *isl_basic_set_fix_si(
1765                 __isl_take isl_basic_set *bset,
1766                 enum isl_dim_type type, unsigned pos, int value);
1767         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
1768                 enum isl_dim_type type, unsigned pos,
1769                 isl_int value);
1770         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
1771                 enum isl_dim_type type, unsigned pos, int value);
1772         __isl_give isl_basic_map *isl_basic_map_fix_si(
1773                 __isl_take isl_basic_map *bmap,
1774                 enum isl_dim_type type, unsigned pos, int value);
1775         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
1776                 enum isl_dim_type type, unsigned pos, int value);
1778 Intersect the set or relation with the hyperplane where the given
1779 dimension has the fixed given value.
1781         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
1782                 enum isl_dim_type type1, int pos1,
1783                 enum isl_dim_type type2, int pos2);
1784         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
1785                 enum isl_dim_type type1, int pos1,
1786                 enum isl_dim_type type2, int pos2);
1788 Intersect the set or relation with the hyperplane where the given
1789 dimensions are equal to each other.
1791         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
1792                 enum isl_dim_type type1, int pos1,
1793                 enum isl_dim_type type2, int pos2);
1795 Intersect the relation with the hyperplane where the given
1796 dimensions have opposite values.
1798 =item * Identity
1800         __isl_give isl_map *isl_set_identity(
1801                 __isl_take isl_set *set);
1802         __isl_give isl_union_map *isl_union_set_identity(
1803                 __isl_take isl_union_set *uset);
1805 Construct an identity relation on the given (union) set.
1807 =item * Deltas
1809         __isl_give isl_basic_set *isl_basic_map_deltas(
1810                 __isl_take isl_basic_map *bmap);
1811         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
1812         __isl_give isl_union_set *isl_union_map_deltas(
1813                 __isl_take isl_union_map *umap);
1815 These functions return a (basic) set containing the differences
1816 between image elements and corresponding domain elements in the input.
1818         __isl_give isl_basic_map *isl_basic_map_deltas_map(
1819                 __isl_take isl_basic_map *bmap);
1820         __isl_give isl_map *isl_map_deltas_map(
1821                 __isl_take isl_map *map);
1822         __isl_give isl_union_map *isl_union_map_deltas_map(
1823                 __isl_take isl_union_map *umap);
1825 The functions above construct a (basic, regular or union) relation
1826 that maps (a wrapped version of) the input relation to its delta set.
1828 =item * Coalescing
1830 Simplify the representation of a set or relation by trying
1831 to combine pairs of basic sets or relations into a single
1832 basic set or relation.
1834         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
1835         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
1836         __isl_give isl_union_set *isl_union_set_coalesce(
1837                 __isl_take isl_union_set *uset);
1838         __isl_give isl_union_map *isl_union_map_coalesce(
1839                 __isl_take isl_union_map *umap);
1841 =item * Detecting equalities
1843         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
1844                 __isl_take isl_basic_set *bset);
1845         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
1846                 __isl_take isl_basic_map *bmap);
1847         __isl_give isl_set *isl_set_detect_equalities(
1848                 __isl_take isl_set *set);
1849         __isl_give isl_map *isl_map_detect_equalities(
1850                 __isl_take isl_map *map);
1851         __isl_give isl_union_set *isl_union_set_detect_equalities(
1852                 __isl_take isl_union_set *uset);
1853         __isl_give isl_union_map *isl_union_map_detect_equalities(
1854                 __isl_take isl_union_map *umap);
1856 Simplify the representation of a set or relation by detecting implicit
1857 equalities.
1859 =item * Removing redundant constraints
1861         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
1862                 __isl_take isl_basic_set *bset);
1863         __isl_give isl_set *isl_set_remove_redundancies(
1864                 __isl_take isl_set *set);
1865         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
1866                 __isl_take isl_basic_map *bmap);
1867         __isl_give isl_map *isl_map_remove_redundancies(
1868                 __isl_take isl_map *map);
1870 =item * Convex hull
1872         __isl_give isl_basic_set *isl_set_convex_hull(
1873                 __isl_take isl_set *set);
1874         __isl_give isl_basic_map *isl_map_convex_hull(
1875                 __isl_take isl_map *map);
1877 If the input set or relation has any existentially quantified
1878 variables, then the result of these operations is currently undefined.
1880 =item * Simple hull
1882         __isl_give isl_basic_set *isl_set_simple_hull(
1883                 __isl_take isl_set *set);
1884         __isl_give isl_basic_map *isl_map_simple_hull(
1885                 __isl_take isl_map *map);
1886         __isl_give isl_union_map *isl_union_map_simple_hull(
1887                 __isl_take isl_union_map *umap);
1889 These functions compute a single basic set or relation
1890 that contains the whole input set or relation.
1891 In particular, the output is described by translates
1892 of the constraints describing the basic sets or relations in the input.
1894 =begin latex
1896 (See \autoref{s:simple hull}.)
1898 =end latex
1900 =item * Affine hull
1902         __isl_give isl_basic_set *isl_basic_set_affine_hull(
1903                 __isl_take isl_basic_set *bset);
1904         __isl_give isl_basic_set *isl_set_affine_hull(
1905                 __isl_take isl_set *set);
1906         __isl_give isl_union_set *isl_union_set_affine_hull(
1907                 __isl_take isl_union_set *uset);
1908         __isl_give isl_basic_map *isl_basic_map_affine_hull(
1909                 __isl_take isl_basic_map *bmap);
1910         __isl_give isl_basic_map *isl_map_affine_hull(
1911                 __isl_take isl_map *map);
1912         __isl_give isl_union_map *isl_union_map_affine_hull(
1913                 __isl_take isl_union_map *umap);
1915 In case of union sets and relations, the affine hull is computed
1916 per space.
1918 =item * Polyhedral hull
1920         __isl_give isl_basic_set *isl_set_polyhedral_hull(
1921                 __isl_take isl_set *set);
1922         __isl_give isl_basic_map *isl_map_polyhedral_hull(
1923                 __isl_take isl_map *map);
1924         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
1925                 __isl_take isl_union_set *uset);
1926         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
1927                 __isl_take isl_union_map *umap);
1929 These functions compute a single basic set or relation
1930 not involving any existentially quantified variables
1931 that contains the whole input set or relation.
1932 In case of union sets and relations, the polyhedral hull is computed
1933 per space.
1935 =item * Optimization
1937         #include <isl/ilp.h>
1938         enum isl_lp_result isl_basic_set_max(
1939                 __isl_keep isl_basic_set *bset,
1940                 __isl_keep isl_aff *obj, isl_int *opt)
1941         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
1942                 __isl_keep isl_aff *obj, isl_int *opt);
1943         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
1944                 __isl_keep isl_aff *obj, isl_int *opt);
1946 Compute the minimum or maximum of the integer affine expression C<obj>
1947 over the points in C<set>, returning the result in C<opt>.
1948 The return value may be one of C<isl_lp_error>,
1949 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
1951 =item * Parametric optimization
1953         __isl_give isl_pw_aff *isl_set_dim_min(
1954                 __isl_take isl_set *set, int pos);
1955         __isl_give isl_pw_aff *isl_set_dim_max(
1956                 __isl_take isl_set *set, int pos);
1957         __isl_give isl_pw_aff *isl_map_dim_max(
1958                 __isl_take isl_map *map, int pos);
1960 Compute the minimum or maximum of the given set or output dimension
1961 as a function of the parameters (and input dimensions), but independently
1962 of the other set or output dimensions.
1963 For lexicographic optimization, see L<"Lexicographic Optimization">.
1965 =item * Dual
1967 The following functions compute either the set of (rational) coefficient
1968 values of valid constraints for the given set or the set of (rational)
1969 values satisfying the constraints with coefficients from the given set.
1970 Internally, these two sets of functions perform essentially the
1971 same operations, except that the set of coefficients is assumed to
1972 be a cone, while the set of values may be any polyhedron.
1973 The current implementation is based on the Farkas lemma and
1974 Fourier-Motzkin elimination, but this may change or be made optional
1975 in future.  In particular, future implementations may use different
1976 dualization algorithms or skip the elimination step.
1978         __isl_give isl_basic_set *isl_basic_set_coefficients(
1979                 __isl_take isl_basic_set *bset);
1980         __isl_give isl_basic_set *isl_set_coefficients(
1981                 __isl_take isl_set *set);
1982         __isl_give isl_union_set *isl_union_set_coefficients(
1983                 __isl_take isl_union_set *bset);
1984         __isl_give isl_basic_set *isl_basic_set_solutions(
1985                 __isl_take isl_basic_set *bset);
1986         __isl_give isl_basic_set *isl_set_solutions(
1987                 __isl_take isl_set *set);
1988         __isl_give isl_union_set *isl_union_set_solutions(
1989                 __isl_take isl_union_set *bset);
1991 =item * Power
1993         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
1994                 int *exact);
1995         __isl_give isl_union_map *isl_union_map_power(
1996                 __isl_take isl_union_map *umap, int *exact);
1998 Compute a parametric representation for all positive powers I<k> of C<map>.
1999 The result maps I<k> to a nested relation corresponding to the
2000 I<k>th power of C<map>.
2001 The result may be an overapproximation.  If the result is known to be exact,
2002 then C<*exact> is set to C<1>.
2004 =item * Transitive closure
2006         __isl_give isl_map *isl_map_transitive_closure(
2007                 __isl_take isl_map *map, int *exact);
2008         __isl_give isl_union_map *isl_union_map_transitive_closure(
2009                 __isl_take isl_union_map *umap, int *exact);
2011 Compute the transitive closure of C<map>.
2012 The result may be an overapproximation.  If the result is known to be exact,
2013 then C<*exact> is set to C<1>.
2015 =item * Reaching path lengths
2017         __isl_give isl_map *isl_map_reaching_path_lengths(
2018                 __isl_take isl_map *map, int *exact);
2020 Compute a relation that maps each element in the range of C<map>
2021 to the lengths of all paths composed of edges in C<map> that
2022 end up in the given element.
2023 The result may be an overapproximation.  If the result is known to be exact,
2024 then C<*exact> is set to C<1>.
2025 To compute the I<maximal> path length, the resulting relation
2026 should be postprocessed by C<isl_map_lexmax>.
2027 In particular, if the input relation is a dependence relation
2028 (mapping sources to sinks), then the maximal path length corresponds
2029 to the free schedule.
2030 Note, however, that C<isl_map_lexmax> expects the maximum to be
2031 finite, so if the path lengths are unbounded (possibly due to
2032 the overapproximation), then you will get an error message.
2034 =item * Wrapping
2036         __isl_give isl_basic_set *isl_basic_map_wrap(
2037                 __isl_take isl_basic_map *bmap);
2038         __isl_give isl_set *isl_map_wrap(
2039                 __isl_take isl_map *map);
2040         __isl_give isl_union_set *isl_union_map_wrap(
2041                 __isl_take isl_union_map *umap);
2042         __isl_give isl_basic_map *isl_basic_set_unwrap(
2043                 __isl_take isl_basic_set *bset);
2044         __isl_give isl_map *isl_set_unwrap(
2045                 __isl_take isl_set *set);
2046         __isl_give isl_union_map *isl_union_set_unwrap(
2047                 __isl_take isl_union_set *uset);
2049 =item * Flattening
2051 Remove any internal structure of domain (and range) of the given
2052 set or relation.  If there is any such internal structure in the input,
2053 then the name of the space is also removed.
2055         __isl_give isl_basic_set *isl_basic_set_flatten(
2056                 __isl_take isl_basic_set *bset);
2057         __isl_give isl_set *isl_set_flatten(
2058                 __isl_take isl_set *set);
2059         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2060                 __isl_take isl_basic_map *bmap);
2061         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2062                 __isl_take isl_basic_map *bmap);
2063         __isl_give isl_map *isl_map_flatten_range(
2064                 __isl_take isl_map *map);
2065         __isl_give isl_map *isl_map_flatten_domain(
2066                 __isl_take isl_map *map);
2067         __isl_give isl_basic_map *isl_basic_map_flatten(
2068                 __isl_take isl_basic_map *bmap);
2069         __isl_give isl_map *isl_map_flatten(
2070                 __isl_take isl_map *map);
2072         __isl_give isl_map *isl_set_flatten_map(
2073                 __isl_take isl_set *set);
2075 The function above constructs a relation
2076 that maps the input set to a flattened version of the set.
2078 =item * Lifting
2080 Lift the input set to a space with extra dimensions corresponding
2081 to the existentially quantified variables in the input.
2082 In particular, the result lives in a wrapped map where the domain
2083 is the original space and the range corresponds to the original
2084 existentially quantified variables.
2086         __isl_give isl_basic_set *isl_basic_set_lift(
2087                 __isl_take isl_basic_set *bset);
2088         __isl_give isl_set *isl_set_lift(
2089                 __isl_take isl_set *set);
2090         __isl_give isl_union_set *isl_union_set_lift(
2091                 __isl_take isl_union_set *uset);
2093 Given a local space that contains the existentially quantified
2094 variables of a set, a basic relation that, when applied to
2095 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2096 can be constructed using the following function.
2098         #include <isl/local_space.h>
2099         __isl_give isl_basic_map *isl_local_space_lifting(
2100                 __isl_take isl_local_space *ls);
2102 =item * Internal Product
2104         __isl_give isl_basic_map *isl_basic_map_zip(
2105                 __isl_take isl_basic_map *bmap);
2106         __isl_give isl_map *isl_map_zip(
2107                 __isl_take isl_map *map);
2108         __isl_give isl_union_map *isl_union_map_zip(
2109                 __isl_take isl_union_map *umap);
2111 Given a relation with nested relations for domain and range,
2112 interchange the range of the domain with the domain of the range.
2114 =item * Aligning parameters
2116         __isl_give isl_set *isl_set_align_params(
2117                 __isl_take isl_set *set,
2118                 __isl_take isl_space *model);
2119         __isl_give isl_map *isl_map_align_params(
2120                 __isl_take isl_map *map,
2121                 __isl_take isl_space *model);
2123 Change the order of the parameters of the given set or relation
2124 such that the first parameters match those of C<model>.
2125 This may involve the introduction of extra parameters.
2126 All parameters need to be named.
2128 =item * Dimension manipulation
2130         __isl_give isl_set *isl_set_add_dims(
2131                 __isl_take isl_set *set,
2132                 enum isl_dim_type type, unsigned n);
2133         __isl_give isl_map *isl_map_add_dims(
2134                 __isl_take isl_map *map,
2135                 enum isl_dim_type type, unsigned n);
2136         __isl_give isl_set *isl_set_insert_dims(
2137                 __isl_take isl_set *set,
2138                 enum isl_dim_type type, unsigned pos, unsigned n);
2139         __isl_give isl_map *isl_map_insert_dims(
2140                 __isl_take isl_map *map,
2141                 enum isl_dim_type type, unsigned pos, unsigned n);
2142         __isl_give isl_basic_set *isl_basic_set_move_dims(
2143                 __isl_take isl_basic_set *bset,
2144                 enum isl_dim_type dst_type, unsigned dst_pos,
2145                 enum isl_dim_type src_type, unsigned src_pos,
2146                 unsigned n);
2147         __isl_give isl_basic_map *isl_basic_map_move_dims(
2148                 __isl_take isl_basic_map *bmap,
2149                 enum isl_dim_type dst_type, unsigned dst_pos,
2150                 enum isl_dim_type src_type, unsigned src_pos,
2151                 unsigned n);
2152         __isl_give isl_set *isl_set_move_dims(
2153                 __isl_take isl_set *set,
2154                 enum isl_dim_type dst_type, unsigned dst_pos,
2155                 enum isl_dim_type src_type, unsigned src_pos,
2156                 unsigned n);
2157         __isl_give isl_map *isl_map_move_dims(
2158                 __isl_take isl_map *map,
2159                 enum isl_dim_type dst_type, unsigned dst_pos,
2160                 enum isl_dim_type src_type, unsigned src_pos,
2161                 unsigned n);
2163 It is usually not advisable to directly change the (input or output)
2164 space of a set or a relation as this removes the name and the internal
2165 structure of the space.  However, the above functions can be useful
2166 to add new parameters, assuming
2167 C<isl_set_align_params> and C<isl_map_align_params>
2168 are not sufficient.
2170 =back
2172 =head2 Binary Operations
2174 The two arguments of a binary operation not only need to live
2175 in the same C<isl_ctx>, they currently also need to have
2176 the same (number of) parameters.
2178 =head3 Basic Operations
2180 =over
2182 =item * Intersection
2184         __isl_give isl_basic_set *isl_basic_set_intersect(
2185                 __isl_take isl_basic_set *bset1,
2186                 __isl_take isl_basic_set *bset2);
2187         __isl_give isl_set *isl_set_intersect_params(
2188                 __isl_take isl_set *set,
2189                 __isl_take isl_set *params);
2190         __isl_give isl_set *isl_set_intersect(
2191                 __isl_take isl_set *set1,
2192                 __isl_take isl_set *set2);
2193         __isl_give isl_union_set *isl_union_set_intersect(
2194                 __isl_take isl_union_set *uset1,
2195                 __isl_take isl_union_set *uset2);
2196         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2197                 __isl_take isl_basic_map *bmap,
2198                 __isl_take isl_basic_set *bset);
2199         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2200                 __isl_take isl_basic_map *bmap,
2201                 __isl_take isl_basic_set *bset);
2202         __isl_give isl_basic_map *isl_basic_map_intersect(
2203                 __isl_take isl_basic_map *bmap1,
2204                 __isl_take isl_basic_map *bmap2);
2205         __isl_give isl_map *isl_map_intersect_params(
2206                 __isl_take isl_map *map,
2207                 __isl_take isl_set *params);
2208         __isl_give isl_map *isl_map_intersect_domain(
2209                 __isl_take isl_map *map,
2210                 __isl_take isl_set *set);
2211         __isl_give isl_map *isl_map_intersect_range(
2212                 __isl_take isl_map *map,
2213                 __isl_take isl_set *set);
2214         __isl_give isl_map *isl_map_intersect(
2215                 __isl_take isl_map *map1,
2216                 __isl_take isl_map *map2);
2217         __isl_give isl_union_map *isl_union_map_intersect_domain(
2218                 __isl_take isl_union_map *umap,
2219                 __isl_take isl_union_set *uset);
2220         __isl_give isl_union_map *isl_union_map_intersect_range(
2221                 __isl_take isl_union_map *umap,
2222                 __isl_take isl_union_set *uset);
2223         __isl_give isl_union_map *isl_union_map_intersect(
2224                 __isl_take isl_union_map *umap1,
2225                 __isl_take isl_union_map *umap2);
2227 =item * Union
2229         __isl_give isl_set *isl_basic_set_union(
2230                 __isl_take isl_basic_set *bset1,
2231                 __isl_take isl_basic_set *bset2);
2232         __isl_give isl_map *isl_basic_map_union(
2233                 __isl_take isl_basic_map *bmap1,
2234                 __isl_take isl_basic_map *bmap2);
2235         __isl_give isl_set *isl_set_union(
2236                 __isl_take isl_set *set1,
2237                 __isl_take isl_set *set2);
2238         __isl_give isl_map *isl_map_union(
2239                 __isl_take isl_map *map1,
2240                 __isl_take isl_map *map2);
2241         __isl_give isl_union_set *isl_union_set_union(
2242                 __isl_take isl_union_set *uset1,
2243                 __isl_take isl_union_set *uset2);
2244         __isl_give isl_union_map *isl_union_map_union(
2245                 __isl_take isl_union_map *umap1,
2246                 __isl_take isl_union_map *umap2);
2248 =item * Set difference
2250         __isl_give isl_set *isl_set_subtract(
2251                 __isl_take isl_set *set1,
2252                 __isl_take isl_set *set2);
2253         __isl_give isl_map *isl_map_subtract(
2254                 __isl_take isl_map *map1,
2255                 __isl_take isl_map *map2);
2256         __isl_give isl_union_set *isl_union_set_subtract(
2257                 __isl_take isl_union_set *uset1,
2258                 __isl_take isl_union_set *uset2);
2259         __isl_give isl_union_map *isl_union_map_subtract(
2260                 __isl_take isl_union_map *umap1,
2261                 __isl_take isl_union_map *umap2);
2263 =item * Application
2265         __isl_give isl_basic_set *isl_basic_set_apply(
2266                 __isl_take isl_basic_set *bset,
2267                 __isl_take isl_basic_map *bmap);
2268         __isl_give isl_set *isl_set_apply(
2269                 __isl_take isl_set *set,
2270                 __isl_take isl_map *map);
2271         __isl_give isl_union_set *isl_union_set_apply(
2272                 __isl_take isl_union_set *uset,
2273                 __isl_take isl_union_map *umap);
2274         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2275                 __isl_take isl_basic_map *bmap1,
2276                 __isl_take isl_basic_map *bmap2);
2277         __isl_give isl_basic_map *isl_basic_map_apply_range(
2278                 __isl_take isl_basic_map *bmap1,
2279                 __isl_take isl_basic_map *bmap2);
2280         __isl_give isl_map *isl_map_apply_domain(
2281                 __isl_take isl_map *map1,
2282                 __isl_take isl_map *map2);
2283         __isl_give isl_union_map *isl_union_map_apply_domain(
2284                 __isl_take isl_union_map *umap1,
2285                 __isl_take isl_union_map *umap2);
2286         __isl_give isl_map *isl_map_apply_range(
2287                 __isl_take isl_map *map1,
2288                 __isl_take isl_map *map2);
2289         __isl_give isl_union_map *isl_union_map_apply_range(
2290                 __isl_take isl_union_map *umap1,
2291                 __isl_take isl_union_map *umap2);
2293 =item * Cartesian Product
2295         __isl_give isl_set *isl_set_product(
2296                 __isl_take isl_set *set1,
2297                 __isl_take isl_set *set2);
2298         __isl_give isl_union_set *isl_union_set_product(
2299                 __isl_take isl_union_set *uset1,
2300                 __isl_take isl_union_set *uset2);
2301         __isl_give isl_basic_map *isl_basic_map_domain_product(
2302                 __isl_take isl_basic_map *bmap1,
2303                 __isl_take isl_basic_map *bmap2);
2304         __isl_give isl_basic_map *isl_basic_map_range_product(
2305                 __isl_take isl_basic_map *bmap1,
2306                 __isl_take isl_basic_map *bmap2);
2307         __isl_give isl_map *isl_map_domain_product(
2308                 __isl_take isl_map *map1,
2309                 __isl_take isl_map *map2);
2310         __isl_give isl_map *isl_map_range_product(
2311                 __isl_take isl_map *map1,
2312                 __isl_take isl_map *map2);
2313         __isl_give isl_union_map *isl_union_map_range_product(
2314                 __isl_take isl_union_map *umap1,
2315                 __isl_take isl_union_map *umap2);
2316         __isl_give isl_map *isl_map_product(
2317                 __isl_take isl_map *map1,
2318                 __isl_take isl_map *map2);
2319         __isl_give isl_union_map *isl_union_map_product(
2320                 __isl_take isl_union_map *umap1,
2321                 __isl_take isl_union_map *umap2);
2323 The above functions compute the cross product of the given
2324 sets or relations.  The domains and ranges of the results
2325 are wrapped maps between domains and ranges of the inputs.
2326 To obtain a ``flat'' product, use the following functions
2327 instead.
2329         __isl_give isl_basic_set *isl_basic_set_flat_product(
2330                 __isl_take isl_basic_set *bset1,
2331                 __isl_take isl_basic_set *bset2);
2332         __isl_give isl_set *isl_set_flat_product(
2333                 __isl_take isl_set *set1,
2334                 __isl_take isl_set *set2);
2335         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2336                 __isl_take isl_basic_map *bmap1,
2337                 __isl_take isl_basic_map *bmap2);
2338         __isl_give isl_map *isl_map_flat_domain_product(
2339                 __isl_take isl_map *map1,
2340                 __isl_take isl_map *map2);
2341         __isl_give isl_map *isl_map_flat_range_product(
2342                 __isl_take isl_map *map1,
2343                 __isl_take isl_map *map2);
2344         __isl_give isl_union_map *isl_union_map_flat_range_product(
2345                 __isl_take isl_union_map *umap1,
2346                 __isl_take isl_union_map *umap2);
2347         __isl_give isl_basic_map *isl_basic_map_flat_product(
2348                 __isl_take isl_basic_map *bmap1,
2349                 __isl_take isl_basic_map *bmap2);
2350         __isl_give isl_map *isl_map_flat_product(
2351                 __isl_take isl_map *map1,
2352                 __isl_take isl_map *map2);
2354 =item * Simplification
2356         __isl_give isl_basic_set *isl_basic_set_gist(
2357                 __isl_take isl_basic_set *bset,
2358                 __isl_take isl_basic_set *context);
2359         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2360                 __isl_take isl_set *context);
2361         __isl_give isl_set *isl_set_gist_params(
2362                 __isl_take isl_set *set,
2363                 __isl_take isl_set *context);
2364         __isl_give isl_union_set *isl_union_set_gist(
2365                 __isl_take isl_union_set *uset,
2366                 __isl_take isl_union_set *context);
2367         __isl_give isl_basic_map *isl_basic_map_gist(
2368                 __isl_take isl_basic_map *bmap,
2369                 __isl_take isl_basic_map *context);
2370         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2371                 __isl_take isl_map *context);
2372         __isl_give isl_map *isl_map_gist_params(
2373                 __isl_take isl_map *map,
2374                 __isl_take isl_set *context);
2375         __isl_give isl_union_map *isl_union_map_gist(
2376                 __isl_take isl_union_map *umap,
2377                 __isl_take isl_union_map *context);
2379 The gist operation returns a set or relation that has the
2380 same intersection with the context as the input set or relation.
2381 Any implicit equality in the intersection is made explicit in the result,
2382 while all inequalities that are redundant with respect to the intersection
2383 are removed.
2384 In case of union sets and relations, the gist operation is performed
2385 per space.
2387 =back
2389 =head3 Lexicographic Optimization
2391 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2392 the following functions
2393 compute a set that contains the lexicographic minimum or maximum
2394 of the elements in C<set> (or C<bset>) for those values of the parameters
2395 that satisfy C<dom>.
2396 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2397 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2398 has no elements.
2399 In other words, the union of the parameter values
2400 for which the result is non-empty and of C<*empty>
2401 is equal to C<dom>.
2403         __isl_give isl_set *isl_basic_set_partial_lexmin(
2404                 __isl_take isl_basic_set *bset,
2405                 __isl_take isl_basic_set *dom,
2406                 __isl_give isl_set **empty);
2407         __isl_give isl_set *isl_basic_set_partial_lexmax(
2408                 __isl_take isl_basic_set *bset,
2409                 __isl_take isl_basic_set *dom,
2410                 __isl_give isl_set **empty);
2411         __isl_give isl_set *isl_set_partial_lexmin(
2412                 __isl_take isl_set *set, __isl_take isl_set *dom,
2413                 __isl_give isl_set **empty);
2414         __isl_give isl_set *isl_set_partial_lexmax(
2415                 __isl_take isl_set *set, __isl_take isl_set *dom,
2416                 __isl_give isl_set **empty);
2418 Given a (basic) set C<set> (or C<bset>), the following functions simply
2419 return a set containing the lexicographic minimum or maximum
2420 of the elements in C<set> (or C<bset>).
2421 In case of union sets, the optimum is computed per space.
2423         __isl_give isl_set *isl_basic_set_lexmin(
2424                 __isl_take isl_basic_set *bset);
2425         __isl_give isl_set *isl_basic_set_lexmax(
2426                 __isl_take isl_basic_set *bset);
2427         __isl_give isl_set *isl_set_lexmin(
2428                 __isl_take isl_set *set);
2429         __isl_give isl_set *isl_set_lexmax(
2430                 __isl_take isl_set *set);
2431         __isl_give isl_union_set *isl_union_set_lexmin(
2432                 __isl_take isl_union_set *uset);
2433         __isl_give isl_union_set *isl_union_set_lexmax(
2434                 __isl_take isl_union_set *uset);
2436 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2437 the following functions
2438 compute a relation that maps each element of C<dom>
2439 to the single lexicographic minimum or maximum
2440 of the elements that are associated to that same
2441 element in C<map> (or C<bmap>).
2442 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2443 that contains the elements in C<dom> that do not map
2444 to any elements in C<map> (or C<bmap>).
2445 In other words, the union of the domain of the result and of C<*empty>
2446 is equal to C<dom>.
2448         __isl_give isl_map *isl_basic_map_partial_lexmax(
2449                 __isl_take isl_basic_map *bmap,
2450                 __isl_take isl_basic_set *dom,
2451                 __isl_give isl_set **empty);
2452         __isl_give isl_map *isl_basic_map_partial_lexmin(
2453                 __isl_take isl_basic_map *bmap,
2454                 __isl_take isl_basic_set *dom,
2455                 __isl_give isl_set **empty);
2456         __isl_give isl_map *isl_map_partial_lexmax(
2457                 __isl_take isl_map *map, __isl_take isl_set *dom,
2458                 __isl_give isl_set **empty);
2459         __isl_give isl_map *isl_map_partial_lexmin(
2460                 __isl_take isl_map *map, __isl_take isl_set *dom,
2461                 __isl_give isl_set **empty);
2463 Given a (basic) map C<map> (or C<bmap>), the following functions simply
2464 return a map mapping each element in the domain of
2465 C<map> (or C<bmap>) to the lexicographic minimum or maximum
2466 of all elements associated to that element.
2467 In case of union relations, the optimum is computed per space.
2469         __isl_give isl_map *isl_basic_map_lexmin(
2470                 __isl_take isl_basic_map *bmap);
2471         __isl_give isl_map *isl_basic_map_lexmax(
2472                 __isl_take isl_basic_map *bmap);
2473         __isl_give isl_map *isl_map_lexmin(
2474                 __isl_take isl_map *map);
2475         __isl_give isl_map *isl_map_lexmax(
2476                 __isl_take isl_map *map);
2477         __isl_give isl_union_map *isl_union_map_lexmin(
2478                 __isl_take isl_union_map *umap);
2479         __isl_give isl_union_map *isl_union_map_lexmax(
2480                 __isl_take isl_union_map *umap);
2482 The following functions return their result in the form of
2483 a piecewise multi-affine expression
2484 (See L<"Piecewise Multiple Quasi Affine Expressions">),
2485 but are otherwise equivalent to the corresponding functions
2486 returning a basic set or relation.
2488         __isl_give isl_pw_multi_aff *
2489         isl_basic_map_lexmin_pw_multi_aff(
2490                 __isl_take isl_basic_map *bmap);
2491         __isl_give isl_pw_multi_aff *
2492         isl_basic_set_partial_lexmin_pw_multi_aff(
2493                 __isl_take isl_basic_set *bset,
2494                 __isl_take isl_basic_set *dom,
2495                 __isl_give isl_set **empty);
2496         __isl_give isl_pw_multi_aff *
2497         isl_basic_set_partial_lexmax_pw_multi_aff(
2498                 __isl_take isl_basic_set *bset,
2499                 __isl_take isl_basic_set *dom,
2500                 __isl_give isl_set **empty);
2501         __isl_give isl_pw_multi_aff *
2502         isl_basic_map_partial_lexmin_pw_multi_aff(
2503                 __isl_take isl_basic_map *bmap,
2504                 __isl_take isl_basic_set *dom,
2505                 __isl_give isl_set **empty);
2506         __isl_give isl_pw_multi_aff *
2507         isl_basic_map_partial_lexmax_pw_multi_aff(
2508                 __isl_take isl_basic_map *bmap,
2509                 __isl_take isl_basic_set *dom,
2510                 __isl_give isl_set **empty);
2512 =head2 Lists
2514 Lists are defined over several element types, including
2515 C<isl_aff>, C<isl_pw_aff>, C<isl_basic_set> and C<isl_set>.
2516 Here we take lists of C<isl_set>s as an example.
2517 Lists can be created, copied and freed using the following functions.
2519         #include <isl/list.h>
2520         __isl_give isl_set_list *isl_set_list_from_set(
2521                 __isl_take isl_set *el);
2522         __isl_give isl_set_list *isl_set_list_alloc(
2523                 isl_ctx *ctx, int n);
2524         __isl_give isl_set_list *isl_set_list_copy(
2525                 __isl_keep isl_set_list *list);
2526         __isl_give isl_set_list *isl_set_list_add(
2527                 __isl_take isl_set_list *list,
2528                 __isl_take isl_set *el);
2529         __isl_give isl_set_list *isl_set_list_concat(
2530                 __isl_take isl_set_list *list1,
2531                 __isl_take isl_set_list *list2);
2532         void *isl_set_list_free(__isl_take isl_set_list *list);
2534 C<isl_set_list_alloc> creates an empty list with a capacity for
2535 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
2536 element.
2538 Lists can be inspected using the following functions.
2540         #include <isl/list.h>
2541         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
2542         int isl_set_list_n_set(__isl_keep isl_set_list *list);
2543         __isl_give isl_set *isl_set_list_get_set(
2544                 __isl_keep isl_set_list *list, int index);
2545         int isl_set_list_foreach(__isl_keep isl_set_list *list,
2546                 int (*fn)(__isl_take isl_set *el, void *user),
2547                 void *user);
2549 Lists can be printed using
2551         #include <isl/list.h>
2552         __isl_give isl_printer *isl_printer_print_set_list(
2553                 __isl_take isl_printer *p,
2554                 __isl_keep isl_set_list *list);
2556 =head2 Matrices
2558 Matrices can be created, copied and freed using the following functions.
2560         #include <isl/mat.h>
2561         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
2562                 unsigned n_row, unsigned n_col);
2563         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
2564         void isl_mat_free(__isl_take isl_mat *mat);
2566 Note that the elements of a newly created matrix may have arbitrary values.
2567 The elements can be changed and inspected using the following functions.
2569         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
2570         int isl_mat_rows(__isl_keep isl_mat *mat);
2571         int isl_mat_cols(__isl_keep isl_mat *mat);
2572         int isl_mat_get_element(__isl_keep isl_mat *mat,
2573                 int row, int col, isl_int *v);
2574         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
2575                 int row, int col, isl_int v);
2576         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
2577                 int row, int col, int v);
2579 C<isl_mat_get_element> will return a negative value if anything went wrong.
2580 In that case, the value of C<*v> is undefined.
2582 The following function can be used to compute the (right) inverse
2583 of a matrix, i.e., a matrix such that the product of the original
2584 and the inverse (in that order) is a multiple of the identity matrix.
2585 The input matrix is assumed to be of full row-rank.
2587         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
2589 The following function can be used to compute the (right) kernel
2590 (or null space) of a matrix, i.e., a matrix such that the product of
2591 the original and the kernel (in that order) is the zero matrix.
2593         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
2595 =head2 Piecewise Quasi Affine Expressions
2597 The zero quasi affine expression on a given domain can be created using
2599         __isl_give isl_aff *isl_aff_zero_on_domain(
2600                 __isl_take isl_local_space *ls);
2602 Note that the space in which the resulting object lives is a map space
2603 with the given space as domain and a one-dimensional range.
2605 An empty piecewise quasi affine expression (one with no cells)
2606 or a piecewise quasi affine expression with a single cell can
2607 be created using the following functions.
2609         #include <isl/aff.h>
2610         __isl_give isl_pw_aff *isl_pw_aff_empty(
2611                 __isl_take isl_space *space);
2612         __isl_give isl_pw_aff *isl_pw_aff_alloc(
2613                 __isl_take isl_set *set, __isl_take isl_aff *aff);
2614         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2615                 __isl_take isl_aff *aff);
2617 Quasi affine expressions can be copied and freed using
2619         #include <isl/aff.h>
2620         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
2621         void *isl_aff_free(__isl_take isl_aff *aff);
2623         __isl_give isl_pw_aff *isl_pw_aff_copy(
2624                 __isl_keep isl_pw_aff *pwaff);
2625         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
2627 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2628 using the following function.  The constraint is required to have
2629 a non-zero coefficient for the specified dimension.
2631         #include <isl/constraint.h>
2632         __isl_give isl_aff *isl_constraint_get_bound(
2633                 __isl_keep isl_constraint *constraint,
2634                 enum isl_dim_type type, int pos);
2636 The entire affine expression of the constraint can also be extracted
2637 using the following function.
2639         #include <isl/constraint.h>
2640         __isl_give isl_aff *isl_constraint_get_aff(
2641                 __isl_keep isl_constraint *constraint);
2643 Conversely, an equality constraint equating
2644 the affine expression to zero or an inequality constraint enforcing
2645 the affine expression to be non-negative, can be constructed using
2647         __isl_give isl_constraint *isl_equality_from_aff(
2648                 __isl_take isl_aff *aff);
2649         __isl_give isl_constraint *isl_inequality_from_aff(
2650                 __isl_take isl_aff *aff);
2652 The expression can be inspected using
2654         #include <isl/aff.h>
2655         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
2656         int isl_aff_dim(__isl_keep isl_aff *aff,
2657                 enum isl_dim_type type);
2658         __isl_give isl_local_space *isl_aff_get_domain_local_space(
2659                 __isl_keep isl_aff *aff);
2660         __isl_give isl_local_space *isl_aff_get_local_space(
2661                 __isl_keep isl_aff *aff);
2662         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
2663                 enum isl_dim_type type, unsigned pos);
2664         const char *isl_pw_aff_get_dim_name(
2665                 __isl_keep isl_pw_aff *pa,
2666                 enum isl_dim_type type, unsigned pos);
2667         __isl_give isl_id *isl_pw_aff_get_dim_id(
2668                 __isl_keep isl_pw_aff *pa,
2669                 enum isl_dim_type type, unsigned pos);
2670         int isl_aff_get_constant(__isl_keep isl_aff *aff,
2671                 isl_int *v);
2672         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
2673                 enum isl_dim_type type, int pos, isl_int *v);
2674         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
2675                 isl_int *v);
2676         __isl_give isl_aff *isl_aff_get_div(
2677                 __isl_keep isl_aff *aff, int pos);
2679         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
2680                 int (*fn)(__isl_take isl_set *set,
2681                           __isl_take isl_aff *aff,
2682                           void *user), void *user);
2684         int isl_aff_is_cst(__isl_keep isl_aff *aff);
2685         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
2687         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
2688                 enum isl_dim_type type, unsigned first, unsigned n);
2689         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
2690                 enum isl_dim_type type, unsigned first, unsigned n);
2692         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
2693         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
2694                 enum isl_dim_type type);
2695         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
2697 It can be modified using
2699         #include <isl/aff.h>
2700         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
2701                 __isl_take isl_pw_aff *pwaff,
2702                 enum isl_dim_type type, __isl_take isl_id *id);
2703         __isl_give isl_aff *isl_aff_set_dim_name(
2704                 __isl_take isl_aff *aff, enum isl_dim_type type,
2705                 unsigned pos, const char *s);
2706         __isl_give isl_aff *isl_aff_set_dim_id(
2707                 __isl_take isl_aff *aff, enum isl_dim_type type,
2708                 unsigned pos, __isl_take isl_id *id);
2709         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
2710                 __isl_take isl_pw_aff *pma,
2711                 enum isl_dim_type type, unsigned pos,
2712                 __isl_take isl_id *id);
2713         __isl_give isl_aff *isl_aff_set_constant(
2714                 __isl_take isl_aff *aff, isl_int v);
2715         __isl_give isl_aff *isl_aff_set_constant_si(
2716                 __isl_take isl_aff *aff, int v);
2717         __isl_give isl_aff *isl_aff_set_coefficient(
2718                 __isl_take isl_aff *aff,
2719                 enum isl_dim_type type, int pos, isl_int v);
2720         __isl_give isl_aff *isl_aff_set_coefficient_si(
2721                 __isl_take isl_aff *aff,
2722                 enum isl_dim_type type, int pos, int v);
2723         __isl_give isl_aff *isl_aff_set_denominator(
2724                 __isl_take isl_aff *aff, isl_int v);
2726         __isl_give isl_aff *isl_aff_add_constant(
2727                 __isl_take isl_aff *aff, isl_int v);
2728         __isl_give isl_aff *isl_aff_add_constant_si(
2729                 __isl_take isl_aff *aff, int v);
2730         __isl_give isl_aff *isl_aff_add_coefficient(
2731                 __isl_take isl_aff *aff,
2732                 enum isl_dim_type type, int pos, isl_int v);
2733         __isl_give isl_aff *isl_aff_add_coefficient_si(
2734                 __isl_take isl_aff *aff,
2735                 enum isl_dim_type type, int pos, int v);
2737         __isl_give isl_aff *isl_aff_insert_dims(
2738                 __isl_take isl_aff *aff,
2739                 enum isl_dim_type type, unsigned first, unsigned n);
2740         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
2741                 __isl_take isl_pw_aff *pwaff,
2742                 enum isl_dim_type type, unsigned first, unsigned n);
2743         __isl_give isl_aff *isl_aff_add_dims(
2744                 __isl_take isl_aff *aff,
2745                 enum isl_dim_type type, unsigned n);
2746         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
2747                 __isl_take isl_pw_aff *pwaff,
2748                 enum isl_dim_type type, unsigned n);
2749         __isl_give isl_aff *isl_aff_drop_dims(
2750                 __isl_take isl_aff *aff,
2751                 enum isl_dim_type type, unsigned first, unsigned n);
2752         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
2753                 __isl_take isl_pw_aff *pwaff,
2754                 enum isl_dim_type type, unsigned first, unsigned n);
2756 Note that the C<set_constant> and C<set_coefficient> functions
2757 set the I<numerator> of the constant or coefficient, while
2758 C<add_constant> and C<add_coefficient> add an integer value to
2759 the possibly rational constant or coefficient.
2761 To check whether an affine expressions is obviously zero
2762 or obviously equal to some other affine expression, use
2764         #include <isl/aff.h>
2765         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
2766         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
2767                 __isl_keep isl_aff *aff2);
2768         int isl_pw_aff_plain_is_equal(
2769                 __isl_keep isl_pw_aff *pwaff1,
2770                 __isl_keep isl_pw_aff *pwaff2);
2772 Operations include
2774         #include <isl/aff.h>
2775         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
2776                 __isl_take isl_aff *aff2);
2777         __isl_give isl_pw_aff *isl_pw_aff_add(
2778                 __isl_take isl_pw_aff *pwaff1,
2779                 __isl_take isl_pw_aff *pwaff2);
2780         __isl_give isl_pw_aff *isl_pw_aff_min(
2781                 __isl_take isl_pw_aff *pwaff1,
2782                 __isl_take isl_pw_aff *pwaff2);
2783         __isl_give isl_pw_aff *isl_pw_aff_max(
2784                 __isl_take isl_pw_aff *pwaff1,
2785                 __isl_take isl_pw_aff *pwaff2);
2786         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
2787                 __isl_take isl_aff *aff2);
2788         __isl_give isl_pw_aff *isl_pw_aff_sub(
2789                 __isl_take isl_pw_aff *pwaff1,
2790                 __isl_take isl_pw_aff *pwaff2);
2791         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
2792         __isl_give isl_pw_aff *isl_pw_aff_neg(
2793                 __isl_take isl_pw_aff *pwaff);
2794         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
2795         __isl_give isl_pw_aff *isl_pw_aff_ceil(
2796                 __isl_take isl_pw_aff *pwaff);
2797         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
2798         __isl_give isl_pw_aff *isl_pw_aff_floor(
2799                 __isl_take isl_pw_aff *pwaff);
2800         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
2801                 isl_int mod);
2802         __isl_give isl_pw_aff *isl_pw_aff_mod(
2803                 __isl_take isl_pw_aff *pwaff, isl_int mod);
2804         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
2805                 isl_int f);
2806         __isl_give isl_pw_aff *isl_pw_aff_scale(
2807                 __isl_take isl_pw_aff *pwaff, isl_int f);
2808         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
2809                 isl_int f);
2810         __isl_give isl_aff *isl_aff_scale_down_ui(
2811                 __isl_take isl_aff *aff, unsigned f);
2812         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
2813                 __isl_take isl_pw_aff *pwaff, isl_int f);
2815         __isl_give isl_pw_aff *isl_pw_aff_list_min(
2816                 __isl_take isl_pw_aff_list *list);
2817         __isl_give isl_pw_aff *isl_pw_aff_list_max(
2818                 __isl_take isl_pw_aff_list *list);
2820         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
2821                 __isl_take isl_pw_aff *pwqp);
2823         __isl_give isl_pw_aff *isl_pw_aff_align_params(
2824                 __isl_take isl_pw_aff *pwaff,
2825                 __isl_take isl_space *model);
2827         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
2828                 __isl_take isl_set *context);
2829         __isl_give isl_pw_aff *isl_pw_aff_gist(
2830                 __isl_take isl_pw_aff *pwaff,
2831                 __isl_take isl_set *context);
2833         __isl_give isl_set *isl_pw_aff_domain(
2834                 __isl_take isl_pw_aff *pwaff);
2835         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
2836                 __isl_take isl_pw_aff *pa,
2837                 __isl_take isl_set *set);
2839         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
2840                 __isl_take isl_aff *aff2);
2841         __isl_give isl_pw_aff *isl_pw_aff_mul(
2842                 __isl_take isl_pw_aff *pwaff1,
2843                 __isl_take isl_pw_aff *pwaff2);
2845 When multiplying two affine expressions, at least one of the two needs
2846 to be a constant.
2848         #include <isl/aff.h>
2849         __isl_give isl_basic_set *isl_aff_le_basic_set(
2850                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
2851         __isl_give isl_basic_set *isl_aff_ge_basic_set(
2852                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
2853         __isl_give isl_set *isl_pw_aff_eq_set(
2854                 __isl_take isl_pw_aff *pwaff1,
2855                 __isl_take isl_pw_aff *pwaff2);
2856         __isl_give isl_set *isl_pw_aff_ne_set(
2857                 __isl_take isl_pw_aff *pwaff1,
2858                 __isl_take isl_pw_aff *pwaff2);
2859         __isl_give isl_set *isl_pw_aff_le_set(
2860                 __isl_take isl_pw_aff *pwaff1,
2861                 __isl_take isl_pw_aff *pwaff2);
2862         __isl_give isl_set *isl_pw_aff_lt_set(
2863                 __isl_take isl_pw_aff *pwaff1,
2864                 __isl_take isl_pw_aff *pwaff2);
2865         __isl_give isl_set *isl_pw_aff_ge_set(
2866                 __isl_take isl_pw_aff *pwaff1,
2867                 __isl_take isl_pw_aff *pwaff2);
2868         __isl_give isl_set *isl_pw_aff_gt_set(
2869                 __isl_take isl_pw_aff *pwaff1,
2870                 __isl_take isl_pw_aff *pwaff2);
2872         __isl_give isl_set *isl_pw_aff_list_eq_set(
2873                 __isl_take isl_pw_aff_list *list1,
2874                 __isl_take isl_pw_aff_list *list2);
2875         __isl_give isl_set *isl_pw_aff_list_ne_set(
2876                 __isl_take isl_pw_aff_list *list1,
2877                 __isl_take isl_pw_aff_list *list2);
2878         __isl_give isl_set *isl_pw_aff_list_le_set(
2879                 __isl_take isl_pw_aff_list *list1,
2880                 __isl_take isl_pw_aff_list *list2);
2881         __isl_give isl_set *isl_pw_aff_list_lt_set(
2882                 __isl_take isl_pw_aff_list *list1,
2883                 __isl_take isl_pw_aff_list *list2);
2884         __isl_give isl_set *isl_pw_aff_list_ge_set(
2885                 __isl_take isl_pw_aff_list *list1,
2886                 __isl_take isl_pw_aff_list *list2);
2887         __isl_give isl_set *isl_pw_aff_list_gt_set(
2888                 __isl_take isl_pw_aff_list *list1,
2889                 __isl_take isl_pw_aff_list *list2);
2891 The function C<isl_aff_ge_basic_set> returns a basic set
2892 containing those elements in the shared space
2893 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
2894 The function C<isl_aff_ge_set> returns a set
2895 containing those elements in the shared domain
2896 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
2897 The functions operating on C<isl_pw_aff_list> apply the corresponding
2898 C<isl_pw_aff> function to each pair of elements in the two lists.
2900         #include <isl/aff.h>
2901         __isl_give isl_set *isl_pw_aff_nonneg_set(
2902                 __isl_take isl_pw_aff *pwaff);
2903         __isl_give isl_set *isl_pw_aff_zero_set(
2904                 __isl_take isl_pw_aff *pwaff);
2905         __isl_give isl_set *isl_pw_aff_non_zero_set(
2906                 __isl_take isl_pw_aff *pwaff);
2908 The function C<isl_pw_aff_nonneg_set> returns a set
2909 containing those elements in the domain
2910 of C<pwaff> where C<pwaff> is non-negative.
2912         #include <isl/aff.h>
2913         __isl_give isl_pw_aff *isl_pw_aff_cond(
2914                 __isl_take isl_set *cond,
2915                 __isl_take isl_pw_aff *pwaff_true,
2916                 __isl_take isl_pw_aff *pwaff_false);
2918 The function C<isl_pw_aff_cond> performs a conditional operator
2919 and returns an expression that is equal to C<pwaff_true>
2920 for elements in C<cond> and equal to C<pwaff_false> for elements
2921 not in C<cond>.
2923         #include <isl/aff.h>
2924         __isl_give isl_pw_aff *isl_pw_aff_union_min(
2925                 __isl_take isl_pw_aff *pwaff1,
2926                 __isl_take isl_pw_aff *pwaff2);
2927         __isl_give isl_pw_aff *isl_pw_aff_union_max(
2928                 __isl_take isl_pw_aff *pwaff1,
2929                 __isl_take isl_pw_aff *pwaff2);
2930         __isl_give isl_pw_aff *isl_pw_aff_union_add(
2931                 __isl_take isl_pw_aff *pwaff1,
2932                 __isl_take isl_pw_aff *pwaff2);
2934 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
2935 expression with a domain that is the union of those of C<pwaff1> and
2936 C<pwaff2> and such that on each cell, the quasi-affine expression is
2937 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
2938 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
2939 associated expression is the defined one.
2941 An expression can be read from input using
2943         #include <isl/aff.h>
2944         __isl_give isl_aff *isl_aff_read_from_str(
2945                 isl_ctx *ctx, const char *str);
2946         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
2947                 isl_ctx *ctx, const char *str);
2949 An expression can be printed using
2951         #include <isl/aff.h>
2952         __isl_give isl_printer *isl_printer_print_aff(
2953                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
2955         __isl_give isl_printer *isl_printer_print_pw_aff(
2956                 __isl_take isl_printer *p,
2957                 __isl_keep isl_pw_aff *pwaff);
2959 =head2 Piecewise Multiple Quasi Affine Expressions
2961 An C<isl_multi_aff> object represents a sequence of
2962 zero or more affine expressions, all defined on the same domain space.
2964 An C<isl_multi_aff> can be constructed from a C<isl_aff_list> using the
2965 following function.
2967         #include <isl/aff.h>
2968         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
2969                 __isl_take isl_space *space,
2970                 __isl_take isl_aff_list *list);
2972 An empty piecewise multiple quasi affine expression (one with no cells) or
2973 a piecewise multiple quasi affine expression with a single cell can
2974 be created using the following functions.
2976         #include <isl/aff.h>
2977         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
2978                 __isl_take isl_space *space);
2979         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
2980                 __isl_take isl_set *set,
2981                 __isl_take isl_multi_aff *maff);
2983 A piecewise multiple quasi affine expression can also be initialized
2984 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
2985 and the C<isl_map> is single-valued.
2987         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
2988                 __isl_take isl_set *set);
2989         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
2990                 __isl_take isl_map *map);
2992 Multiple quasi affine expressions can be copied and freed using
2994         #include <isl/aff.h>
2995         __isl_give isl_multi_aff *isl_multi_aff_copy(
2996                 __isl_keep isl_multi_aff *maff);
2997         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
2999         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3000                 __isl_keep isl_pw_multi_aff *pma);
3001         void *isl_pw_multi_aff_free(
3002                 __isl_take isl_pw_multi_aff *pma);
3004 The expression can be inspected using
3006         #include <isl/aff.h>
3007         isl_ctx *isl_multi_aff_get_ctx(
3008                 __isl_keep isl_multi_aff *maff);
3009         isl_ctx *isl_pw_multi_aff_get_ctx(
3010                 __isl_keep isl_pw_multi_aff *pma);
3011         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3012                 enum isl_dim_type type);
3013         unsigned isl_pw_multi_aff_dim(
3014                 __isl_keep isl_pw_multi_aff *pma,
3015                 enum isl_dim_type type);
3016         __isl_give isl_aff *isl_multi_aff_get_aff(
3017                 __isl_keep isl_multi_aff *multi, int pos);
3018         const char *isl_pw_multi_aff_get_dim_name(
3019                 __isl_keep isl_pw_multi_aff *pma,
3020                 enum isl_dim_type type, unsigned pos);
3021         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3022                 __isl_keep isl_pw_multi_aff *pma,
3023                 enum isl_dim_type type, unsigned pos);
3024         const char *isl_multi_aff_get_tuple_name(
3025                 __isl_keep isl_multi_aff *multi,
3026                 enum isl_dim_type type);
3027         const char *isl_pw_multi_aff_get_tuple_name(
3028                 __isl_keep isl_pw_multi_aff *pma,
3029                 enum isl_dim_type type);
3030         int isl_pw_multi_aff_has_tuple_id(
3031                 __isl_keep isl_pw_multi_aff *pma,
3032                 enum isl_dim_type type);
3033         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3034                 __isl_keep isl_pw_multi_aff *pma,
3035                 enum isl_dim_type type);
3037         int isl_pw_multi_aff_foreach_piece(
3038                 __isl_keep isl_pw_multi_aff *pma,
3039                 int (*fn)(__isl_take isl_set *set,
3040                             __isl_take isl_multi_aff *maff,
3041                             void *user), void *user);
3043 It can be modified using
3045         #include <isl/aff.h>
3046         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3047                 __isl_take isl_multi_aff *maff,
3048                 enum isl_dim_type type, unsigned pos, const char *s);
3049         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3050                 __isl_take isl_pw_multi_aff *pma,
3051                 enum isl_dim_type type, __isl_take isl_id *id);
3053 To check whether two multiple affine expressions are
3054 obviously equal to each other, use
3056         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3057                 __isl_keep isl_multi_aff *maff2);
3058         int isl_pw_multi_aff_plain_is_equal(
3059                 __isl_keep isl_pw_multi_aff *pma1,
3060                 __isl_keep isl_pw_multi_aff *pma2);
3062 Operations include
3064         #include <isl/aff.h>
3065         __isl_give isl_multi_aff *isl_multi_aff_add(
3066                 __isl_take isl_multi_aff *maff1,
3067                 __isl_take isl_multi_aff *maff2);
3068         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3069                 __isl_take isl_pw_multi_aff *pma1,
3070                 __isl_take isl_pw_multi_aff *pma2);
3071         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3072                 __isl_take isl_pw_multi_aff *pma1,
3073                 __isl_take isl_pw_multi_aff *pma2);
3074         __isl_give isl_multi_aff *isl_multi_aff_scale(
3075                 __isl_take isl_multi_aff *maff,
3076                 isl_int f);
3077         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3078                 __isl_take isl_pw_multi_aff *pma,
3079                 __isl_take isl_set *set);
3080         __isl_give isl_multi_aff *isl_multi_aff_lift(
3081                 __isl_take isl_multi_aff *maff,
3082                 __isl_give isl_local_space **ls);
3083         __isl_give isl_multi_aff *isl_multi_aff_gist(
3084                 __isl_take isl_multi_aff *maff,
3085                 __isl_take isl_set *context);
3087 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
3088 then it is assigned the local space that lies at the basis of
3089 the lifting applied.
3091 An expression can be read from input using
3093         #include <isl/aff.h>
3094         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3095                 isl_ctx *ctx, const char *str);
3096         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3097                 isl_ctx *ctx, const char *str);
3099 An expression can be printed using
3101         #include <isl/aff.h>
3102         __isl_give isl_printer *isl_printer_print_multi_aff(
3103                 __isl_take isl_printer *p,
3104                 __isl_keep isl_multi_aff *maff);
3105         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3106                 __isl_take isl_printer *p,
3107                 __isl_keep isl_pw_multi_aff *pma);
3109 =head2 Points
3111 Points are elements of a set.  They can be used to construct
3112 simple sets (boxes) or they can be used to represent the
3113 individual elements of a set.
3114 The zero point (the origin) can be created using
3116         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
3118 The coordinates of a point can be inspected, set and changed
3119 using
3121         void isl_point_get_coordinate(__isl_keep isl_point *pnt,
3122                 enum isl_dim_type type, int pos, isl_int *v);
3123         __isl_give isl_point *isl_point_set_coordinate(
3124                 __isl_take isl_point *pnt,
3125                 enum isl_dim_type type, int pos, isl_int v);
3127         __isl_give isl_point *isl_point_add_ui(
3128                 __isl_take isl_point *pnt,
3129                 enum isl_dim_type type, int pos, unsigned val);
3130         __isl_give isl_point *isl_point_sub_ui(
3131                 __isl_take isl_point *pnt,
3132                 enum isl_dim_type type, int pos, unsigned val);
3134 Other properties can be obtained using
3136         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
3138 Points can be copied or freed using
3140         __isl_give isl_point *isl_point_copy(
3141                 __isl_keep isl_point *pnt);
3142         void isl_point_free(__isl_take isl_point *pnt);
3144 A singleton set can be created from a point using
3146         __isl_give isl_basic_set *isl_basic_set_from_point(
3147                 __isl_take isl_point *pnt);
3148         __isl_give isl_set *isl_set_from_point(
3149                 __isl_take isl_point *pnt);
3151 and a box can be created from two opposite extremal points using
3153         __isl_give isl_basic_set *isl_basic_set_box_from_points(
3154                 __isl_take isl_point *pnt1,
3155                 __isl_take isl_point *pnt2);
3156         __isl_give isl_set *isl_set_box_from_points(
3157                 __isl_take isl_point *pnt1,
3158                 __isl_take isl_point *pnt2);
3160 All elements of a B<bounded> (union) set can be enumerated using
3161 the following functions.
3163         int isl_set_foreach_point(__isl_keep isl_set *set,
3164                 int (*fn)(__isl_take isl_point *pnt, void *user),
3165                 void *user);
3166         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
3167                 int (*fn)(__isl_take isl_point *pnt, void *user),
3168                 void *user);
3170 The function C<fn> is called for each integer point in
3171 C<set> with as second argument the last argument of
3172 the C<isl_set_foreach_point> call.  The function C<fn>
3173 should return C<0> on success and C<-1> on failure.
3174 In the latter case, C<isl_set_foreach_point> will stop
3175 enumerating and return C<-1> as well.
3176 If the enumeration is performed successfully and to completion,
3177 then C<isl_set_foreach_point> returns C<0>.
3179 To obtain a single point of a (basic) set, use
3181         __isl_give isl_point *isl_basic_set_sample_point(
3182                 __isl_take isl_basic_set *bset);
3183         __isl_give isl_point *isl_set_sample_point(
3184                 __isl_take isl_set *set);
3186 If C<set> does not contain any (integer) points, then the
3187 resulting point will be ``void'', a property that can be
3188 tested using
3190         int isl_point_is_void(__isl_keep isl_point *pnt);
3192 =head2 Piecewise Quasipolynomials
3194 A piecewise quasipolynomial is a particular kind of function that maps
3195 a parametric point to a rational value.
3196 More specifically, a quasipolynomial is a polynomial expression in greatest
3197 integer parts of affine expressions of parameters and variables.
3198 A piecewise quasipolynomial is a subdivision of a given parametric
3199 domain into disjoint cells with a quasipolynomial associated to
3200 each cell.  The value of the piecewise quasipolynomial at a given
3201 point is the value of the quasipolynomial associated to the cell
3202 that contains the point.  Outside of the union of cells,
3203 the value is assumed to be zero.
3204 For example, the piecewise quasipolynomial
3206         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
3208 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
3209 A given piecewise quasipolynomial has a fixed domain dimension.
3210 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
3211 defined over different domains.
3212 Piecewise quasipolynomials are mainly used by the C<barvinok>
3213 library for representing the number of elements in a parametric set or map.
3214 For example, the piecewise quasipolynomial above represents
3215 the number of points in the map
3217         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
3219 =head3 Input and Output
3221 Piecewise quasipolynomials can be read from input using
3223         __isl_give isl_union_pw_qpolynomial *
3224         isl_union_pw_qpolynomial_read_from_str(
3225                 isl_ctx *ctx, const char *str);
3227 Quasipolynomials and piecewise quasipolynomials can be printed
3228 using the following functions.
3230         __isl_give isl_printer *isl_printer_print_qpolynomial(
3231                 __isl_take isl_printer *p,
3232                 __isl_keep isl_qpolynomial *qp);
3234         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3235                 __isl_take isl_printer *p,
3236                 __isl_keep isl_pw_qpolynomial *pwqp);
3238         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3239                 __isl_take isl_printer *p,
3240                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3242 The output format of the printer
3243 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3244 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
3245 is supported.
3246 In case of printing in C<ISL_FORMAT_C>, the user may want
3247 to set the names of all dimensions
3249         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
3250                 __isl_take isl_qpolynomial *qp,
3251                 enum isl_dim_type type, unsigned pos,
3252                 const char *s);
3253         __isl_give isl_pw_qpolynomial *
3254         isl_pw_qpolynomial_set_dim_name(
3255                 __isl_take isl_pw_qpolynomial *pwqp,
3256                 enum isl_dim_type type, unsigned pos,
3257                 const char *s);
3259 =head3 Creating New (Piecewise) Quasipolynomials
3261 Some simple quasipolynomials can be created using the following functions.
3262 More complicated quasipolynomials can be created by applying
3263 operations such as addition and multiplication
3264 on the resulting quasipolynomials
3266         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
3267                 __isl_take isl_space *domain);
3268         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
3269                 __isl_take isl_space *domain);
3270         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
3271                 __isl_take isl_space *domain);
3272         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
3273                 __isl_take isl_space *domain);
3274         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
3275                 __isl_take isl_space *domain);
3276         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
3277                 __isl_take isl_space *domain,
3278                 const isl_int n, const isl_int d);
3279         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
3280                 __isl_take isl_space *domain,
3281                 enum isl_dim_type type, unsigned pos);
3282         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
3283                 __isl_take isl_aff *aff);
3285 Note that the space in which a quasipolynomial lives is a map space
3286 with a one-dimensional range.  The C<domain> argument in some of
3287 the functions above corresponds to the domain of this map space.
3289 The zero piecewise quasipolynomial or a piecewise quasipolynomial
3290 with a single cell can be created using the following functions.
3291 Multiple of these single cell piecewise quasipolynomials can
3292 be combined to create more complicated piecewise quasipolynomials.
3294         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
3295                 __isl_take isl_space *space);
3296         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
3297                 __isl_take isl_set *set,
3298                 __isl_take isl_qpolynomial *qp);
3299         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
3300                 __isl_take isl_qpolynomial *qp);
3301         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
3302                 __isl_take isl_pw_aff *pwaff);
3304         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
3305                 __isl_take isl_space *space);
3306         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
3307                 __isl_take isl_pw_qpolynomial *pwqp);
3308         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
3309                 __isl_take isl_union_pw_qpolynomial *upwqp,
3310                 __isl_take isl_pw_qpolynomial *pwqp);
3312 Quasipolynomials can be copied and freed again using the following
3313 functions.
3315         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
3316                 __isl_keep isl_qpolynomial *qp);
3317         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
3319         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
3320                 __isl_keep isl_pw_qpolynomial *pwqp);
3321         void *isl_pw_qpolynomial_free(
3322                 __isl_take isl_pw_qpolynomial *pwqp);
3324         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
3325                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3326         void isl_union_pw_qpolynomial_free(
3327                 __isl_take isl_union_pw_qpolynomial *upwqp);
3329 =head3 Inspecting (Piecewise) Quasipolynomials
3331 To iterate over all piecewise quasipolynomials in a union
3332 piecewise quasipolynomial, use the following function
3334         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
3335                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3336                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
3337                 void *user);
3339 To extract the piecewise quasipolynomial in a given space from a union, use
3341         __isl_give isl_pw_qpolynomial *
3342         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
3343                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3344                 __isl_take isl_space *space);
3346 To iterate over the cells in a piecewise quasipolynomial,
3347 use either of the following two functions
3349         int isl_pw_qpolynomial_foreach_piece(
3350                 __isl_keep isl_pw_qpolynomial *pwqp,
3351                 int (*fn)(__isl_take isl_set *set,
3352                           __isl_take isl_qpolynomial *qp,
3353                           void *user), void *user);
3354         int isl_pw_qpolynomial_foreach_lifted_piece(
3355                 __isl_keep isl_pw_qpolynomial *pwqp,
3356                 int (*fn)(__isl_take isl_set *set,
3357                           __isl_take isl_qpolynomial *qp,
3358                           void *user), void *user);
3360 As usual, the function C<fn> should return C<0> on success
3361 and C<-1> on failure.  The difference between
3362 C<isl_pw_qpolynomial_foreach_piece> and
3363 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
3364 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
3365 compute unique representations for all existentially quantified
3366 variables and then turn these existentially quantified variables
3367 into extra set variables, adapting the associated quasipolynomial
3368 accordingly.  This means that the C<set> passed to C<fn>
3369 will not have any existentially quantified variables, but that
3370 the dimensions of the sets may be different for different
3371 invocations of C<fn>.
3373 To iterate over all terms in a quasipolynomial,
3376         int isl_qpolynomial_foreach_term(
3377                 __isl_keep isl_qpolynomial *qp,
3378                 int (*fn)(__isl_take isl_term *term,
3379                           void *user), void *user);
3381 The terms themselves can be inspected and freed using
3382 these functions
3384         unsigned isl_term_dim(__isl_keep isl_term *term,
3385                 enum isl_dim_type type);
3386         void isl_term_get_num(__isl_keep isl_term *term,
3387                 isl_int *n);
3388         void isl_term_get_den(__isl_keep isl_term *term,
3389                 isl_int *d);
3390         int isl_term_get_exp(__isl_keep isl_term *term,
3391                 enum isl_dim_type type, unsigned pos);
3392         __isl_give isl_aff *isl_term_get_div(
3393                 __isl_keep isl_term *term, unsigned pos);
3394         void isl_term_free(__isl_take isl_term *term);
3396 Each term is a product of parameters, set variables and
3397 integer divisions.  The function C<isl_term_get_exp>
3398 returns the exponent of a given dimensions in the given term.
3399 The C<isl_int>s in the arguments of C<isl_term_get_num>
3400 and C<isl_term_get_den> need to have been initialized
3401 using C<isl_int_init> before calling these functions.
3403 =head3 Properties of (Piecewise) Quasipolynomials
3405 To check whether a quasipolynomial is actually a constant,
3406 use the following function.
3408         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
3409                 isl_int *n, isl_int *d);
3411 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
3412 then the numerator and denominator of the constant
3413 are returned in C<*n> and C<*d>, respectively.
3415 To check whether two union piecewise quasipolynomials are
3416 obviously equal, use
3418         int isl_union_pw_qpolynomial_plain_is_equal(
3419                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
3420                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
3422 =head3 Operations on (Piecewise) Quasipolynomials
3424         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
3425                 __isl_take isl_qpolynomial *qp, isl_int v);
3426         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
3427                 __isl_take isl_qpolynomial *qp);
3428         __isl_give isl_qpolynomial *isl_qpolynomial_add(
3429                 __isl_take isl_qpolynomial *qp1,
3430                 __isl_take isl_qpolynomial *qp2);
3431         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
3432                 __isl_take isl_qpolynomial *qp1,
3433                 __isl_take isl_qpolynomial *qp2);
3434         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
3435                 __isl_take isl_qpolynomial *qp1,
3436                 __isl_take isl_qpolynomial *qp2);
3437         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
3438                 __isl_take isl_qpolynomial *qp, unsigned exponent);
3440         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
3441                 __isl_take isl_pw_qpolynomial *pwqp1,
3442                 __isl_take isl_pw_qpolynomial *pwqp2);
3443         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
3444                 __isl_take isl_pw_qpolynomial *pwqp1,
3445                 __isl_take isl_pw_qpolynomial *pwqp2);
3446         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
3447                 __isl_take isl_pw_qpolynomial *pwqp1,
3448                 __isl_take isl_pw_qpolynomial *pwqp2);
3449         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
3450                 __isl_take isl_pw_qpolynomial *pwqp);
3451         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
3452                 __isl_take isl_pw_qpolynomial *pwqp1,
3453                 __isl_take isl_pw_qpolynomial *pwqp2);
3454         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
3455                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
3457         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
3458                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3459                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3460         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
3461                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3462                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3463         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
3464                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3465                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3467         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
3468                 __isl_take isl_pw_qpolynomial *pwqp,
3469                 __isl_take isl_point *pnt);
3471         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
3472                 __isl_take isl_union_pw_qpolynomial *upwqp,
3473                 __isl_take isl_point *pnt);
3475         __isl_give isl_set *isl_pw_qpolynomial_domain(
3476                 __isl_take isl_pw_qpolynomial *pwqp);
3477         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
3478                 __isl_take isl_pw_qpolynomial *pwpq,
3479                 __isl_take isl_set *set);
3481         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
3482                 __isl_take isl_union_pw_qpolynomial *upwqp);
3483         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
3484                 __isl_take isl_union_pw_qpolynomial *upwpq,
3485                 __isl_take isl_union_set *uset);
3487         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
3488                 __isl_take isl_qpolynomial *qp,
3489                 __isl_take isl_space *model);
3491         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
3492                 __isl_take isl_qpolynomial *qp);
3493         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
3494                 __isl_take isl_pw_qpolynomial *pwqp);
3496         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
3497                 __isl_take isl_union_pw_qpolynomial *upwqp);
3499         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
3500                 __isl_take isl_qpolynomial *qp,
3501                 __isl_take isl_set *context);
3503         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
3504                 __isl_take isl_pw_qpolynomial *pwqp,
3505                 __isl_take isl_set *context);
3507         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
3508                 __isl_take isl_union_pw_qpolynomial *upwqp,
3509                 __isl_take isl_union_set *context);
3511 The gist operation applies the gist operation to each of
3512 the cells in the domain of the input piecewise quasipolynomial.
3513 The context is also exploited
3514 to simplify the quasipolynomials associated to each cell.
3516         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
3517                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
3518         __isl_give isl_union_pw_qpolynomial *
3519         isl_union_pw_qpolynomial_to_polynomial(
3520                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
3522 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
3523 the polynomial will be an overapproximation.  If C<sign> is negative,
3524 it will be an underapproximation.  If C<sign> is zero, the approximation
3525 will lie somewhere in between.
3527 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
3529 A piecewise quasipolynomial reduction is a piecewise
3530 reduction (or fold) of quasipolynomials.
3531 In particular, the reduction can be maximum or a minimum.
3532 The objects are mainly used to represent the result of
3533 an upper or lower bound on a quasipolynomial over its domain,
3534 i.e., as the result of the following function.
3536         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
3537                 __isl_take isl_pw_qpolynomial *pwqp,
3538                 enum isl_fold type, int *tight);
3540         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
3541                 __isl_take isl_union_pw_qpolynomial *upwqp,
3542                 enum isl_fold type, int *tight);
3544 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
3545 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
3546 is the returned bound is known be tight, i.e., for each value
3547 of the parameters there is at least
3548 one element in the domain that reaches the bound.
3549 If the domain of C<pwqp> is not wrapping, then the bound is computed
3550 over all elements in that domain and the result has a purely parametric
3551 domain.  If the domain of C<pwqp> is wrapping, then the bound is
3552 computed over the range of the wrapped relation.  The domain of the
3553 wrapped relation becomes the domain of the result.
3555 A (piecewise) quasipolynomial reduction can be copied or freed using the
3556 following functions.
3558         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
3559                 __isl_keep isl_qpolynomial_fold *fold);
3560         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
3561                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3562         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
3563                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3564         void isl_qpolynomial_fold_free(
3565                 __isl_take isl_qpolynomial_fold *fold);
3566         void *isl_pw_qpolynomial_fold_free(
3567                 __isl_take isl_pw_qpolynomial_fold *pwf);
3568         void isl_union_pw_qpolynomial_fold_free(
3569                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3571 =head3 Printing Piecewise Quasipolynomial Reductions
3573 Piecewise quasipolynomial reductions can be printed
3574 using the following function.
3576         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
3577                 __isl_take isl_printer *p,
3578                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3579         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
3580                 __isl_take isl_printer *p,
3581                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3583 For C<isl_printer_print_pw_qpolynomial_fold>,
3584 output format of the printer
3585 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3586 For C<isl_printer_print_union_pw_qpolynomial_fold>,
3587 output format of the printer
3588 needs to be set to C<ISL_FORMAT_ISL>.
3589 In case of printing in C<ISL_FORMAT_C>, the user may want
3590 to set the names of all dimensions
3592         __isl_give isl_pw_qpolynomial_fold *
3593         isl_pw_qpolynomial_fold_set_dim_name(
3594                 __isl_take isl_pw_qpolynomial_fold *pwf,
3595                 enum isl_dim_type type, unsigned pos,
3596                 const char *s);
3598 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
3600 To iterate over all piecewise quasipolynomial reductions in a union
3601 piecewise quasipolynomial reduction, use the following function
3603         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
3604                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
3605                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
3606                             void *user), void *user);
3608 To iterate over the cells in a piecewise quasipolynomial reduction,
3609 use either of the following two functions
3611         int isl_pw_qpolynomial_fold_foreach_piece(
3612                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3613                 int (*fn)(__isl_take isl_set *set,
3614                           __isl_take isl_qpolynomial_fold *fold,
3615                           void *user), void *user);
3616         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
3617                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3618                 int (*fn)(__isl_take isl_set *set,
3619                           __isl_take isl_qpolynomial_fold *fold,
3620                           void *user), void *user);
3622 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
3623 of the difference between these two functions.
3625 To iterate over all quasipolynomials in a reduction, use
3627         int isl_qpolynomial_fold_foreach_qpolynomial(
3628                 __isl_keep isl_qpolynomial_fold *fold,
3629                 int (*fn)(__isl_take isl_qpolynomial *qp,
3630                           void *user), void *user);
3632 =head3 Properties of Piecewise Quasipolynomial Reductions
3634 To check whether two union piecewise quasipolynomial reductions are
3635 obviously equal, use
3637         int isl_union_pw_qpolynomial_fold_plain_is_equal(
3638                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
3639                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
3641 =head3 Operations on Piecewise Quasipolynomial Reductions
3643         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
3644                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
3646         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
3647                 __isl_take isl_pw_qpolynomial_fold *pwf1,
3648                 __isl_take isl_pw_qpolynomial_fold *pwf2);
3650         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
3651                 __isl_take isl_pw_qpolynomial_fold *pwf1,
3652                 __isl_take isl_pw_qpolynomial_fold *pwf2);
3654         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
3655                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
3656                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
3658         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
3659                 __isl_take isl_pw_qpolynomial_fold *pwf,
3660                 __isl_take isl_point *pnt);
3662         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
3663                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3664                 __isl_take isl_point *pnt);
3666         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
3667                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3668         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
3669                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3670                 __isl_take isl_union_set *uset);
3672         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
3673                 __isl_take isl_pw_qpolynomial_fold *pwf);
3675         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
3676                 __isl_take isl_pw_qpolynomial_fold *pwf);
3678         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
3679                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3681         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
3682                 __isl_take isl_pw_qpolynomial_fold *pwf,
3683                 __isl_take isl_set *context);
3685         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
3686                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3687                 __isl_take isl_union_set *context);
3689 The gist operation applies the gist operation to each of
3690 the cells in the domain of the input piecewise quasipolynomial reduction.
3691 In future, the operation will also exploit the context
3692 to simplify the quasipolynomial reductions associated to each cell.
3694         __isl_give isl_pw_qpolynomial_fold *
3695         isl_set_apply_pw_qpolynomial_fold(
3696                 __isl_take isl_set *set,
3697                 __isl_take isl_pw_qpolynomial_fold *pwf,
3698                 int *tight);
3699         __isl_give isl_pw_qpolynomial_fold *
3700         isl_map_apply_pw_qpolynomial_fold(
3701                 __isl_take isl_map *map,
3702                 __isl_take isl_pw_qpolynomial_fold *pwf,
3703                 int *tight);
3704         __isl_give isl_union_pw_qpolynomial_fold *
3705         isl_union_set_apply_union_pw_qpolynomial_fold(
3706                 __isl_take isl_union_set *uset,
3707                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3708                 int *tight);
3709         __isl_give isl_union_pw_qpolynomial_fold *
3710         isl_union_map_apply_union_pw_qpolynomial_fold(
3711                 __isl_take isl_union_map *umap,
3712                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3713                 int *tight);
3715 The functions taking a map
3716 compose the given map with the given piecewise quasipolynomial reduction.
3717 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
3718 over all elements in the intersection of the range of the map
3719 and the domain of the piecewise quasipolynomial reduction
3720 as a function of an element in the domain of the map.
3721 The functions taking a set compute a bound over all elements in the
3722 intersection of the set and the domain of the
3723 piecewise quasipolynomial reduction.
3725 =head2 Dependence Analysis
3727 C<isl> contains specialized functionality for performing
3728 array dataflow analysis.  That is, given a I<sink> access relation
3729 and a collection of possible I<source> access relations,
3730 C<isl> can compute relations that describe
3731 for each iteration of the sink access, which iteration
3732 of which of the source access relations was the last
3733 to access the same data element before the given iteration
3734 of the sink access.
3735 To compute standard flow dependences, the sink should be
3736 a read, while the sources should be writes.
3737 If any of the source accesses are marked as being I<may>
3738 accesses, then there will be a dependence to the last
3739 I<must> access B<and> to any I<may> access that follows
3740 this last I<must> access.
3741 In particular, if I<all> sources are I<may> accesses,
3742 then memory based dependence analysis is performed.
3743 If, on the other hand, all sources are I<must> accesses,
3744 then value based dependence analysis is performed.
3746         #include <isl/flow.h>
3748         typedef int (*isl_access_level_before)(void *first, void *second);
3750         __isl_give isl_access_info *isl_access_info_alloc(
3751                 __isl_take isl_map *sink,
3752                 void *sink_user, isl_access_level_before fn,
3753                 int max_source);
3754         __isl_give isl_access_info *isl_access_info_add_source(
3755                 __isl_take isl_access_info *acc,
3756                 __isl_take isl_map *source, int must,
3757                 void *source_user);
3758         void isl_access_info_free(__isl_take isl_access_info *acc);
3760         __isl_give isl_flow *isl_access_info_compute_flow(
3761                 __isl_take isl_access_info *acc);
3763         int isl_flow_foreach(__isl_keep isl_flow *deps,
3764                 int (*fn)(__isl_take isl_map *dep, int must,
3765                           void *dep_user, void *user),
3766                 void *user);
3767         __isl_give isl_map *isl_flow_get_no_source(
3768                 __isl_keep isl_flow *deps, int must);
3769         void isl_flow_free(__isl_take isl_flow *deps);
3771 The function C<isl_access_info_compute_flow> performs the actual
3772 dependence analysis.  The other functions are used to construct
3773 the input for this function or to read off the output.
3775 The input is collected in an C<isl_access_info>, which can
3776 be created through a call to C<isl_access_info_alloc>.
3777 The arguments to this functions are the sink access relation
3778 C<sink>, a token C<sink_user> used to identify the sink
3779 access to the user, a callback function for specifying the
3780 relative order of source and sink accesses, and the number
3781 of source access relations that will be added.
3782 The callback function has type C<int (*)(void *first, void *second)>.
3783 The function is called with two user supplied tokens identifying
3784 either a source or the sink and it should return the shared nesting
3785 level and the relative order of the two accesses.
3786 In particular, let I<n> be the number of loops shared by
3787 the two accesses.  If C<first> precedes C<second> textually,
3788 then the function should return I<2 * n + 1>; otherwise,
3789 it should return I<2 * n>.
3790 The sources can be added to the C<isl_access_info> by performing
3791 (at most) C<max_source> calls to C<isl_access_info_add_source>.
3792 C<must> indicates whether the source is a I<must> access
3793 or a I<may> access.  Note that a multi-valued access relation
3794 should only be marked I<must> if every iteration in the domain
3795 of the relation accesses I<all> elements in its image.
3796 The C<source_user> token is again used to identify
3797 the source access.  The range of the source access relation
3798 C<source> should have the same dimension as the range
3799 of the sink access relation.
3800 The C<isl_access_info_free> function should usually not be
3801 called explicitly, because it is called implicitly by
3802 C<isl_access_info_compute_flow>.
3804 The result of the dependence analysis is collected in an
3805 C<isl_flow>.  There may be elements of
3806 the sink access for which no preceding source access could be
3807 found or for which all preceding sources are I<may> accesses.
3808 The relations containing these elements can be obtained through
3809 calls to C<isl_flow_get_no_source>, the first with C<must> set
3810 and the second with C<must> unset.
3811 In the case of standard flow dependence analysis,
3812 with the sink a read and the sources I<must> writes,
3813 the first relation corresponds to the reads from uninitialized
3814 array elements and the second relation is empty.
3815 The actual flow dependences can be extracted using
3816 C<isl_flow_foreach>.  This function will call the user-specified
3817 callback function C<fn> for each B<non-empty> dependence between
3818 a source and the sink.  The callback function is called
3819 with four arguments, the actual flow dependence relation
3820 mapping source iterations to sink iterations, a boolean that
3821 indicates whether it is a I<must> or I<may> dependence, a token
3822 identifying the source and an additional C<void *> with value
3823 equal to the third argument of the C<isl_flow_foreach> call.
3824 A dependence is marked I<must> if it originates from a I<must>
3825 source and if it is not followed by any I<may> sources.
3827 After finishing with an C<isl_flow>, the user should call
3828 C<isl_flow_free> to free all associated memory.
3830 A higher-level interface to dependence analysis is provided
3831 by the following function.
3833         #include <isl/flow.h>
3835         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
3836                 __isl_take isl_union_map *must_source,
3837                 __isl_take isl_union_map *may_source,
3838                 __isl_take isl_union_map *schedule,
3839                 __isl_give isl_union_map **must_dep,
3840                 __isl_give isl_union_map **may_dep,
3841                 __isl_give isl_union_map **must_no_source,
3842                 __isl_give isl_union_map **may_no_source);
3844 The arrays are identified by the tuple names of the ranges
3845 of the accesses.  The iteration domains by the tuple names
3846 of the domains of the accesses and of the schedule.
3847 The relative order of the iteration domains is given by the
3848 schedule.  The relations returned through C<must_no_source>
3849 and C<may_no_source> are subsets of C<sink>.
3850 Any of C<must_dep>, C<may_dep>, C<must_no_source>
3851 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
3852 any of the other arguments is treated as an error.
3854 =head2 Scheduling
3856 B<The functionality described in this section is fairly new
3857 and may be subject to change.>
3859 The following function can be used to compute a schedule
3860 for a union of domains.  The generated schedule respects
3861 all C<validity> dependences.  That is, all dependence distances
3862 over these dependences in the scheduled space are lexicographically
3863 positive.  The generated schedule schedule also tries to minimize
3864 the dependence distances over C<proximity> dependences.
3865 Moreover, it tries to obtain sequences (bands) of schedule dimensions
3866 for groups of domains where the dependence distances have only
3867 non-negative values.
3868 The algorithm used to construct the schedule is similar to that
3869 of C<Pluto>.
3871         #include <isl/schedule.h>
3872         __isl_give isl_schedule *isl_union_set_compute_schedule(
3873                 __isl_take isl_union_set *domain,
3874                 __isl_take isl_union_map *validity,
3875                 __isl_take isl_union_map *proximity);
3876         void *isl_schedule_free(__isl_take isl_schedule *sched);
3878 A mapping from the domains to the scheduled space can be obtained
3879 from an C<isl_schedule> using the following function.
3881         __isl_give isl_union_map *isl_schedule_get_map(
3882                 __isl_keep isl_schedule *sched);
3884 A representation of the schedule can be printed using
3885          
3886         __isl_give isl_printer *isl_printer_print_schedule(
3887                 __isl_take isl_printer *p,
3888                 __isl_keep isl_schedule *schedule);
3890 A representation of the schedule as a forest of bands can be obtained
3891 using the following function.
3893         __isl_give isl_band_list *isl_schedule_get_band_forest(
3894                 __isl_keep isl_schedule *schedule);
3896 The list can be manipulated as explained in L<"Lists">.
3897 The bands inside the list can be copied and freed using the following
3898 functions.
3900         #include <isl/band.h>
3901         __isl_give isl_band *isl_band_copy(
3902                 __isl_keep isl_band *band);
3903         void *isl_band_free(__isl_take isl_band *band);
3905 Each band contains zero or more scheduling dimensions.
3906 These are referred to as the members of the band.
3907 The section of the schedule that corresponds to the band is
3908 referred to as the partial schedule of the band.
3909 For those nodes that participate in a band, the outer scheduling
3910 dimensions form the prefix schedule, while the inner scheduling
3911 dimensions form the suffix schedule.
3912 That is, if we take a cut of the band forest, then the union of
3913 the concatenations of the prefix, partial and suffix schedules of
3914 each band in the cut is equal to the entire schedule (modulo
3915 some possible padding at the end with zero scheduling dimensions).
3916 The properties of a band can be inspected using the following functions.
3918         #include <isl/band.h>
3919         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
3921         int isl_band_has_children(__isl_keep isl_band *band);
3922         __isl_give isl_band_list *isl_band_get_children(
3923                 __isl_keep isl_band *band);
3925         __isl_give isl_union_map *isl_band_get_prefix_schedule(
3926                 __isl_keep isl_band *band);
3927         __isl_give isl_union_map *isl_band_get_partial_schedule(
3928                 __isl_keep isl_band *band);
3929         __isl_give isl_union_map *isl_band_get_suffix_schedule(
3930                 __isl_keep isl_band *band);
3932         int isl_band_n_member(__isl_keep isl_band *band);
3933         int isl_band_member_is_zero_distance(
3934                 __isl_keep isl_band *band, int pos);
3936 Note that a scheduling dimension is considered to be ``zero
3937 distance'' if it does not carry any proximity dependences
3938 within its band.
3939 That is, if the dependence distances of the proximity
3940 dependences are all zero in that direction (for fixed
3941 iterations of outer bands).
3943 A representation of the band can be printed using
3945         #include <isl/band.h>
3946         __isl_give isl_printer *isl_printer_print_band(
3947                 __isl_take isl_printer *p,
3948                 __isl_keep isl_band *band);
3950 =head2 Parametric Vertex Enumeration
3952 The parametric vertex enumeration described in this section
3953 is mainly intended to be used internally and by the C<barvinok>
3954 library.
3956         #include <isl/vertices.h>
3957         __isl_give isl_vertices *isl_basic_set_compute_vertices(
3958                 __isl_keep isl_basic_set *bset);
3960 The function C<isl_basic_set_compute_vertices> performs the
3961 actual computation of the parametric vertices and the chamber
3962 decomposition and store the result in an C<isl_vertices> object.
3963 This information can be queried by either iterating over all
3964 the vertices or iterating over all the chambers or cells
3965 and then iterating over all vertices that are active on the chamber.
3967         int isl_vertices_foreach_vertex(
3968                 __isl_keep isl_vertices *vertices,
3969                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
3970                 void *user);
3972         int isl_vertices_foreach_cell(
3973                 __isl_keep isl_vertices *vertices,
3974                 int (*fn)(__isl_take isl_cell *cell, void *user),
3975                 void *user);
3976         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
3977                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
3978                 void *user);
3980 Other operations that can be performed on an C<isl_vertices> object are
3981 the following.
3983         isl_ctx *isl_vertices_get_ctx(
3984                 __isl_keep isl_vertices *vertices);
3985         int isl_vertices_get_n_vertices(
3986                 __isl_keep isl_vertices *vertices);
3987         void isl_vertices_free(__isl_take isl_vertices *vertices);
3989 Vertices can be inspected and destroyed using the following functions.
3991         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
3992         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
3993         __isl_give isl_basic_set *isl_vertex_get_domain(
3994                 __isl_keep isl_vertex *vertex);
3995         __isl_give isl_basic_set *isl_vertex_get_expr(
3996                 __isl_keep isl_vertex *vertex);
3997         void isl_vertex_free(__isl_take isl_vertex *vertex);
3999 C<isl_vertex_get_expr> returns a singleton parametric set describing
4000 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4001 of the vertex.
4002 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4003 B<rational> basic sets, so they should mainly be used for inspection
4004 and should not be mixed with integer sets.
4006 Chambers can be inspected and destroyed using the following functions.
4008         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4009         __isl_give isl_basic_set *isl_cell_get_domain(
4010                 __isl_keep isl_cell *cell);
4011         void isl_cell_free(__isl_take isl_cell *cell);
4013 =head1 Applications
4015 Although C<isl> is mainly meant to be used as a library,
4016 it also contains some basic applications that use some
4017 of the functionality of C<isl>.
4018 The input may be specified in either the L<isl format>
4019 or the L<PolyLib format>.
4021 =head2 C<isl_polyhedron_sample>
4023 C<isl_polyhedron_sample> takes a polyhedron as input and prints
4024 an integer element of the polyhedron, if there is any.
4025 The first column in the output is the denominator and is always
4026 equal to 1.  If the polyhedron contains no integer points,
4027 then a vector of length zero is printed.
4029 =head2 C<isl_pip>
4031 C<isl_pip> takes the same input as the C<example> program
4032 from the C<piplib> distribution, i.e., a set of constraints
4033 on the parameters, a line containing only -1 and finally a set
4034 of constraints on a parametric polyhedron.
4035 The coefficients of the parameters appear in the last columns
4036 (but before the final constant column).
4037 The output is the lexicographic minimum of the parametric polyhedron.
4038 As C<isl> currently does not have its own output format, the output
4039 is just a dump of the internal state.
4041 =head2 C<isl_polyhedron_minimize>
4043 C<isl_polyhedron_minimize> computes the minimum of some linear
4044 or affine objective function over the integer points in a polyhedron.
4045 If an affine objective function
4046 is given, then the constant should appear in the last column.
4048 =head2 C<isl_polytope_scan>
4050 Given a polytope, C<isl_polytope_scan> prints
4051 all integer points in the polytope.