add isl_*_list_sort
[isl.git] / doc / user.pod
blob6ab350708f2ce5dc79dc4918819f28ca47bd4d72
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 =head3 Changes since isl-0.09
158 =over
160 =item * The C<schedule_split_parallel> option has been replaced
161 by the C<schedule_split_scaled> option.
163 =item * The first argument of C<isl_pw_aff_cond> is now
164 an C<isl_pw_aff> instead of an C<isl_set>.
165 A call C<isl_pw_aff_cond(a, b, c)> can be replaced by
167         isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
169 =back
171 =head3 Changes since isl-0.10
173 =over
175 =item * The functions C<isl_set_dim_has_lower_bound> and
176 C<isl_set_dim_has_upper_bound> have been renamed to
177 C<isl_set_dim_has_any_lower_bound> and
178 C<isl_set_dim_has_any_upper_bound>.
179 The new C<isl_set_dim_has_lower_bound> and
180 C<isl_set_dim_has_upper_bound> have slightly different meanings.
182 =back
184 =head1 License
186 C<isl> is released under the MIT license.
188 =over
190 Permission is hereby granted, free of charge, to any person obtaining a copy of
191 this software and associated documentation files (the "Software"), to deal in
192 the Software without restriction, including without limitation the rights to
193 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
194 of the Software, and to permit persons to whom the Software is furnished to do
195 so, subject to the following conditions:
197 The above copyright notice and this permission notice shall be included in all
198 copies or substantial portions of the Software.
200 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
201 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
202 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
203 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
204 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
205 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
206 SOFTWARE.
208 =back
210 Note that C<isl> currently requires C<GMP>, which is released
211 under the GNU Lesser General Public License (LGPL).  This means
212 that code linked against C<isl> is also linked against LGPL code.
214 =head1 Installation
216 The source of C<isl> can be obtained either as a tarball
217 or from the git repository.  Both are available from
218 L<http://freshmeat.net/projects/isl/>.
219 The installation process depends on how you obtained
220 the source.
222 =head2 Installation from the git repository
224 =over
226 =item 1 Clone or update the repository
228 The first time the source is obtained, you need to clone
229 the repository.
231         git clone git://repo.or.cz/isl.git
233 To obtain updates, you need to pull in the latest changes
235         git pull
237 =item 2 Generate C<configure>
239         ./autogen.sh
241 =back
243 After performing the above steps, continue
244 with the L<Common installation instructions>.
246 =head2 Common installation instructions
248 =over
250 =item 1 Obtain C<GMP>
252 Building C<isl> requires C<GMP>, including its headers files.
253 Your distribution may not provide these header files by default
254 and you may need to install a package called C<gmp-devel> or something
255 similar.  Alternatively, C<GMP> can be built from
256 source, available from L<http://gmplib.org/>.
258 =item 2 Configure
260 C<isl> uses the standard C<autoconf> C<configure> script.
261 To run it, just type
263         ./configure
265 optionally followed by some configure options.
266 A complete list of options can be obtained by running
268         ./configure --help
270 Below we discuss some of the more common options.
272 C<isl> can optionally use C<piplib>, but no
273 C<piplib> functionality is currently used by default.
274 The C<--with-piplib> option can
275 be used to specify which C<piplib>
276 library to use, either an installed version (C<system>),
277 an externally built version (C<build>)
278 or no version (C<no>).  The option C<build> is mostly useful
279 in C<configure> scripts of larger projects that bundle both C<isl>
280 and C<piplib>.
282 =over
284 =item C<--prefix>
286 Installation prefix for C<isl>
288 =item C<--with-gmp-prefix>
290 Installation prefix for C<GMP> (architecture-independent files).
292 =item C<--with-gmp-exec-prefix>
294 Installation prefix for C<GMP> (architecture-dependent files).
296 =item C<--with-piplib>
298 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
300 =item C<--with-piplib-prefix>
302 Installation prefix for C<system> C<piplib> (architecture-independent files).
304 =item C<--with-piplib-exec-prefix>
306 Installation prefix for C<system> C<piplib> (architecture-dependent files).
308 =item C<--with-piplib-builddir>
310 Location where C<build> C<piplib> was built.
312 =back
314 =item 3 Compile
316         make
318 =item 4 Install (optional)
320         make install
322 =back
324 =head1 Integer Set Library
326 =head2 Initialization
328 All manipulations of integer sets and relations occur within
329 the context of an C<isl_ctx>.
330 A given C<isl_ctx> can only be used within a single thread.
331 All arguments of a function are required to have been allocated
332 within the same context.
333 There are currently no functions available for moving an object
334 from one C<isl_ctx> to another C<isl_ctx>.  This means that
335 there is currently no way of safely moving an object from one
336 thread to another, unless the whole C<isl_ctx> is moved.
338 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
339 freed using C<isl_ctx_free>.
340 All objects allocated within an C<isl_ctx> should be freed
341 before the C<isl_ctx> itself is freed.
343         isl_ctx *isl_ctx_alloc();
344         void isl_ctx_free(isl_ctx *ctx);
346 =head2 Integers
348 All operations on integers, mainly the coefficients
349 of the constraints describing the sets and relations,
350 are performed in exact integer arithmetic using C<GMP>.
351 However, to allow future versions of C<isl> to optionally
352 support fixed integer arithmetic, all calls to C<GMP>
353 are wrapped inside C<isl> specific macros.
354 The basic type is C<isl_int> and the operations below
355 are available on this type.
356 The meanings of these operations are essentially the same
357 as their C<GMP> C<mpz_> counterparts.
358 As always with C<GMP> types, C<isl_int>s need to be
359 initialized with C<isl_int_init> before they can be used
360 and they need to be released with C<isl_int_clear>
361 after the last use.
362 The user should not assume that an C<isl_int> is represented
363 as a C<mpz_t>, but should instead explicitly convert between
364 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
365 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
367 =over
369 =item isl_int_init(i)
371 =item isl_int_clear(i)
373 =item isl_int_set(r,i)
375 =item isl_int_set_si(r,i)
377 =item isl_int_set_gmp(r,g)
379 =item isl_int_get_gmp(i,g)
381 =item isl_int_abs(r,i)
383 =item isl_int_neg(r,i)
385 =item isl_int_swap(i,j)
387 =item isl_int_swap_or_set(i,j)
389 =item isl_int_add_ui(r,i,j)
391 =item isl_int_sub_ui(r,i,j)
393 =item isl_int_add(r,i,j)
395 =item isl_int_sub(r,i,j)
397 =item isl_int_mul(r,i,j)
399 =item isl_int_mul_ui(r,i,j)
401 =item isl_int_addmul(r,i,j)
403 =item isl_int_submul(r,i,j)
405 =item isl_int_gcd(r,i,j)
407 =item isl_int_lcm(r,i,j)
409 =item isl_int_divexact(r,i,j)
411 =item isl_int_cdiv_q(r,i,j)
413 =item isl_int_fdiv_q(r,i,j)
415 =item isl_int_fdiv_r(r,i,j)
417 =item isl_int_fdiv_q_ui(r,i,j)
419 =item isl_int_read(r,s)
421 =item isl_int_print(out,i,width)
423 =item isl_int_sgn(i)
425 =item isl_int_cmp(i,j)
427 =item isl_int_cmp_si(i,si)
429 =item isl_int_eq(i,j)
431 =item isl_int_ne(i,j)
433 =item isl_int_lt(i,j)
435 =item isl_int_le(i,j)
437 =item isl_int_gt(i,j)
439 =item isl_int_ge(i,j)
441 =item isl_int_abs_eq(i,j)
443 =item isl_int_abs_ne(i,j)
445 =item isl_int_abs_lt(i,j)
447 =item isl_int_abs_gt(i,j)
449 =item isl_int_abs_ge(i,j)
451 =item isl_int_is_zero(i)
453 =item isl_int_is_one(i)
455 =item isl_int_is_negone(i)
457 =item isl_int_is_pos(i)
459 =item isl_int_is_neg(i)
461 =item isl_int_is_nonpos(i)
463 =item isl_int_is_nonneg(i)
465 =item isl_int_is_divisible_by(i,j)
467 =back
469 =head2 Sets and Relations
471 C<isl> uses six types of objects for representing sets and relations,
472 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
473 C<isl_union_set> and C<isl_union_map>.
474 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
475 can be described as a conjunction of affine constraints, while
476 C<isl_set> and C<isl_map> represent unions of
477 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
478 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
479 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
480 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
481 where spaces are considered different if they have a different number
482 of dimensions and/or different names (see L<"Spaces">).
483 The difference between sets and relations (maps) is that sets have
484 one set of variables, while relations have two sets of variables,
485 input variables and output variables.
487 =head2 Memory Management
489 Since a high-level operation on sets and/or relations usually involves
490 several substeps and since the user is usually not interested in
491 the intermediate results, most functions that return a new object
492 will also release all the objects passed as arguments.
493 If the user still wants to use one or more of these arguments
494 after the function call, she should pass along a copy of the
495 object rather than the object itself.
496 The user is then responsible for making sure that the original
497 object gets used somewhere else or is explicitly freed.
499 The arguments and return values of all documented functions are
500 annotated to make clear which arguments are released and which
501 arguments are preserved.  In particular, the following annotations
502 are used
504 =over
506 =item C<__isl_give>
508 C<__isl_give> means that a new object is returned.
509 The user should make sure that the returned pointer is
510 used exactly once as a value for an C<__isl_take> argument.
511 In between, it can be used as a value for as many
512 C<__isl_keep> arguments as the user likes.
513 There is one exception, and that is the case where the
514 pointer returned is C<NULL>.  Is this case, the user
515 is free to use it as an C<__isl_take> argument or not.
517 =item C<__isl_take>
519 C<__isl_take> means that the object the argument points to
520 is taken over by the function and may no longer be used
521 by the user as an argument to any other function.
522 The pointer value must be one returned by a function
523 returning an C<__isl_give> pointer.
524 If the user passes in a C<NULL> value, then this will
525 be treated as an error in the sense that the function will
526 not perform its usual operation.  However, it will still
527 make sure that all the other C<__isl_take> arguments
528 are released.
530 =item C<__isl_keep>
532 C<__isl_keep> means that the function will only use the object
533 temporarily.  After the function has finished, the user
534 can still use it as an argument to other functions.
535 A C<NULL> value will be treated in the same way as
536 a C<NULL> value for an C<__isl_take> argument.
538 =back
540 =head2 Error Handling
542 C<isl> supports different ways to react in case a runtime error is triggered.
543 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
544 with two maps that have incompatible spaces. There are three possible ways
545 to react on error: to warn, to continue or to abort.
547 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
548 the last error in the corresponding C<isl_ctx> and the function in which the
549 error was triggered returns C<NULL>. An error does not corrupt internal state,
550 such that isl can continue to be used. C<isl> also provides functions to
551 read the last error and to reset the memory that stores the last error. The
552 last error is only stored for information purposes. Its presence does not
553 change the behavior of C<isl>. Hence, resetting an error is not required to
554 continue to use isl, but only to observe new errors.
556         #include <isl/ctx.h>
557         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
558         void isl_ctx_reset_error(isl_ctx *ctx);
560 Another option is to continue on error. This is similar to warn on error mode,
561 except that C<isl> does not print any warning. This allows a program to
562 implement its own error reporting.
564 The last option is to directly abort the execution of the program from within
565 the isl library. This makes it obviously impossible to recover from an error,
566 but it allows to directly spot the error location. By aborting on error,
567 debuggers break at the location the error occurred and can provide a stack
568 trace. Other tools that automatically provide stack traces on abort or that do
569 not want to continue execution after an error was triggered may also prefer to
570 abort on error.
572 The on error behavior of isl can be specified by calling
573 C<isl_options_set_on_error> or by setting the command line option
574 C<--isl-on-error>. Valid arguments for the function call are
575 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
576 choices for the command line option are C<warn>, C<continue> and C<abort>.
577 It is also possible to query the current error mode.
579         #include <isl/options.h>
580         int isl_options_set_on_error(isl_ctx *ctx, int val);
581         int isl_options_get_on_error(isl_ctx *ctx);
583 =head2 Identifiers
585 Identifiers are used to identify both individual dimensions
586 and tuples of dimensions.  They consist of an optional name and an optional
587 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
588 Identifiers with the same name but different pointer values
589 are considered to be distinct.
590 Similarly, identifiers with different names but the same pointer value
591 are also considered to be distinct.
592 Equal identifiers are represented using the same object.
593 Pairs of identifiers can therefore be tested for equality using the
594 C<==> operator.
595 Identifiers can be constructed, copied, freed, inspected and printed
596 using the following functions.
598         #include <isl/id.h>
599         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
600                 __isl_keep const char *name, void *user);
601         __isl_give isl_id *isl_id_set_free_user(
602                 __isl_take isl_id *id,
603                 __isl_give void (*free_user)(void *user));
604         __isl_give isl_id *isl_id_copy(isl_id *id);
605         void *isl_id_free(__isl_take isl_id *id);
607         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
608         void *isl_id_get_user(__isl_keep isl_id *id);
609         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
611         __isl_give isl_printer *isl_printer_print_id(
612                 __isl_take isl_printer *p, __isl_keep isl_id *id);
614 The callback set by C<isl_id_set_free_user> is called on the user
615 pointer when the last reference to the C<isl_id> is freed.
616 Note that C<isl_id_get_name> returns a pointer to some internal
617 data structure, so the result can only be used while the
618 corresponding C<isl_id> is alive.
620 =head2 Spaces
622 Whenever a new set, relation or similiar object is created from scratch,
623 the space in which it lives needs to be specified using an C<isl_space>.
624 Each space involves zero or more parameters and zero, one or two
625 tuples of set or input/output dimensions.  The parameters and dimensions
626 are identified by an C<isl_dim_type> and a position.
627 The type C<isl_dim_param> refers to parameters,
628 the type C<isl_dim_set> refers to set dimensions (for spaces
629 with a single tuple of dimensions) and the types C<isl_dim_in>
630 and C<isl_dim_out> refer to input and output dimensions
631 (for spaces with two tuples of dimensions).
632 Local spaces (see L</"Local Spaces">) also contain dimensions
633 of type C<isl_dim_div>.
634 Note that parameters are only identified by their position within
635 a given object.  Across different objects, parameters are (usually)
636 identified by their names or identifiers.  Only unnamed parameters
637 are identified by their positions across objects.  The use of unnamed
638 parameters is discouraged.
640         #include <isl/space.h>
641         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
642                 unsigned nparam, unsigned n_in, unsigned n_out);
643         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
644                 unsigned nparam);
645         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
646                 unsigned nparam, unsigned dim);
647         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
648         void *isl_space_free(__isl_take isl_space *space);
649         unsigned isl_space_dim(__isl_keep isl_space *space,
650                 enum isl_dim_type type);
652 The space used for creating a parameter domain
653 needs to be created using C<isl_space_params_alloc>.
654 For other sets, the space
655 needs to be created using C<isl_space_set_alloc>, while
656 for a relation, the space
657 needs to be created using C<isl_space_alloc>.
658 C<isl_space_dim> can be used
659 to find out the number of dimensions of each type in
660 a space, where type may be
661 C<isl_dim_param>, C<isl_dim_in> (only for relations),
662 C<isl_dim_out> (only for relations), C<isl_dim_set>
663 (only for sets) or C<isl_dim_all>.
665 To check whether a given space is that of a set or a map
666 or whether it is a parameter space, use these functions:
668         #include <isl/space.h>
669         int isl_space_is_params(__isl_keep isl_space *space);
670         int isl_space_is_set(__isl_keep isl_space *space);
671         int isl_space_is_map(__isl_keep isl_space *space);
673 Spaces can be compared using the following functions:
675         #include <isl/space.h>
676         int isl_space_is_equal(__isl_keep isl_space *space1,
677                 __isl_keep isl_space *space2);
678         int isl_space_is_domain(__isl_keep isl_space *space1,
679                 __isl_keep isl_space *space2);
680         int isl_space_is_range(__isl_keep isl_space *space1,
681                 __isl_keep isl_space *space2);
683 C<isl_space_is_domain> checks whether the first argument is equal
684 to the domain of the second argument.  This requires in particular that
685 the first argument is a set space and that the second argument
686 is a map space.
688 It is often useful to create objects that live in the
689 same space as some other object.  This can be accomplished
690 by creating the new objects
691 (see L<Creating New Sets and Relations> or
692 L<Creating New (Piecewise) Quasipolynomials>) based on the space
693 of the original object.
695         #include <isl/set.h>
696         __isl_give isl_space *isl_basic_set_get_space(
697                 __isl_keep isl_basic_set *bset);
698         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
700         #include <isl/union_set.h>
701         __isl_give isl_space *isl_union_set_get_space(
702                 __isl_keep isl_union_set *uset);
704         #include <isl/map.h>
705         __isl_give isl_space *isl_basic_map_get_space(
706                 __isl_keep isl_basic_map *bmap);
707         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
709         #include <isl/union_map.h>
710         __isl_give isl_space *isl_union_map_get_space(
711                 __isl_keep isl_union_map *umap);
713         #include <isl/constraint.h>
714         __isl_give isl_space *isl_constraint_get_space(
715                 __isl_keep isl_constraint *constraint);
717         #include <isl/polynomial.h>
718         __isl_give isl_space *isl_qpolynomial_get_domain_space(
719                 __isl_keep isl_qpolynomial *qp);
720         __isl_give isl_space *isl_qpolynomial_get_space(
721                 __isl_keep isl_qpolynomial *qp);
722         __isl_give isl_space *isl_qpolynomial_fold_get_space(
723                 __isl_keep isl_qpolynomial_fold *fold);
724         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
725                 __isl_keep isl_pw_qpolynomial *pwqp);
726         __isl_give isl_space *isl_pw_qpolynomial_get_space(
727                 __isl_keep isl_pw_qpolynomial *pwqp);
728         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
729                 __isl_keep isl_pw_qpolynomial_fold *pwf);
730         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
731                 __isl_keep isl_pw_qpolynomial_fold *pwf);
732         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
733                 __isl_keep isl_union_pw_qpolynomial *upwqp);
734         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
735                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
737         #include <isl/aff.h>
738         __isl_give isl_space *isl_aff_get_domain_space(
739                 __isl_keep isl_aff *aff);
740         __isl_give isl_space *isl_aff_get_space(
741                 __isl_keep isl_aff *aff);
742         __isl_give isl_space *isl_pw_aff_get_domain_space(
743                 __isl_keep isl_pw_aff *pwaff);
744         __isl_give isl_space *isl_pw_aff_get_space(
745                 __isl_keep isl_pw_aff *pwaff);
746         __isl_give isl_space *isl_multi_aff_get_domain_space(
747                 __isl_keep isl_multi_aff *maff);
748         __isl_give isl_space *isl_multi_aff_get_space(
749                 __isl_keep isl_multi_aff *maff);
750         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
751                 __isl_keep isl_pw_multi_aff *pma);
752         __isl_give isl_space *isl_pw_multi_aff_get_space(
753                 __isl_keep isl_pw_multi_aff *pma);
754         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
755                 __isl_keep isl_union_pw_multi_aff *upma);
756         __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
757                 __isl_keep isl_multi_pw_aff *mpa);
758         __isl_give isl_space *isl_multi_pw_aff_get_space(
759                 __isl_keep isl_multi_pw_aff *mpa);
761         #include <isl/point.h>
762         __isl_give isl_space *isl_point_get_space(
763                 __isl_keep isl_point *pnt);
765 The identifiers or names of the individual dimensions may be set or read off
766 using the following functions.
768         #include <isl/space.h>
769         __isl_give isl_space *isl_space_set_dim_id(
770                 __isl_take isl_space *space,
771                 enum isl_dim_type type, unsigned pos,
772                 __isl_take isl_id *id);
773         int isl_space_has_dim_id(__isl_keep isl_space *space,
774                 enum isl_dim_type type, unsigned pos);
775         __isl_give isl_id *isl_space_get_dim_id(
776                 __isl_keep isl_space *space,
777                 enum isl_dim_type type, unsigned pos);
778         __isl_give isl_space *isl_space_set_dim_name(
779                 __isl_take isl_space *space,
780                  enum isl_dim_type type, unsigned pos,
781                  __isl_keep const char *name);
782         int isl_space_has_dim_name(__isl_keep isl_space *space,
783                 enum isl_dim_type type, unsigned pos);
784         __isl_keep const char *isl_space_get_dim_name(
785                 __isl_keep isl_space *space,
786                 enum isl_dim_type type, unsigned pos);
788 Note that C<isl_space_get_name> returns a pointer to some internal
789 data structure, so the result can only be used while the
790 corresponding C<isl_space> is alive.
791 Also note that every function that operates on two sets or relations
792 requires that both arguments have the same parameters.  This also
793 means that if one of the arguments has named parameters, then the
794 other needs to have named parameters too and the names need to match.
795 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
796 arguments may have different parameters (as long as they are named),
797 in which case the result will have as parameters the union of the parameters of
798 the arguments.
800 Given the identifier or name of a dimension (typically a parameter),
801 its position can be obtained from the following function.
803         #include <isl/space.h>
804         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
805                 enum isl_dim_type type, __isl_keep isl_id *id);
806         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
807                 enum isl_dim_type type, const char *name);
809 The identifiers or names of entire spaces may be set or read off
810 using the following functions.
812         #include <isl/space.h>
813         __isl_give isl_space *isl_space_set_tuple_id(
814                 __isl_take isl_space *space,
815                 enum isl_dim_type type, __isl_take isl_id *id);
816         __isl_give isl_space *isl_space_reset_tuple_id(
817                 __isl_take isl_space *space, enum isl_dim_type type);
818         int isl_space_has_tuple_id(__isl_keep isl_space *space,
819                 enum isl_dim_type type);
820         __isl_give isl_id *isl_space_get_tuple_id(
821                 __isl_keep isl_space *space, enum isl_dim_type type);
822         __isl_give isl_space *isl_space_set_tuple_name(
823                 __isl_take isl_space *space,
824                 enum isl_dim_type type, const char *s);
825         int isl_space_has_tuple_name(__isl_keep isl_space *space,
826                 enum isl_dim_type type);
827         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
828                 enum isl_dim_type type);
830 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
831 or C<isl_dim_set>.  As with C<isl_space_get_name>,
832 the C<isl_space_get_tuple_name> function returns a pointer to some internal
833 data structure.
834 Binary operations require the corresponding spaces of their arguments
835 to have the same name.
837 Spaces can be nested.  In particular, the domain of a set or
838 the domain or range of a relation can be a nested relation.
839 The following functions can be used to construct and deconstruct
840 such nested spaces.
842         #include <isl/space.h>
843         int isl_space_is_wrapping(__isl_keep isl_space *space);
844         __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
845         __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
847 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
848 be the space of a set, while that of
849 C<isl_space_wrap> should be the space of a relation.
850 Conversely, the output of C<isl_space_unwrap> is the space
851 of a relation, while that of C<isl_space_wrap> is the space of a set.
853 Spaces can be created from other spaces
854 using the following functions.
856         __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
857         __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
858         __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
859         __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
860         __isl_give isl_space *isl_space_params(
861                 __isl_take isl_space *space);
862         __isl_give isl_space *isl_space_set_from_params(
863                 __isl_take isl_space *space);
864         __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
865         __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
866                 __isl_take isl_space *right);
867         __isl_give isl_space *isl_space_align_params(
868                 __isl_take isl_space *space1, __isl_take isl_space *space2)
869         __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
870                 enum isl_dim_type type, unsigned pos, unsigned n);
871         __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
872                 enum isl_dim_type type, unsigned n);
873         __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
874                 enum isl_dim_type type, unsigned first, unsigned n);
875         __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
876                 enum isl_dim_type dst_type, unsigned dst_pos,
877                 enum isl_dim_type src_type, unsigned src_pos,
878                 unsigned n);
879         __isl_give isl_space *isl_space_map_from_set(
880                 __isl_take isl_space *space);
881         __isl_give isl_space *isl_space_map_from_domain_and_range(
882                 __isl_take isl_space *domain,
883                 __isl_take isl_space *range);
884         __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
885         __isl_give isl_space *isl_space_curry(
886                 __isl_take isl_space *space);
887         __isl_give isl_space *isl_space_uncurry(
888                 __isl_take isl_space *space);
890 Note that if dimensions are added or removed from a space, then
891 the name and the internal structure are lost.
893 =head2 Local Spaces
895 A local space is essentially a space with
896 zero or more existentially quantified variables.
897 The local space of a (constraint of a) basic set or relation can be obtained
898 using the following functions.
900         #include <isl/constraint.h>
901         __isl_give isl_local_space *isl_constraint_get_local_space(
902                 __isl_keep isl_constraint *constraint);
904         #include <isl/set.h>
905         __isl_give isl_local_space *isl_basic_set_get_local_space(
906                 __isl_keep isl_basic_set *bset);
908         #include <isl/map.h>
909         __isl_give isl_local_space *isl_basic_map_get_local_space(
910                 __isl_keep isl_basic_map *bmap);
912 A new local space can be created from a space using
914         #include <isl/local_space.h>
915         __isl_give isl_local_space *isl_local_space_from_space(
916                 __isl_take isl_space *space);
918 They can be inspected, modified, copied and freed using the following functions.
920         #include <isl/local_space.h>
921         isl_ctx *isl_local_space_get_ctx(
922                 __isl_keep isl_local_space *ls);
923         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
924         int isl_local_space_dim(__isl_keep isl_local_space *ls,
925                 enum isl_dim_type type);
926         int isl_local_space_has_dim_id(
927                 __isl_keep isl_local_space *ls,
928                 enum isl_dim_type type, unsigned pos);
929         __isl_give isl_id *isl_local_space_get_dim_id(
930                 __isl_keep isl_local_space *ls,
931                 enum isl_dim_type type, unsigned pos);
932         int isl_local_space_has_dim_name(
933                 __isl_keep isl_local_space *ls,
934                 enum isl_dim_type type, unsigned pos)
935         const char *isl_local_space_get_dim_name(
936                 __isl_keep isl_local_space *ls,
937                 enum isl_dim_type type, unsigned pos);
938         __isl_give isl_local_space *isl_local_space_set_dim_name(
939                 __isl_take isl_local_space *ls,
940                 enum isl_dim_type type, unsigned pos, const char *s);
941         __isl_give isl_local_space *isl_local_space_set_dim_id(
942                 __isl_take isl_local_space *ls,
943                 enum isl_dim_type type, unsigned pos,
944                 __isl_take isl_id *id);
945         __isl_give isl_space *isl_local_space_get_space(
946                 __isl_keep isl_local_space *ls);
947         __isl_give isl_aff *isl_local_space_get_div(
948                 __isl_keep isl_local_space *ls, int pos);
949         __isl_give isl_local_space *isl_local_space_copy(
950                 __isl_keep isl_local_space *ls);
951         void *isl_local_space_free(__isl_take isl_local_space *ls);
953 Note that C<isl_local_space_get_div> can only be used on local spaces
954 of sets.
956 Two local spaces can be compared using
958         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
959                 __isl_keep isl_local_space *ls2);
961 Local spaces can be created from other local spaces
962 using the following functions.
964         __isl_give isl_local_space *isl_local_space_domain(
965                 __isl_take isl_local_space *ls);
966         __isl_give isl_local_space *isl_local_space_range(
967                 __isl_take isl_local_space *ls);
968         __isl_give isl_local_space *isl_local_space_from_domain(
969                 __isl_take isl_local_space *ls);
970         __isl_give isl_local_space *isl_local_space_intersect(
971                 __isl_take isl_local_space *ls1,
972                 __isl_take isl_local_space *ls2);
973         __isl_give isl_local_space *isl_local_space_add_dims(
974                 __isl_take isl_local_space *ls,
975                 enum isl_dim_type type, unsigned n);
976         __isl_give isl_local_space *isl_local_space_insert_dims(
977                 __isl_take isl_local_space *ls,
978                 enum isl_dim_type type, unsigned first, unsigned n);
979         __isl_give isl_local_space *isl_local_space_drop_dims(
980                 __isl_take isl_local_space *ls,
981                 enum isl_dim_type type, unsigned first, unsigned n);
983 =head2 Input and Output
985 C<isl> supports its own input/output format, which is similar
986 to the C<Omega> format, but also supports the C<PolyLib> format
987 in some cases.
989 =head3 C<isl> format
991 The C<isl> format is similar to that of C<Omega>, but has a different
992 syntax for describing the parameters and allows for the definition
993 of an existentially quantified variable as the integer division
994 of an affine expression.
995 For example, the set of integers C<i> between C<0> and C<n>
996 such that C<i % 10 <= 6> can be described as
998         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
999                                 i - 10 a <= 6) }
1001 A set or relation can have several disjuncts, separated
1002 by the keyword C<or>.  Each disjunct is either a conjunction
1003 of constraints or a projection (C<exists>) of a conjunction
1004 of constraints.  The constraints are separated by the keyword
1005 C<and>.
1007 =head3 C<PolyLib> format
1009 If the represented set is a union, then the first line
1010 contains a single number representing the number of disjuncts.
1011 Otherwise, a line containing the number C<1> is optional.
1013 Each disjunct is represented by a matrix of constraints.
1014 The first line contains two numbers representing
1015 the number of rows and columns,
1016 where the number of rows is equal to the number of constraints
1017 and the number of columns is equal to two plus the number of variables.
1018 The following lines contain the actual rows of the constraint matrix.
1019 In each row, the first column indicates whether the constraint
1020 is an equality (C<0>) or inequality (C<1>).  The final column
1021 corresponds to the constant term.
1023 If the set is parametric, then the coefficients of the parameters
1024 appear in the last columns before the constant column.
1025 The coefficients of any existentially quantified variables appear
1026 between those of the set variables and those of the parameters.
1028 =head3 Extended C<PolyLib> format
1030 The extended C<PolyLib> format is nearly identical to the
1031 C<PolyLib> format.  The only difference is that the line
1032 containing the number of rows and columns of a constraint matrix
1033 also contains four additional numbers:
1034 the number of output dimensions, the number of input dimensions,
1035 the number of local dimensions (i.e., the number of existentially
1036 quantified variables) and the number of parameters.
1037 For sets, the number of ``output'' dimensions is equal
1038 to the number of set dimensions, while the number of ``input''
1039 dimensions is zero.
1041 =head3 Input
1043         #include <isl/set.h>
1044         __isl_give isl_basic_set *isl_basic_set_read_from_file(
1045                 isl_ctx *ctx, FILE *input);
1046         __isl_give isl_basic_set *isl_basic_set_read_from_str(
1047                 isl_ctx *ctx, const char *str);
1048         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
1049                 FILE *input);
1050         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
1051                 const char *str);
1053         #include <isl/map.h>
1054         __isl_give isl_basic_map *isl_basic_map_read_from_file(
1055                 isl_ctx *ctx, FILE *input);
1056         __isl_give isl_basic_map *isl_basic_map_read_from_str(
1057                 isl_ctx *ctx, const char *str);
1058         __isl_give isl_map *isl_map_read_from_file(
1059                 isl_ctx *ctx, FILE *input);
1060         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
1061                 const char *str);
1063         #include <isl/union_set.h>
1064         __isl_give isl_union_set *isl_union_set_read_from_file(
1065                 isl_ctx *ctx, FILE *input);
1066         __isl_give isl_union_set *isl_union_set_read_from_str(
1067                 isl_ctx *ctx, const char *str);
1069         #include <isl/union_map.h>
1070         __isl_give isl_union_map *isl_union_map_read_from_file(
1071                 isl_ctx *ctx, FILE *input);
1072         __isl_give isl_union_map *isl_union_map_read_from_str(
1073                 isl_ctx *ctx, const char *str);
1075 The input format is autodetected and may be either the C<PolyLib> format
1076 or the C<isl> format.
1078 =head3 Output
1080 Before anything can be printed, an C<isl_printer> needs to
1081 be created.
1083         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1084                 FILE *file);
1085         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1086         void *isl_printer_free(__isl_take isl_printer *printer);
1087         __isl_give char *isl_printer_get_str(
1088                 __isl_keep isl_printer *printer);
1090 The printer can be inspected using the following functions.
1092         FILE *isl_printer_get_file(
1093                 __isl_keep isl_printer *printer);
1094         int isl_printer_get_output_format(
1095                 __isl_keep isl_printer *p);
1097 The behavior of the printer can be modified in various ways
1099         __isl_give isl_printer *isl_printer_set_output_format(
1100                 __isl_take isl_printer *p, int output_format);
1101         __isl_give isl_printer *isl_printer_set_indent(
1102                 __isl_take isl_printer *p, int indent);
1103         __isl_give isl_printer *isl_printer_indent(
1104                 __isl_take isl_printer *p, int indent);
1105         __isl_give isl_printer *isl_printer_set_prefix(
1106                 __isl_take isl_printer *p, const char *prefix);
1107         __isl_give isl_printer *isl_printer_set_suffix(
1108                 __isl_take isl_printer *p, const char *suffix);
1110 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1111 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1112 and defaults to C<ISL_FORMAT_ISL>.
1113 Each line in the output is indented by C<indent> (set by
1114 C<isl_printer_set_indent>) spaces
1115 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1116 In the C<PolyLib> format output,
1117 the coefficients of the existentially quantified variables
1118 appear between those of the set variables and those
1119 of the parameters.
1120 The function C<isl_printer_indent> increases the indentation
1121 by the specified amount (which may be negative).
1123 To actually print something, use
1125         #include <isl/printer.h>
1126         __isl_give isl_printer *isl_printer_print_double(
1127                 __isl_take isl_printer *p, double d);
1129         #include <isl/set.h>
1130         __isl_give isl_printer *isl_printer_print_basic_set(
1131                 __isl_take isl_printer *printer,
1132                 __isl_keep isl_basic_set *bset);
1133         __isl_give isl_printer *isl_printer_print_set(
1134                 __isl_take isl_printer *printer,
1135                 __isl_keep isl_set *set);
1137         #include <isl/map.h>
1138         __isl_give isl_printer *isl_printer_print_basic_map(
1139                 __isl_take isl_printer *printer,
1140                 __isl_keep isl_basic_map *bmap);
1141         __isl_give isl_printer *isl_printer_print_map(
1142                 __isl_take isl_printer *printer,
1143                 __isl_keep isl_map *map);
1145         #include <isl/union_set.h>
1146         __isl_give isl_printer *isl_printer_print_union_set(
1147                 __isl_take isl_printer *p,
1148                 __isl_keep isl_union_set *uset);
1150         #include <isl/union_map.h>
1151         __isl_give isl_printer *isl_printer_print_union_map(
1152                 __isl_take isl_printer *p,
1153                 __isl_keep isl_union_map *umap);
1155 When called on a file printer, the following function flushes
1156 the file.  When called on a string printer, the buffer is cleared.
1158         __isl_give isl_printer *isl_printer_flush(
1159                 __isl_take isl_printer *p);
1161 =head2 Creating New Sets and Relations
1163 C<isl> has functions for creating some standard sets and relations.
1165 =over
1167 =item * Empty sets and relations
1169         __isl_give isl_basic_set *isl_basic_set_empty(
1170                 __isl_take isl_space *space);
1171         __isl_give isl_basic_map *isl_basic_map_empty(
1172                 __isl_take isl_space *space);
1173         __isl_give isl_set *isl_set_empty(
1174                 __isl_take isl_space *space);
1175         __isl_give isl_map *isl_map_empty(
1176                 __isl_take isl_space *space);
1177         __isl_give isl_union_set *isl_union_set_empty(
1178                 __isl_take isl_space *space);
1179         __isl_give isl_union_map *isl_union_map_empty(
1180                 __isl_take isl_space *space);
1182 For C<isl_union_set>s and C<isl_union_map>s, the space
1183 is only used to specify the parameters.
1185 =item * Universe sets and relations
1187         __isl_give isl_basic_set *isl_basic_set_universe(
1188                 __isl_take isl_space *space);
1189         __isl_give isl_basic_map *isl_basic_map_universe(
1190                 __isl_take isl_space *space);
1191         __isl_give isl_set *isl_set_universe(
1192                 __isl_take isl_space *space);
1193         __isl_give isl_map *isl_map_universe(
1194                 __isl_take isl_space *space);
1195         __isl_give isl_union_set *isl_union_set_universe(
1196                 __isl_take isl_union_set *uset);
1197         __isl_give isl_union_map *isl_union_map_universe(
1198                 __isl_take isl_union_map *umap);
1200 The sets and relations constructed by the functions above
1201 contain all integer values, while those constructed by the
1202 functions below only contain non-negative values.
1204         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1205                 __isl_take isl_space *space);
1206         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1207                 __isl_take isl_space *space);
1208         __isl_give isl_set *isl_set_nat_universe(
1209                 __isl_take isl_space *space);
1210         __isl_give isl_map *isl_map_nat_universe(
1211                 __isl_take isl_space *space);
1213 =item * Identity relations
1215         __isl_give isl_basic_map *isl_basic_map_identity(
1216                 __isl_take isl_space *space);
1217         __isl_give isl_map *isl_map_identity(
1218                 __isl_take isl_space *space);
1220 The number of input and output dimensions in C<space> needs
1221 to be the same.
1223 =item * Lexicographic order
1225         __isl_give isl_map *isl_map_lex_lt(
1226                 __isl_take isl_space *set_space);
1227         __isl_give isl_map *isl_map_lex_le(
1228                 __isl_take isl_space *set_space);
1229         __isl_give isl_map *isl_map_lex_gt(
1230                 __isl_take isl_space *set_space);
1231         __isl_give isl_map *isl_map_lex_ge(
1232                 __isl_take isl_space *set_space);
1233         __isl_give isl_map *isl_map_lex_lt_first(
1234                 __isl_take isl_space *space, unsigned n);
1235         __isl_give isl_map *isl_map_lex_le_first(
1236                 __isl_take isl_space *space, unsigned n);
1237         __isl_give isl_map *isl_map_lex_gt_first(
1238                 __isl_take isl_space *space, unsigned n);
1239         __isl_give isl_map *isl_map_lex_ge_first(
1240                 __isl_take isl_space *space, unsigned n);
1242 The first four functions take a space for a B<set>
1243 and return relations that express that the elements in the domain
1244 are lexicographically less
1245 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1246 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1247 than the elements in the range.
1248 The last four functions take a space for a map
1249 and return relations that express that the first C<n> dimensions
1250 in the domain are lexicographically less
1251 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1252 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1253 than the first C<n> dimensions in the range.
1255 =back
1257 A basic set or relation can be converted to a set or relation
1258 using the following functions.
1260         __isl_give isl_set *isl_set_from_basic_set(
1261                 __isl_take isl_basic_set *bset);
1262         __isl_give isl_map *isl_map_from_basic_map(
1263                 __isl_take isl_basic_map *bmap);
1265 Sets and relations can be converted to union sets and relations
1266 using the following functions.
1268         __isl_give isl_union_set *isl_union_set_from_basic_set(
1269                 __isl_take isl_basic_set *bset);
1270         __isl_give isl_union_map *isl_union_map_from_basic_map(
1271                 __isl_take isl_basic_map *bmap);
1272         __isl_give isl_union_set *isl_union_set_from_set(
1273                 __isl_take isl_set *set);
1274         __isl_give isl_union_map *isl_union_map_from_map(
1275                 __isl_take isl_map *map);
1277 The inverse conversions below can only be used if the input
1278 union set or relation is known to contain elements in exactly one
1279 space.
1281         __isl_give isl_set *isl_set_from_union_set(
1282                 __isl_take isl_union_set *uset);
1283         __isl_give isl_map *isl_map_from_union_map(
1284                 __isl_take isl_union_map *umap);
1286 A zero-dimensional (basic) set can be constructed on a given parameter domain
1287 using the following function.
1289         __isl_give isl_basic_set *isl_basic_set_from_params(
1290                 __isl_take isl_basic_set *bset);
1291         __isl_give isl_set *isl_set_from_params(
1292                 __isl_take isl_set *set);
1294 Sets and relations can be copied and freed again using the following
1295 functions.
1297         __isl_give isl_basic_set *isl_basic_set_copy(
1298                 __isl_keep isl_basic_set *bset);
1299         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1300         __isl_give isl_union_set *isl_union_set_copy(
1301                 __isl_keep isl_union_set *uset);
1302         __isl_give isl_basic_map *isl_basic_map_copy(
1303                 __isl_keep isl_basic_map *bmap);
1304         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1305         __isl_give isl_union_map *isl_union_map_copy(
1306                 __isl_keep isl_union_map *umap);
1307         void *isl_basic_set_free(__isl_take isl_basic_set *bset);
1308         void *isl_set_free(__isl_take isl_set *set);
1309         void *isl_union_set_free(__isl_take isl_union_set *uset);
1310         void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
1311         void *isl_map_free(__isl_take isl_map *map);
1312         void *isl_union_map_free(__isl_take isl_union_map *umap);
1314 Other sets and relations can be constructed by starting
1315 from a universe set or relation, adding equality and/or
1316 inequality constraints and then projecting out the
1317 existentially quantified variables, if any.
1318 Constraints can be constructed, manipulated and
1319 added to (or removed from) (basic) sets and relations
1320 using the following functions.
1322         #include <isl/constraint.h>
1323         __isl_give isl_constraint *isl_equality_alloc(
1324                 __isl_take isl_local_space *ls);
1325         __isl_give isl_constraint *isl_inequality_alloc(
1326                 __isl_take isl_local_space *ls);
1327         __isl_give isl_constraint *isl_constraint_set_constant(
1328                 __isl_take isl_constraint *constraint, isl_int v);
1329         __isl_give isl_constraint *isl_constraint_set_constant_si(
1330                 __isl_take isl_constraint *constraint, int v);
1331         __isl_give isl_constraint *isl_constraint_set_coefficient(
1332                 __isl_take isl_constraint *constraint,
1333                 enum isl_dim_type type, int pos, isl_int v);
1334         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1335                 __isl_take isl_constraint *constraint,
1336                 enum isl_dim_type type, int pos, int v);
1337         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1338                 __isl_take isl_basic_map *bmap,
1339                 __isl_take isl_constraint *constraint);
1340         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1341                 __isl_take isl_basic_set *bset,
1342                 __isl_take isl_constraint *constraint);
1343         __isl_give isl_map *isl_map_add_constraint(
1344                 __isl_take isl_map *map,
1345                 __isl_take isl_constraint *constraint);
1346         __isl_give isl_set *isl_set_add_constraint(
1347                 __isl_take isl_set *set,
1348                 __isl_take isl_constraint *constraint);
1349         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1350                 __isl_take isl_basic_set *bset,
1351                 __isl_take isl_constraint *constraint);
1353 For example, to create a set containing the even integers
1354 between 10 and 42, you would use the following code.
1356         isl_space *space;
1357         isl_local_space *ls;
1358         isl_constraint *c;
1359         isl_basic_set *bset;
1361         space = isl_space_set_alloc(ctx, 0, 2);
1362         bset = isl_basic_set_universe(isl_space_copy(space));
1363         ls = isl_local_space_from_space(space);
1365         c = isl_equality_alloc(isl_local_space_copy(ls));
1366         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1367         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1368         bset = isl_basic_set_add_constraint(bset, c);
1370         c = isl_inequality_alloc(isl_local_space_copy(ls));
1371         c = isl_constraint_set_constant_si(c, -10);
1372         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1373         bset = isl_basic_set_add_constraint(bset, c);
1375         c = isl_inequality_alloc(ls);
1376         c = isl_constraint_set_constant_si(c, 42);
1377         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1378         bset = isl_basic_set_add_constraint(bset, c);
1380         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1382 Or, alternatively,
1384         isl_basic_set *bset;
1385         bset = isl_basic_set_read_from_str(ctx,
1386                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1388 A basic set or relation can also be constructed from two matrices
1389 describing the equalities and the inequalities.
1391         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1392                 __isl_take isl_space *space,
1393                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1394                 enum isl_dim_type c1,
1395                 enum isl_dim_type c2, enum isl_dim_type c3,
1396                 enum isl_dim_type c4);
1397         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1398                 __isl_take isl_space *space,
1399                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1400                 enum isl_dim_type c1,
1401                 enum isl_dim_type c2, enum isl_dim_type c3,
1402                 enum isl_dim_type c4, enum isl_dim_type c5);
1404 The C<isl_dim_type> arguments indicate the order in which
1405 different kinds of variables appear in the input matrices
1406 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1407 C<isl_dim_set> and C<isl_dim_div> for sets and
1408 of C<isl_dim_cst>, C<isl_dim_param>,
1409 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1411 A (basic or union) set or relation can also be constructed from a
1412 (union) (piecewise) (multiple) affine expression
1413 or a list of affine expressions
1414 (See L<"Piecewise Quasi Affine Expressions"> and
1415 L<"Piecewise Multiple Quasi Affine Expressions">).
1417         __isl_give isl_basic_map *isl_basic_map_from_aff(
1418                 __isl_take isl_aff *aff);
1419         __isl_give isl_map *isl_map_from_aff(
1420                 __isl_take isl_aff *aff);
1421         __isl_give isl_set *isl_set_from_pw_aff(
1422                 __isl_take isl_pw_aff *pwaff);
1423         __isl_give isl_map *isl_map_from_pw_aff(
1424                 __isl_take isl_pw_aff *pwaff);
1425         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1426                 __isl_take isl_space *domain_space,
1427                 __isl_take isl_aff_list *list);
1428         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1429                 __isl_take isl_multi_aff *maff)
1430         __isl_give isl_map *isl_map_from_multi_aff(
1431                 __isl_take isl_multi_aff *maff)
1432         __isl_give isl_set *isl_set_from_pw_multi_aff(
1433                 __isl_take isl_pw_multi_aff *pma);
1434         __isl_give isl_map *isl_map_from_pw_multi_aff(
1435                 __isl_take isl_pw_multi_aff *pma);
1436         __isl_give isl_union_map *
1437         isl_union_map_from_union_pw_multi_aff(
1438                 __isl_take isl_union_pw_multi_aff *upma);
1440 The C<domain_dim> argument describes the domain of the resulting
1441 basic relation.  It is required because the C<list> may consist
1442 of zero affine expressions.
1444 =head2 Inspecting Sets and Relations
1446 Usually, the user should not have to care about the actual constraints
1447 of the sets and maps, but should instead apply the abstract operations
1448 explained in the following sections.
1449 Occasionally, however, it may be required to inspect the individual
1450 coefficients of the constraints.  This section explains how to do so.
1451 In these cases, it may also be useful to have C<isl> compute
1452 an explicit representation of the existentially quantified variables.
1454         __isl_give isl_set *isl_set_compute_divs(
1455                 __isl_take isl_set *set);
1456         __isl_give isl_map *isl_map_compute_divs(
1457                 __isl_take isl_map *map);
1458         __isl_give isl_union_set *isl_union_set_compute_divs(
1459                 __isl_take isl_union_set *uset);
1460         __isl_give isl_union_map *isl_union_map_compute_divs(
1461                 __isl_take isl_union_map *umap);
1463 This explicit representation defines the existentially quantified
1464 variables as integer divisions of the other variables, possibly
1465 including earlier existentially quantified variables.
1466 An explicitly represented existentially quantified variable therefore
1467 has a unique value when the values of the other variables are known.
1468 If, furthermore, the same existentials, i.e., existentials
1469 with the same explicit representations, should appear in the
1470 same order in each of the disjuncts of a set or map, then the user should call
1471 either of the following functions.
1473         __isl_give isl_set *isl_set_align_divs(
1474                 __isl_take isl_set *set);
1475         __isl_give isl_map *isl_map_align_divs(
1476                 __isl_take isl_map *map);
1478 Alternatively, the existentially quantified variables can be removed
1479 using the following functions, which compute an overapproximation.
1481         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1482                 __isl_take isl_basic_set *bset);
1483         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1484                 __isl_take isl_basic_map *bmap);
1485         __isl_give isl_set *isl_set_remove_divs(
1486                 __isl_take isl_set *set);
1487         __isl_give isl_map *isl_map_remove_divs(
1488                 __isl_take isl_map *map);
1490 It is also possible to only remove those divs that are defined
1491 in terms of a given range of dimensions or only those for which
1492 no explicit representation is known.
1494         __isl_give isl_basic_set *
1495         isl_basic_set_remove_divs_involving_dims(
1496                 __isl_take isl_basic_set *bset,
1497                 enum isl_dim_type type,
1498                 unsigned first, unsigned n);
1499         __isl_give isl_basic_map *
1500         isl_basic_map_remove_divs_involving_dims(
1501                 __isl_take isl_basic_map *bmap,
1502                 enum isl_dim_type type,
1503                 unsigned first, unsigned n);
1504         __isl_give isl_set *isl_set_remove_divs_involving_dims(
1505                 __isl_take isl_set *set, enum isl_dim_type type,
1506                 unsigned first, unsigned n);
1507         __isl_give isl_map *isl_map_remove_divs_involving_dims(
1508                 __isl_take isl_map *map, enum isl_dim_type type,
1509                 unsigned first, unsigned n);
1511         __isl_give isl_basic_set *
1512         isl_basic_set_remove_unknown_divs(
1513                 __isl_take isl_basic_set *bset);
1514         __isl_give isl_set *isl_set_remove_unknown_divs(
1515                 __isl_take isl_set *set);
1516         __isl_give isl_map *isl_map_remove_unknown_divs(
1517                 __isl_take isl_map *map);
1519 To iterate over all the sets or maps in a union set or map, use
1521         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1522                 int (*fn)(__isl_take isl_set *set, void *user),
1523                 void *user);
1524         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1525                 int (*fn)(__isl_take isl_map *map, void *user),
1526                 void *user);
1528 The number of sets or maps in a union set or map can be obtained
1529 from
1531         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1532         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1534 To extract the set or map in a given space from a union, use
1536         __isl_give isl_set *isl_union_set_extract_set(
1537                 __isl_keep isl_union_set *uset,
1538                 __isl_take isl_space *space);
1539         __isl_give isl_map *isl_union_map_extract_map(
1540                 __isl_keep isl_union_map *umap,
1541                 __isl_take isl_space *space);
1543 To iterate over all the basic sets or maps in a set or map, use
1545         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1546                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1547                 void *user);
1548         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1549                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1550                 void *user);
1552 The callback function C<fn> should return 0 if successful and
1553 -1 if an error occurs.  In the latter case, or if any other error
1554 occurs, the above functions will return -1.
1556 It should be noted that C<isl> does not guarantee that
1557 the basic sets or maps passed to C<fn> are disjoint.
1558 If this is required, then the user should call one of
1559 the following functions first.
1561         __isl_give isl_set *isl_set_make_disjoint(
1562                 __isl_take isl_set *set);
1563         __isl_give isl_map *isl_map_make_disjoint(
1564                 __isl_take isl_map *map);
1566 The number of basic sets in a set can be obtained
1567 from
1569         int isl_set_n_basic_set(__isl_keep isl_set *set);
1571 To iterate over the constraints of a basic set or map, use
1573         #include <isl/constraint.h>
1575         int isl_basic_set_n_constraint(
1576                 __isl_keep isl_basic_set *bset);
1577         int isl_basic_set_foreach_constraint(
1578                 __isl_keep isl_basic_set *bset,
1579                 int (*fn)(__isl_take isl_constraint *c, void *user),
1580                 void *user);
1581         int isl_basic_map_foreach_constraint(
1582                 __isl_keep isl_basic_map *bmap,
1583                 int (*fn)(__isl_take isl_constraint *c, void *user),
1584                 void *user);
1585         void *isl_constraint_free(__isl_take isl_constraint *c);
1587 Again, the callback function C<fn> should return 0 if successful and
1588 -1 if an error occurs.  In the latter case, or if any other error
1589 occurs, the above functions will return -1.
1590 The constraint C<c> represents either an equality or an inequality.
1591 Use the following function to find out whether a constraint
1592 represents an equality.  If not, it represents an inequality.
1594         int isl_constraint_is_equality(
1595                 __isl_keep isl_constraint *constraint);
1597 The coefficients of the constraints can be inspected using
1598 the following functions.
1600         int isl_constraint_is_lower_bound(
1601                 __isl_keep isl_constraint *constraint,
1602                 enum isl_dim_type type, unsigned pos);
1603         int isl_constraint_is_upper_bound(
1604                 __isl_keep isl_constraint *constraint,
1605                 enum isl_dim_type type, unsigned pos);
1606         void isl_constraint_get_constant(
1607                 __isl_keep isl_constraint *constraint, isl_int *v);
1608         void isl_constraint_get_coefficient(
1609                 __isl_keep isl_constraint *constraint,
1610                 enum isl_dim_type type, int pos, isl_int *v);
1611         int isl_constraint_involves_dims(
1612                 __isl_keep isl_constraint *constraint,
1613                 enum isl_dim_type type, unsigned first, unsigned n);
1615 The explicit representations of the existentially quantified
1616 variables can be inspected using the following function.
1617 Note that the user is only allowed to use this function
1618 if the inspected set or map is the result of a call
1619 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1620 The existentially quantified variable is equal to the floor
1621 of the returned affine expression.  The affine expression
1622 itself can be inspected using the functions in
1623 L<"Piecewise Quasi Affine Expressions">.
1625         __isl_give isl_aff *isl_constraint_get_div(
1626                 __isl_keep isl_constraint *constraint, int pos);
1628 To obtain the constraints of a basic set or map in matrix
1629 form, use the following functions.
1631         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1632                 __isl_keep isl_basic_set *bset,
1633                 enum isl_dim_type c1, enum isl_dim_type c2,
1634                 enum isl_dim_type c3, enum isl_dim_type c4);
1635         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1636                 __isl_keep isl_basic_set *bset,
1637                 enum isl_dim_type c1, enum isl_dim_type c2,
1638                 enum isl_dim_type c3, enum isl_dim_type c4);
1639         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1640                 __isl_keep isl_basic_map *bmap,
1641                 enum isl_dim_type c1,
1642                 enum isl_dim_type c2, enum isl_dim_type c3,
1643                 enum isl_dim_type c4, enum isl_dim_type c5);
1644         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1645                 __isl_keep isl_basic_map *bmap,
1646                 enum isl_dim_type c1,
1647                 enum isl_dim_type c2, enum isl_dim_type c3,
1648                 enum isl_dim_type c4, enum isl_dim_type c5);
1650 The C<isl_dim_type> arguments dictate the order in which
1651 different kinds of variables appear in the resulting matrix
1652 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1653 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1655 The number of parameters, input, output or set dimensions can
1656 be obtained using the following functions.
1658         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1659                 enum isl_dim_type type);
1660         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1661                 enum isl_dim_type type);
1662         unsigned isl_set_dim(__isl_keep isl_set *set,
1663                 enum isl_dim_type type);
1664         unsigned isl_map_dim(__isl_keep isl_map *map,
1665                 enum isl_dim_type type);
1667 To check whether the description of a set or relation depends
1668 on one or more given dimensions, it is not necessary to iterate over all
1669 constraints.  Instead the following functions can be used.
1671         int isl_basic_set_involves_dims(
1672                 __isl_keep isl_basic_set *bset,
1673                 enum isl_dim_type type, unsigned first, unsigned n);
1674         int isl_set_involves_dims(__isl_keep isl_set *set,
1675                 enum isl_dim_type type, unsigned first, unsigned n);
1676         int isl_basic_map_involves_dims(
1677                 __isl_keep isl_basic_map *bmap,
1678                 enum isl_dim_type type, unsigned first, unsigned n);
1679         int isl_map_involves_dims(__isl_keep isl_map *map,
1680                 enum isl_dim_type type, unsigned first, unsigned n);
1682 Similarly, the following functions can be used to check whether
1683 a given dimension is involved in any lower or upper bound.
1685         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1686                 enum isl_dim_type type, unsigned pos);
1687         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1688                 enum isl_dim_type type, unsigned pos);
1690 Note that these functions return true even if there is a bound on
1691 the dimension on only some of the basic sets of C<set>.
1692 To check if they have a bound for all of the basic sets in C<set>,
1693 use the following functions instead.
1695         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1696                 enum isl_dim_type type, unsigned pos);
1697         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1698                 enum isl_dim_type type, unsigned pos);
1700 The identifiers or names of the domain and range spaces of a set
1701 or relation can be read off or set using the following functions.
1703         __isl_give isl_set *isl_set_set_tuple_id(
1704                 __isl_take isl_set *set, __isl_take isl_id *id);
1705         __isl_give isl_set *isl_set_reset_tuple_id(
1706                 __isl_take isl_set *set);
1707         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1708         __isl_give isl_id *isl_set_get_tuple_id(
1709                 __isl_keep isl_set *set);
1710         __isl_give isl_map *isl_map_set_tuple_id(
1711                 __isl_take isl_map *map, enum isl_dim_type type,
1712                 __isl_take isl_id *id);
1713         __isl_give isl_map *isl_map_reset_tuple_id(
1714                 __isl_take isl_map *map, enum isl_dim_type type);
1715         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1716                 enum isl_dim_type type);
1717         __isl_give isl_id *isl_map_get_tuple_id(
1718                 __isl_keep isl_map *map, enum isl_dim_type type);
1720         const char *isl_basic_set_get_tuple_name(
1721                 __isl_keep isl_basic_set *bset);
1722         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1723                 __isl_take isl_basic_set *set, const char *s);
1724         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1725         const char *isl_set_get_tuple_name(
1726                 __isl_keep isl_set *set);
1727         const char *isl_basic_map_get_tuple_name(
1728                 __isl_keep isl_basic_map *bmap,
1729                 enum isl_dim_type type);
1730         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1731                 __isl_take isl_basic_map *bmap,
1732                 enum isl_dim_type type, const char *s);
1733         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1734                 enum isl_dim_type type);
1735         const char *isl_map_get_tuple_name(
1736                 __isl_keep isl_map *map,
1737                 enum isl_dim_type type);
1739 As with C<isl_space_get_tuple_name>, the value returned points to
1740 an internal data structure.
1741 The identifiers, positions or names of individual dimensions can be
1742 read off using the following functions.
1744         __isl_give isl_id *isl_basic_set_get_dim_id(
1745                 __isl_keep isl_basic_set *bset,
1746                 enum isl_dim_type type, unsigned pos);
1747         __isl_give isl_set *isl_set_set_dim_id(
1748                 __isl_take isl_set *set, enum isl_dim_type type,
1749                 unsigned pos, __isl_take isl_id *id);
1750         int isl_set_has_dim_id(__isl_keep isl_set *set,
1751                 enum isl_dim_type type, unsigned pos);
1752         __isl_give isl_id *isl_set_get_dim_id(
1753                 __isl_keep isl_set *set, enum isl_dim_type type,
1754                 unsigned pos);
1755         int isl_basic_map_has_dim_id(
1756                 __isl_keep isl_basic_map *bmap,
1757                 enum isl_dim_type type, unsigned pos);
1758         __isl_give isl_map *isl_map_set_dim_id(
1759                 __isl_take isl_map *map, enum isl_dim_type type,
1760                 unsigned pos, __isl_take isl_id *id);
1761         int isl_map_has_dim_id(__isl_keep isl_map *map,
1762                 enum isl_dim_type type, unsigned pos);
1763         __isl_give isl_id *isl_map_get_dim_id(
1764                 __isl_keep isl_map *map, enum isl_dim_type type,
1765                 unsigned pos);
1767         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1768                 enum isl_dim_type type, __isl_keep isl_id *id);
1769         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1770                 enum isl_dim_type type, __isl_keep isl_id *id);
1771         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1772                 enum isl_dim_type type, const char *name);
1773         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1774                 enum isl_dim_type type, const char *name);
1776         const char *isl_constraint_get_dim_name(
1777                 __isl_keep isl_constraint *constraint,
1778                 enum isl_dim_type type, unsigned pos);
1779         const char *isl_basic_set_get_dim_name(
1780                 __isl_keep isl_basic_set *bset,
1781                 enum isl_dim_type type, unsigned pos);
1782         int isl_set_has_dim_name(__isl_keep isl_set *set,
1783                 enum isl_dim_type type, unsigned pos);
1784         const char *isl_set_get_dim_name(
1785                 __isl_keep isl_set *set,
1786                 enum isl_dim_type type, unsigned pos);
1787         const char *isl_basic_map_get_dim_name(
1788                 __isl_keep isl_basic_map *bmap,
1789                 enum isl_dim_type type, unsigned pos);
1790         int isl_map_has_dim_name(__isl_keep isl_map *map,
1791                 enum isl_dim_type type, unsigned pos);
1792         const char *isl_map_get_dim_name(
1793                 __isl_keep isl_map *map,
1794                 enum isl_dim_type type, unsigned pos);
1796 These functions are mostly useful to obtain the identifiers, positions
1797 or names of the parameters.  Identifiers of individual dimensions are
1798 essentially only useful for printing.  They are ignored by all other
1799 operations and may not be preserved across those operations.
1801 =head2 Properties
1803 =head3 Unary Properties
1805 =over
1807 =item * Emptiness
1809 The following functions test whether the given set or relation
1810 contains any integer points.  The ``plain'' variants do not perform
1811 any computations, but simply check if the given set or relation
1812 is already known to be empty.
1814         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1815         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1816         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1817         int isl_set_is_empty(__isl_keep isl_set *set);
1818         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1819         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1820         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1821         int isl_map_plain_is_empty(__isl_keep isl_map *map);
1822         int isl_map_is_empty(__isl_keep isl_map *map);
1823         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1825 =item * Universality
1827         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1828         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1829         int isl_set_plain_is_universe(__isl_keep isl_set *set);
1831 =item * Single-valuedness
1833         int isl_basic_map_is_single_valued(
1834                 __isl_keep isl_basic_map *bmap);
1835         int isl_map_plain_is_single_valued(
1836                 __isl_keep isl_map *map);
1837         int isl_map_is_single_valued(__isl_keep isl_map *map);
1838         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1840 =item * Injectivity
1842         int isl_map_plain_is_injective(__isl_keep isl_map *map);
1843         int isl_map_is_injective(__isl_keep isl_map *map);
1844         int isl_union_map_plain_is_injective(
1845                 __isl_keep isl_union_map *umap);
1846         int isl_union_map_is_injective(
1847                 __isl_keep isl_union_map *umap);
1849 =item * Bijectivity
1851         int isl_map_is_bijective(__isl_keep isl_map *map);
1852         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1854 =item * Position
1856         int isl_basic_map_plain_is_fixed(
1857                 __isl_keep isl_basic_map *bmap,
1858                 enum isl_dim_type type, unsigned pos,
1859                 isl_int *val);
1860         int isl_set_plain_is_fixed(__isl_keep isl_set *set,
1861                 enum isl_dim_type type, unsigned pos,
1862                 isl_int *val);
1863         int isl_map_plain_is_fixed(__isl_keep isl_map *map,
1864                 enum isl_dim_type type, unsigned pos,
1865                 isl_int *val);
1867 Check if the relation obviously lies on a hyperplane where the given dimension
1868 has a fixed value and if so, return that value in C<*val>.
1870 =item * Space
1872 To check whether a set is a parameter domain, use this function:
1874         int isl_set_is_params(__isl_keep isl_set *set);
1875         int isl_union_set_is_params(
1876                 __isl_keep isl_union_set *uset);
1878 =item * Wrapping
1880 The following functions check whether the domain of the given
1881 (basic) set is a wrapped relation.
1883         int isl_basic_set_is_wrapping(
1884                 __isl_keep isl_basic_set *bset);
1885         int isl_set_is_wrapping(__isl_keep isl_set *set);
1887 =item * Internal Product
1889         int isl_basic_map_can_zip(
1890                 __isl_keep isl_basic_map *bmap);
1891         int isl_map_can_zip(__isl_keep isl_map *map);
1893 Check whether the product of domain and range of the given relation
1894 can be computed,
1895 i.e., whether both domain and range are nested relations.
1897 =item * Currying
1899         int isl_basic_map_can_curry(
1900                 __isl_keep isl_basic_map *bmap);
1901         int isl_map_can_curry(__isl_keep isl_map *map);
1903 Check whether the domain of the (basic) relation is a wrapped relation.
1905         int isl_basic_map_can_uncurry(
1906                 __isl_keep isl_basic_map *bmap);
1907         int isl_map_can_uncurry(__isl_keep isl_map *map);
1909 Check whether the range of the (basic) relation is a wrapped relation.
1911 =back
1913 =head3 Binary Properties
1915 =over
1917 =item * Equality
1919         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
1920                 __isl_keep isl_set *set2);
1921         int isl_set_is_equal(__isl_keep isl_set *set1,
1922                 __isl_keep isl_set *set2);
1923         int isl_union_set_is_equal(
1924                 __isl_keep isl_union_set *uset1,
1925                 __isl_keep isl_union_set *uset2);
1926         int isl_basic_map_is_equal(
1927                 __isl_keep isl_basic_map *bmap1,
1928                 __isl_keep isl_basic_map *bmap2);
1929         int isl_map_is_equal(__isl_keep isl_map *map1,
1930                 __isl_keep isl_map *map2);
1931         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
1932                 __isl_keep isl_map *map2);
1933         int isl_union_map_is_equal(
1934                 __isl_keep isl_union_map *umap1,
1935                 __isl_keep isl_union_map *umap2);
1937 =item * Disjointness
1939         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
1940                 __isl_keep isl_set *set2);
1941         int isl_set_is_disjoint(__isl_keep isl_set *set1,
1942                 __isl_keep isl_set *set2);
1943         int isl_map_is_disjoint(__isl_keep isl_map *map1,
1944                 __isl_keep isl_map *map2);
1946 =item * Subset
1948         int isl_basic_set_is_subset(
1949                 __isl_keep isl_basic_set *bset1,
1950                 __isl_keep isl_basic_set *bset2);
1951         int isl_set_is_subset(__isl_keep isl_set *set1,
1952                 __isl_keep isl_set *set2);
1953         int isl_set_is_strict_subset(
1954                 __isl_keep isl_set *set1,
1955                 __isl_keep isl_set *set2);
1956         int isl_union_set_is_subset(
1957                 __isl_keep isl_union_set *uset1,
1958                 __isl_keep isl_union_set *uset2);
1959         int isl_union_set_is_strict_subset(
1960                 __isl_keep isl_union_set *uset1,
1961                 __isl_keep isl_union_set *uset2);
1962         int isl_basic_map_is_subset(
1963                 __isl_keep isl_basic_map *bmap1,
1964                 __isl_keep isl_basic_map *bmap2);
1965         int isl_basic_map_is_strict_subset(
1966                 __isl_keep isl_basic_map *bmap1,
1967                 __isl_keep isl_basic_map *bmap2);
1968         int isl_map_is_subset(
1969                 __isl_keep isl_map *map1,
1970                 __isl_keep isl_map *map2);
1971         int isl_map_is_strict_subset(
1972                 __isl_keep isl_map *map1,
1973                 __isl_keep isl_map *map2);
1974         int isl_union_map_is_subset(
1975                 __isl_keep isl_union_map *umap1,
1976                 __isl_keep isl_union_map *umap2);
1977         int isl_union_map_is_strict_subset(
1978                 __isl_keep isl_union_map *umap1,
1979                 __isl_keep isl_union_map *umap2);
1981 Check whether the first argument is a (strict) subset of the
1982 second argument.
1984 =item * Order
1986         int isl_set_plain_cmp(__isl_keep isl_set *set1,
1987                 __isl_keep isl_set *set2);
1989 This function is useful for sorting C<isl_set>s.
1990 The order depends on the internal representation of the inputs.
1991 The order is fixed over different calls to the function (assuming
1992 the internal representation of the inputs has not changed), but may
1993 change over different versions of C<isl>.
1995 =back
1997 =head2 Unary Operations
1999 =over
2001 =item * Complement
2003         __isl_give isl_set *isl_set_complement(
2004                 __isl_take isl_set *set);
2005         __isl_give isl_map *isl_map_complement(
2006                 __isl_take isl_map *map);
2008 =item * Inverse map
2010         __isl_give isl_basic_map *isl_basic_map_reverse(
2011                 __isl_take isl_basic_map *bmap);
2012         __isl_give isl_map *isl_map_reverse(
2013                 __isl_take isl_map *map);
2014         __isl_give isl_union_map *isl_union_map_reverse(
2015                 __isl_take isl_union_map *umap);
2017 =item * Projection
2019         __isl_give isl_basic_set *isl_basic_set_project_out(
2020                 __isl_take isl_basic_set *bset,
2021                 enum isl_dim_type type, unsigned first, unsigned n);
2022         __isl_give isl_basic_map *isl_basic_map_project_out(
2023                 __isl_take isl_basic_map *bmap,
2024                 enum isl_dim_type type, unsigned first, unsigned n);
2025         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2026                 enum isl_dim_type type, unsigned first, unsigned n);
2027         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2028                 enum isl_dim_type type, unsigned first, unsigned n);
2029         __isl_give isl_basic_set *isl_basic_set_params(
2030                 __isl_take isl_basic_set *bset);
2031         __isl_give isl_basic_set *isl_basic_map_domain(
2032                 __isl_take isl_basic_map *bmap);
2033         __isl_give isl_basic_set *isl_basic_map_range(
2034                 __isl_take isl_basic_map *bmap);
2035         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2036         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2037         __isl_give isl_set *isl_map_domain(
2038                 __isl_take isl_map *bmap);
2039         __isl_give isl_set *isl_map_range(
2040                 __isl_take isl_map *map);
2041         __isl_give isl_set *isl_union_set_params(
2042                 __isl_take isl_union_set *uset);
2043         __isl_give isl_set *isl_union_map_params(
2044                 __isl_take isl_union_map *umap);
2045         __isl_give isl_union_set *isl_union_map_domain(
2046                 __isl_take isl_union_map *umap);
2047         __isl_give isl_union_set *isl_union_map_range(
2048                 __isl_take isl_union_map *umap);
2050         __isl_give isl_basic_map *isl_basic_map_domain_map(
2051                 __isl_take isl_basic_map *bmap);
2052         __isl_give isl_basic_map *isl_basic_map_range_map(
2053                 __isl_take isl_basic_map *bmap);
2054         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2055         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2056         __isl_give isl_union_map *isl_union_map_domain_map(
2057                 __isl_take isl_union_map *umap);
2058         __isl_give isl_union_map *isl_union_map_range_map(
2059                 __isl_take isl_union_map *umap);
2061 The functions above construct a (basic, regular or union) relation
2062 that maps (a wrapped version of) the input relation to its domain or range.
2064 =item * Elimination
2066         __isl_give isl_basic_set *isl_basic_set_eliminate(
2067                 __isl_take isl_basic_set *bset,
2068                 enum isl_dim_type type,
2069                 unsigned first, unsigned n);
2070         __isl_give isl_set *isl_set_eliminate(
2071                 __isl_take isl_set *set, enum isl_dim_type type,
2072                 unsigned first, unsigned n);
2073         __isl_give isl_basic_map *isl_basic_map_eliminate(
2074                 __isl_take isl_basic_map *bmap,
2075                 enum isl_dim_type type,
2076                 unsigned first, unsigned n);
2077         __isl_give isl_map *isl_map_eliminate(
2078                 __isl_take isl_map *map, enum isl_dim_type type,
2079                 unsigned first, unsigned n);
2081 Eliminate the coefficients for the given dimensions from the constraints,
2082 without removing the dimensions.
2084 =item * Slicing
2086         __isl_give isl_basic_set *isl_basic_set_fix(
2087                 __isl_take isl_basic_set *bset,
2088                 enum isl_dim_type type, unsigned pos,
2089                 isl_int value);
2090         __isl_give isl_basic_set *isl_basic_set_fix_si(
2091                 __isl_take isl_basic_set *bset,
2092                 enum isl_dim_type type, unsigned pos, int value);
2093         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
2094                 enum isl_dim_type type, unsigned pos,
2095                 isl_int value);
2096         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2097                 enum isl_dim_type type, unsigned pos, int value);
2098         __isl_give isl_basic_map *isl_basic_map_fix_si(
2099                 __isl_take isl_basic_map *bmap,
2100                 enum isl_dim_type type, unsigned pos, int value);
2101         __isl_give isl_map *isl_map_fix(__isl_take isl_map *map,
2102                 enum isl_dim_type type, unsigned pos,
2103                 isl_int value);
2104         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2105                 enum isl_dim_type type, unsigned pos, int value);
2107 Intersect the set or relation with the hyperplane where the given
2108 dimension has the fixed given value.
2110         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2111                 __isl_take isl_basic_map *bmap,
2112                 enum isl_dim_type type, unsigned pos, int value);
2113         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2114                 __isl_take isl_basic_map *bmap,
2115                 enum isl_dim_type type, unsigned pos, int value);
2116         __isl_give isl_set *isl_set_lower_bound(
2117                 __isl_take isl_set *set,
2118                 enum isl_dim_type type, unsigned pos,
2119                 isl_int value);
2120         __isl_give isl_set *isl_set_lower_bound_si(
2121                 __isl_take isl_set *set,
2122                 enum isl_dim_type type, unsigned pos, int value);
2123         __isl_give isl_map *isl_map_lower_bound_si(
2124                 __isl_take isl_map *map,
2125                 enum isl_dim_type type, unsigned pos, int value);
2126         __isl_give isl_set *isl_set_upper_bound(
2127                 __isl_take isl_set *set,
2128                 enum isl_dim_type type, unsigned pos,
2129                 isl_int value);
2130         __isl_give isl_set *isl_set_upper_bound_si(
2131                 __isl_take isl_set *set,
2132                 enum isl_dim_type type, unsigned pos, int value);
2133         __isl_give isl_map *isl_map_upper_bound_si(
2134                 __isl_take isl_map *map,
2135                 enum isl_dim_type type, unsigned pos, int value);
2137 Intersect the set or relation with the half-space where the given
2138 dimension has a value bounded by the fixed given value.
2140         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2141                 enum isl_dim_type type1, int pos1,
2142                 enum isl_dim_type type2, int pos2);
2143         __isl_give isl_basic_map *isl_basic_map_equate(
2144                 __isl_take isl_basic_map *bmap,
2145                 enum isl_dim_type type1, int pos1,
2146                 enum isl_dim_type type2, int pos2);
2147         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2148                 enum isl_dim_type type1, int pos1,
2149                 enum isl_dim_type type2, int pos2);
2151 Intersect the set or relation with the hyperplane where the given
2152 dimensions are equal to each other.
2154         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
2155                 enum isl_dim_type type1, int pos1,
2156                 enum isl_dim_type type2, int pos2);
2158 Intersect the relation with the hyperplane where the given
2159 dimensions have opposite values.
2161         __isl_give isl_basic_map *isl_basic_map_order_ge(
2162                 __isl_take isl_basic_map *bmap,
2163                 enum isl_dim_type type1, int pos1,
2164                 enum isl_dim_type type2, int pos2);
2165         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2166                 enum isl_dim_type type1, int pos1,
2167                 enum isl_dim_type type2, int pos2);
2168         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2169                 enum isl_dim_type type1, int pos1,
2170                 enum isl_dim_type type2, int pos2);
2172 Intersect the relation with the half-space where the given
2173 dimensions satisfy the given ordering.
2175 =item * Identity
2177         __isl_give isl_map *isl_set_identity(
2178                 __isl_take isl_set *set);
2179         __isl_give isl_union_map *isl_union_set_identity(
2180                 __isl_take isl_union_set *uset);
2182 Construct an identity relation on the given (union) set.
2184 =item * Deltas
2186         __isl_give isl_basic_set *isl_basic_map_deltas(
2187                 __isl_take isl_basic_map *bmap);
2188         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2189         __isl_give isl_union_set *isl_union_map_deltas(
2190                 __isl_take isl_union_map *umap);
2192 These functions return a (basic) set containing the differences
2193 between image elements and corresponding domain elements in the input.
2195         __isl_give isl_basic_map *isl_basic_map_deltas_map(
2196                 __isl_take isl_basic_map *bmap);
2197         __isl_give isl_map *isl_map_deltas_map(
2198                 __isl_take isl_map *map);
2199         __isl_give isl_union_map *isl_union_map_deltas_map(
2200                 __isl_take isl_union_map *umap);
2202 The functions above construct a (basic, regular or union) relation
2203 that maps (a wrapped version of) the input relation to its delta set.
2205 =item * Coalescing
2207 Simplify the representation of a set or relation by trying
2208 to combine pairs of basic sets or relations into a single
2209 basic set or relation.
2211         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2212         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2213         __isl_give isl_union_set *isl_union_set_coalesce(
2214                 __isl_take isl_union_set *uset);
2215         __isl_give isl_union_map *isl_union_map_coalesce(
2216                 __isl_take isl_union_map *umap);
2218 One of the methods for combining pairs of basic sets or relations
2219 can result in coefficients that are much larger than those that appear
2220 in the constraints of the input.  By default, the coefficients are
2221 not allowed to grow larger, but this can be changed by unsetting
2222 the following option.
2224         int isl_options_set_coalesce_bounded_wrapping(
2225                 isl_ctx *ctx, int val);
2226         int isl_options_get_coalesce_bounded_wrapping(
2227                 isl_ctx *ctx);
2229 =item * Detecting equalities
2231         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2232                 __isl_take isl_basic_set *bset);
2233         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2234                 __isl_take isl_basic_map *bmap);
2235         __isl_give isl_set *isl_set_detect_equalities(
2236                 __isl_take isl_set *set);
2237         __isl_give isl_map *isl_map_detect_equalities(
2238                 __isl_take isl_map *map);
2239         __isl_give isl_union_set *isl_union_set_detect_equalities(
2240                 __isl_take isl_union_set *uset);
2241         __isl_give isl_union_map *isl_union_map_detect_equalities(
2242                 __isl_take isl_union_map *umap);
2244 Simplify the representation of a set or relation by detecting implicit
2245 equalities.
2247 =item * Removing redundant constraints
2249         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2250                 __isl_take isl_basic_set *bset);
2251         __isl_give isl_set *isl_set_remove_redundancies(
2252                 __isl_take isl_set *set);
2253         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2254                 __isl_take isl_basic_map *bmap);
2255         __isl_give isl_map *isl_map_remove_redundancies(
2256                 __isl_take isl_map *map);
2258 =item * Convex hull
2260         __isl_give isl_basic_set *isl_set_convex_hull(
2261                 __isl_take isl_set *set);
2262         __isl_give isl_basic_map *isl_map_convex_hull(
2263                 __isl_take isl_map *map);
2265 If the input set or relation has any existentially quantified
2266 variables, then the result of these operations is currently undefined.
2268 =item * Simple hull
2270         __isl_give isl_basic_set *
2271         isl_set_unshifted_simple_hull(
2272                 __isl_take isl_set *set);
2273         __isl_give isl_basic_map *
2274         isl_map_unshifted_simple_hull(
2275                 __isl_take isl_map *map);
2276         __isl_give isl_basic_set *isl_set_simple_hull(
2277                 __isl_take isl_set *set);
2278         __isl_give isl_basic_map *isl_map_simple_hull(
2279                 __isl_take isl_map *map);
2280         __isl_give isl_union_map *isl_union_map_simple_hull(
2281                 __isl_take isl_union_map *umap);
2283 These functions compute a single basic set or relation
2284 that contains the whole input set or relation.
2285 In particular, the output is described by translates
2286 of the constraints describing the basic sets or relations in the input.
2287 In case of C<isl_set_unshifted_simple_hull>, only the original
2288 constraints are used, without any translation.
2290 =begin latex
2292 (See \autoref{s:simple hull}.)
2294 =end latex
2296 =item * Affine hull
2298         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2299                 __isl_take isl_basic_set *bset);
2300         __isl_give isl_basic_set *isl_set_affine_hull(
2301                 __isl_take isl_set *set);
2302         __isl_give isl_union_set *isl_union_set_affine_hull(
2303                 __isl_take isl_union_set *uset);
2304         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2305                 __isl_take isl_basic_map *bmap);
2306         __isl_give isl_basic_map *isl_map_affine_hull(
2307                 __isl_take isl_map *map);
2308         __isl_give isl_union_map *isl_union_map_affine_hull(
2309                 __isl_take isl_union_map *umap);
2311 In case of union sets and relations, the affine hull is computed
2312 per space.
2314 =item * Polyhedral hull
2316         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2317                 __isl_take isl_set *set);
2318         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2319                 __isl_take isl_map *map);
2320         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2321                 __isl_take isl_union_set *uset);
2322         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2323                 __isl_take isl_union_map *umap);
2325 These functions compute a single basic set or relation
2326 not involving any existentially quantified variables
2327 that contains the whole input set or relation.
2328 In case of union sets and relations, the polyhedral hull is computed
2329 per space.
2331 =item * Other approximations
2333         __isl_give isl_basic_set *
2334         isl_basic_set_drop_constraints_involving_dims(
2335                 __isl_take isl_basic_set *bset,
2336                 enum isl_dim_type type,
2337                 unsigned first, unsigned n);
2338         __isl_give isl_basic_map *
2339         isl_basic_map_drop_constraints_involving_dims(
2340                 __isl_take isl_basic_map *bmap,
2341                 enum isl_dim_type type,
2342                 unsigned first, unsigned n);
2343         __isl_give isl_basic_set *
2344         isl_basic_set_drop_constraints_not_involving_dims(
2345                 __isl_take isl_basic_set *bset,
2346                 enum isl_dim_type type,
2347                 unsigned first, unsigned n);
2348         __isl_give isl_set *
2349         isl_set_drop_constraints_involving_dims(
2350                 __isl_take isl_set *set,
2351                 enum isl_dim_type type,
2352                 unsigned first, unsigned n);
2353         __isl_give isl_map *
2354         isl_map_drop_constraints_involving_dims(
2355                 __isl_take isl_map *map,
2356                 enum isl_dim_type type,
2357                 unsigned first, unsigned n);
2359 These functions drop any constraints (not) involving the specified dimensions.
2360 Note that the result depends on the representation of the input.
2362 =item * Feasibility
2364         __isl_give isl_basic_set *isl_basic_set_sample(
2365                 __isl_take isl_basic_set *bset);
2366         __isl_give isl_basic_set *isl_set_sample(
2367                 __isl_take isl_set *set);
2368         __isl_give isl_basic_map *isl_basic_map_sample(
2369                 __isl_take isl_basic_map *bmap);
2370         __isl_give isl_basic_map *isl_map_sample(
2371                 __isl_take isl_map *map);
2373 If the input (basic) set or relation is non-empty, then return
2374 a singleton subset of the input.  Otherwise, return an empty set.
2376 =item * Optimization
2378         #include <isl/ilp.h>
2379         enum isl_lp_result isl_basic_set_max(
2380                 __isl_keep isl_basic_set *bset,
2381                 __isl_keep isl_aff *obj, isl_int *opt)
2382         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2383                 __isl_keep isl_aff *obj, isl_int *opt);
2384         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2385                 __isl_keep isl_aff *obj, isl_int *opt);
2387 Compute the minimum or maximum of the integer affine expression C<obj>
2388 over the points in C<set>, returning the result in C<opt>.
2389 The return value may be one of C<isl_lp_error>,
2390 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2392 =item * Parametric optimization
2394         __isl_give isl_pw_aff *isl_set_dim_min(
2395                 __isl_take isl_set *set, int pos);
2396         __isl_give isl_pw_aff *isl_set_dim_max(
2397                 __isl_take isl_set *set, int pos);
2398         __isl_give isl_pw_aff *isl_map_dim_max(
2399                 __isl_take isl_map *map, int pos);
2401 Compute the minimum or maximum of the given set or output dimension
2402 as a function of the parameters (and input dimensions), but independently
2403 of the other set or output dimensions.
2404 For lexicographic optimization, see L<"Lexicographic Optimization">.
2406 =item * Dual
2408 The following functions compute either the set of (rational) coefficient
2409 values of valid constraints for the given set or the set of (rational)
2410 values satisfying the constraints with coefficients from the given set.
2411 Internally, these two sets of functions perform essentially the
2412 same operations, except that the set of coefficients is assumed to
2413 be a cone, while the set of values may be any polyhedron.
2414 The current implementation is based on the Farkas lemma and
2415 Fourier-Motzkin elimination, but this may change or be made optional
2416 in future.  In particular, future implementations may use different
2417 dualization algorithms or skip the elimination step.
2419         __isl_give isl_basic_set *isl_basic_set_coefficients(
2420                 __isl_take isl_basic_set *bset);
2421         __isl_give isl_basic_set *isl_set_coefficients(
2422                 __isl_take isl_set *set);
2423         __isl_give isl_union_set *isl_union_set_coefficients(
2424                 __isl_take isl_union_set *bset);
2425         __isl_give isl_basic_set *isl_basic_set_solutions(
2426                 __isl_take isl_basic_set *bset);
2427         __isl_give isl_basic_set *isl_set_solutions(
2428                 __isl_take isl_set *set);
2429         __isl_give isl_union_set *isl_union_set_solutions(
2430                 __isl_take isl_union_set *bset);
2432 =item * Power
2434         __isl_give isl_map *isl_map_fixed_power(
2435                 __isl_take isl_map *map, isl_int exp);
2436         __isl_give isl_union_map *isl_union_map_fixed_power(
2437                 __isl_take isl_union_map *umap, isl_int exp);
2439 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2440 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2441 of C<map> is computed.
2443         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2444                 int *exact);
2445         __isl_give isl_union_map *isl_union_map_power(
2446                 __isl_take isl_union_map *umap, int *exact);
2448 Compute a parametric representation for all positive powers I<k> of C<map>.
2449 The result maps I<k> to a nested relation corresponding to the
2450 I<k>th power of C<map>.
2451 The result may be an overapproximation.  If the result is known to be exact,
2452 then C<*exact> is set to C<1>.
2454 =item * Transitive closure
2456         __isl_give isl_map *isl_map_transitive_closure(
2457                 __isl_take isl_map *map, int *exact);
2458         __isl_give isl_union_map *isl_union_map_transitive_closure(
2459                 __isl_take isl_union_map *umap, int *exact);
2461 Compute the transitive closure of C<map>.
2462 The result may be an overapproximation.  If the result is known to be exact,
2463 then C<*exact> is set to C<1>.
2465 =item * Reaching path lengths
2467         __isl_give isl_map *isl_map_reaching_path_lengths(
2468                 __isl_take isl_map *map, int *exact);
2470 Compute a relation that maps each element in the range of C<map>
2471 to the lengths of all paths composed of edges in C<map> that
2472 end up in the given element.
2473 The result may be an overapproximation.  If the result is known to be exact,
2474 then C<*exact> is set to C<1>.
2475 To compute the I<maximal> path length, the resulting relation
2476 should be postprocessed by C<isl_map_lexmax>.
2477 In particular, if the input relation is a dependence relation
2478 (mapping sources to sinks), then the maximal path length corresponds
2479 to the free schedule.
2480 Note, however, that C<isl_map_lexmax> expects the maximum to be
2481 finite, so if the path lengths are unbounded (possibly due to
2482 the overapproximation), then you will get an error message.
2484 =item * Wrapping
2486         __isl_give isl_basic_set *isl_basic_map_wrap(
2487                 __isl_take isl_basic_map *bmap);
2488         __isl_give isl_set *isl_map_wrap(
2489                 __isl_take isl_map *map);
2490         __isl_give isl_union_set *isl_union_map_wrap(
2491                 __isl_take isl_union_map *umap);
2492         __isl_give isl_basic_map *isl_basic_set_unwrap(
2493                 __isl_take isl_basic_set *bset);
2494         __isl_give isl_map *isl_set_unwrap(
2495                 __isl_take isl_set *set);
2496         __isl_give isl_union_map *isl_union_set_unwrap(
2497                 __isl_take isl_union_set *uset);
2499 =item * Flattening
2501 Remove any internal structure of domain (and range) of the given
2502 set or relation.  If there is any such internal structure in the input,
2503 then the name of the space is also removed.
2505         __isl_give isl_basic_set *isl_basic_set_flatten(
2506                 __isl_take isl_basic_set *bset);
2507         __isl_give isl_set *isl_set_flatten(
2508                 __isl_take isl_set *set);
2509         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2510                 __isl_take isl_basic_map *bmap);
2511         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2512                 __isl_take isl_basic_map *bmap);
2513         __isl_give isl_map *isl_map_flatten_range(
2514                 __isl_take isl_map *map);
2515         __isl_give isl_map *isl_map_flatten_domain(
2516                 __isl_take isl_map *map);
2517         __isl_give isl_basic_map *isl_basic_map_flatten(
2518                 __isl_take isl_basic_map *bmap);
2519         __isl_give isl_map *isl_map_flatten(
2520                 __isl_take isl_map *map);
2522         __isl_give isl_map *isl_set_flatten_map(
2523                 __isl_take isl_set *set);
2525 The function above constructs a relation
2526 that maps the input set to a flattened version of the set.
2528 =item * Lifting
2530 Lift the input set to a space with extra dimensions corresponding
2531 to the existentially quantified variables in the input.
2532 In particular, the result lives in a wrapped map where the domain
2533 is the original space and the range corresponds to the original
2534 existentially quantified variables.
2536         __isl_give isl_basic_set *isl_basic_set_lift(
2537                 __isl_take isl_basic_set *bset);
2538         __isl_give isl_set *isl_set_lift(
2539                 __isl_take isl_set *set);
2540         __isl_give isl_union_set *isl_union_set_lift(
2541                 __isl_take isl_union_set *uset);
2543 Given a local space that contains the existentially quantified
2544 variables of a set, a basic relation that, when applied to
2545 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2546 can be constructed using the following function.
2548         #include <isl/local_space.h>
2549         __isl_give isl_basic_map *isl_local_space_lifting(
2550                 __isl_take isl_local_space *ls);
2552 =item * Internal Product
2554         __isl_give isl_basic_map *isl_basic_map_zip(
2555                 __isl_take isl_basic_map *bmap);
2556         __isl_give isl_map *isl_map_zip(
2557                 __isl_take isl_map *map);
2558         __isl_give isl_union_map *isl_union_map_zip(
2559                 __isl_take isl_union_map *umap);
2561 Given a relation with nested relations for domain and range,
2562 interchange the range of the domain with the domain of the range.
2564 =item * Currying
2566         __isl_give isl_basic_map *isl_basic_map_curry(
2567                 __isl_take isl_basic_map *bmap);
2568         __isl_give isl_basic_map *isl_basic_map_uncurry(
2569                 __isl_take isl_basic_map *bmap);
2570         __isl_give isl_map *isl_map_curry(
2571                 __isl_take isl_map *map);
2572         __isl_give isl_map *isl_map_uncurry(
2573                 __isl_take isl_map *map);
2574         __isl_give isl_union_map *isl_union_map_curry(
2575                 __isl_take isl_union_map *umap);
2576         __isl_give isl_union_map *isl_union_map_uncurry(
2577                 __isl_take isl_union_map *umap);
2579 Given a relation with a nested relation for domain,
2580 the C<curry> functions
2581 move the range of the nested relation out of the domain
2582 and use it as the domain of a nested relation in the range,
2583 with the original range as range of this nested relation.
2584 The C<uncurry> functions perform the inverse operation.
2586 =item * Aligning parameters
2588         __isl_give isl_basic_set *isl_basic_set_align_params(
2589                 __isl_take isl_basic_set *bset,
2590                 __isl_take isl_space *model);
2591         __isl_give isl_set *isl_set_align_params(
2592                 __isl_take isl_set *set,
2593                 __isl_take isl_space *model);
2594         __isl_give isl_basic_map *isl_basic_map_align_params(
2595                 __isl_take isl_basic_map *bmap,
2596                 __isl_take isl_space *model);
2597         __isl_give isl_map *isl_map_align_params(
2598                 __isl_take isl_map *map,
2599                 __isl_take isl_space *model);
2601 Change the order of the parameters of the given set or relation
2602 such that the first parameters match those of C<model>.
2603 This may involve the introduction of extra parameters.
2604 All parameters need to be named.
2606 =item * Dimension manipulation
2608         __isl_give isl_basic_set *isl_basic_set_add_dims(
2609                 __isl_take isl_basic_set *bset,
2610                 enum isl_dim_type type, unsigned n);
2611         __isl_give isl_set *isl_set_add_dims(
2612                 __isl_take isl_set *set,
2613                 enum isl_dim_type type, unsigned n);
2614         __isl_give isl_map *isl_map_add_dims(
2615                 __isl_take isl_map *map,
2616                 enum isl_dim_type type, unsigned n);
2617         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2618                 __isl_take isl_basic_set *bset,
2619                 enum isl_dim_type type, unsigned pos,
2620                 unsigned n);
2621         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2622                 __isl_take isl_basic_map *bmap,
2623                 enum isl_dim_type type, unsigned pos,
2624                 unsigned n);
2625         __isl_give isl_set *isl_set_insert_dims(
2626                 __isl_take isl_set *set,
2627                 enum isl_dim_type type, unsigned pos, unsigned n);
2628         __isl_give isl_map *isl_map_insert_dims(
2629                 __isl_take isl_map *map,
2630                 enum isl_dim_type type, unsigned pos, unsigned n);
2631         __isl_give isl_basic_set *isl_basic_set_move_dims(
2632                 __isl_take isl_basic_set *bset,
2633                 enum isl_dim_type dst_type, unsigned dst_pos,
2634                 enum isl_dim_type src_type, unsigned src_pos,
2635                 unsigned n);
2636         __isl_give isl_basic_map *isl_basic_map_move_dims(
2637                 __isl_take isl_basic_map *bmap,
2638                 enum isl_dim_type dst_type, unsigned dst_pos,
2639                 enum isl_dim_type src_type, unsigned src_pos,
2640                 unsigned n);
2641         __isl_give isl_set *isl_set_move_dims(
2642                 __isl_take isl_set *set,
2643                 enum isl_dim_type dst_type, unsigned dst_pos,
2644                 enum isl_dim_type src_type, unsigned src_pos,
2645                 unsigned n);
2646         __isl_give isl_map *isl_map_move_dims(
2647                 __isl_take isl_map *map,
2648                 enum isl_dim_type dst_type, unsigned dst_pos,
2649                 enum isl_dim_type src_type, unsigned src_pos,
2650                 unsigned n);
2652 It is usually not advisable to directly change the (input or output)
2653 space of a set or a relation as this removes the name and the internal
2654 structure of the space.  However, the above functions can be useful
2655 to add new parameters, assuming
2656 C<isl_set_align_params> and C<isl_map_align_params>
2657 are not sufficient.
2659 =back
2661 =head2 Binary Operations
2663 The two arguments of a binary operation not only need to live
2664 in the same C<isl_ctx>, they currently also need to have
2665 the same (number of) parameters.
2667 =head3 Basic Operations
2669 =over
2671 =item * Intersection
2673         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2674                 __isl_take isl_basic_set *bset1,
2675                 __isl_take isl_basic_set *bset2);
2676         __isl_give isl_basic_set *isl_basic_set_intersect(
2677                 __isl_take isl_basic_set *bset1,
2678                 __isl_take isl_basic_set *bset2);
2679         __isl_give isl_set *isl_set_intersect_params(
2680                 __isl_take isl_set *set,
2681                 __isl_take isl_set *params);
2682         __isl_give isl_set *isl_set_intersect(
2683                 __isl_take isl_set *set1,
2684                 __isl_take isl_set *set2);
2685         __isl_give isl_union_set *isl_union_set_intersect_params(
2686                 __isl_take isl_union_set *uset,
2687                 __isl_take isl_set *set);
2688         __isl_give isl_union_map *isl_union_map_intersect_params(
2689                 __isl_take isl_union_map *umap,
2690                 __isl_take isl_set *set);
2691         __isl_give isl_union_set *isl_union_set_intersect(
2692                 __isl_take isl_union_set *uset1,
2693                 __isl_take isl_union_set *uset2);
2694         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2695                 __isl_take isl_basic_map *bmap,
2696                 __isl_take isl_basic_set *bset);
2697         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2698                 __isl_take isl_basic_map *bmap,
2699                 __isl_take isl_basic_set *bset);
2700         __isl_give isl_basic_map *isl_basic_map_intersect(
2701                 __isl_take isl_basic_map *bmap1,
2702                 __isl_take isl_basic_map *bmap2);
2703         __isl_give isl_map *isl_map_intersect_params(
2704                 __isl_take isl_map *map,
2705                 __isl_take isl_set *params);
2706         __isl_give isl_map *isl_map_intersect_domain(
2707                 __isl_take isl_map *map,
2708                 __isl_take isl_set *set);
2709         __isl_give isl_map *isl_map_intersect_range(
2710                 __isl_take isl_map *map,
2711                 __isl_take isl_set *set);
2712         __isl_give isl_map *isl_map_intersect(
2713                 __isl_take isl_map *map1,
2714                 __isl_take isl_map *map2);
2715         __isl_give isl_union_map *isl_union_map_intersect_domain(
2716                 __isl_take isl_union_map *umap,
2717                 __isl_take isl_union_set *uset);
2718         __isl_give isl_union_map *isl_union_map_intersect_range(
2719                 __isl_take isl_union_map *umap,
2720                 __isl_take isl_union_set *uset);
2721         __isl_give isl_union_map *isl_union_map_intersect(
2722                 __isl_take isl_union_map *umap1,
2723                 __isl_take isl_union_map *umap2);
2725 The second argument to the C<_params> functions needs to be
2726 a parametric (basic) set.  For the other functions, a parametric set
2727 for either argument is only allowed if the other argument is
2728 a parametric set as well.
2730 =item * Union
2732         __isl_give isl_set *isl_basic_set_union(
2733                 __isl_take isl_basic_set *bset1,
2734                 __isl_take isl_basic_set *bset2);
2735         __isl_give isl_map *isl_basic_map_union(
2736                 __isl_take isl_basic_map *bmap1,
2737                 __isl_take isl_basic_map *bmap2);
2738         __isl_give isl_set *isl_set_union(
2739                 __isl_take isl_set *set1,
2740                 __isl_take isl_set *set2);
2741         __isl_give isl_map *isl_map_union(
2742                 __isl_take isl_map *map1,
2743                 __isl_take isl_map *map2);
2744         __isl_give isl_union_set *isl_union_set_union(
2745                 __isl_take isl_union_set *uset1,
2746                 __isl_take isl_union_set *uset2);
2747         __isl_give isl_union_map *isl_union_map_union(
2748                 __isl_take isl_union_map *umap1,
2749                 __isl_take isl_union_map *umap2);
2751 =item * Set difference
2753         __isl_give isl_set *isl_set_subtract(
2754                 __isl_take isl_set *set1,
2755                 __isl_take isl_set *set2);
2756         __isl_give isl_map *isl_map_subtract(
2757                 __isl_take isl_map *map1,
2758                 __isl_take isl_map *map2);
2759         __isl_give isl_map *isl_map_subtract_domain(
2760                 __isl_take isl_map *map,
2761                 __isl_take isl_set *dom);
2762         __isl_give isl_map *isl_map_subtract_range(
2763                 __isl_take isl_map *map,
2764                 __isl_take isl_set *dom);
2765         __isl_give isl_union_set *isl_union_set_subtract(
2766                 __isl_take isl_union_set *uset1,
2767                 __isl_take isl_union_set *uset2);
2768         __isl_give isl_union_map *isl_union_map_subtract(
2769                 __isl_take isl_union_map *umap1,
2770                 __isl_take isl_union_map *umap2);
2771         __isl_give isl_union_map *isl_union_map_subtract_domain(
2772                 __isl_take isl_union_map *umap,
2773                 __isl_take isl_union_set *dom);
2774         __isl_give isl_union_map *isl_union_map_subtract_range(
2775                 __isl_take isl_union_map *umap,
2776                 __isl_take isl_union_set *dom);
2778 =item * Application
2780         __isl_give isl_basic_set *isl_basic_set_apply(
2781                 __isl_take isl_basic_set *bset,
2782                 __isl_take isl_basic_map *bmap);
2783         __isl_give isl_set *isl_set_apply(
2784                 __isl_take isl_set *set,
2785                 __isl_take isl_map *map);
2786         __isl_give isl_union_set *isl_union_set_apply(
2787                 __isl_take isl_union_set *uset,
2788                 __isl_take isl_union_map *umap);
2789         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2790                 __isl_take isl_basic_map *bmap1,
2791                 __isl_take isl_basic_map *bmap2);
2792         __isl_give isl_basic_map *isl_basic_map_apply_range(
2793                 __isl_take isl_basic_map *bmap1,
2794                 __isl_take isl_basic_map *bmap2);
2795         __isl_give isl_map *isl_map_apply_domain(
2796                 __isl_take isl_map *map1,
2797                 __isl_take isl_map *map2);
2798         __isl_give isl_union_map *isl_union_map_apply_domain(
2799                 __isl_take isl_union_map *umap1,
2800                 __isl_take isl_union_map *umap2);
2801         __isl_give isl_map *isl_map_apply_range(
2802                 __isl_take isl_map *map1,
2803                 __isl_take isl_map *map2);
2804         __isl_give isl_union_map *isl_union_map_apply_range(
2805                 __isl_take isl_union_map *umap1,
2806                 __isl_take isl_union_map *umap2);
2808 =item * Preimage
2810         __isl_give isl_basic_set *
2811         isl_basic_set_preimage_multi_aff(
2812                 __isl_take isl_basic_set *bset,
2813                 __isl_take isl_multi_aff *ma);
2814         __isl_give isl_set *isl_set_preimage_multi_aff(
2815                 __isl_take isl_set *set,
2816                 __isl_take isl_multi_aff *ma);
2817         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
2818                 __isl_take isl_set *set,
2819                 __isl_take isl_pw_multi_aff *pma);
2821 These functions compute the preimage of the given set under
2822 the given function.  In other words, the expression is plugged
2823 into the set description.
2824 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
2825 L</"Piecewise Multiple Quasi Affine Expressions">.
2827 =item * Cartesian Product
2829         __isl_give isl_set *isl_set_product(
2830                 __isl_take isl_set *set1,
2831                 __isl_take isl_set *set2);
2832         __isl_give isl_union_set *isl_union_set_product(
2833                 __isl_take isl_union_set *uset1,
2834                 __isl_take isl_union_set *uset2);
2835         __isl_give isl_basic_map *isl_basic_map_domain_product(
2836                 __isl_take isl_basic_map *bmap1,
2837                 __isl_take isl_basic_map *bmap2);
2838         __isl_give isl_basic_map *isl_basic_map_range_product(
2839                 __isl_take isl_basic_map *bmap1,
2840                 __isl_take isl_basic_map *bmap2);
2841         __isl_give isl_basic_map *isl_basic_map_product(
2842                 __isl_take isl_basic_map *bmap1,
2843                 __isl_take isl_basic_map *bmap2);
2844         __isl_give isl_map *isl_map_domain_product(
2845                 __isl_take isl_map *map1,
2846                 __isl_take isl_map *map2);
2847         __isl_give isl_map *isl_map_range_product(
2848                 __isl_take isl_map *map1,
2849                 __isl_take isl_map *map2);
2850         __isl_give isl_union_map *isl_union_map_domain_product(
2851                 __isl_take isl_union_map *umap1,
2852                 __isl_take isl_union_map *umap2);
2853         __isl_give isl_union_map *isl_union_map_range_product(
2854                 __isl_take isl_union_map *umap1,
2855                 __isl_take isl_union_map *umap2);
2856         __isl_give isl_map *isl_map_product(
2857                 __isl_take isl_map *map1,
2858                 __isl_take isl_map *map2);
2859         __isl_give isl_union_map *isl_union_map_product(
2860                 __isl_take isl_union_map *umap1,
2861                 __isl_take isl_union_map *umap2);
2863 The above functions compute the cross product of the given
2864 sets or relations.  The domains and ranges of the results
2865 are wrapped maps between domains and ranges of the inputs.
2866 To obtain a ``flat'' product, use the following functions
2867 instead.
2869         __isl_give isl_basic_set *isl_basic_set_flat_product(
2870                 __isl_take isl_basic_set *bset1,
2871                 __isl_take isl_basic_set *bset2);
2872         __isl_give isl_set *isl_set_flat_product(
2873                 __isl_take isl_set *set1,
2874                 __isl_take isl_set *set2);
2875         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2876                 __isl_take isl_basic_map *bmap1,
2877                 __isl_take isl_basic_map *bmap2);
2878         __isl_give isl_map *isl_map_flat_domain_product(
2879                 __isl_take isl_map *map1,
2880                 __isl_take isl_map *map2);
2881         __isl_give isl_map *isl_map_flat_range_product(
2882                 __isl_take isl_map *map1,
2883                 __isl_take isl_map *map2);
2884         __isl_give isl_union_map *isl_union_map_flat_range_product(
2885                 __isl_take isl_union_map *umap1,
2886                 __isl_take isl_union_map *umap2);
2887         __isl_give isl_basic_map *isl_basic_map_flat_product(
2888                 __isl_take isl_basic_map *bmap1,
2889                 __isl_take isl_basic_map *bmap2);
2890         __isl_give isl_map *isl_map_flat_product(
2891                 __isl_take isl_map *map1,
2892                 __isl_take isl_map *map2);
2894 =item * Simplification
2896         __isl_give isl_basic_set *isl_basic_set_gist(
2897                 __isl_take isl_basic_set *bset,
2898                 __isl_take isl_basic_set *context);
2899         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2900                 __isl_take isl_set *context);
2901         __isl_give isl_set *isl_set_gist_params(
2902                 __isl_take isl_set *set,
2903                 __isl_take isl_set *context);
2904         __isl_give isl_union_set *isl_union_set_gist(
2905                 __isl_take isl_union_set *uset,
2906                 __isl_take isl_union_set *context);
2907         __isl_give isl_union_set *isl_union_set_gist_params(
2908                 __isl_take isl_union_set *uset,
2909                 __isl_take isl_set *set);
2910         __isl_give isl_basic_map *isl_basic_map_gist(
2911                 __isl_take isl_basic_map *bmap,
2912                 __isl_take isl_basic_map *context);
2913         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2914                 __isl_take isl_map *context);
2915         __isl_give isl_map *isl_map_gist_params(
2916                 __isl_take isl_map *map,
2917                 __isl_take isl_set *context);
2918         __isl_give isl_map *isl_map_gist_domain(
2919                 __isl_take isl_map *map,
2920                 __isl_take isl_set *context);
2921         __isl_give isl_map *isl_map_gist_range(
2922                 __isl_take isl_map *map,
2923                 __isl_take isl_set *context);
2924         __isl_give isl_union_map *isl_union_map_gist(
2925                 __isl_take isl_union_map *umap,
2926                 __isl_take isl_union_map *context);
2927         __isl_give isl_union_map *isl_union_map_gist_params(
2928                 __isl_take isl_union_map *umap,
2929                 __isl_take isl_set *set);
2930         __isl_give isl_union_map *isl_union_map_gist_domain(
2931                 __isl_take isl_union_map *umap,
2932                 __isl_take isl_union_set *uset);
2933         __isl_give isl_union_map *isl_union_map_gist_range(
2934                 __isl_take isl_union_map *umap,
2935                 __isl_take isl_union_set *uset);
2937 The gist operation returns a set or relation that has the
2938 same intersection with the context as the input set or relation.
2939 Any implicit equality in the intersection is made explicit in the result,
2940 while all inequalities that are redundant with respect to the intersection
2941 are removed.
2942 In case of union sets and relations, the gist operation is performed
2943 per space.
2945 =back
2947 =head3 Lexicographic Optimization
2949 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2950 the following functions
2951 compute a set that contains the lexicographic minimum or maximum
2952 of the elements in C<set> (or C<bset>) for those values of the parameters
2953 that satisfy C<dom>.
2954 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2955 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2956 has no elements.
2957 In other words, the union of the parameter values
2958 for which the result is non-empty and of C<*empty>
2959 is equal to C<dom>.
2961         __isl_give isl_set *isl_basic_set_partial_lexmin(
2962                 __isl_take isl_basic_set *bset,
2963                 __isl_take isl_basic_set *dom,
2964                 __isl_give isl_set **empty);
2965         __isl_give isl_set *isl_basic_set_partial_lexmax(
2966                 __isl_take isl_basic_set *bset,
2967                 __isl_take isl_basic_set *dom,
2968                 __isl_give isl_set **empty);
2969         __isl_give isl_set *isl_set_partial_lexmin(
2970                 __isl_take isl_set *set, __isl_take isl_set *dom,
2971                 __isl_give isl_set **empty);
2972         __isl_give isl_set *isl_set_partial_lexmax(
2973                 __isl_take isl_set *set, __isl_take isl_set *dom,
2974                 __isl_give isl_set **empty);
2976 Given a (basic) set C<set> (or C<bset>), the following functions simply
2977 return a set containing the lexicographic minimum or maximum
2978 of the elements in C<set> (or C<bset>).
2979 In case of union sets, the optimum is computed per space.
2981         __isl_give isl_set *isl_basic_set_lexmin(
2982                 __isl_take isl_basic_set *bset);
2983         __isl_give isl_set *isl_basic_set_lexmax(
2984                 __isl_take isl_basic_set *bset);
2985         __isl_give isl_set *isl_set_lexmin(
2986                 __isl_take isl_set *set);
2987         __isl_give isl_set *isl_set_lexmax(
2988                 __isl_take isl_set *set);
2989         __isl_give isl_union_set *isl_union_set_lexmin(
2990                 __isl_take isl_union_set *uset);
2991         __isl_give isl_union_set *isl_union_set_lexmax(
2992                 __isl_take isl_union_set *uset);
2994 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2995 the following functions
2996 compute a relation that maps each element of C<dom>
2997 to the single lexicographic minimum or maximum
2998 of the elements that are associated to that same
2999 element in C<map> (or C<bmap>).
3000 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3001 that contains the elements in C<dom> that do not map
3002 to any elements in C<map> (or C<bmap>).
3003 In other words, the union of the domain of the result and of C<*empty>
3004 is equal to C<dom>.
3006         __isl_give isl_map *isl_basic_map_partial_lexmax(
3007                 __isl_take isl_basic_map *bmap,
3008                 __isl_take isl_basic_set *dom,
3009                 __isl_give isl_set **empty);
3010         __isl_give isl_map *isl_basic_map_partial_lexmin(
3011                 __isl_take isl_basic_map *bmap,
3012                 __isl_take isl_basic_set *dom,
3013                 __isl_give isl_set **empty);
3014         __isl_give isl_map *isl_map_partial_lexmax(
3015                 __isl_take isl_map *map, __isl_take isl_set *dom,
3016                 __isl_give isl_set **empty);
3017         __isl_give isl_map *isl_map_partial_lexmin(
3018                 __isl_take isl_map *map, __isl_take isl_set *dom,
3019                 __isl_give isl_set **empty);
3021 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3022 return a map mapping each element in the domain of
3023 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3024 of all elements associated to that element.
3025 In case of union relations, the optimum is computed per space.
3027         __isl_give isl_map *isl_basic_map_lexmin(
3028                 __isl_take isl_basic_map *bmap);
3029         __isl_give isl_map *isl_basic_map_lexmax(
3030                 __isl_take isl_basic_map *bmap);
3031         __isl_give isl_map *isl_map_lexmin(
3032                 __isl_take isl_map *map);
3033         __isl_give isl_map *isl_map_lexmax(
3034                 __isl_take isl_map *map);
3035         __isl_give isl_union_map *isl_union_map_lexmin(
3036                 __isl_take isl_union_map *umap);
3037         __isl_give isl_union_map *isl_union_map_lexmax(
3038                 __isl_take isl_union_map *umap);
3040 The following functions return their result in the form of
3041 a piecewise multi-affine expression
3042 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3043 but are otherwise equivalent to the corresponding functions
3044 returning a basic set or relation.
3046         __isl_give isl_pw_multi_aff *
3047         isl_basic_map_lexmin_pw_multi_aff(
3048                 __isl_take isl_basic_map *bmap);
3049         __isl_give isl_pw_multi_aff *
3050         isl_basic_set_partial_lexmin_pw_multi_aff(
3051                 __isl_take isl_basic_set *bset,
3052                 __isl_take isl_basic_set *dom,
3053                 __isl_give isl_set **empty);
3054         __isl_give isl_pw_multi_aff *
3055         isl_basic_set_partial_lexmax_pw_multi_aff(
3056                 __isl_take isl_basic_set *bset,
3057                 __isl_take isl_basic_set *dom,
3058                 __isl_give isl_set **empty);
3059         __isl_give isl_pw_multi_aff *
3060         isl_basic_map_partial_lexmin_pw_multi_aff(
3061                 __isl_take isl_basic_map *bmap,
3062                 __isl_take isl_basic_set *dom,
3063                 __isl_give isl_set **empty);
3064         __isl_give isl_pw_multi_aff *
3065         isl_basic_map_partial_lexmax_pw_multi_aff(
3066                 __isl_take isl_basic_map *bmap,
3067                 __isl_take isl_basic_set *dom,
3068                 __isl_give isl_set **empty);
3069         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3070                 __isl_take isl_set *set);
3071         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3072                 __isl_take isl_set *set);
3073         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3074                 __isl_take isl_map *map);
3075         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3076                 __isl_take isl_map *map);
3078 =head2 Lists
3080 Lists are defined over several element types, including
3081 C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3082 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3083 Here we take lists of C<isl_set>s as an example.
3084 Lists can be created, copied, modified and freed using the following functions.
3086         #include <isl/list.h>
3087         __isl_give isl_set_list *isl_set_list_from_set(
3088                 __isl_take isl_set *el);
3089         __isl_give isl_set_list *isl_set_list_alloc(
3090                 isl_ctx *ctx, int n);
3091         __isl_give isl_set_list *isl_set_list_copy(
3092                 __isl_keep isl_set_list *list);
3093         __isl_give isl_set_list *isl_set_list_insert(
3094                 __isl_take isl_set_list *list, unsigned pos,
3095                 __isl_take isl_set *el);
3096         __isl_give isl_set_list *isl_set_list_add(
3097                 __isl_take isl_set_list *list,
3098                 __isl_take isl_set *el);
3099         __isl_give isl_set_list *isl_set_list_drop(
3100                 __isl_take isl_set_list *list,
3101                 unsigned first, unsigned n);
3102         __isl_give isl_set_list *isl_set_list_set_set(
3103                 __isl_take isl_set_list *list, int index,
3104                 __isl_take isl_set *set);
3105         __isl_give isl_set_list *isl_set_list_concat(
3106                 __isl_take isl_set_list *list1,
3107                 __isl_take isl_set_list *list2);
3108         __isl_give isl_set_list *isl_set_list_sort(
3109                 __isl_take isl_set_list *list,
3110                 int (*cmp)(__isl_keep isl_set *a,
3111                         __isl_keep isl_set *b, void *user),
3112                 void *user);
3113         void *isl_set_list_free(__isl_take isl_set_list *list);
3115 C<isl_set_list_alloc> creates an empty list with a capacity for
3116 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3117 element.
3119 Lists can be inspected using the following functions.
3121         #include <isl/list.h>
3122         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3123         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3124         __isl_give isl_set *isl_set_list_get_set(
3125                 __isl_keep isl_set_list *list, int index);
3126         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3127                 int (*fn)(__isl_take isl_set *el, void *user),
3128                 void *user);
3130 Lists can be printed using
3132         #include <isl/list.h>
3133         __isl_give isl_printer *isl_printer_print_set_list(
3134                 __isl_take isl_printer *p,
3135                 __isl_keep isl_set_list *list);
3137 =head2 Vectors
3139 Vectors can be created, copied and freed using the following functions.
3141         #include <isl/vec.h>
3142         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3143                 unsigned size);
3144         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3145         void *isl_vec_free(__isl_take isl_vec *vec);
3147 Note that the elements of a newly created vector may have arbitrary values.
3148 The elements can be changed and inspected using the following functions.
3150         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3151         int isl_vec_size(__isl_keep isl_vec *vec);
3152         int isl_vec_get_element(__isl_keep isl_vec *vec,
3153                 int pos, isl_int *v);
3154         __isl_give isl_vec *isl_vec_set_element(
3155                 __isl_take isl_vec *vec, int pos, isl_int v);
3156         __isl_give isl_vec *isl_vec_set_element_si(
3157                 __isl_take isl_vec *vec, int pos, int v);
3158         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3159                 isl_int v);
3160         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3161                 int v);
3162         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3163                 isl_int m);
3165 C<isl_vec_get_element> will return a negative value if anything went wrong.
3166 In that case, the value of C<*v> is undefined.
3168 The following function can be used to concatenate two vectors.
3170         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3171                 __isl_take isl_vec *vec2);
3173 =head2 Matrices
3175 Matrices can be created, copied and freed using the following functions.
3177         #include <isl/mat.h>
3178         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3179                 unsigned n_row, unsigned n_col);
3180         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3181         void isl_mat_free(__isl_take isl_mat *mat);
3183 Note that the elements of a newly created matrix may have arbitrary values.
3184 The elements can be changed and inspected using the following functions.
3186         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3187         int isl_mat_rows(__isl_keep isl_mat *mat);
3188         int isl_mat_cols(__isl_keep isl_mat *mat);
3189         int isl_mat_get_element(__isl_keep isl_mat *mat,
3190                 int row, int col, isl_int *v);
3191         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3192                 int row, int col, isl_int v);
3193         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3194                 int row, int col, int v);
3196 C<isl_mat_get_element> will return a negative value if anything went wrong.
3197 In that case, the value of C<*v> is undefined.
3199 The following function can be used to compute the (right) inverse
3200 of a matrix, i.e., a matrix such that the product of the original
3201 and the inverse (in that order) is a multiple of the identity matrix.
3202 The input matrix is assumed to be of full row-rank.
3204         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3206 The following function can be used to compute the (right) kernel
3207 (or null space) of a matrix, i.e., a matrix such that the product of
3208 the original and the kernel (in that order) is the zero matrix.
3210         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3212 =head2 Piecewise Quasi Affine Expressions
3214 The zero quasi affine expression or the quasi affine expression
3215 that is equal to a specified dimension on a given domain can be created using
3217         __isl_give isl_aff *isl_aff_zero_on_domain(
3218                 __isl_take isl_local_space *ls);
3219         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3220                 __isl_take isl_local_space *ls);
3221         __isl_give isl_aff *isl_aff_var_on_domain(
3222                 __isl_take isl_local_space *ls,
3223                 enum isl_dim_type type, unsigned pos);
3224         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3225                 __isl_take isl_local_space *ls,
3226                 enum isl_dim_type type, unsigned pos);
3228 Note that the space in which the resulting objects live is a map space
3229 with the given space as domain and a one-dimensional range.
3231 An empty piecewise quasi affine expression (one with no cells)
3232 or a piecewise quasi affine expression with a single cell can
3233 be created using the following functions.
3235         #include <isl/aff.h>
3236         __isl_give isl_pw_aff *isl_pw_aff_empty(
3237                 __isl_take isl_space *space);
3238         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3239                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3240         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3241                 __isl_take isl_aff *aff);
3243 A piecewise quasi affine expression that is equal to 1 on a set
3244 and 0 outside the set can be created using the following function.
3246         #include <isl/aff.h>
3247         __isl_give isl_pw_aff *isl_set_indicator_function(
3248                 __isl_take isl_set *set);
3250 Quasi affine expressions can be copied and freed using
3252         #include <isl/aff.h>
3253         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3254         void *isl_aff_free(__isl_take isl_aff *aff);
3256         __isl_give isl_pw_aff *isl_pw_aff_copy(
3257                 __isl_keep isl_pw_aff *pwaff);
3258         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3260 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3261 using the following function.  The constraint is required to have
3262 a non-zero coefficient for the specified dimension.
3264         #include <isl/constraint.h>
3265         __isl_give isl_aff *isl_constraint_get_bound(
3266                 __isl_keep isl_constraint *constraint,
3267                 enum isl_dim_type type, int pos);
3269 The entire affine expression of the constraint can also be extracted
3270 using the following function.
3272         #include <isl/constraint.h>
3273         __isl_give isl_aff *isl_constraint_get_aff(
3274                 __isl_keep isl_constraint *constraint);
3276 Conversely, an equality constraint equating
3277 the affine expression to zero or an inequality constraint enforcing
3278 the affine expression to be non-negative, can be constructed using
3280         __isl_give isl_constraint *isl_equality_from_aff(
3281                 __isl_take isl_aff *aff);
3282         __isl_give isl_constraint *isl_inequality_from_aff(
3283                 __isl_take isl_aff *aff);
3285 The expression can be inspected using
3287         #include <isl/aff.h>
3288         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3289         int isl_aff_dim(__isl_keep isl_aff *aff,
3290                 enum isl_dim_type type);
3291         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3292                 __isl_keep isl_aff *aff);
3293         __isl_give isl_local_space *isl_aff_get_local_space(
3294                 __isl_keep isl_aff *aff);
3295         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3296                 enum isl_dim_type type, unsigned pos);
3297         const char *isl_pw_aff_get_dim_name(
3298                 __isl_keep isl_pw_aff *pa,
3299                 enum isl_dim_type type, unsigned pos);
3300         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3301                 enum isl_dim_type type, unsigned pos);
3302         __isl_give isl_id *isl_pw_aff_get_dim_id(
3303                 __isl_keep isl_pw_aff *pa,
3304                 enum isl_dim_type type, unsigned pos);
3305         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3306                 __isl_keep isl_pw_aff *pa,
3307                 enum isl_dim_type type);
3308         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3309                 isl_int *v);
3310         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3311                 enum isl_dim_type type, int pos, isl_int *v);
3312         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3313                 isl_int *v);
3314         __isl_give isl_aff *isl_aff_get_div(
3315                 __isl_keep isl_aff *aff, int pos);
3317         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3318         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3319                 int (*fn)(__isl_take isl_set *set,
3320                           __isl_take isl_aff *aff,
3321                           void *user), void *user);
3323         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3324         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3326         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3327                 enum isl_dim_type type, unsigned first, unsigned n);
3328         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3329                 enum isl_dim_type type, unsigned first, unsigned n);
3331         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3332         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3333                 enum isl_dim_type type);
3334         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3336 It can be modified using
3338         #include <isl/aff.h>
3339         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3340                 __isl_take isl_pw_aff *pwaff,
3341                 enum isl_dim_type type, __isl_take isl_id *id);
3342         __isl_give isl_aff *isl_aff_set_dim_name(
3343                 __isl_take isl_aff *aff, enum isl_dim_type type,
3344                 unsigned pos, const char *s);
3345         __isl_give isl_aff *isl_aff_set_dim_id(
3346                 __isl_take isl_aff *aff, enum isl_dim_type type,
3347                 unsigned pos, __isl_take isl_id *id);
3348         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3349                 __isl_take isl_pw_aff *pma,
3350                 enum isl_dim_type type, unsigned pos,
3351                 __isl_take isl_id *id);
3352         __isl_give isl_aff *isl_aff_set_constant(
3353                 __isl_take isl_aff *aff, isl_int v);
3354         __isl_give isl_aff *isl_aff_set_constant_si(
3355                 __isl_take isl_aff *aff, int v);
3356         __isl_give isl_aff *isl_aff_set_coefficient(
3357                 __isl_take isl_aff *aff,
3358                 enum isl_dim_type type, int pos, isl_int v);
3359         __isl_give isl_aff *isl_aff_set_coefficient_si(
3360                 __isl_take isl_aff *aff,
3361                 enum isl_dim_type type, int pos, int v);
3362         __isl_give isl_aff *isl_aff_set_denominator(
3363                 __isl_take isl_aff *aff, isl_int v);
3365         __isl_give isl_aff *isl_aff_add_constant(
3366                 __isl_take isl_aff *aff, isl_int v);
3367         __isl_give isl_aff *isl_aff_add_constant_si(
3368                 __isl_take isl_aff *aff, int v);
3369         __isl_give isl_aff *isl_aff_add_constant_num(
3370                 __isl_take isl_aff *aff, isl_int v);
3371         __isl_give isl_aff *isl_aff_add_constant_num_si(
3372                 __isl_take isl_aff *aff, int v);
3373         __isl_give isl_aff *isl_aff_add_coefficient(
3374                 __isl_take isl_aff *aff,
3375                 enum isl_dim_type type, int pos, isl_int v);
3376         __isl_give isl_aff *isl_aff_add_coefficient_si(
3377                 __isl_take isl_aff *aff,
3378                 enum isl_dim_type type, int pos, int v);
3380         __isl_give isl_aff *isl_aff_insert_dims(
3381                 __isl_take isl_aff *aff,
3382                 enum isl_dim_type type, unsigned first, unsigned n);
3383         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3384                 __isl_take isl_pw_aff *pwaff,
3385                 enum isl_dim_type type, unsigned first, unsigned n);
3386         __isl_give isl_aff *isl_aff_add_dims(
3387                 __isl_take isl_aff *aff,
3388                 enum isl_dim_type type, unsigned n);
3389         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3390                 __isl_take isl_pw_aff *pwaff,
3391                 enum isl_dim_type type, unsigned n);
3392         __isl_give isl_aff *isl_aff_drop_dims(
3393                 __isl_take isl_aff *aff,
3394                 enum isl_dim_type type, unsigned first, unsigned n);
3395         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3396                 __isl_take isl_pw_aff *pwaff,
3397                 enum isl_dim_type type, unsigned first, unsigned n);
3399 Note that the C<set_constant> and C<set_coefficient> functions
3400 set the I<numerator> of the constant or coefficient, while
3401 C<add_constant> and C<add_coefficient> add an integer value to
3402 the possibly rational constant or coefficient.
3403 The C<add_constant_num> functions add an integer value to
3404 the numerator.
3406 To check whether an affine expressions is obviously zero
3407 or obviously equal to some other affine expression, use
3409         #include <isl/aff.h>
3410         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3411         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3412                 __isl_keep isl_aff *aff2);
3413         int isl_pw_aff_plain_is_equal(
3414                 __isl_keep isl_pw_aff *pwaff1,
3415                 __isl_keep isl_pw_aff *pwaff2);
3417 Operations include
3419         #include <isl/aff.h>
3420         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3421                 __isl_take isl_aff *aff2);
3422         __isl_give isl_pw_aff *isl_pw_aff_add(
3423                 __isl_take isl_pw_aff *pwaff1,
3424                 __isl_take isl_pw_aff *pwaff2);
3425         __isl_give isl_pw_aff *isl_pw_aff_min(
3426                 __isl_take isl_pw_aff *pwaff1,
3427                 __isl_take isl_pw_aff *pwaff2);
3428         __isl_give isl_pw_aff *isl_pw_aff_max(
3429                 __isl_take isl_pw_aff *pwaff1,
3430                 __isl_take isl_pw_aff *pwaff2);
3431         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3432                 __isl_take isl_aff *aff2);
3433         __isl_give isl_pw_aff *isl_pw_aff_sub(
3434                 __isl_take isl_pw_aff *pwaff1,
3435                 __isl_take isl_pw_aff *pwaff2);
3436         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3437         __isl_give isl_pw_aff *isl_pw_aff_neg(
3438                 __isl_take isl_pw_aff *pwaff);
3439         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3440         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3441                 __isl_take isl_pw_aff *pwaff);
3442         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3443         __isl_give isl_pw_aff *isl_pw_aff_floor(
3444                 __isl_take isl_pw_aff *pwaff);
3445         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3446                 isl_int mod);
3447         __isl_give isl_pw_aff *isl_pw_aff_mod(
3448                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3449         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3450                 isl_int f);
3451         __isl_give isl_pw_aff *isl_pw_aff_scale(
3452                 __isl_take isl_pw_aff *pwaff, isl_int f);
3453         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3454                 isl_int f);
3455         __isl_give isl_aff *isl_aff_scale_down_ui(
3456                 __isl_take isl_aff *aff, unsigned f);
3457         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3458                 __isl_take isl_pw_aff *pwaff, isl_int f);
3460         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3461                 __isl_take isl_pw_aff_list *list);
3462         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3463                 __isl_take isl_pw_aff_list *list);
3465         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3466                 __isl_take isl_pw_aff *pwqp);
3468         __isl_give isl_aff *isl_aff_align_params(
3469                 __isl_take isl_aff *aff,
3470                 __isl_take isl_space *model);
3471         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3472                 __isl_take isl_pw_aff *pwaff,
3473                 __isl_take isl_space *model);
3475         __isl_give isl_aff *isl_aff_project_domain_on_params(
3476                 __isl_take isl_aff *aff);
3478         __isl_give isl_aff *isl_aff_gist_params(
3479                 __isl_take isl_aff *aff,
3480                 __isl_take isl_set *context);
3481         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3482                 __isl_take isl_set *context);
3483         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3484                 __isl_take isl_pw_aff *pwaff,
3485                 __isl_take isl_set *context);
3486         __isl_give isl_pw_aff *isl_pw_aff_gist(
3487                 __isl_take isl_pw_aff *pwaff,
3488                 __isl_take isl_set *context);
3490         __isl_give isl_set *isl_pw_aff_domain(
3491                 __isl_take isl_pw_aff *pwaff);
3492         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3493                 __isl_take isl_pw_aff *pa,
3494                 __isl_take isl_set *set);
3495         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3496                 __isl_take isl_pw_aff *pa,
3497                 __isl_take isl_set *set);
3499         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3500                 __isl_take isl_aff *aff2);
3501         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3502                 __isl_take isl_aff *aff2);
3503         __isl_give isl_pw_aff *isl_pw_aff_mul(
3504                 __isl_take isl_pw_aff *pwaff1,
3505                 __isl_take isl_pw_aff *pwaff2);
3506         __isl_give isl_pw_aff *isl_pw_aff_div(
3507                 __isl_take isl_pw_aff *pa1,
3508                 __isl_take isl_pw_aff *pa2);
3509         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3510                 __isl_take isl_pw_aff *pa1,
3511                 __isl_take isl_pw_aff *pa2);
3512         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3513                 __isl_take isl_pw_aff *pa1,
3514                 __isl_take isl_pw_aff *pa2);
3516 When multiplying two affine expressions, at least one of the two needs
3517 to be a constant.  Similarly, when dividing an affine expression by another,
3518 the second expression needs to be a constant.
3519 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3520 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3521 remainder.
3523         #include <isl/aff.h>
3524         __isl_give isl_aff *isl_aff_pullback_multi_aff(
3525                 __isl_take isl_aff *aff,
3526                 __isl_take isl_multi_aff *ma);
3527         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3528                 __isl_take isl_pw_aff *pa,
3529                 __isl_take isl_multi_aff *ma);
3530         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3531                 __isl_take isl_pw_aff *pa,
3532                 __isl_take isl_pw_multi_aff *pma);
3534 These functions precompose the input expression by the given
3535 C<isl_multi_aff> or C<isl_pw_multi_aff>.  In other words,
3536 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3537 into the (piecewise) affine expression.
3538 Objects of type C<isl_multi_aff> are described in
3539 L</"Piecewise Multiple Quasi Affine Expressions">.
3541         #include <isl/aff.h>
3542         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3543                 __isl_take isl_aff *aff);
3544         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3545                 __isl_take isl_aff *aff);
3546         __isl_give isl_basic_set *isl_aff_le_basic_set(
3547                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3548         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3549                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3550         __isl_give isl_set *isl_pw_aff_eq_set(
3551                 __isl_take isl_pw_aff *pwaff1,
3552                 __isl_take isl_pw_aff *pwaff2);
3553         __isl_give isl_set *isl_pw_aff_ne_set(
3554                 __isl_take isl_pw_aff *pwaff1,
3555                 __isl_take isl_pw_aff *pwaff2);
3556         __isl_give isl_set *isl_pw_aff_le_set(
3557                 __isl_take isl_pw_aff *pwaff1,
3558                 __isl_take isl_pw_aff *pwaff2);
3559         __isl_give isl_set *isl_pw_aff_lt_set(
3560                 __isl_take isl_pw_aff *pwaff1,
3561                 __isl_take isl_pw_aff *pwaff2);
3562         __isl_give isl_set *isl_pw_aff_ge_set(
3563                 __isl_take isl_pw_aff *pwaff1,
3564                 __isl_take isl_pw_aff *pwaff2);
3565         __isl_give isl_set *isl_pw_aff_gt_set(
3566                 __isl_take isl_pw_aff *pwaff1,
3567                 __isl_take isl_pw_aff *pwaff2);
3569         __isl_give isl_set *isl_pw_aff_list_eq_set(
3570                 __isl_take isl_pw_aff_list *list1,
3571                 __isl_take isl_pw_aff_list *list2);
3572         __isl_give isl_set *isl_pw_aff_list_ne_set(
3573                 __isl_take isl_pw_aff_list *list1,
3574                 __isl_take isl_pw_aff_list *list2);
3575         __isl_give isl_set *isl_pw_aff_list_le_set(
3576                 __isl_take isl_pw_aff_list *list1,
3577                 __isl_take isl_pw_aff_list *list2);
3578         __isl_give isl_set *isl_pw_aff_list_lt_set(
3579                 __isl_take isl_pw_aff_list *list1,
3580                 __isl_take isl_pw_aff_list *list2);
3581         __isl_give isl_set *isl_pw_aff_list_ge_set(
3582                 __isl_take isl_pw_aff_list *list1,
3583                 __isl_take isl_pw_aff_list *list2);
3584         __isl_give isl_set *isl_pw_aff_list_gt_set(
3585                 __isl_take isl_pw_aff_list *list1,
3586                 __isl_take isl_pw_aff_list *list2);
3588 The function C<isl_aff_neg_basic_set> returns a basic set
3589 containing those elements in the domain space
3590 of C<aff> where C<aff> is negative.
3591 The function C<isl_aff_ge_basic_set> returns a basic set
3592 containing those elements in the shared space
3593 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3594 The function C<isl_pw_aff_ge_set> returns a set
3595 containing those elements in the shared domain
3596 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3597 The functions operating on C<isl_pw_aff_list> apply the corresponding
3598 C<isl_pw_aff> function to each pair of elements in the two lists.
3600         #include <isl/aff.h>
3601         __isl_give isl_set *isl_pw_aff_nonneg_set(
3602                 __isl_take isl_pw_aff *pwaff);
3603         __isl_give isl_set *isl_pw_aff_zero_set(
3604                 __isl_take isl_pw_aff *pwaff);
3605         __isl_give isl_set *isl_pw_aff_non_zero_set(
3606                 __isl_take isl_pw_aff *pwaff);
3608 The function C<isl_pw_aff_nonneg_set> returns a set
3609 containing those elements in the domain
3610 of C<pwaff> where C<pwaff> is non-negative.
3612         #include <isl/aff.h>
3613         __isl_give isl_pw_aff *isl_pw_aff_cond(
3614                 __isl_take isl_pw_aff *cond,
3615                 __isl_take isl_pw_aff *pwaff_true,
3616                 __isl_take isl_pw_aff *pwaff_false);
3618 The function C<isl_pw_aff_cond> performs a conditional operator
3619 and returns an expression that is equal to C<pwaff_true>
3620 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3621 where C<cond> is zero.
3623         #include <isl/aff.h>
3624         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3625                 __isl_take isl_pw_aff *pwaff1,
3626                 __isl_take isl_pw_aff *pwaff2);
3627         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3628                 __isl_take isl_pw_aff *pwaff1,
3629                 __isl_take isl_pw_aff *pwaff2);
3630         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3631                 __isl_take isl_pw_aff *pwaff1,
3632                 __isl_take isl_pw_aff *pwaff2);
3634 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3635 expression with a domain that is the union of those of C<pwaff1> and
3636 C<pwaff2> and such that on each cell, the quasi-affine expression is
3637 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3638 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3639 associated expression is the defined one.
3641 An expression can be read from input using
3643         #include <isl/aff.h>
3644         __isl_give isl_aff *isl_aff_read_from_str(
3645                 isl_ctx *ctx, const char *str);
3646         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3647                 isl_ctx *ctx, const char *str);
3649 An expression can be printed using
3651         #include <isl/aff.h>
3652         __isl_give isl_printer *isl_printer_print_aff(
3653                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3655         __isl_give isl_printer *isl_printer_print_pw_aff(
3656                 __isl_take isl_printer *p,
3657                 __isl_keep isl_pw_aff *pwaff);
3659 =head2 Piecewise Multiple Quasi Affine Expressions
3661 An C<isl_multi_aff> object represents a sequence of
3662 zero or more affine expressions, all defined on the same domain space.
3663 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
3664 zero or more piecewise affine expressions.
3666 An C<isl_multi_aff> can be constructed from a single
3667 C<isl_aff> or an C<isl_aff_list> using the
3668 following functions.  Similarly for C<isl_multi_pw_aff>.
3670         #include <isl/aff.h>
3671         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
3672                 __isl_take isl_aff *aff);
3673         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
3674                 __isl_take isl_pw_aff *pa);
3675         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3676                 __isl_take isl_space *space,
3677                 __isl_take isl_aff_list *list);
3679 An empty piecewise multiple quasi affine expression (one with no cells),
3680 the zero piecewise multiple quasi affine expression (with value zero
3681 for each output dimension),
3682 a piecewise multiple quasi affine expression with a single cell (with
3683 either a universe or a specified domain) or
3684 a zero-dimensional piecewise multiple quasi affine expression
3685 on a given domain
3686 can be created using the following functions.
3688         #include <isl/aff.h>
3689         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3690                 __isl_take isl_space *space);
3691         __isl_give isl_multi_aff *isl_multi_aff_zero(
3692                 __isl_take isl_space *space);
3693         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
3694                 __isl_take isl_space *space);
3695         __isl_give isl_multi_aff *isl_multi_aff_identity(
3696                 __isl_take isl_space *space);
3697         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3698                 __isl_take isl_space *space);
3699         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
3700                 __isl_take isl_space *space);
3701         __isl_give isl_pw_multi_aff *
3702         isl_pw_multi_aff_from_multi_aff(
3703                 __isl_take isl_multi_aff *ma);
3704         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3705                 __isl_take isl_set *set,
3706                 __isl_take isl_multi_aff *maff);
3707         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3708                 __isl_take isl_set *set);
3710         __isl_give isl_union_pw_multi_aff *
3711         isl_union_pw_multi_aff_empty(
3712                 __isl_take isl_space *space);
3713         __isl_give isl_union_pw_multi_aff *
3714         isl_union_pw_multi_aff_add_pw_multi_aff(
3715                 __isl_take isl_union_pw_multi_aff *upma,
3716                 __isl_take isl_pw_multi_aff *pma);
3717         __isl_give isl_union_pw_multi_aff *
3718         isl_union_pw_multi_aff_from_domain(
3719                 __isl_take isl_union_set *uset);
3721 A piecewise multiple quasi affine expression can also be initialized
3722 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3723 and the C<isl_map> is single-valued.
3724 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
3725 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
3727         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3728                 __isl_take isl_set *set);
3729         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3730                 __isl_take isl_map *map);
3732         __isl_give isl_union_pw_multi_aff *
3733         isl_union_pw_multi_aff_from_union_set(
3734                 __isl_take isl_union_set *uset);
3735         __isl_give isl_union_pw_multi_aff *
3736         isl_union_pw_multi_aff_from_union_map(
3737                 __isl_take isl_union_map *umap);
3739 Multiple quasi affine expressions can be copied and freed using
3741         #include <isl/aff.h>
3742         __isl_give isl_multi_aff *isl_multi_aff_copy(
3743                 __isl_keep isl_multi_aff *maff);
3744         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3746         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3747                 __isl_keep isl_pw_multi_aff *pma);
3748         void *isl_pw_multi_aff_free(
3749                 __isl_take isl_pw_multi_aff *pma);
3751         __isl_give isl_union_pw_multi_aff *
3752         isl_union_pw_multi_aff_copy(
3753                 __isl_keep isl_union_pw_multi_aff *upma);
3754         void *isl_union_pw_multi_aff_free(
3755                 __isl_take isl_union_pw_multi_aff *upma);
3757         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
3758                 __isl_keep isl_multi_pw_aff *mpa);
3759         void *isl_multi_pw_aff_free(
3760                 __isl_take isl_multi_pw_aff *mpa);
3762 The expression can be inspected using
3764         #include <isl/aff.h>
3765         isl_ctx *isl_multi_aff_get_ctx(
3766                 __isl_keep isl_multi_aff *maff);
3767         isl_ctx *isl_pw_multi_aff_get_ctx(
3768                 __isl_keep isl_pw_multi_aff *pma);
3769         isl_ctx *isl_union_pw_multi_aff_get_ctx(
3770                 __isl_keep isl_union_pw_multi_aff *upma);
3771         isl_ctx *isl_multi_pw_aff_get_ctx(
3772                 __isl_keep isl_multi_pw_aff *mpa);
3773         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3774                 enum isl_dim_type type);
3775         unsigned isl_pw_multi_aff_dim(
3776                 __isl_keep isl_pw_multi_aff *pma,
3777                 enum isl_dim_type type);
3778         unsigned isl_multi_pw_aff_dim(
3779                 __isl_keep isl_multi_pw_aff *mpa,
3780                 enum isl_dim_type type);
3781         __isl_give isl_aff *isl_multi_aff_get_aff(
3782                 __isl_keep isl_multi_aff *multi, int pos);
3783         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3784                 __isl_keep isl_pw_multi_aff *pma, int pos);
3785         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
3786                 __isl_keep isl_multi_pw_aff *mpa, int pos);
3787         const char *isl_pw_multi_aff_get_dim_name(
3788                 __isl_keep isl_pw_multi_aff *pma,
3789                 enum isl_dim_type type, unsigned pos);
3790         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3791                 __isl_keep isl_pw_multi_aff *pma,
3792                 enum isl_dim_type type, unsigned pos);
3793         const char *isl_multi_aff_get_tuple_name(
3794                 __isl_keep isl_multi_aff *multi,
3795                 enum isl_dim_type type);
3796         int isl_pw_multi_aff_has_tuple_name(
3797                 __isl_keep isl_pw_multi_aff *pma,
3798                 enum isl_dim_type type);
3799         const char *isl_pw_multi_aff_get_tuple_name(
3800                 __isl_keep isl_pw_multi_aff *pma,
3801                 enum isl_dim_type type);
3802         int isl_pw_multi_aff_has_tuple_id(
3803                 __isl_keep isl_pw_multi_aff *pma,
3804                 enum isl_dim_type type);
3805         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3806                 __isl_keep isl_pw_multi_aff *pma,
3807                 enum isl_dim_type type);
3809         int isl_pw_multi_aff_foreach_piece(
3810                 __isl_keep isl_pw_multi_aff *pma,
3811                 int (*fn)(__isl_take isl_set *set,
3812                             __isl_take isl_multi_aff *maff,
3813                             void *user), void *user);
3815         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
3816                 __isl_keep isl_union_pw_multi_aff *upma,
3817                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
3818                             void *user), void *user);
3820 It can be modified using
3822         #include <isl/aff.h>
3823         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
3824                 __isl_take isl_multi_aff *multi, int pos,
3825                 __isl_take isl_aff *aff);
3826         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
3827                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
3828                 __isl_take isl_pw_aff *pa);
3829         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3830                 __isl_take isl_multi_aff *maff,
3831                 enum isl_dim_type type, unsigned pos, const char *s);
3832         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
3833                 __isl_take isl_multi_aff *maff,
3834                 enum isl_dim_type type, const char *s);
3835         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
3836                 __isl_take isl_multi_aff *maff,
3837                 enum isl_dim_type type, __isl_take isl_id *id);
3838         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3839                 __isl_take isl_pw_multi_aff *pma,
3840                 enum isl_dim_type type, __isl_take isl_id *id);
3842         __isl_give isl_multi_pw_aff *
3843         isl_multi_pw_aff_set_dim_name(
3844                 __isl_take isl_multi_pw_aff *mpa,
3845                 enum isl_dim_type type, unsigned pos, const char *s);
3846         __isl_give isl_multi_pw_aff *
3847         isl_multi_pw_aff_set_tuple_name(
3848                 __isl_take isl_multi_pw_aff *mpa,
3849                 enum isl_dim_type type, const char *s);
3851         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
3852                 __isl_take isl_multi_aff *ma,
3853                 enum isl_dim_type type, unsigned first, unsigned n);
3854         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
3855                 __isl_take isl_multi_aff *ma,
3856                 enum isl_dim_type type, unsigned n);
3857         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
3858                 __isl_take isl_multi_aff *maff,
3859                 enum isl_dim_type type, unsigned first, unsigned n);
3860         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
3861                 __isl_take isl_pw_multi_aff *pma,
3862                 enum isl_dim_type type, unsigned first, unsigned n);
3864         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
3865                 __isl_take isl_multi_pw_aff *mpa,
3866                 enum isl_dim_type type, unsigned first, unsigned n);
3867         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
3868                 __isl_take isl_multi_pw_aff *mpa,
3869                 enum isl_dim_type type, unsigned n);
3871 To check whether two multiple affine expressions are
3872 obviously equal to each other, use
3874         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3875                 __isl_keep isl_multi_aff *maff2);
3876         int isl_pw_multi_aff_plain_is_equal(
3877                 __isl_keep isl_pw_multi_aff *pma1,
3878                 __isl_keep isl_pw_multi_aff *pma2);
3880 Operations include
3882         #include <isl/aff.h>
3883         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
3884                 __isl_take isl_pw_multi_aff *pma1,
3885                 __isl_take isl_pw_multi_aff *pma2);
3886         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
3887                 __isl_take isl_pw_multi_aff *pma1,
3888                 __isl_take isl_pw_multi_aff *pma2);
3889         __isl_give isl_multi_aff *isl_multi_aff_add(
3890                 __isl_take isl_multi_aff *maff1,
3891                 __isl_take isl_multi_aff *maff2);
3892         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3893                 __isl_take isl_pw_multi_aff *pma1,
3894                 __isl_take isl_pw_multi_aff *pma2);
3895         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
3896                 __isl_take isl_union_pw_multi_aff *upma1,
3897                 __isl_take isl_union_pw_multi_aff *upma2);
3898         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3899                 __isl_take isl_pw_multi_aff *pma1,
3900                 __isl_take isl_pw_multi_aff *pma2);
3901         __isl_give isl_multi_aff *isl_multi_aff_sub(
3902                 __isl_take isl_multi_aff *ma1,
3903                 __isl_take isl_multi_aff *ma2);
3904         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
3905                 __isl_take isl_pw_multi_aff *pma1,
3906                 __isl_take isl_pw_multi_aff *pma2);
3907         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
3908                 __isl_take isl_union_pw_multi_aff *upma1,
3909                 __isl_take isl_union_pw_multi_aff *upma2);
3911 C<isl_multi_aff_sub> subtracts the second argument from the first.
3913         __isl_give isl_multi_aff *isl_multi_aff_scale(
3914                 __isl_take isl_multi_aff *maff,
3915                 isl_int f);
3916         __isl_give isl_multi_aff *isl_multi_aff_scale_vec(
3917                 __isl_take isl_multi_aff *ma,
3918                 __isl_take isl_vec *v);
3919         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_vec(
3920                 __isl_take isl_pw_multi_aff *pma,
3921                 __isl_take isl_vec *v);
3922         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_scale_vec(
3923                 __isl_take isl_union_pw_multi_aff *upma,
3924                 __isl_take isl_vec *v);
3926 C<isl_multi_aff_scale_vec> scales the first elements of C<ma>
3927 by the corresponding elements of C<v>.
3929         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
3930                 __isl_take isl_pw_multi_aff *pma,
3931                 __isl_take isl_set *set);
3932         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3933                 __isl_take isl_pw_multi_aff *pma,
3934                 __isl_take isl_set *set);
3935         __isl_give isl_union_pw_multi_aff *
3936         isl_union_pw_multi_aff_intersect_domain(
3937                 __isl_take isl_union_pw_multi_aff *upma,
3938                 __isl_take isl_union_set *uset);
3939         __isl_give isl_multi_aff *isl_multi_aff_lift(
3940                 __isl_take isl_multi_aff *maff,
3941                 __isl_give isl_local_space **ls);
3942         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
3943                 __isl_take isl_pw_multi_aff *pma);
3944         __isl_give isl_multi_aff *isl_multi_aff_align_params(
3945                 __isl_take isl_multi_aff *multi,
3946                 __isl_take isl_space *model);
3947         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
3948                 __isl_take isl_pw_multi_aff *pma,
3949                 __isl_take isl_space *model);
3950         __isl_give isl_pw_multi_aff *
3951         isl_pw_multi_aff_project_domain_on_params(
3952                 __isl_take isl_pw_multi_aff *pma);
3953         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
3954                 __isl_take isl_multi_aff *maff,
3955                 __isl_take isl_set *context);
3956         __isl_give isl_multi_aff *isl_multi_aff_gist(
3957                 __isl_take isl_multi_aff *maff,
3958                 __isl_take isl_set *context);
3959         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
3960                 __isl_take isl_pw_multi_aff *pma,
3961                 __isl_take isl_set *set);
3962         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
3963                 __isl_take isl_pw_multi_aff *pma,
3964                 __isl_take isl_set *set);
3965         __isl_give isl_set *isl_pw_multi_aff_domain(
3966                 __isl_take isl_pw_multi_aff *pma);
3967         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
3968                 __isl_take isl_union_pw_multi_aff *upma);
3969         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
3970                 __isl_take isl_multi_aff *ma1, unsigned pos,
3971                 __isl_take isl_multi_aff *ma2);
3972         __isl_give isl_multi_aff *isl_multi_aff_splice(
3973                 __isl_take isl_multi_aff *ma1,
3974                 unsigned in_pos, unsigned out_pos,
3975                 __isl_take isl_multi_aff *ma2);
3976         __isl_give isl_multi_aff *isl_multi_aff_range_product(
3977                 __isl_take isl_multi_aff *ma1,
3978                 __isl_take isl_multi_aff *ma2);
3979         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
3980                 __isl_take isl_multi_aff *ma1,
3981                 __isl_take isl_multi_aff *ma2);
3982         __isl_give isl_multi_aff *isl_multi_aff_product(
3983                 __isl_take isl_multi_aff *ma1,
3984                 __isl_take isl_multi_aff *ma2);
3985         __isl_give isl_pw_multi_aff *
3986         isl_pw_multi_aff_range_product(
3987                 __isl_take isl_pw_multi_aff *pma1,
3988                 __isl_take isl_pw_multi_aff *pma2);
3989         __isl_give isl_pw_multi_aff *
3990         isl_pw_multi_aff_flat_range_product(
3991                 __isl_take isl_pw_multi_aff *pma1,
3992                 __isl_take isl_pw_multi_aff *pma2);
3993         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
3994                 __isl_take isl_pw_multi_aff *pma1,
3995                 __isl_take isl_pw_multi_aff *pma2);
3996         __isl_give isl_union_pw_multi_aff *
3997         isl_union_pw_multi_aff_flat_range_product(
3998                 __isl_take isl_union_pw_multi_aff *upma1,
3999                 __isl_take isl_union_pw_multi_aff *upma2);
4000         __isl_give isl_multi_pw_aff *
4001         isl_multi_pw_aff_range_splice(
4002                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4003                 __isl_take isl_multi_pw_aff *mpa2);
4004         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4005                 __isl_take isl_multi_pw_aff *mpa1,
4006                 unsigned in_pos, unsigned out_pos,
4007                 __isl_take isl_multi_pw_aff *mpa2);
4008         __isl_give isl_multi_pw_aff *
4009         isl_multi_pw_aff_range_product(
4010                 __isl_take isl_multi_pw_aff *mpa1,
4011                 __isl_take isl_multi_pw_aff *mpa2);
4012         __isl_give isl_multi_pw_aff *
4013         isl_multi_pw_aff_flat_range_product(
4014                 __isl_take isl_multi_pw_aff *mpa1,
4015                 __isl_take isl_multi_pw_aff *mpa2);
4017 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4018 then it is assigned the local space that lies at the basis of
4019 the lifting applied.
4021         #include <isl/aff.h>
4022         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4023                 __isl_take isl_multi_aff *ma1,
4024                 __isl_take isl_multi_aff *ma2);
4025         __isl_give isl_pw_multi_aff *
4026         isl_pw_multi_aff_pullback_multi_aff(
4027                 __isl_take isl_pw_multi_aff *pma,
4028                 __isl_take isl_multi_aff *ma);
4029         __isl_give isl_pw_multi_aff *
4030         isl_pw_multi_aff_pullback_pw_multi_aff(
4031                 __isl_take isl_pw_multi_aff *pma1,
4032                 __isl_take isl_pw_multi_aff *pma2);
4034 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4035 In other words, C<ma2> is plugged
4036 into C<ma1>.
4038         __isl_give isl_set *isl_multi_aff_lex_le_set(
4039                 __isl_take isl_multi_aff *ma1,
4040                 __isl_take isl_multi_aff *ma2);
4041         __isl_give isl_set *isl_multi_aff_lex_ge_set(
4042                 __isl_take isl_multi_aff *ma1,
4043                 __isl_take isl_multi_aff *ma2);
4045 The function C<isl_multi_aff_lex_le_set> returns a set
4046 containing those elements in the shared domain space
4047 where C<ma1> is lexicographically smaller than or
4048 equal to C<ma2>.
4050 An expression can be read from input using
4052         #include <isl/aff.h>
4053         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4054                 isl_ctx *ctx, const char *str);
4055         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4056                 isl_ctx *ctx, const char *str);
4057         __isl_give isl_union_pw_multi_aff *
4058         isl_union_pw_multi_aff_read_from_str(
4059                 isl_ctx *ctx, const char *str);
4061 An expression can be printed using
4063         #include <isl/aff.h>
4064         __isl_give isl_printer *isl_printer_print_multi_aff(
4065                 __isl_take isl_printer *p,
4066                 __isl_keep isl_multi_aff *maff);
4067         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4068                 __isl_take isl_printer *p,
4069                 __isl_keep isl_pw_multi_aff *pma);
4070         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4071                 __isl_take isl_printer *p,
4072                 __isl_keep isl_union_pw_multi_aff *upma);
4073         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4074                 __isl_take isl_printer *p,
4075                 __isl_keep isl_multi_pw_aff *mpa);
4077 =head2 Points
4079 Points are elements of a set.  They can be used to construct
4080 simple sets (boxes) or they can be used to represent the
4081 individual elements of a set.
4082 The zero point (the origin) can be created using
4084         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4086 The coordinates of a point can be inspected, set and changed
4087 using
4089         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
4090                 enum isl_dim_type type, int pos, isl_int *v);
4091         __isl_give isl_point *isl_point_set_coordinate(
4092                 __isl_take isl_point *pnt,
4093                 enum isl_dim_type type, int pos, isl_int v);
4095         __isl_give isl_point *isl_point_add_ui(
4096                 __isl_take isl_point *pnt,
4097                 enum isl_dim_type type, int pos, unsigned val);
4098         __isl_give isl_point *isl_point_sub_ui(
4099                 __isl_take isl_point *pnt,
4100                 enum isl_dim_type type, int pos, unsigned val);
4102 Other properties can be obtained using
4104         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4106 Points can be copied or freed using
4108         __isl_give isl_point *isl_point_copy(
4109                 __isl_keep isl_point *pnt);
4110         void isl_point_free(__isl_take isl_point *pnt);
4112 A singleton set can be created from a point using
4114         __isl_give isl_basic_set *isl_basic_set_from_point(
4115                 __isl_take isl_point *pnt);
4116         __isl_give isl_set *isl_set_from_point(
4117                 __isl_take isl_point *pnt);
4119 and a box can be created from two opposite extremal points using
4121         __isl_give isl_basic_set *isl_basic_set_box_from_points(
4122                 __isl_take isl_point *pnt1,
4123                 __isl_take isl_point *pnt2);
4124         __isl_give isl_set *isl_set_box_from_points(
4125                 __isl_take isl_point *pnt1,
4126                 __isl_take isl_point *pnt2);
4128 All elements of a B<bounded> (union) set can be enumerated using
4129 the following functions.
4131         int isl_set_foreach_point(__isl_keep isl_set *set,
4132                 int (*fn)(__isl_take isl_point *pnt, void *user),
4133                 void *user);
4134         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4135                 int (*fn)(__isl_take isl_point *pnt, void *user),
4136                 void *user);
4138 The function C<fn> is called for each integer point in
4139 C<set> with as second argument the last argument of
4140 the C<isl_set_foreach_point> call.  The function C<fn>
4141 should return C<0> on success and C<-1> on failure.
4142 In the latter case, C<isl_set_foreach_point> will stop
4143 enumerating and return C<-1> as well.
4144 If the enumeration is performed successfully and to completion,
4145 then C<isl_set_foreach_point> returns C<0>.
4147 To obtain a single point of a (basic) set, use
4149         __isl_give isl_point *isl_basic_set_sample_point(
4150                 __isl_take isl_basic_set *bset);
4151         __isl_give isl_point *isl_set_sample_point(
4152                 __isl_take isl_set *set);
4154 If C<set> does not contain any (integer) points, then the
4155 resulting point will be ``void'', a property that can be
4156 tested using
4158         int isl_point_is_void(__isl_keep isl_point *pnt);
4160 =head2 Piecewise Quasipolynomials
4162 A piecewise quasipolynomial is a particular kind of function that maps
4163 a parametric point to a rational value.
4164 More specifically, a quasipolynomial is a polynomial expression in greatest
4165 integer parts of affine expressions of parameters and variables.
4166 A piecewise quasipolynomial is a subdivision of a given parametric
4167 domain into disjoint cells with a quasipolynomial associated to
4168 each cell.  The value of the piecewise quasipolynomial at a given
4169 point is the value of the quasipolynomial associated to the cell
4170 that contains the point.  Outside of the union of cells,
4171 the value is assumed to be zero.
4172 For example, the piecewise quasipolynomial
4174         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4176 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4177 A given piecewise quasipolynomial has a fixed domain dimension.
4178 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4179 defined over different domains.
4180 Piecewise quasipolynomials are mainly used by the C<barvinok>
4181 library for representing the number of elements in a parametric set or map.
4182 For example, the piecewise quasipolynomial above represents
4183 the number of points in the map
4185         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4187 =head3 Input and Output
4189 Piecewise quasipolynomials can be read from input using
4191         __isl_give isl_union_pw_qpolynomial *
4192         isl_union_pw_qpolynomial_read_from_str(
4193                 isl_ctx *ctx, const char *str);
4195 Quasipolynomials and piecewise quasipolynomials can be printed
4196 using the following functions.
4198         __isl_give isl_printer *isl_printer_print_qpolynomial(
4199                 __isl_take isl_printer *p,
4200                 __isl_keep isl_qpolynomial *qp);
4202         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4203                 __isl_take isl_printer *p,
4204                 __isl_keep isl_pw_qpolynomial *pwqp);
4206         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4207                 __isl_take isl_printer *p,
4208                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4210 The output format of the printer
4211 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4212 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4213 is supported.
4214 In case of printing in C<ISL_FORMAT_C>, the user may want
4215 to set the names of all dimensions
4217         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4218                 __isl_take isl_qpolynomial *qp,
4219                 enum isl_dim_type type, unsigned pos,
4220                 const char *s);
4221         __isl_give isl_pw_qpolynomial *
4222         isl_pw_qpolynomial_set_dim_name(
4223                 __isl_take isl_pw_qpolynomial *pwqp,
4224                 enum isl_dim_type type, unsigned pos,
4225                 const char *s);
4227 =head3 Creating New (Piecewise) Quasipolynomials
4229 Some simple quasipolynomials can be created using the following functions.
4230 More complicated quasipolynomials can be created by applying
4231 operations such as addition and multiplication
4232 on the resulting quasipolynomials
4234         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4235                 __isl_take isl_space *domain);
4236         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4237                 __isl_take isl_space *domain);
4238         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4239                 __isl_take isl_space *domain);
4240         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4241                 __isl_take isl_space *domain);
4242         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4243                 __isl_take isl_space *domain);
4244         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4245                 __isl_take isl_space *domain,
4246                 const isl_int n, const isl_int d);
4247         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4248                 __isl_take isl_space *domain,
4249                 enum isl_dim_type type, unsigned pos);
4250         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4251                 __isl_take isl_aff *aff);
4253 Note that the space in which a quasipolynomial lives is a map space
4254 with a one-dimensional range.  The C<domain> argument in some of
4255 the functions above corresponds to the domain of this map space.
4257 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4258 with a single cell can be created using the following functions.
4259 Multiple of these single cell piecewise quasipolynomials can
4260 be combined to create more complicated piecewise quasipolynomials.
4262         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4263                 __isl_take isl_space *space);
4264         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4265                 __isl_take isl_set *set,
4266                 __isl_take isl_qpolynomial *qp);
4267         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4268                 __isl_take isl_qpolynomial *qp);
4269         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4270                 __isl_take isl_pw_aff *pwaff);
4272         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4273                 __isl_take isl_space *space);
4274         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4275                 __isl_take isl_pw_qpolynomial *pwqp);
4276         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4277                 __isl_take isl_union_pw_qpolynomial *upwqp,
4278                 __isl_take isl_pw_qpolynomial *pwqp);
4280 Quasipolynomials can be copied and freed again using the following
4281 functions.
4283         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4284                 __isl_keep isl_qpolynomial *qp);
4285         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4287         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4288                 __isl_keep isl_pw_qpolynomial *pwqp);
4289         void *isl_pw_qpolynomial_free(
4290                 __isl_take isl_pw_qpolynomial *pwqp);
4292         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4293                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4294         void *isl_union_pw_qpolynomial_free(
4295                 __isl_take isl_union_pw_qpolynomial *upwqp);
4297 =head3 Inspecting (Piecewise) Quasipolynomials
4299 To iterate over all piecewise quasipolynomials in a union
4300 piecewise quasipolynomial, use the following function
4302         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4303                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4304                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4305                 void *user);
4307 To extract the piecewise quasipolynomial in a given space from a union, use
4309         __isl_give isl_pw_qpolynomial *
4310         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4311                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4312                 __isl_take isl_space *space);
4314 To iterate over the cells in a piecewise quasipolynomial,
4315 use either of the following two functions
4317         int isl_pw_qpolynomial_foreach_piece(
4318                 __isl_keep isl_pw_qpolynomial *pwqp,
4319                 int (*fn)(__isl_take isl_set *set,
4320                           __isl_take isl_qpolynomial *qp,
4321                           void *user), void *user);
4322         int isl_pw_qpolynomial_foreach_lifted_piece(
4323                 __isl_keep isl_pw_qpolynomial *pwqp,
4324                 int (*fn)(__isl_take isl_set *set,
4325                           __isl_take isl_qpolynomial *qp,
4326                           void *user), void *user);
4328 As usual, the function C<fn> should return C<0> on success
4329 and C<-1> on failure.  The difference between
4330 C<isl_pw_qpolynomial_foreach_piece> and
4331 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4332 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4333 compute unique representations for all existentially quantified
4334 variables and then turn these existentially quantified variables
4335 into extra set variables, adapting the associated quasipolynomial
4336 accordingly.  This means that the C<set> passed to C<fn>
4337 will not have any existentially quantified variables, but that
4338 the dimensions of the sets may be different for different
4339 invocations of C<fn>.
4341 To iterate over all terms in a quasipolynomial,
4344         int isl_qpolynomial_foreach_term(
4345                 __isl_keep isl_qpolynomial *qp,
4346                 int (*fn)(__isl_take isl_term *term,
4347                           void *user), void *user);
4349 The terms themselves can be inspected and freed using
4350 these functions
4352         unsigned isl_term_dim(__isl_keep isl_term *term,
4353                 enum isl_dim_type type);
4354         void isl_term_get_num(__isl_keep isl_term *term,
4355                 isl_int *n);
4356         void isl_term_get_den(__isl_keep isl_term *term,
4357                 isl_int *d);
4358         int isl_term_get_exp(__isl_keep isl_term *term,
4359                 enum isl_dim_type type, unsigned pos);
4360         __isl_give isl_aff *isl_term_get_div(
4361                 __isl_keep isl_term *term, unsigned pos);
4362         void isl_term_free(__isl_take isl_term *term);
4364 Each term is a product of parameters, set variables and
4365 integer divisions.  The function C<isl_term_get_exp>
4366 returns the exponent of a given dimensions in the given term.
4367 The C<isl_int>s in the arguments of C<isl_term_get_num>
4368 and C<isl_term_get_den> need to have been initialized
4369 using C<isl_int_init> before calling these functions.
4371 =head3 Properties of (Piecewise) Quasipolynomials
4373 To check whether a quasipolynomial is actually a constant,
4374 use the following function.
4376         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4377                 isl_int *n, isl_int *d);
4379 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4380 then the numerator and denominator of the constant
4381 are returned in C<*n> and C<*d>, respectively.
4383 To check whether two union piecewise quasipolynomials are
4384 obviously equal, use
4386         int isl_union_pw_qpolynomial_plain_is_equal(
4387                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4388                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4390 =head3 Operations on (Piecewise) Quasipolynomials
4392         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4393                 __isl_take isl_qpolynomial *qp, isl_int v);
4394         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4395                 __isl_take isl_qpolynomial *qp);
4396         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4397                 __isl_take isl_qpolynomial *qp1,
4398                 __isl_take isl_qpolynomial *qp2);
4399         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4400                 __isl_take isl_qpolynomial *qp1,
4401                 __isl_take isl_qpolynomial *qp2);
4402         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4403                 __isl_take isl_qpolynomial *qp1,
4404                 __isl_take isl_qpolynomial *qp2);
4405         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4406                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4408         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4409                 __isl_take isl_pw_qpolynomial *pwqp1,
4410                 __isl_take isl_pw_qpolynomial *pwqp2);
4411         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4412                 __isl_take isl_pw_qpolynomial *pwqp1,
4413                 __isl_take isl_pw_qpolynomial *pwqp2);
4414         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4415                 __isl_take isl_pw_qpolynomial *pwqp1,
4416                 __isl_take isl_pw_qpolynomial *pwqp2);
4417         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4418                 __isl_take isl_pw_qpolynomial *pwqp);
4419         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4420                 __isl_take isl_pw_qpolynomial *pwqp1,
4421                 __isl_take isl_pw_qpolynomial *pwqp2);
4422         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4423                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4425         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4426                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4427                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4428         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4429                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4430                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4431         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4432                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4433                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4435         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4436                 __isl_take isl_pw_qpolynomial *pwqp,
4437                 __isl_take isl_point *pnt);
4439         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4440                 __isl_take isl_union_pw_qpolynomial *upwqp,
4441                 __isl_take isl_point *pnt);
4443         __isl_give isl_set *isl_pw_qpolynomial_domain(
4444                 __isl_take isl_pw_qpolynomial *pwqp);
4445         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4446                 __isl_take isl_pw_qpolynomial *pwpq,
4447                 __isl_take isl_set *set);
4448         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4449                 __isl_take isl_pw_qpolynomial *pwpq,
4450                 __isl_take isl_set *set);
4452         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4453                 __isl_take isl_union_pw_qpolynomial *upwqp);
4454         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4455                 __isl_take isl_union_pw_qpolynomial *upwpq,
4456                 __isl_take isl_union_set *uset);
4457         __isl_give isl_union_pw_qpolynomial *
4458         isl_union_pw_qpolynomial_intersect_params(
4459                 __isl_take isl_union_pw_qpolynomial *upwpq,
4460                 __isl_take isl_set *set);
4462         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4463                 __isl_take isl_qpolynomial *qp,
4464                 __isl_take isl_space *model);
4466         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4467                 __isl_take isl_qpolynomial *qp);
4468         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4469                 __isl_take isl_pw_qpolynomial *pwqp);
4471         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4472                 __isl_take isl_union_pw_qpolynomial *upwqp);
4474         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4475                 __isl_take isl_qpolynomial *qp,
4476                 __isl_take isl_set *context);
4477         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4478                 __isl_take isl_qpolynomial *qp,
4479                 __isl_take isl_set *context);
4481         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4482                 __isl_take isl_pw_qpolynomial *pwqp,
4483                 __isl_take isl_set *context);
4484         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4485                 __isl_take isl_pw_qpolynomial *pwqp,
4486                 __isl_take isl_set *context);
4488         __isl_give isl_union_pw_qpolynomial *
4489         isl_union_pw_qpolynomial_gist_params(
4490                 __isl_take isl_union_pw_qpolynomial *upwqp,
4491                 __isl_take isl_set *context);
4492         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4493                 __isl_take isl_union_pw_qpolynomial *upwqp,
4494                 __isl_take isl_union_set *context);
4496 The gist operation applies the gist operation to each of
4497 the cells in the domain of the input piecewise quasipolynomial.
4498 The context is also exploited
4499 to simplify the quasipolynomials associated to each cell.
4501         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4502                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4503         __isl_give isl_union_pw_qpolynomial *
4504         isl_union_pw_qpolynomial_to_polynomial(
4505                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4507 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4508 the polynomial will be an overapproximation.  If C<sign> is negative,
4509 it will be an underapproximation.  If C<sign> is zero, the approximation
4510 will lie somewhere in between.
4512 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4514 A piecewise quasipolynomial reduction is a piecewise
4515 reduction (or fold) of quasipolynomials.
4516 In particular, the reduction can be maximum or a minimum.
4517 The objects are mainly used to represent the result of
4518 an upper or lower bound on a quasipolynomial over its domain,
4519 i.e., as the result of the following function.
4521         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4522                 __isl_take isl_pw_qpolynomial *pwqp,
4523                 enum isl_fold type, int *tight);
4525         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4526                 __isl_take isl_union_pw_qpolynomial *upwqp,
4527                 enum isl_fold type, int *tight);
4529 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4530 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4531 is the returned bound is known be tight, i.e., for each value
4532 of the parameters there is at least
4533 one element in the domain that reaches the bound.
4534 If the domain of C<pwqp> is not wrapping, then the bound is computed
4535 over all elements in that domain and the result has a purely parametric
4536 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4537 computed over the range of the wrapped relation.  The domain of the
4538 wrapped relation becomes the domain of the result.
4540 A (piecewise) quasipolynomial reduction can be copied or freed using the
4541 following functions.
4543         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4544                 __isl_keep isl_qpolynomial_fold *fold);
4545         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4546                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4547         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4548                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4549         void isl_qpolynomial_fold_free(
4550                 __isl_take isl_qpolynomial_fold *fold);
4551         void *isl_pw_qpolynomial_fold_free(
4552                 __isl_take isl_pw_qpolynomial_fold *pwf);
4553         void *isl_union_pw_qpolynomial_fold_free(
4554                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4556 =head3 Printing Piecewise Quasipolynomial Reductions
4558 Piecewise quasipolynomial reductions can be printed
4559 using the following function.
4561         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4562                 __isl_take isl_printer *p,
4563                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4564         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4565                 __isl_take isl_printer *p,
4566                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4568 For C<isl_printer_print_pw_qpolynomial_fold>,
4569 output format of the printer
4570 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4571 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4572 output format of the printer
4573 needs to be set to C<ISL_FORMAT_ISL>.
4574 In case of printing in C<ISL_FORMAT_C>, the user may want
4575 to set the names of all dimensions
4577         __isl_give isl_pw_qpolynomial_fold *
4578         isl_pw_qpolynomial_fold_set_dim_name(
4579                 __isl_take isl_pw_qpolynomial_fold *pwf,
4580                 enum isl_dim_type type, unsigned pos,
4581                 const char *s);
4583 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4585 To iterate over all piecewise quasipolynomial reductions in a union
4586 piecewise quasipolynomial reduction, use the following function
4588         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4589                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4590                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4591                             void *user), void *user);
4593 To iterate over the cells in a piecewise quasipolynomial reduction,
4594 use either of the following two functions
4596         int isl_pw_qpolynomial_fold_foreach_piece(
4597                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4598                 int (*fn)(__isl_take isl_set *set,
4599                           __isl_take isl_qpolynomial_fold *fold,
4600                           void *user), void *user);
4601         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4602                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4603                 int (*fn)(__isl_take isl_set *set,
4604                           __isl_take isl_qpolynomial_fold *fold,
4605                           void *user), void *user);
4607 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4608 of the difference between these two functions.
4610 To iterate over all quasipolynomials in a reduction, use
4612         int isl_qpolynomial_fold_foreach_qpolynomial(
4613                 __isl_keep isl_qpolynomial_fold *fold,
4614                 int (*fn)(__isl_take isl_qpolynomial *qp,
4615                           void *user), void *user);
4617 =head3 Properties of Piecewise Quasipolynomial Reductions
4619 To check whether two union piecewise quasipolynomial reductions are
4620 obviously equal, use
4622         int isl_union_pw_qpolynomial_fold_plain_is_equal(
4623                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4624                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4626 =head3 Operations on Piecewise Quasipolynomial Reductions
4628         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4629                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4631         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4632                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4633                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4635         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4636                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4637                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4639         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4640                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4641                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4643         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4644                 __isl_take isl_pw_qpolynomial_fold *pwf,
4645                 __isl_take isl_point *pnt);
4647         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4648                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4649                 __isl_take isl_point *pnt);
4651         __isl_give isl_pw_qpolynomial_fold *
4652         isl_pw_qpolynomial_fold_intersect_params(
4653                 __isl_take isl_pw_qpolynomial_fold *pwf,
4654                 __isl_take isl_set *set);
4656         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4657                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4658         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4659                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4660                 __isl_take isl_union_set *uset);
4661         __isl_give isl_union_pw_qpolynomial_fold *
4662         isl_union_pw_qpolynomial_fold_intersect_params(
4663                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4664                 __isl_take isl_set *set);
4666         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4667                 __isl_take isl_pw_qpolynomial_fold *pwf);
4669         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4670                 __isl_take isl_pw_qpolynomial_fold *pwf);
4672         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4673                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4675         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4676                 __isl_take isl_qpolynomial_fold *fold,
4677                 __isl_take isl_set *context);
4678         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4679                 __isl_take isl_qpolynomial_fold *fold,
4680                 __isl_take isl_set *context);
4682         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4683                 __isl_take isl_pw_qpolynomial_fold *pwf,
4684                 __isl_take isl_set *context);
4685         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4686                 __isl_take isl_pw_qpolynomial_fold *pwf,
4687                 __isl_take isl_set *context);
4689         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4690                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4691                 __isl_take isl_union_set *context);
4692         __isl_give isl_union_pw_qpolynomial_fold *
4693         isl_union_pw_qpolynomial_fold_gist_params(
4694                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4695                 __isl_take isl_set *context);
4697 The gist operation applies the gist operation to each of
4698 the cells in the domain of the input piecewise quasipolynomial reduction.
4699 In future, the operation will also exploit the context
4700 to simplify the quasipolynomial reductions associated to each cell.
4702         __isl_give isl_pw_qpolynomial_fold *
4703         isl_set_apply_pw_qpolynomial_fold(
4704                 __isl_take isl_set *set,
4705                 __isl_take isl_pw_qpolynomial_fold *pwf,
4706                 int *tight);
4707         __isl_give isl_pw_qpolynomial_fold *
4708         isl_map_apply_pw_qpolynomial_fold(
4709                 __isl_take isl_map *map,
4710                 __isl_take isl_pw_qpolynomial_fold *pwf,
4711                 int *tight);
4712         __isl_give isl_union_pw_qpolynomial_fold *
4713         isl_union_set_apply_union_pw_qpolynomial_fold(
4714                 __isl_take isl_union_set *uset,
4715                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4716                 int *tight);
4717         __isl_give isl_union_pw_qpolynomial_fold *
4718         isl_union_map_apply_union_pw_qpolynomial_fold(
4719                 __isl_take isl_union_map *umap,
4720                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4721                 int *tight);
4723 The functions taking a map
4724 compose the given map with the given piecewise quasipolynomial reduction.
4725 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
4726 over all elements in the intersection of the range of the map
4727 and the domain of the piecewise quasipolynomial reduction
4728 as a function of an element in the domain of the map.
4729 The functions taking a set compute a bound over all elements in the
4730 intersection of the set and the domain of the
4731 piecewise quasipolynomial reduction.
4733 =head2 Parametric Vertex Enumeration
4735 The parametric vertex enumeration described in this section
4736 is mainly intended to be used internally and by the C<barvinok>
4737 library.
4739         #include <isl/vertices.h>
4740         __isl_give isl_vertices *isl_basic_set_compute_vertices(
4741                 __isl_keep isl_basic_set *bset);
4743 The function C<isl_basic_set_compute_vertices> performs the
4744 actual computation of the parametric vertices and the chamber
4745 decomposition and store the result in an C<isl_vertices> object.
4746 This information can be queried by either iterating over all
4747 the vertices or iterating over all the chambers or cells
4748 and then iterating over all vertices that are active on the chamber.
4750         int isl_vertices_foreach_vertex(
4751                 __isl_keep isl_vertices *vertices,
4752                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4753                 void *user);
4755         int isl_vertices_foreach_cell(
4756                 __isl_keep isl_vertices *vertices,
4757                 int (*fn)(__isl_take isl_cell *cell, void *user),
4758                 void *user);
4759         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
4760                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4761                 void *user);
4763 Other operations that can be performed on an C<isl_vertices> object are
4764 the following.
4766         isl_ctx *isl_vertices_get_ctx(
4767                 __isl_keep isl_vertices *vertices);
4768         int isl_vertices_get_n_vertices(
4769                 __isl_keep isl_vertices *vertices);
4770         void isl_vertices_free(__isl_take isl_vertices *vertices);
4772 Vertices can be inspected and destroyed using the following functions.
4774         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
4775         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
4776         __isl_give isl_basic_set *isl_vertex_get_domain(
4777                 __isl_keep isl_vertex *vertex);
4778         __isl_give isl_basic_set *isl_vertex_get_expr(
4779                 __isl_keep isl_vertex *vertex);
4780         void isl_vertex_free(__isl_take isl_vertex *vertex);
4782 C<isl_vertex_get_expr> returns a singleton parametric set describing
4783 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4784 of the vertex.
4785 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4786 B<rational> basic sets, so they should mainly be used for inspection
4787 and should not be mixed with integer sets.
4789 Chambers can be inspected and destroyed using the following functions.
4791         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4792         __isl_give isl_basic_set *isl_cell_get_domain(
4793                 __isl_keep isl_cell *cell);
4794         void isl_cell_free(__isl_take isl_cell *cell);
4796 =head1 Polyhedral Compilation Library
4798 This section collects functionality in C<isl> that has been specifically
4799 designed for use during polyhedral compilation.
4801 =head2 Dependence Analysis
4803 C<isl> contains specialized functionality for performing
4804 array dataflow analysis.  That is, given a I<sink> access relation
4805 and a collection of possible I<source> access relations,
4806 C<isl> can compute relations that describe
4807 for each iteration of the sink access, which iteration
4808 of which of the source access relations was the last
4809 to access the same data element before the given iteration
4810 of the sink access.
4811 The resulting dependence relations map source iterations
4812 to the corresponding sink iterations.
4813 To compute standard flow dependences, the sink should be
4814 a read, while the sources should be writes.
4815 If any of the source accesses are marked as being I<may>
4816 accesses, then there will be a dependence from the last
4817 I<must> access B<and> from any I<may> access that follows
4818 this last I<must> access.
4819 In particular, if I<all> sources are I<may> accesses,
4820 then memory based dependence analysis is performed.
4821 If, on the other hand, all sources are I<must> accesses,
4822 then value based dependence analysis is performed.
4824         #include <isl/flow.h>
4826         typedef int (*isl_access_level_before)(void *first, void *second);
4828         __isl_give isl_access_info *isl_access_info_alloc(
4829                 __isl_take isl_map *sink,
4830                 void *sink_user, isl_access_level_before fn,
4831                 int max_source);
4832         __isl_give isl_access_info *isl_access_info_add_source(
4833                 __isl_take isl_access_info *acc,
4834                 __isl_take isl_map *source, int must,
4835                 void *source_user);
4836         void *isl_access_info_free(__isl_take isl_access_info *acc);
4838         __isl_give isl_flow *isl_access_info_compute_flow(
4839                 __isl_take isl_access_info *acc);
4841         int isl_flow_foreach(__isl_keep isl_flow *deps,
4842                 int (*fn)(__isl_take isl_map *dep, int must,
4843                           void *dep_user, void *user),
4844                 void *user);
4845         __isl_give isl_map *isl_flow_get_no_source(
4846                 __isl_keep isl_flow *deps, int must);
4847         void isl_flow_free(__isl_take isl_flow *deps);
4849 The function C<isl_access_info_compute_flow> performs the actual
4850 dependence analysis.  The other functions are used to construct
4851 the input for this function or to read off the output.
4853 The input is collected in an C<isl_access_info>, which can
4854 be created through a call to C<isl_access_info_alloc>.
4855 The arguments to this functions are the sink access relation
4856 C<sink>, a token C<sink_user> used to identify the sink
4857 access to the user, a callback function for specifying the
4858 relative order of source and sink accesses, and the number
4859 of source access relations that will be added.
4860 The callback function has type C<int (*)(void *first, void *second)>.
4861 The function is called with two user supplied tokens identifying
4862 either a source or the sink and it should return the shared nesting
4863 level and the relative order of the two accesses.
4864 In particular, let I<n> be the number of loops shared by
4865 the two accesses.  If C<first> precedes C<second> textually,
4866 then the function should return I<2 * n + 1>; otherwise,
4867 it should return I<2 * n>.
4868 The sources can be added to the C<isl_access_info> by performing
4869 (at most) C<max_source> calls to C<isl_access_info_add_source>.
4870 C<must> indicates whether the source is a I<must> access
4871 or a I<may> access.  Note that a multi-valued access relation
4872 should only be marked I<must> if every iteration in the domain
4873 of the relation accesses I<all> elements in its image.
4874 The C<source_user> token is again used to identify
4875 the source access.  The range of the source access relation
4876 C<source> should have the same dimension as the range
4877 of the sink access relation.
4878 The C<isl_access_info_free> function should usually not be
4879 called explicitly, because it is called implicitly by
4880 C<isl_access_info_compute_flow>.
4882 The result of the dependence analysis is collected in an
4883 C<isl_flow>.  There may be elements of
4884 the sink access for which no preceding source access could be
4885 found or for which all preceding sources are I<may> accesses.
4886 The relations containing these elements can be obtained through
4887 calls to C<isl_flow_get_no_source>, the first with C<must> set
4888 and the second with C<must> unset.
4889 In the case of standard flow dependence analysis,
4890 with the sink a read and the sources I<must> writes,
4891 the first relation corresponds to the reads from uninitialized
4892 array elements and the second relation is empty.
4893 The actual flow dependences can be extracted using
4894 C<isl_flow_foreach>.  This function will call the user-specified
4895 callback function C<fn> for each B<non-empty> dependence between
4896 a source and the sink.  The callback function is called
4897 with four arguments, the actual flow dependence relation
4898 mapping source iterations to sink iterations, a boolean that
4899 indicates whether it is a I<must> or I<may> dependence, a token
4900 identifying the source and an additional C<void *> with value
4901 equal to the third argument of the C<isl_flow_foreach> call.
4902 A dependence is marked I<must> if it originates from a I<must>
4903 source and if it is not followed by any I<may> sources.
4905 After finishing with an C<isl_flow>, the user should call
4906 C<isl_flow_free> to free all associated memory.
4908 A higher-level interface to dependence analysis is provided
4909 by the following function.
4911         #include <isl/flow.h>
4913         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
4914                 __isl_take isl_union_map *must_source,
4915                 __isl_take isl_union_map *may_source,
4916                 __isl_take isl_union_map *schedule,
4917                 __isl_give isl_union_map **must_dep,
4918                 __isl_give isl_union_map **may_dep,
4919                 __isl_give isl_union_map **must_no_source,
4920                 __isl_give isl_union_map **may_no_source);
4922 The arrays are identified by the tuple names of the ranges
4923 of the accesses.  The iteration domains by the tuple names
4924 of the domains of the accesses and of the schedule.
4925 The relative order of the iteration domains is given by the
4926 schedule.  The relations returned through C<must_no_source>
4927 and C<may_no_source> are subsets of C<sink>.
4928 Any of C<must_dep>, C<may_dep>, C<must_no_source>
4929 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
4930 any of the other arguments is treated as an error.
4932 =head3 Interaction with Dependence Analysis
4934 During the dependence analysis, we frequently need to perform
4935 the following operation.  Given a relation between sink iterations
4936 and potential source iterations from a particular source domain,
4937 what is the last potential source iteration corresponding to each
4938 sink iteration.  It can sometimes be convenient to adjust
4939 the set of potential source iterations before or after each such operation.
4940 The prototypical example is fuzzy array dataflow analysis,
4941 where we need to analyze if, based on data-dependent constraints,
4942 the sink iteration can ever be executed without one or more of
4943 the corresponding potential source iterations being executed.
4944 If so, we can introduce extra parameters and select an unknown
4945 but fixed source iteration from the potential source iterations.
4946 To be able to perform such manipulations, C<isl> provides the following
4947 function.
4949         #include <isl/flow.h>
4951         typedef __isl_give isl_restriction *(*isl_access_restrict)(
4952                 __isl_keep isl_map *source_map,
4953                 __isl_keep isl_set *sink, void *source_user,
4954                 void *user);
4955         __isl_give isl_access_info *isl_access_info_set_restrict(
4956                 __isl_take isl_access_info *acc,
4957                 isl_access_restrict fn, void *user);
4959 The function C<isl_access_info_set_restrict> should be called
4960 before calling C<isl_access_info_compute_flow> and registers a callback function
4961 that will be called any time C<isl> is about to compute the last
4962 potential source.  The first argument is the (reverse) proto-dependence,
4963 mapping sink iterations to potential source iterations.
4964 The second argument represents the sink iterations for which
4965 we want to compute the last source iteration.
4966 The third argument is the token corresponding to the source
4967 and the final argument is the token passed to C<isl_access_info_set_restrict>.
4968 The callback is expected to return a restriction on either the input or
4969 the output of the operation computing the last potential source.
4970 If the input needs to be restricted then restrictions are needed
4971 for both the source and the sink iterations.  The sink iterations
4972 and the potential source iterations will be intersected with these sets.
4973 If the output needs to be restricted then only a restriction on the source
4974 iterations is required.
4975 If any error occurs, the callback should return C<NULL>.
4976 An C<isl_restriction> object can be created, freed and inspected
4977 using the following functions.
4979         #include <isl/flow.h>
4981         __isl_give isl_restriction *isl_restriction_input(
4982                 __isl_take isl_set *source_restr,
4983                 __isl_take isl_set *sink_restr);
4984         __isl_give isl_restriction *isl_restriction_output(
4985                 __isl_take isl_set *source_restr);
4986         __isl_give isl_restriction *isl_restriction_none(
4987                 __isl_take isl_map *source_map);
4988         __isl_give isl_restriction *isl_restriction_empty(
4989                 __isl_take isl_map *source_map);
4990         void *isl_restriction_free(
4991                 __isl_take isl_restriction *restr);
4992         isl_ctx *isl_restriction_get_ctx(
4993                 __isl_keep isl_restriction *restr);
4995 C<isl_restriction_none> and C<isl_restriction_empty> are special
4996 cases of C<isl_restriction_input>.  C<isl_restriction_none>
4997 is essentially equivalent to
4999         isl_restriction_input(isl_set_universe(
5000             isl_space_range(isl_map_get_space(source_map))),
5001                             isl_set_universe(
5002             isl_space_domain(isl_map_get_space(source_map))));
5004 whereas C<isl_restriction_empty> is essentially equivalent to
5006         isl_restriction_input(isl_set_empty(
5007             isl_space_range(isl_map_get_space(source_map))),
5008                             isl_set_universe(
5009             isl_space_domain(isl_map_get_space(source_map))));
5011 =head2 Scheduling
5013 B<The functionality described in this section is fairly new
5014 and may be subject to change.>
5016 The following function can be used to compute a schedule
5017 for a union of domains.
5018 By default, the algorithm used to construct the schedule is similar
5019 to that of C<Pluto>.
5020 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5021 be selected.
5022 The generated schedule respects all C<validity> dependences.
5023 That is, all dependence distances over these dependences in the
5024 scheduled space are lexicographically positive.
5025 The default algorithm tries to minimize the dependence distances over
5026 C<proximity> dependences.
5027 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5028 for groups of domains where the dependence distances have only
5029 non-negative values.
5030 When using Feautrier's algorithm, the C<proximity> dependence
5031 distances are only minimized during the extension to a
5032 full-dimensional schedule.
5034         #include <isl/schedule.h>
5035         __isl_give isl_schedule *isl_union_set_compute_schedule(
5036                 __isl_take isl_union_set *domain,
5037                 __isl_take isl_union_map *validity,
5038                 __isl_take isl_union_map *proximity);
5039         void *isl_schedule_free(__isl_take isl_schedule *sched);
5041 A mapping from the domains to the scheduled space can be obtained
5042 from an C<isl_schedule> using the following function.
5044         __isl_give isl_union_map *isl_schedule_get_map(
5045                 __isl_keep isl_schedule *sched);
5047 A representation of the schedule can be printed using
5048          
5049         __isl_give isl_printer *isl_printer_print_schedule(
5050                 __isl_take isl_printer *p,
5051                 __isl_keep isl_schedule *schedule);
5053 A representation of the schedule as a forest of bands can be obtained
5054 using the following function.
5056         __isl_give isl_band_list *isl_schedule_get_band_forest(
5057                 __isl_keep isl_schedule *schedule);
5059 The individual bands can be visited in depth-first post-order
5060 using the following function.
5062         #include <isl/schedule.h>
5063         int isl_schedule_foreach_band(
5064                 __isl_keep isl_schedule *sched,
5065                 int (*fn)(__isl_keep isl_band *band, void *user),
5066                 void *user);
5068 The list can be manipulated as explained in L<"Lists">.
5069 The bands inside the list can be copied and freed using the following
5070 functions.
5072         #include <isl/band.h>
5073         __isl_give isl_band *isl_band_copy(
5074                 __isl_keep isl_band *band);
5075         void *isl_band_free(__isl_take isl_band *band);
5077 Each band contains zero or more scheduling dimensions.
5078 These are referred to as the members of the band.
5079 The section of the schedule that corresponds to the band is
5080 referred to as the partial schedule of the band.
5081 For those nodes that participate in a band, the outer scheduling
5082 dimensions form the prefix schedule, while the inner scheduling
5083 dimensions form the suffix schedule.
5084 That is, if we take a cut of the band forest, then the union of
5085 the concatenations of the prefix, partial and suffix schedules of
5086 each band in the cut is equal to the entire schedule (modulo
5087 some possible padding at the end with zero scheduling dimensions).
5088 The properties of a band can be inspected using the following functions.
5090         #include <isl/band.h>
5091         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5093         int isl_band_has_children(__isl_keep isl_band *band);
5094         __isl_give isl_band_list *isl_band_get_children(
5095                 __isl_keep isl_band *band);
5097         __isl_give isl_union_map *isl_band_get_prefix_schedule(
5098                 __isl_keep isl_band *band);
5099         __isl_give isl_union_map *isl_band_get_partial_schedule(
5100                 __isl_keep isl_band *band);
5101         __isl_give isl_union_map *isl_band_get_suffix_schedule(
5102                 __isl_keep isl_band *band);
5104         int isl_band_n_member(__isl_keep isl_band *band);
5105         int isl_band_member_is_zero_distance(
5106                 __isl_keep isl_band *band, int pos);
5108         int isl_band_list_foreach_band(
5109                 __isl_keep isl_band_list *list,
5110                 int (*fn)(__isl_keep isl_band *band, void *user),
5111                 void *user);
5113 Note that a scheduling dimension is considered to be ``zero
5114 distance'' if it does not carry any proximity dependences
5115 within its band.
5116 That is, if the dependence distances of the proximity
5117 dependences are all zero in that direction (for fixed
5118 iterations of outer bands).
5119 Like C<isl_schedule_foreach_band>,
5120 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5121 in depth-first post-order.
5123 A band can be tiled using the following function.
5125         #include <isl/band.h>
5126         int isl_band_tile(__isl_keep isl_band *band,
5127                 __isl_take isl_vec *sizes);
5129         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5130                 int val);
5131         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5132         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5133                 int val);
5134         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5136 The C<isl_band_tile> function tiles the band using the given tile sizes
5137 inside its schedule.
5138 A new child band is created to represent the point loops and it is
5139 inserted between the modified band and its children.
5140 The C<tile_scale_tile_loops> option specifies whether the tile
5141 loops iterators should be scaled by the tile sizes.
5142 If the C<tile_shift_point_loops> option is set, then the point loops
5143 are shifted to start at zero.
5145 A band can be split into two nested bands using the following function.
5147         int isl_band_split(__isl_keep isl_band *band, int pos);
5149 The resulting outer band contains the first C<pos> dimensions of C<band>
5150 while the inner band contains the remaining dimensions.
5152 A representation of the band can be printed using
5154         #include <isl/band.h>
5155         __isl_give isl_printer *isl_printer_print_band(
5156                 __isl_take isl_printer *p,
5157                 __isl_keep isl_band *band);
5159 =head3 Options
5161         #include <isl/schedule.h>
5162         int isl_options_set_schedule_max_coefficient(
5163                 isl_ctx *ctx, int val);
5164         int isl_options_get_schedule_max_coefficient(
5165                 isl_ctx *ctx);
5166         int isl_options_set_schedule_max_constant_term(
5167                 isl_ctx *ctx, int val);
5168         int isl_options_get_schedule_max_constant_term(
5169                 isl_ctx *ctx);
5170         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5171         int isl_options_get_schedule_fuse(isl_ctx *ctx);
5172         int isl_options_set_schedule_maximize_band_depth(
5173                 isl_ctx *ctx, int val);
5174         int isl_options_get_schedule_maximize_band_depth(
5175                 isl_ctx *ctx);
5176         int isl_options_set_schedule_outer_zero_distance(
5177                 isl_ctx *ctx, int val);
5178         int isl_options_get_schedule_outer_zero_distance(
5179                 isl_ctx *ctx);
5180         int isl_options_set_schedule_split_scaled(
5181                 isl_ctx *ctx, int val);
5182         int isl_options_get_schedule_split_scaled(
5183                 isl_ctx *ctx);
5184         int isl_options_set_schedule_algorithm(
5185                 isl_ctx *ctx, int val);
5186         int isl_options_get_schedule_algorithm(
5187                 isl_ctx *ctx);
5188         int isl_options_set_schedule_separate_components(
5189                 isl_ctx *ctx, int val);
5190         int isl_options_get_schedule_separate_components(
5191                 isl_ctx *ctx);
5193 =over
5195 =item * schedule_max_coefficient
5197 This option enforces that the coefficients for variable and parameter
5198 dimensions in the calculated schedule are not larger than the specified value.
5199 This option can significantly increase the speed of the scheduling calculation
5200 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5201 this option does not introduce bounds on the variable or parameter
5202 coefficients.
5204 =item * schedule_max_constant_term
5206 This option enforces that the constant coefficients in the calculated schedule
5207 are not larger than the maximal constant term. This option can significantly
5208 increase the speed of the scheduling calculation and may also prevent fusing of
5209 unrelated dimensions. A value of -1 means that this option does not introduce
5210 bounds on the constant coefficients.
5212 =item * schedule_fuse
5214 This option controls the level of fusion.
5215 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5216 resulting schedule will be distributed as much as possible.
5217 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5218 try to fuse loops in the resulting schedule.
5220 =item * schedule_maximize_band_depth
5222 If this option is set, we do not split bands at the point
5223 where we detect splitting is necessary. Instead, we
5224 backtrack and split bands as early as possible. This
5225 reduces the number of splits and maximizes the width of
5226 the bands. Wider bands give more possibilities for tiling.
5227 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5228 then bands will be split as early as possible, even if there is no need.
5229 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5231 =item * schedule_outer_zero_distance
5233 If this option is set, then we try to construct schedules
5234 where the outermost scheduling dimension in each band
5235 results in a zero dependence distance over the proximity
5236 dependences.
5238 =item * schedule_split_scaled
5240 If this option is set, then we try to construct schedules in which the
5241 constant term is split off from the linear part if the linear parts of
5242 the scheduling rows for all nodes in the graphs have a common non-trivial
5243 divisor.
5244 The constant term is then placed in a separate band and the linear
5245 part is reduced.
5247 =item * schedule_algorithm
5249 Selects the scheduling algorithm to be used.
5250 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5251 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5253 =item * schedule_separate_components
5255 If at any point the dependence graph contains any (weakly connected) components,
5256 then these components are scheduled separately.
5257 If this option is not set, then some iterations of the domains
5258 in these components may be scheduled together.
5259 If this option is set, then the components are given consecutive
5260 schedules.
5262 =back
5264 =head2 AST Generation
5266 This section describes the C<isl> functionality for generating
5267 ASTs that visit all the elements
5268 in a domain in an order specified by a schedule.
5269 In particular, given a C<isl_union_map>, an AST is generated
5270 that visits all the elements in the domain of the C<isl_union_map>
5271 according to the lexicographic order of the corresponding image
5272 element(s).  If the range of the C<isl_union_map> consists of
5273 elements in more than one space, then each of these spaces is handled
5274 separately in an arbitrary order.
5275 It should be noted that the image elements only specify the I<order>
5276 in which the corresponding domain elements should be visited.
5277 No direct relation between the image elements and the loop iterators
5278 in the generated AST should be assumed.
5280 Each AST is generated within a build.  The initial build
5281 simply specifies the constraints on the parameters (if any)
5282 and can be created, inspected, copied and freed using the following functions.
5284         #include <isl/ast_build.h>
5285         __isl_give isl_ast_build *isl_ast_build_from_context(
5286                 __isl_take isl_set *set);
5287         isl_ctx *isl_ast_build_get_ctx(
5288                 __isl_keep isl_ast_build *build);
5289         __isl_give isl_ast_build *isl_ast_build_copy(
5290                 __isl_keep isl_ast_build *build);
5291         void *isl_ast_build_free(
5292                 __isl_take isl_ast_build *build);
5294 The C<set> argument is usually a parameter set with zero or more parameters.
5295 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5296 and L</"Fine-grained Control over AST Generation">.
5297 Finally, the AST itself can be constructed using the following
5298 function.
5300         #include <isl/ast_build.h>
5301         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5302                 __isl_keep isl_ast_build *build,
5303                 __isl_take isl_union_map *schedule);
5305 =head3 Inspecting the AST
5307 The basic properties of an AST node can be obtained as follows.
5309         #include <isl/ast.h>
5310         isl_ctx *isl_ast_node_get_ctx(
5311                 __isl_keep isl_ast_node *node);
5312         enum isl_ast_node_type isl_ast_node_get_type(
5313                 __isl_keep isl_ast_node *node);
5315 The type of an AST node is one of
5316 C<isl_ast_node_for>,
5317 C<isl_ast_node_if>,
5318 C<isl_ast_node_block> or
5319 C<isl_ast_node_user>.
5320 An C<isl_ast_node_for> represents a for node.
5321 An C<isl_ast_node_if> represents an if node.
5322 An C<isl_ast_node_block> represents a compound node.
5323 An C<isl_ast_node_user> represents an expression statement.
5324 An expression statement typically corresponds to a domain element, i.e.,
5325 one of the elements that is visited by the AST.
5327 Each type of node has its own additional properties.
5329         #include <isl/ast.h>
5330         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5331                 __isl_keep isl_ast_node *node);
5332         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5333                 __isl_keep isl_ast_node *node);
5334         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5335                 __isl_keep isl_ast_node *node);
5336         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5337                 __isl_keep isl_ast_node *node);
5338         __isl_give isl_ast_node *isl_ast_node_for_get_body(
5339                 __isl_keep isl_ast_node *node);
5340         int isl_ast_node_for_is_degenerate(
5341                 __isl_keep isl_ast_node *node);
5343 An C<isl_ast_for> is considered degenerate if it is known to execute
5344 exactly once.
5346         #include <isl/ast.h>
5347         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5348                 __isl_keep isl_ast_node *node);
5349         __isl_give isl_ast_node *isl_ast_node_if_get_then(
5350                 __isl_keep isl_ast_node *node);
5351         int isl_ast_node_if_has_else(
5352                 __isl_keep isl_ast_node *node);
5353         __isl_give isl_ast_node *isl_ast_node_if_get_else(
5354                 __isl_keep isl_ast_node *node);
5356         __isl_give isl_ast_node_list *
5357         isl_ast_node_block_get_children(
5358                 __isl_keep isl_ast_node *node);
5360         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5361                 __isl_keep isl_ast_node *node);
5363 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5364 the following functions.
5366         #include <isl/ast.h>
5367         isl_ctx *isl_ast_expr_get_ctx(
5368                 __isl_keep isl_ast_expr *expr);
5369         enum isl_ast_expr_type isl_ast_expr_get_type(
5370                 __isl_keep isl_ast_expr *expr);
5372 The type of an AST expression is one of
5373 C<isl_ast_expr_op>,
5374 C<isl_ast_expr_id> or
5375 C<isl_ast_expr_int>.
5376 An C<isl_ast_expr_op> represents the result of an operation.
5377 An C<isl_ast_expr_id> represents an identifier.
5378 An C<isl_ast_expr_int> represents an integer value.
5380 Each type of expression has its own additional properties.
5382         #include <isl/ast.h>
5383         enum isl_ast_op_type isl_ast_expr_get_op_type(
5384                 __isl_keep isl_ast_expr *expr);
5385         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5386         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5387                 __isl_keep isl_ast_expr *expr, int pos);
5388         int isl_ast_node_foreach_ast_op_type(
5389                 __isl_keep isl_ast_node *node,
5390                 int (*fn)(enum isl_ast_op_type type, void *user),
5391                 void *user);
5393 C<isl_ast_expr_get_op_type> returns the type of the operation
5394 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
5395 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
5396 argument.
5397 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5398 C<isl_ast_op_type> that appears in C<node>.
5399 The operation type is one of the following.
5401 =over
5403 =item C<isl_ast_op_and>
5405 Logical I<and> of two arguments.
5406 Both arguments can be evaluated.
5408 =item C<isl_ast_op_and_then>
5410 Logical I<and> of two arguments.
5411 The second argument can only be evaluated if the first evaluates to true.
5413 =item C<isl_ast_op_or>
5415 Logical I<or> of two arguments.
5416 Both arguments can be evaluated.
5418 =item C<isl_ast_op_or_else>
5420 Logical I<or> of two arguments.
5421 The second argument can only be evaluated if the first evaluates to false.
5423 =item C<isl_ast_op_max>
5425 Maximum of two or more arguments.
5427 =item C<isl_ast_op_min>
5429 Minimum of two or more arguments.
5431 =item C<isl_ast_op_minus>
5433 Change sign.
5435 =item C<isl_ast_op_add>
5437 Sum of two arguments.
5439 =item C<isl_ast_op_sub>
5441 Difference of two arguments.
5443 =item C<isl_ast_op_mul>
5445 Product of two arguments.
5447 =item C<isl_ast_op_div>
5449 Exact division.  That is, the result is known to be an integer.
5451 =item C<isl_ast_op_fdiv_q>
5453 Result of integer division, rounded towards negative
5454 infinity.
5456 =item C<isl_ast_op_pdiv_q>
5458 Result of integer division, where dividend is known to be non-negative.
5460 =item C<isl_ast_op_pdiv_r>
5462 Remainder of integer division, where dividend is known to be non-negative.
5464 =item C<isl_ast_op_cond>
5466 Conditional operator defined on three arguments.
5467 If the first argument evaluates to true, then the result
5468 is equal to the second argument.  Otherwise, the result
5469 is equal to the third argument.
5470 The second and third argument may only be evaluated if
5471 the first argument evaluates to true and false, respectively.
5472 Corresponds to C<a ? b : c> in C.
5474 =item C<isl_ast_op_select>
5476 Conditional operator defined on three arguments.
5477 If the first argument evaluates to true, then the result
5478 is equal to the second argument.  Otherwise, the result
5479 is equal to the third argument.
5480 The second and third argument may be evaluated independently
5481 of the value of the first argument.
5482 Corresponds to C<a * b + (1 - a) * c> in C.
5484 =item C<isl_ast_op_eq>
5486 Equality relation.
5488 =item C<isl_ast_op_le>
5490 Less than or equal relation.
5492 =item C<isl_ast_op_lt>
5494 Less than relation.
5496 =item C<isl_ast_op_ge>
5498 Greater than or equal relation.
5500 =item C<isl_ast_op_gt>
5502 Greater than relation.
5504 =item C<isl_ast_op_call>
5506 A function call.
5507 The number of arguments of the C<isl_ast_expr> is one more than
5508 the number of arguments in the function call, the first argument
5509 representing the function being called.
5511 =back
5513         #include <isl/ast.h>
5514         __isl_give isl_id *isl_ast_expr_get_id(
5515                 __isl_keep isl_ast_expr *expr);
5517 Return the identifier represented by the AST expression.
5519         #include <isl/ast.h>
5520         int isl_ast_expr_get_int(__isl_keep isl_ast_expr *expr,
5521                 isl_int *v);
5523 Return the integer represented by the AST expression.
5524 Note that the integer is returned through the C<v> argument.
5525 The return value of the function itself indicates whether the
5526 operation was performed successfully.
5528 =head3 Manipulating and printing the AST
5530 AST nodes can be copied and freed using the following functions.
5532         #include <isl/ast.h>
5533         __isl_give isl_ast_node *isl_ast_node_copy(
5534                 __isl_keep isl_ast_node *node);
5535         void *isl_ast_node_free(__isl_take isl_ast_node *node);
5537 AST expressions can be copied and freed using the following functions.
5539         #include <isl/ast.h>
5540         __isl_give isl_ast_expr *isl_ast_expr_copy(
5541                 __isl_keep isl_ast_expr *expr);
5542         void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5544 New AST expressions can be created either directly or within
5545 the context of an C<isl_ast_build>.
5547         #include <isl/ast.h>
5548         __isl_give isl_ast_expr *isl_ast_expr_from_id(
5549                 __isl_take isl_id *id);
5550         __isl_give isl_ast_expr *isl_ast_expr_neg(
5551                 __isl_take isl_ast_expr *expr);
5552         __isl_give isl_ast_expr *isl_ast_expr_add(
5553                 __isl_take isl_ast_expr *expr1,
5554                 __isl_take isl_ast_expr *expr2);
5555         __isl_give isl_ast_expr *isl_ast_expr_sub(
5556                 __isl_take isl_ast_expr *expr1,
5557                 __isl_take isl_ast_expr *expr2);
5558         __isl_give isl_ast_expr *isl_ast_expr_mul(
5559                 __isl_take isl_ast_expr *expr1,
5560                 __isl_take isl_ast_expr *expr2);
5561         __isl_give isl_ast_expr *isl_ast_expr_div(
5562                 __isl_take isl_ast_expr *expr1,
5563                 __isl_take isl_ast_expr *expr2);
5564         __isl_give isl_ast_expr *isl_ast_expr_and(
5565                 __isl_take isl_ast_expr *expr1,
5566                 __isl_take isl_ast_expr *expr2)
5567         __isl_give isl_ast_expr *isl_ast_expr_or(
5568                 __isl_take isl_ast_expr *expr1,
5569                 __isl_take isl_ast_expr *expr2)
5571         #include <isl/ast_build.h>
5572         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5573                 __isl_keep isl_ast_build *build,
5574                 __isl_take isl_pw_aff *pa);
5575         __isl_give isl_ast_expr *
5576         isl_ast_build_call_from_pw_multi_aff(
5577                 __isl_keep isl_ast_build *build,
5578                 __isl_take isl_pw_multi_aff *pma);
5580 The domains of C<pa> and C<pma> should correspond
5581 to the schedule space of C<build>.
5582 The tuple id of C<pma> is used as the function being called.
5584 User specified data can be attached to an C<isl_ast_node> and obtained
5585 from the same C<isl_ast_node> using the following functions.
5587         #include <isl/ast.h>
5588         __isl_give isl_ast_node *isl_ast_node_set_annotation(
5589                 __isl_take isl_ast_node *node,
5590                 __isl_take isl_id *annotation);
5591         __isl_give isl_id *isl_ast_node_get_annotation(
5592                 __isl_keep isl_ast_node *node);
5594 Basic printing can be performed using the following functions.
5596         #include <isl/ast.h>
5597         __isl_give isl_printer *isl_printer_print_ast_expr(
5598                 __isl_take isl_printer *p,
5599                 __isl_keep isl_ast_expr *expr);
5600         __isl_give isl_printer *isl_printer_print_ast_node(
5601                 __isl_take isl_printer *p,
5602                 __isl_keep isl_ast_node *node);
5604 More advanced printing can be performed using the following functions.
5606         #include <isl/ast.h>
5607         __isl_give isl_printer *isl_ast_op_type_print_macro(
5608                 enum isl_ast_op_type type,
5609                 __isl_take isl_printer *p);
5610         __isl_give isl_printer *isl_ast_node_print_macros(
5611                 __isl_keep isl_ast_node *node,
5612                 __isl_take isl_printer *p);
5613         __isl_give isl_printer *isl_ast_node_print(
5614                 __isl_keep isl_ast_node *node,
5615                 __isl_take isl_printer *p,
5616                 __isl_take isl_ast_print_options *options);
5617         __isl_give isl_printer *isl_ast_node_for_print(
5618                 __isl_keep isl_ast_node *node,
5619                 __isl_take isl_printer *p,
5620                 __isl_take isl_ast_print_options *options);
5621         __isl_give isl_printer *isl_ast_node_if_print(
5622                 __isl_keep isl_ast_node *node,
5623                 __isl_take isl_printer *p,
5624                 __isl_take isl_ast_print_options *options);
5626 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
5627 C<isl> may print out an AST that makes use of macros such
5628 as C<floord>, C<min> and C<max>.
5629 C<isl_ast_op_type_print_macro> prints out the macro
5630 corresponding to a specific C<isl_ast_op_type>.
5631 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
5632 for expressions where these macros would be used and prints
5633 out the required macro definitions.
5634 Essentially, C<isl_ast_node_print_macros> calls
5635 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
5636 as function argument.
5637 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
5638 C<isl_ast_node_if_print> print an C<isl_ast_node>
5639 in C<ISL_FORMAT_C>, but allow for some extra control
5640 through an C<isl_ast_print_options> object.
5641 This object can be created using the following functions.
5643         #include <isl/ast.h>
5644         __isl_give isl_ast_print_options *
5645         isl_ast_print_options_alloc(isl_ctx *ctx);
5646         __isl_give isl_ast_print_options *
5647         isl_ast_print_options_copy(
5648                 __isl_keep isl_ast_print_options *options);
5649         void *isl_ast_print_options_free(
5650                 __isl_take isl_ast_print_options *options);
5652         __isl_give isl_ast_print_options *
5653         isl_ast_print_options_set_print_user(
5654                 __isl_take isl_ast_print_options *options,
5655                 __isl_give isl_printer *(*print_user)(
5656                         __isl_take isl_printer *p,
5657                         __isl_take isl_ast_print_options *options,
5658                         __isl_keep isl_ast_node *node, void *user),
5659                 void *user);
5660         __isl_give isl_ast_print_options *
5661         isl_ast_print_options_set_print_for(
5662                 __isl_take isl_ast_print_options *options,
5663                 __isl_give isl_printer *(*print_for)(
5664                         __isl_take isl_printer *p,
5665                         __isl_take isl_ast_print_options *options,
5666                         __isl_keep isl_ast_node *node, void *user),
5667                 void *user);
5669 The callback set by C<isl_ast_print_options_set_print_user>
5670 is called whenever a node of type C<isl_ast_node_user> needs to
5671 be printed.
5672 The callback set by C<isl_ast_print_options_set_print_for>
5673 is called whenever a node of type C<isl_ast_node_for> needs to
5674 be printed.
5675 Note that C<isl_ast_node_for_print> will I<not> call the
5676 callback set by C<isl_ast_print_options_set_print_for> on the node
5677 on which C<isl_ast_node_for_print> is called, but only on nested
5678 nodes of type C<isl_ast_node_for>.  It is therefore safe to
5679 call C<isl_ast_node_for_print> from within the callback set by
5680 C<isl_ast_print_options_set_print_for>.
5682 The following option determines the type to be used for iterators
5683 while printing the AST.
5685         int isl_options_set_ast_iterator_type(
5686                 isl_ctx *ctx, const char *val);
5687         const char *isl_options_get_ast_iterator_type(
5688                 isl_ctx *ctx);
5690 =head3 Options
5692         #include <isl/ast_build.h>
5693         int isl_options_set_ast_build_atomic_upper_bound(
5694                 isl_ctx *ctx, int val);
5695         int isl_options_get_ast_build_atomic_upper_bound(
5696                 isl_ctx *ctx);
5697         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
5698                 int val);
5699         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
5700         int isl_options_set_ast_build_exploit_nested_bounds(
5701                 isl_ctx *ctx, int val);
5702         int isl_options_get_ast_build_exploit_nested_bounds(
5703                 isl_ctx *ctx);
5704         int isl_options_set_ast_build_group_coscheduled(
5705                 isl_ctx *ctx, int val);
5706         int isl_options_get_ast_build_group_coscheduled(
5707                 isl_ctx *ctx);
5708         int isl_options_set_ast_build_scale_strides(
5709                 isl_ctx *ctx, int val);
5710         int isl_options_get_ast_build_scale_strides(
5711                 isl_ctx *ctx);
5712         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
5713                 int val);
5714         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
5715         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
5716                 int val);
5717         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
5719 =over
5721 =item * ast_build_atomic_upper_bound
5723 Generate loop upper bounds that consist of the current loop iterator,
5724 an operator and an expression not involving the iterator.
5725 If this option is not set, then the current loop iterator may appear
5726 several times in the upper bound.
5727 For example, when this option is turned off, AST generation
5728 for the schedule
5730         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
5732 produces
5734         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
5735           A(c0);
5737 When the option is turned on, the following AST is generated
5739         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
5740           A(c0);
5742 =item * ast_build_prefer_pdiv
5744 If this option is turned off, then the AST generation will
5745 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
5746 operators, but no C<isl_ast_op_pdiv_q> or
5747 C<isl_ast_op_pdiv_r> operators.
5748 If this options is turned on, then C<isl> will try to convert
5749 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
5750 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
5752 =item * ast_build_exploit_nested_bounds
5754 Simplify conditions based on bounds of nested for loops.
5755 In particular, remove conditions that are implied by the fact
5756 that one or more nested loops have at least one iteration,
5757 meaning that the upper bound is at least as large as the lower bound.
5758 For example, when this option is turned off, AST generation
5759 for the schedule
5761         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
5762                                         0 <= j <= M }
5764 produces
5766         if (M >= 0)
5767           for (int c0 = 0; c0 <= N; c0 += 1)
5768             for (int c1 = 0; c1 <= M; c1 += 1)
5769               A(c0, c1);
5771 When the option is turned on, the following AST is generated
5773         for (int c0 = 0; c0 <= N; c0 += 1)
5774           for (int c1 = 0; c1 <= M; c1 += 1)
5775             A(c0, c1);
5777 =item * ast_build_group_coscheduled
5779 If two domain elements are assigned the same schedule point, then
5780 they may be executed in any order and they may even appear in different
5781 loops.  If this options is set, then the AST generator will make
5782 sure that coscheduled domain elements do not appear in separate parts
5783 of the AST.  This is useful in case of nested AST generation
5784 if the outer AST generation is given only part of a schedule
5785 and the inner AST generation should handle the domains that are
5786 coscheduled by this initial part of the schedule together.
5787 For example if an AST is generated for a schedule
5789         { A[i] -> [0]; B[i] -> [0] }
5791 then the C<isl_ast_build_set_create_leaf> callback described
5792 below may get called twice, once for each domain.
5793 Setting this option ensures that the callback is only called once
5794 on both domains together.
5796 =item * ast_build_separation_bounds
5798 This option specifies which bounds to use during separation.
5799 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
5800 then all (possibly implicit) bounds on the current dimension will
5801 be used during separation.
5802 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
5803 then only those bounds that are explicitly available will
5804 be used during separation.
5806 =item * ast_build_scale_strides
5808 This option specifies whether the AST generator is allowed
5809 to scale down iterators of strided loops.
5811 =item * ast_build_allow_else
5813 This option specifies whether the AST generator is allowed
5814 to construct if statements with else branches.
5816 =item * ast_build_allow_or
5818 This option specifies whether the AST generator is allowed
5819 to construct if conditions with disjunctions.
5821 =back
5823 =head3 Fine-grained Control over AST Generation
5825 Besides specifying the constraints on the parameters,
5826 an C<isl_ast_build> object can be used to control
5827 various aspects of the AST generation process.
5828 The most prominent way of control is through ``options'',
5829 which can be set using the following function.
5831         #include <isl/ast_build.h>
5832         __isl_give isl_ast_build *
5833         isl_ast_build_set_options(
5834                 __isl_take isl_ast_build *control,
5835                 __isl_take isl_union_map *options);
5837 The options are encoded in an <isl_union_map>.
5838 The domain of this union relation refers to the schedule domain,
5839 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
5840 In the case of nested AST generation (see L</"Nested AST Generation">),
5841 the domain of C<options> should refer to the extra piece of the schedule.
5842 That is, it should be equal to the range of the wrapped relation in the
5843 range of the schedule.
5844 The range of the options can consist of elements in one or more spaces,
5845 the names of which determine the effect of the option.
5846 The values of the range typically also refer to the schedule dimension
5847 to which the option applies.  In case of nested AST generation
5848 (see L</"Nested AST Generation">), these values refer to the position
5849 of the schedule dimension within the innermost AST generation.
5850 The constraints on the domain elements of
5851 the option should only refer to this dimension and earlier dimensions.
5852 We consider the following spaces.
5854 =over
5856 =item C<separation_class>
5858 This space is a wrapped relation between two one dimensional spaces.
5859 The input space represents the schedule dimension to which the option
5860 applies and the output space represents the separation class.
5861 While constructing a loop corresponding to the specified schedule
5862 dimension(s), the AST generator will try to generate separate loops
5863 for domain elements that are assigned different classes.
5864 If only some of the elements are assigned a class, then those elements
5865 that are not assigned any class will be treated as belonging to a class
5866 that is separate from the explicitly assigned classes.
5867 The typical use case for this option is to separate full tiles from
5868 partial tiles.
5869 The other options, described below, are applied after the separation
5870 into classes.
5872 As an example, consider the separation into full and partial tiles
5873 of a tiling of a triangular domain.
5874 Take, for example, the domain
5876         { A[i,j] : 0 <= i,j and i + j <= 100 }
5878 and a tiling into tiles of 10 by 10.  The input to the AST generator
5879 is then the schedule
5881         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
5882                                                 i + j <= 100 }
5884 Without any options, the following AST is generated
5886         for (int c0 = 0; c0 <= 10; c0 += 1)
5887           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
5888             for (int c2 = 10 * c0;
5889                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
5890                  c2 += 1)
5891               for (int c3 = 10 * c1;
5892                    c3 <= min(10 * c1 + 9, -c2 + 100);
5893                    c3 += 1)
5894                 A(c2, c3);
5896 Separation into full and partial tiles can be obtained by assigning
5897 a class, say C<0>, to the full tiles.  The full tiles are represented by those
5898 values of the first and second schedule dimensions for which there are
5899 values of the third and fourth dimensions to cover an entire tile.
5900 That is, we need to specify the following option
5902         { [a,b,c,d] -> separation_class[[0]->[0]] :
5903                 exists b': 0 <= 10a,10b' and
5904                            10a+9+10b'+9 <= 100;
5905           [a,b,c,d] -> separation_class[[1]->[0]] :
5906                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
5908 which simplifies to
5910         { [a, b, c, d] -> separation_class[[1] -> [0]] :
5911                 a >= 0 and b >= 0 and b <= 8 - a;
5912           [a, b, c, d] -> separation_class[[0] -> [0]] :
5913                 a >= 0 and a <= 8 }
5915 With this option, the generated AST is as follows
5917         {
5918           for (int c0 = 0; c0 <= 8; c0 += 1) {
5919             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
5920               for (int c2 = 10 * c0;
5921                    c2 <= 10 * c0 + 9; c2 += 1)
5922                 for (int c3 = 10 * c1;
5923                      c3 <= 10 * c1 + 9; c3 += 1)
5924                   A(c2, c3);
5925             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
5926               for (int c2 = 10 * c0;
5927                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
5928                    c2 += 1)
5929                 for (int c3 = 10 * c1;
5930                      c3 <= min(-c2 + 100, 10 * c1 + 9);
5931                      c3 += 1)
5932                   A(c2, c3);
5933           }
5934           for (int c0 = 9; c0 <= 10; c0 += 1)
5935             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
5936               for (int c2 = 10 * c0;
5937                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
5938                    c2 += 1)
5939                 for (int c3 = 10 * c1;
5940                      c3 <= min(10 * c1 + 9, -c2 + 100);
5941                      c3 += 1)
5942                   A(c2, c3);
5943         }
5945 =item C<separate>
5947 This is a single-dimensional space representing the schedule dimension(s)
5948 to which ``separation'' should be applied.  Separation tries to split
5949 a loop into several pieces if this can avoid the generation of guards
5950 inside the loop.
5951 See also the C<atomic> option.
5953 =item C<atomic>
5955 This is a single-dimensional space representing the schedule dimension(s)
5956 for which the domains should be considered ``atomic''.  That is, the
5957 AST generator will make sure that any given domain space will only appear
5958 in a single loop at the specified level.
5960 Consider the following schedule
5962         { a[i] -> [i] : 0 <= i < 10;
5963           b[i] -> [i+1] : 0 <= i < 10 }
5965 If the following option is specified
5967         { [i] -> separate[x] }
5969 then the following AST will be generated
5971         {
5972           a(0);
5973           for (int c0 = 1; c0 <= 9; c0 += 1) {
5974             a(c0);
5975             b(c0 - 1);
5976           }
5977           b(9);
5978         }
5980 If, on the other hand, the following option is specified
5982         { [i] -> atomic[x] }
5984 then the following AST will be generated
5986         for (int c0 = 0; c0 <= 10; c0 += 1) {
5987           if (c0 <= 9)
5988             a(c0);
5989           if (c0 >= 1)
5990             b(c0 - 1);
5991         }
5993 If neither C<atomic> nor C<separate> is specified, then the AST generator
5994 may produce either of these two results or some intermediate form.
5996 =item C<unroll>
5998 This is a single-dimensional space representing the schedule dimension(s)
5999 that should be I<completely> unrolled.
6000 To obtain a partial unrolling, the user should apply an additional
6001 strip-mining to the schedule and fully unroll the inner loop.
6003 =back
6005 Additional control is available through the following functions.
6007         #include <isl/ast_build.h>
6008         __isl_give isl_ast_build *
6009         isl_ast_build_set_iterators(
6010                 __isl_take isl_ast_build *control,
6011                 __isl_take isl_id_list *iterators);
6013 The function C<isl_ast_build_set_iterators> allows the user to
6014 specify a list of iterator C<isl_id>s to be used as iterators.
6015 If the input schedule is injective, then
6016 the number of elements in this list should be as large as the dimension
6017 of the schedule space, but no direct correspondence should be assumed
6018 between dimensions and elements.
6019 If the input schedule is not injective, then an additional number
6020 of C<isl_id>s equal to the largest dimension of the input domains
6021 may be required.
6022 If the number of provided C<isl_id>s is insufficient, then additional
6023 names are automatically generated.
6025         #include <isl/ast_build.h>
6026         __isl_give isl_ast_build *
6027         isl_ast_build_set_create_leaf(
6028                 __isl_take isl_ast_build *control,
6029                 __isl_give isl_ast_node *(*fn)(
6030                         __isl_take isl_ast_build *build,
6031                         void *user), void *user);
6034 C<isl_ast_build_set_create_leaf> function allows for the
6035 specification of a callback that should be called whenever the AST
6036 generator arrives at an element of the schedule domain.
6037 The callback should return an AST node that should be inserted
6038 at the corresponding position of the AST.  The default action (when
6039 the callback is not set) is to continue generating parts of the AST to scan
6040 all the domain elements associated to the schedule domain element
6041 and to insert user nodes, ``calling'' the domain element, for each of them.
6042 The C<build> argument contains the current state of the C<isl_ast_build>.
6043 To ease nested AST generation (see L</"Nested AST Generation">),
6044 all control information that is
6045 specific to the current AST generation such as the options and
6046 the callbacks has been removed from this C<isl_ast_build>.
6047 The callback would typically return the result of a nested
6048 AST generation or a
6049 user defined node created using the following function.
6051         #include <isl/ast.h>
6052         __isl_give isl_ast_node *isl_ast_node_alloc_user(
6053                 __isl_take isl_ast_expr *expr);
6055         #include <isl/ast_build.h>
6056         __isl_give isl_ast_build *
6057         isl_ast_build_set_at_each_domain(
6058                 __isl_take isl_ast_build *build,
6059                 __isl_give isl_ast_node *(*fn)(
6060                         __isl_take isl_ast_node *node,
6061                         __isl_keep isl_ast_build *build,
6062                         void *user), void *user);
6063         __isl_give isl_ast_build *
6064         isl_ast_build_set_before_each_for(
6065                 __isl_take isl_ast_build *build,
6066                 __isl_give isl_id *(*fn)(
6067                         __isl_keep isl_ast_build *build,
6068                         void *user), void *user);
6069         __isl_give isl_ast_build *
6070         isl_ast_build_set_after_each_for(
6071                 __isl_take isl_ast_build *build,
6072                 __isl_give isl_ast_node *(*fn)(
6073                         __isl_take isl_ast_node *node,
6074                         __isl_keep isl_ast_build *build,
6075                         void *user), void *user);
6077 The callback set by C<isl_ast_build_set_at_each_domain> will
6078 be called for each domain AST node.
6079 The callbacks set by C<isl_ast_build_set_before_each_for>
6080 and C<isl_ast_build_set_after_each_for> will be called
6081 for each for AST node.  The first will be called in depth-first
6082 pre-order, while the second will be called in depth-first post-order.
6083 Since C<isl_ast_build_set_before_each_for> is called before the for
6084 node is actually constructed, it is only passed an C<isl_ast_build>.
6085 The returned C<isl_id> will be added as an annotation (using
6086 C<isl_ast_node_set_annotation>) to the constructed for node.
6087 In particular, if the user has also specified an C<after_each_for>
6088 callback, then the annotation can be retrieved from the node passed to
6089 that callback using C<isl_ast_node_get_annotation>.
6090 All callbacks should C<NULL> on failure.
6091 The given C<isl_ast_build> can be used to create new
6092 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6093 or C<isl_ast_build_call_from_pw_multi_aff>.
6095 =head3 Nested AST Generation
6097 C<isl> allows the user to create an AST within the context
6098 of another AST.  These nested ASTs are created using the
6099 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6100 outer AST.  The C<build> argument should be an C<isl_ast_build>
6101 passed to a callback set by
6102 C<isl_ast_build_set_create_leaf>.
6103 The space of the range of the C<schedule> argument should refer
6104 to this build.  In particular, the space should be a wrapped
6105 relation and the domain of this wrapped relation should be the
6106 same as that of the range of the schedule returned by
6107 C<isl_ast_build_get_schedule> below.
6108 In practice, the new schedule is typically
6109 created by calling C<isl_union_map_range_product> on the old schedule
6110 and some extra piece of the schedule.
6111 The space of the schedule domain is also available from
6112 the C<isl_ast_build>.
6114         #include <isl/ast_build.h>
6115         __isl_give isl_union_map *isl_ast_build_get_schedule(
6116                 __isl_keep isl_ast_build *build);
6117         __isl_give isl_space *isl_ast_build_get_schedule_space(
6118                 __isl_keep isl_ast_build *build);
6119         __isl_give isl_ast_build *isl_ast_build_restrict(
6120                 __isl_take isl_ast_build *build,
6121                 __isl_take isl_set *set);
6123 The C<isl_ast_build_get_schedule> function returns a (partial)
6124 schedule for the domains elements for which part of the AST still needs to
6125 be generated in the current build.
6126 In particular, the domain elements are mapped to those iterations of the loops
6127 enclosing the current point of the AST generation inside which
6128 the domain elements are executed.
6129 No direct correspondence between
6130 the input schedule and this schedule should be assumed.
6131 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6132 to create a set for C<isl_ast_build_restrict> to intersect
6133 with the current build.  In particular, the set passed to
6134 C<isl_ast_build_restrict> can have additional parameters.
6135 The ids of the set dimensions in the space returned by
6136 C<isl_ast_build_get_schedule_space> correspond to the
6137 iterators of the already generated loops.
6138 The user should not rely on the ids of the output dimensions
6139 of the relations in the union relation returned by
6140 C<isl_ast_build_get_schedule> having any particular value.
6142 =head1 Applications
6144 Although C<isl> is mainly meant to be used as a library,
6145 it also contains some basic applications that use some
6146 of the functionality of C<isl>.
6147 The input may be specified in either the L<isl format>
6148 or the L<PolyLib format>.
6150 =head2 C<isl_polyhedron_sample>
6152 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6153 an integer element of the polyhedron, if there is any.
6154 The first column in the output is the denominator and is always
6155 equal to 1.  If the polyhedron contains no integer points,
6156 then a vector of length zero is printed.
6158 =head2 C<isl_pip>
6160 C<isl_pip> takes the same input as the C<example> program
6161 from the C<piplib> distribution, i.e., a set of constraints
6162 on the parameters, a line containing only -1 and finally a set
6163 of constraints on a parametric polyhedron.
6164 The coefficients of the parameters appear in the last columns
6165 (but before the final constant column).
6166 The output is the lexicographic minimum of the parametric polyhedron.
6167 As C<isl> currently does not have its own output format, the output
6168 is just a dump of the internal state.
6170 =head2 C<isl_polyhedron_minimize>
6172 C<isl_polyhedron_minimize> computes the minimum of some linear
6173 or affine objective function over the integer points in a polyhedron.
6174 If an affine objective function
6175 is given, then the constant should appear in the last column.
6177 =head2 C<isl_polytope_scan>
6179 Given a polytope, C<isl_polytope_scan> prints
6180 all integer points in the polytope.
6182 =head2 C<isl_codegen>
6184 Given a schedule, a context set and an options relation,
6185 C<isl_codegen> prints out an AST that scans the domain elements
6186 of the schedule in the order of their image(s) taking into account
6187 the constraints in the context set.