add isl_basic_map_order_gt
[isl.git] / doc / user.pod
blob2278000d65e073b95b1ef86b2c329d4a65e4cb4e
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_basic_map *isl_basic_map_order_gt(
2169                 __isl_take isl_basic_map *bmap,
2170                 enum isl_dim_type type1, int pos1,
2171                 enum isl_dim_type type2, int pos2);
2172         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2173                 enum isl_dim_type type1, int pos1,
2174                 enum isl_dim_type type2, int pos2);
2176 Intersect the relation with the half-space where the given
2177 dimensions satisfy the given ordering.
2179 =item * Identity
2181         __isl_give isl_map *isl_set_identity(
2182                 __isl_take isl_set *set);
2183         __isl_give isl_union_map *isl_union_set_identity(
2184                 __isl_take isl_union_set *uset);
2186 Construct an identity relation on the given (union) set.
2188 =item * Deltas
2190         __isl_give isl_basic_set *isl_basic_map_deltas(
2191                 __isl_take isl_basic_map *bmap);
2192         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2193         __isl_give isl_union_set *isl_union_map_deltas(
2194                 __isl_take isl_union_map *umap);
2196 These functions return a (basic) set containing the differences
2197 between image elements and corresponding domain elements in the input.
2199         __isl_give isl_basic_map *isl_basic_map_deltas_map(
2200                 __isl_take isl_basic_map *bmap);
2201         __isl_give isl_map *isl_map_deltas_map(
2202                 __isl_take isl_map *map);
2203         __isl_give isl_union_map *isl_union_map_deltas_map(
2204                 __isl_take isl_union_map *umap);
2206 The functions above construct a (basic, regular or union) relation
2207 that maps (a wrapped version of) the input relation to its delta set.
2209 =item * Coalescing
2211 Simplify the representation of a set or relation by trying
2212 to combine pairs of basic sets or relations into a single
2213 basic set or relation.
2215         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2216         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2217         __isl_give isl_union_set *isl_union_set_coalesce(
2218                 __isl_take isl_union_set *uset);
2219         __isl_give isl_union_map *isl_union_map_coalesce(
2220                 __isl_take isl_union_map *umap);
2222 One of the methods for combining pairs of basic sets or relations
2223 can result in coefficients that are much larger than those that appear
2224 in the constraints of the input.  By default, the coefficients are
2225 not allowed to grow larger, but this can be changed by unsetting
2226 the following option.
2228         int isl_options_set_coalesce_bounded_wrapping(
2229                 isl_ctx *ctx, int val);
2230         int isl_options_get_coalesce_bounded_wrapping(
2231                 isl_ctx *ctx);
2233 =item * Detecting equalities
2235         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2236                 __isl_take isl_basic_set *bset);
2237         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2238                 __isl_take isl_basic_map *bmap);
2239         __isl_give isl_set *isl_set_detect_equalities(
2240                 __isl_take isl_set *set);
2241         __isl_give isl_map *isl_map_detect_equalities(
2242                 __isl_take isl_map *map);
2243         __isl_give isl_union_set *isl_union_set_detect_equalities(
2244                 __isl_take isl_union_set *uset);
2245         __isl_give isl_union_map *isl_union_map_detect_equalities(
2246                 __isl_take isl_union_map *umap);
2248 Simplify the representation of a set or relation by detecting implicit
2249 equalities.
2251 =item * Removing redundant constraints
2253         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2254                 __isl_take isl_basic_set *bset);
2255         __isl_give isl_set *isl_set_remove_redundancies(
2256                 __isl_take isl_set *set);
2257         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2258                 __isl_take isl_basic_map *bmap);
2259         __isl_give isl_map *isl_map_remove_redundancies(
2260                 __isl_take isl_map *map);
2262 =item * Convex hull
2264         __isl_give isl_basic_set *isl_set_convex_hull(
2265                 __isl_take isl_set *set);
2266         __isl_give isl_basic_map *isl_map_convex_hull(
2267                 __isl_take isl_map *map);
2269 If the input set or relation has any existentially quantified
2270 variables, then the result of these operations is currently undefined.
2272 =item * Simple hull
2274         __isl_give isl_basic_set *
2275         isl_set_unshifted_simple_hull(
2276                 __isl_take isl_set *set);
2277         __isl_give isl_basic_map *
2278         isl_map_unshifted_simple_hull(
2279                 __isl_take isl_map *map);
2280         __isl_give isl_basic_set *isl_set_simple_hull(
2281                 __isl_take isl_set *set);
2282         __isl_give isl_basic_map *isl_map_simple_hull(
2283                 __isl_take isl_map *map);
2284         __isl_give isl_union_map *isl_union_map_simple_hull(
2285                 __isl_take isl_union_map *umap);
2287 These functions compute a single basic set or relation
2288 that contains the whole input set or relation.
2289 In particular, the output is described by translates
2290 of the constraints describing the basic sets or relations in the input.
2291 In case of C<isl_set_unshifted_simple_hull>, only the original
2292 constraints are used, without any translation.
2294 =begin latex
2296 (See \autoref{s:simple hull}.)
2298 =end latex
2300 =item * Affine hull
2302         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2303                 __isl_take isl_basic_set *bset);
2304         __isl_give isl_basic_set *isl_set_affine_hull(
2305                 __isl_take isl_set *set);
2306         __isl_give isl_union_set *isl_union_set_affine_hull(
2307                 __isl_take isl_union_set *uset);
2308         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2309                 __isl_take isl_basic_map *bmap);
2310         __isl_give isl_basic_map *isl_map_affine_hull(
2311                 __isl_take isl_map *map);
2312         __isl_give isl_union_map *isl_union_map_affine_hull(
2313                 __isl_take isl_union_map *umap);
2315 In case of union sets and relations, the affine hull is computed
2316 per space.
2318 =item * Polyhedral hull
2320         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2321                 __isl_take isl_set *set);
2322         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2323                 __isl_take isl_map *map);
2324         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2325                 __isl_take isl_union_set *uset);
2326         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2327                 __isl_take isl_union_map *umap);
2329 These functions compute a single basic set or relation
2330 not involving any existentially quantified variables
2331 that contains the whole input set or relation.
2332 In case of union sets and relations, the polyhedral hull is computed
2333 per space.
2335 =item * Other approximations
2337         __isl_give isl_basic_set *
2338         isl_basic_set_drop_constraints_involving_dims(
2339                 __isl_take isl_basic_set *bset,
2340                 enum isl_dim_type type,
2341                 unsigned first, unsigned n);
2342         __isl_give isl_basic_map *
2343         isl_basic_map_drop_constraints_involving_dims(
2344                 __isl_take isl_basic_map *bmap,
2345                 enum isl_dim_type type,
2346                 unsigned first, unsigned n);
2347         __isl_give isl_basic_set *
2348         isl_basic_set_drop_constraints_not_involving_dims(
2349                 __isl_take isl_basic_set *bset,
2350                 enum isl_dim_type type,
2351                 unsigned first, unsigned n);
2352         __isl_give isl_set *
2353         isl_set_drop_constraints_involving_dims(
2354                 __isl_take isl_set *set,
2355                 enum isl_dim_type type,
2356                 unsigned first, unsigned n);
2357         __isl_give isl_map *
2358         isl_map_drop_constraints_involving_dims(
2359                 __isl_take isl_map *map,
2360                 enum isl_dim_type type,
2361                 unsigned first, unsigned n);
2363 These functions drop any constraints (not) involving the specified dimensions.
2364 Note that the result depends on the representation of the input.
2366 =item * Feasibility
2368         __isl_give isl_basic_set *isl_basic_set_sample(
2369                 __isl_take isl_basic_set *bset);
2370         __isl_give isl_basic_set *isl_set_sample(
2371                 __isl_take isl_set *set);
2372         __isl_give isl_basic_map *isl_basic_map_sample(
2373                 __isl_take isl_basic_map *bmap);
2374         __isl_give isl_basic_map *isl_map_sample(
2375                 __isl_take isl_map *map);
2377 If the input (basic) set or relation is non-empty, then return
2378 a singleton subset of the input.  Otherwise, return an empty set.
2380 =item * Optimization
2382         #include <isl/ilp.h>
2383         enum isl_lp_result isl_basic_set_max(
2384                 __isl_keep isl_basic_set *bset,
2385                 __isl_keep isl_aff *obj, isl_int *opt)
2386         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2387                 __isl_keep isl_aff *obj, isl_int *opt);
2388         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2389                 __isl_keep isl_aff *obj, isl_int *opt);
2391 Compute the minimum or maximum of the integer affine expression C<obj>
2392 over the points in C<set>, returning the result in C<opt>.
2393 The return value may be one of C<isl_lp_error>,
2394 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2396 =item * Parametric optimization
2398         __isl_give isl_pw_aff *isl_set_dim_min(
2399                 __isl_take isl_set *set, int pos);
2400         __isl_give isl_pw_aff *isl_set_dim_max(
2401                 __isl_take isl_set *set, int pos);
2402         __isl_give isl_pw_aff *isl_map_dim_max(
2403                 __isl_take isl_map *map, int pos);
2405 Compute the minimum or maximum of the given set or output dimension
2406 as a function of the parameters (and input dimensions), but independently
2407 of the other set or output dimensions.
2408 For lexicographic optimization, see L<"Lexicographic Optimization">.
2410 =item * Dual
2412 The following functions compute either the set of (rational) coefficient
2413 values of valid constraints for the given set or the set of (rational)
2414 values satisfying the constraints with coefficients from the given set.
2415 Internally, these two sets of functions perform essentially the
2416 same operations, except that the set of coefficients is assumed to
2417 be a cone, while the set of values may be any polyhedron.
2418 The current implementation is based on the Farkas lemma and
2419 Fourier-Motzkin elimination, but this may change or be made optional
2420 in future.  In particular, future implementations may use different
2421 dualization algorithms or skip the elimination step.
2423         __isl_give isl_basic_set *isl_basic_set_coefficients(
2424                 __isl_take isl_basic_set *bset);
2425         __isl_give isl_basic_set *isl_set_coefficients(
2426                 __isl_take isl_set *set);
2427         __isl_give isl_union_set *isl_union_set_coefficients(
2428                 __isl_take isl_union_set *bset);
2429         __isl_give isl_basic_set *isl_basic_set_solutions(
2430                 __isl_take isl_basic_set *bset);
2431         __isl_give isl_basic_set *isl_set_solutions(
2432                 __isl_take isl_set *set);
2433         __isl_give isl_union_set *isl_union_set_solutions(
2434                 __isl_take isl_union_set *bset);
2436 =item * Power
2438         __isl_give isl_map *isl_map_fixed_power(
2439                 __isl_take isl_map *map, isl_int exp);
2440         __isl_give isl_union_map *isl_union_map_fixed_power(
2441                 __isl_take isl_union_map *umap, isl_int exp);
2443 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2444 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2445 of C<map> is computed.
2447         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2448                 int *exact);
2449         __isl_give isl_union_map *isl_union_map_power(
2450                 __isl_take isl_union_map *umap, int *exact);
2452 Compute a parametric representation for all positive powers I<k> of C<map>.
2453 The result maps I<k> to a nested relation corresponding to the
2454 I<k>th power of C<map>.
2455 The result may be an overapproximation.  If the result is known to be exact,
2456 then C<*exact> is set to C<1>.
2458 =item * Transitive closure
2460         __isl_give isl_map *isl_map_transitive_closure(
2461                 __isl_take isl_map *map, int *exact);
2462         __isl_give isl_union_map *isl_union_map_transitive_closure(
2463                 __isl_take isl_union_map *umap, int *exact);
2465 Compute the transitive closure of C<map>.
2466 The result may be an overapproximation.  If the result is known to be exact,
2467 then C<*exact> is set to C<1>.
2469 =item * Reaching path lengths
2471         __isl_give isl_map *isl_map_reaching_path_lengths(
2472                 __isl_take isl_map *map, int *exact);
2474 Compute a relation that maps each element in the range of C<map>
2475 to the lengths of all paths composed of edges in C<map> that
2476 end up in the given element.
2477 The result may be an overapproximation.  If the result is known to be exact,
2478 then C<*exact> is set to C<1>.
2479 To compute the I<maximal> path length, the resulting relation
2480 should be postprocessed by C<isl_map_lexmax>.
2481 In particular, if the input relation is a dependence relation
2482 (mapping sources to sinks), then the maximal path length corresponds
2483 to the free schedule.
2484 Note, however, that C<isl_map_lexmax> expects the maximum to be
2485 finite, so if the path lengths are unbounded (possibly due to
2486 the overapproximation), then you will get an error message.
2488 =item * Wrapping
2490         __isl_give isl_basic_set *isl_basic_map_wrap(
2491                 __isl_take isl_basic_map *bmap);
2492         __isl_give isl_set *isl_map_wrap(
2493                 __isl_take isl_map *map);
2494         __isl_give isl_union_set *isl_union_map_wrap(
2495                 __isl_take isl_union_map *umap);
2496         __isl_give isl_basic_map *isl_basic_set_unwrap(
2497                 __isl_take isl_basic_set *bset);
2498         __isl_give isl_map *isl_set_unwrap(
2499                 __isl_take isl_set *set);
2500         __isl_give isl_union_map *isl_union_set_unwrap(
2501                 __isl_take isl_union_set *uset);
2503 =item * Flattening
2505 Remove any internal structure of domain (and range) of the given
2506 set or relation.  If there is any such internal structure in the input,
2507 then the name of the space is also removed.
2509         __isl_give isl_basic_set *isl_basic_set_flatten(
2510                 __isl_take isl_basic_set *bset);
2511         __isl_give isl_set *isl_set_flatten(
2512                 __isl_take isl_set *set);
2513         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2514                 __isl_take isl_basic_map *bmap);
2515         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2516                 __isl_take isl_basic_map *bmap);
2517         __isl_give isl_map *isl_map_flatten_range(
2518                 __isl_take isl_map *map);
2519         __isl_give isl_map *isl_map_flatten_domain(
2520                 __isl_take isl_map *map);
2521         __isl_give isl_basic_map *isl_basic_map_flatten(
2522                 __isl_take isl_basic_map *bmap);
2523         __isl_give isl_map *isl_map_flatten(
2524                 __isl_take isl_map *map);
2526         __isl_give isl_map *isl_set_flatten_map(
2527                 __isl_take isl_set *set);
2529 The function above constructs a relation
2530 that maps the input set to a flattened version of the set.
2532 =item * Lifting
2534 Lift the input set to a space with extra dimensions corresponding
2535 to the existentially quantified variables in the input.
2536 In particular, the result lives in a wrapped map where the domain
2537 is the original space and the range corresponds to the original
2538 existentially quantified variables.
2540         __isl_give isl_basic_set *isl_basic_set_lift(
2541                 __isl_take isl_basic_set *bset);
2542         __isl_give isl_set *isl_set_lift(
2543                 __isl_take isl_set *set);
2544         __isl_give isl_union_set *isl_union_set_lift(
2545                 __isl_take isl_union_set *uset);
2547 Given a local space that contains the existentially quantified
2548 variables of a set, a basic relation that, when applied to
2549 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2550 can be constructed using the following function.
2552         #include <isl/local_space.h>
2553         __isl_give isl_basic_map *isl_local_space_lifting(
2554                 __isl_take isl_local_space *ls);
2556 =item * Internal Product
2558         __isl_give isl_basic_map *isl_basic_map_zip(
2559                 __isl_take isl_basic_map *bmap);
2560         __isl_give isl_map *isl_map_zip(
2561                 __isl_take isl_map *map);
2562         __isl_give isl_union_map *isl_union_map_zip(
2563                 __isl_take isl_union_map *umap);
2565 Given a relation with nested relations for domain and range,
2566 interchange the range of the domain with the domain of the range.
2568 =item * Currying
2570         __isl_give isl_basic_map *isl_basic_map_curry(
2571                 __isl_take isl_basic_map *bmap);
2572         __isl_give isl_basic_map *isl_basic_map_uncurry(
2573                 __isl_take isl_basic_map *bmap);
2574         __isl_give isl_map *isl_map_curry(
2575                 __isl_take isl_map *map);
2576         __isl_give isl_map *isl_map_uncurry(
2577                 __isl_take isl_map *map);
2578         __isl_give isl_union_map *isl_union_map_curry(
2579                 __isl_take isl_union_map *umap);
2580         __isl_give isl_union_map *isl_union_map_uncurry(
2581                 __isl_take isl_union_map *umap);
2583 Given a relation with a nested relation for domain,
2584 the C<curry> functions
2585 move the range of the nested relation out of the domain
2586 and use it as the domain of a nested relation in the range,
2587 with the original range as range of this nested relation.
2588 The C<uncurry> functions perform the inverse operation.
2590 =item * Aligning parameters
2592         __isl_give isl_basic_set *isl_basic_set_align_params(
2593                 __isl_take isl_basic_set *bset,
2594                 __isl_take isl_space *model);
2595         __isl_give isl_set *isl_set_align_params(
2596                 __isl_take isl_set *set,
2597                 __isl_take isl_space *model);
2598         __isl_give isl_basic_map *isl_basic_map_align_params(
2599                 __isl_take isl_basic_map *bmap,
2600                 __isl_take isl_space *model);
2601         __isl_give isl_map *isl_map_align_params(
2602                 __isl_take isl_map *map,
2603                 __isl_take isl_space *model);
2605 Change the order of the parameters of the given set or relation
2606 such that the first parameters match those of C<model>.
2607 This may involve the introduction of extra parameters.
2608 All parameters need to be named.
2610 =item * Dimension manipulation
2612         __isl_give isl_basic_set *isl_basic_set_add_dims(
2613                 __isl_take isl_basic_set *bset,
2614                 enum isl_dim_type type, unsigned n);
2615         __isl_give isl_set *isl_set_add_dims(
2616                 __isl_take isl_set *set,
2617                 enum isl_dim_type type, unsigned n);
2618         __isl_give isl_map *isl_map_add_dims(
2619                 __isl_take isl_map *map,
2620                 enum isl_dim_type type, unsigned n);
2621         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2622                 __isl_take isl_basic_set *bset,
2623                 enum isl_dim_type type, unsigned pos,
2624                 unsigned n);
2625         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2626                 __isl_take isl_basic_map *bmap,
2627                 enum isl_dim_type type, unsigned pos,
2628                 unsigned n);
2629         __isl_give isl_set *isl_set_insert_dims(
2630                 __isl_take isl_set *set,
2631                 enum isl_dim_type type, unsigned pos, unsigned n);
2632         __isl_give isl_map *isl_map_insert_dims(
2633                 __isl_take isl_map *map,
2634                 enum isl_dim_type type, unsigned pos, unsigned n);
2635         __isl_give isl_basic_set *isl_basic_set_move_dims(
2636                 __isl_take isl_basic_set *bset,
2637                 enum isl_dim_type dst_type, unsigned dst_pos,
2638                 enum isl_dim_type src_type, unsigned src_pos,
2639                 unsigned n);
2640         __isl_give isl_basic_map *isl_basic_map_move_dims(
2641                 __isl_take isl_basic_map *bmap,
2642                 enum isl_dim_type dst_type, unsigned dst_pos,
2643                 enum isl_dim_type src_type, unsigned src_pos,
2644                 unsigned n);
2645         __isl_give isl_set *isl_set_move_dims(
2646                 __isl_take isl_set *set,
2647                 enum isl_dim_type dst_type, unsigned dst_pos,
2648                 enum isl_dim_type src_type, unsigned src_pos,
2649                 unsigned n);
2650         __isl_give isl_map *isl_map_move_dims(
2651                 __isl_take isl_map *map,
2652                 enum isl_dim_type dst_type, unsigned dst_pos,
2653                 enum isl_dim_type src_type, unsigned src_pos,
2654                 unsigned n);
2656 It is usually not advisable to directly change the (input or output)
2657 space of a set or a relation as this removes the name and the internal
2658 structure of the space.  However, the above functions can be useful
2659 to add new parameters, assuming
2660 C<isl_set_align_params> and C<isl_map_align_params>
2661 are not sufficient.
2663 =back
2665 =head2 Binary Operations
2667 The two arguments of a binary operation not only need to live
2668 in the same C<isl_ctx>, they currently also need to have
2669 the same (number of) parameters.
2671 =head3 Basic Operations
2673 =over
2675 =item * Intersection
2677         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2678                 __isl_take isl_basic_set *bset1,
2679                 __isl_take isl_basic_set *bset2);
2680         __isl_give isl_basic_set *isl_basic_set_intersect(
2681                 __isl_take isl_basic_set *bset1,
2682                 __isl_take isl_basic_set *bset2);
2683         __isl_give isl_set *isl_set_intersect_params(
2684                 __isl_take isl_set *set,
2685                 __isl_take isl_set *params);
2686         __isl_give isl_set *isl_set_intersect(
2687                 __isl_take isl_set *set1,
2688                 __isl_take isl_set *set2);
2689         __isl_give isl_union_set *isl_union_set_intersect_params(
2690                 __isl_take isl_union_set *uset,
2691                 __isl_take isl_set *set);
2692         __isl_give isl_union_map *isl_union_map_intersect_params(
2693                 __isl_take isl_union_map *umap,
2694                 __isl_take isl_set *set);
2695         __isl_give isl_union_set *isl_union_set_intersect(
2696                 __isl_take isl_union_set *uset1,
2697                 __isl_take isl_union_set *uset2);
2698         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2699                 __isl_take isl_basic_map *bmap,
2700                 __isl_take isl_basic_set *bset);
2701         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2702                 __isl_take isl_basic_map *bmap,
2703                 __isl_take isl_basic_set *bset);
2704         __isl_give isl_basic_map *isl_basic_map_intersect(
2705                 __isl_take isl_basic_map *bmap1,
2706                 __isl_take isl_basic_map *bmap2);
2707         __isl_give isl_map *isl_map_intersect_params(
2708                 __isl_take isl_map *map,
2709                 __isl_take isl_set *params);
2710         __isl_give isl_map *isl_map_intersect_domain(
2711                 __isl_take isl_map *map,
2712                 __isl_take isl_set *set);
2713         __isl_give isl_map *isl_map_intersect_range(
2714                 __isl_take isl_map *map,
2715                 __isl_take isl_set *set);
2716         __isl_give isl_map *isl_map_intersect(
2717                 __isl_take isl_map *map1,
2718                 __isl_take isl_map *map2);
2719         __isl_give isl_union_map *isl_union_map_intersect_domain(
2720                 __isl_take isl_union_map *umap,
2721                 __isl_take isl_union_set *uset);
2722         __isl_give isl_union_map *isl_union_map_intersect_range(
2723                 __isl_take isl_union_map *umap,
2724                 __isl_take isl_union_set *uset);
2725         __isl_give isl_union_map *isl_union_map_intersect(
2726                 __isl_take isl_union_map *umap1,
2727                 __isl_take isl_union_map *umap2);
2729 The second argument to the C<_params> functions needs to be
2730 a parametric (basic) set.  For the other functions, a parametric set
2731 for either argument is only allowed if the other argument is
2732 a parametric set as well.
2734 =item * Union
2736         __isl_give isl_set *isl_basic_set_union(
2737                 __isl_take isl_basic_set *bset1,
2738                 __isl_take isl_basic_set *bset2);
2739         __isl_give isl_map *isl_basic_map_union(
2740                 __isl_take isl_basic_map *bmap1,
2741                 __isl_take isl_basic_map *bmap2);
2742         __isl_give isl_set *isl_set_union(
2743                 __isl_take isl_set *set1,
2744                 __isl_take isl_set *set2);
2745         __isl_give isl_map *isl_map_union(
2746                 __isl_take isl_map *map1,
2747                 __isl_take isl_map *map2);
2748         __isl_give isl_union_set *isl_union_set_union(
2749                 __isl_take isl_union_set *uset1,
2750                 __isl_take isl_union_set *uset2);
2751         __isl_give isl_union_map *isl_union_map_union(
2752                 __isl_take isl_union_map *umap1,
2753                 __isl_take isl_union_map *umap2);
2755 =item * Set difference
2757         __isl_give isl_set *isl_set_subtract(
2758                 __isl_take isl_set *set1,
2759                 __isl_take isl_set *set2);
2760         __isl_give isl_map *isl_map_subtract(
2761                 __isl_take isl_map *map1,
2762                 __isl_take isl_map *map2);
2763         __isl_give isl_map *isl_map_subtract_domain(
2764                 __isl_take isl_map *map,
2765                 __isl_take isl_set *dom);
2766         __isl_give isl_map *isl_map_subtract_range(
2767                 __isl_take isl_map *map,
2768                 __isl_take isl_set *dom);
2769         __isl_give isl_union_set *isl_union_set_subtract(
2770                 __isl_take isl_union_set *uset1,
2771                 __isl_take isl_union_set *uset2);
2772         __isl_give isl_union_map *isl_union_map_subtract(
2773                 __isl_take isl_union_map *umap1,
2774                 __isl_take isl_union_map *umap2);
2775         __isl_give isl_union_map *isl_union_map_subtract_domain(
2776                 __isl_take isl_union_map *umap,
2777                 __isl_take isl_union_set *dom);
2778         __isl_give isl_union_map *isl_union_map_subtract_range(
2779                 __isl_take isl_union_map *umap,
2780                 __isl_take isl_union_set *dom);
2782 =item * Application
2784         __isl_give isl_basic_set *isl_basic_set_apply(
2785                 __isl_take isl_basic_set *bset,
2786                 __isl_take isl_basic_map *bmap);
2787         __isl_give isl_set *isl_set_apply(
2788                 __isl_take isl_set *set,
2789                 __isl_take isl_map *map);
2790         __isl_give isl_union_set *isl_union_set_apply(
2791                 __isl_take isl_union_set *uset,
2792                 __isl_take isl_union_map *umap);
2793         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2794                 __isl_take isl_basic_map *bmap1,
2795                 __isl_take isl_basic_map *bmap2);
2796         __isl_give isl_basic_map *isl_basic_map_apply_range(
2797                 __isl_take isl_basic_map *bmap1,
2798                 __isl_take isl_basic_map *bmap2);
2799         __isl_give isl_map *isl_map_apply_domain(
2800                 __isl_take isl_map *map1,
2801                 __isl_take isl_map *map2);
2802         __isl_give isl_union_map *isl_union_map_apply_domain(
2803                 __isl_take isl_union_map *umap1,
2804                 __isl_take isl_union_map *umap2);
2805         __isl_give isl_map *isl_map_apply_range(
2806                 __isl_take isl_map *map1,
2807                 __isl_take isl_map *map2);
2808         __isl_give isl_union_map *isl_union_map_apply_range(
2809                 __isl_take isl_union_map *umap1,
2810                 __isl_take isl_union_map *umap2);
2812 =item * Preimage
2814         __isl_give isl_basic_set *
2815         isl_basic_set_preimage_multi_aff(
2816                 __isl_take isl_basic_set *bset,
2817                 __isl_take isl_multi_aff *ma);
2818         __isl_give isl_set *isl_set_preimage_multi_aff(
2819                 __isl_take isl_set *set,
2820                 __isl_take isl_multi_aff *ma);
2821         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
2822                 __isl_take isl_set *set,
2823                 __isl_take isl_pw_multi_aff *pma);
2824         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
2825                 __isl_take isl_map *map,
2826                 __isl_take isl_multi_aff *ma);
2827         __isl_give isl_union_map *
2828         isl_union_map_preimage_domain_multi_aff(
2829                 __isl_take isl_union_map *umap,
2830                 __isl_take isl_multi_aff *ma);
2832 These functions compute the preimage of the given set or map domain under
2833 the given function.  In other words, the expression is plugged
2834 into the set description or into the domain of the map.
2835 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
2836 L</"Piecewise Multiple Quasi Affine Expressions">.
2838 =item * Cartesian Product
2840         __isl_give isl_set *isl_set_product(
2841                 __isl_take isl_set *set1,
2842                 __isl_take isl_set *set2);
2843         __isl_give isl_union_set *isl_union_set_product(
2844                 __isl_take isl_union_set *uset1,
2845                 __isl_take isl_union_set *uset2);
2846         __isl_give isl_basic_map *isl_basic_map_domain_product(
2847                 __isl_take isl_basic_map *bmap1,
2848                 __isl_take isl_basic_map *bmap2);
2849         __isl_give isl_basic_map *isl_basic_map_range_product(
2850                 __isl_take isl_basic_map *bmap1,
2851                 __isl_take isl_basic_map *bmap2);
2852         __isl_give isl_basic_map *isl_basic_map_product(
2853                 __isl_take isl_basic_map *bmap1,
2854                 __isl_take isl_basic_map *bmap2);
2855         __isl_give isl_map *isl_map_domain_product(
2856                 __isl_take isl_map *map1,
2857                 __isl_take isl_map *map2);
2858         __isl_give isl_map *isl_map_range_product(
2859                 __isl_take isl_map *map1,
2860                 __isl_take isl_map *map2);
2861         __isl_give isl_union_map *isl_union_map_domain_product(
2862                 __isl_take isl_union_map *umap1,
2863                 __isl_take isl_union_map *umap2);
2864         __isl_give isl_union_map *isl_union_map_range_product(
2865                 __isl_take isl_union_map *umap1,
2866                 __isl_take isl_union_map *umap2);
2867         __isl_give isl_map *isl_map_product(
2868                 __isl_take isl_map *map1,
2869                 __isl_take isl_map *map2);
2870         __isl_give isl_union_map *isl_union_map_product(
2871                 __isl_take isl_union_map *umap1,
2872                 __isl_take isl_union_map *umap2);
2874 The above functions compute the cross product of the given
2875 sets or relations.  The domains and ranges of the results
2876 are wrapped maps between domains and ranges of the inputs.
2877 To obtain a ``flat'' product, use the following functions
2878 instead.
2880         __isl_give isl_basic_set *isl_basic_set_flat_product(
2881                 __isl_take isl_basic_set *bset1,
2882                 __isl_take isl_basic_set *bset2);
2883         __isl_give isl_set *isl_set_flat_product(
2884                 __isl_take isl_set *set1,
2885                 __isl_take isl_set *set2);
2886         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2887                 __isl_take isl_basic_map *bmap1,
2888                 __isl_take isl_basic_map *bmap2);
2889         __isl_give isl_map *isl_map_flat_domain_product(
2890                 __isl_take isl_map *map1,
2891                 __isl_take isl_map *map2);
2892         __isl_give isl_map *isl_map_flat_range_product(
2893                 __isl_take isl_map *map1,
2894                 __isl_take isl_map *map2);
2895         __isl_give isl_union_map *isl_union_map_flat_range_product(
2896                 __isl_take isl_union_map *umap1,
2897                 __isl_take isl_union_map *umap2);
2898         __isl_give isl_basic_map *isl_basic_map_flat_product(
2899                 __isl_take isl_basic_map *bmap1,
2900                 __isl_take isl_basic_map *bmap2);
2901         __isl_give isl_map *isl_map_flat_product(
2902                 __isl_take isl_map *map1,
2903                 __isl_take isl_map *map2);
2905 =item * Simplification
2907         __isl_give isl_basic_set *isl_basic_set_gist(
2908                 __isl_take isl_basic_set *bset,
2909                 __isl_take isl_basic_set *context);
2910         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2911                 __isl_take isl_set *context);
2912         __isl_give isl_set *isl_set_gist_params(
2913                 __isl_take isl_set *set,
2914                 __isl_take isl_set *context);
2915         __isl_give isl_union_set *isl_union_set_gist(
2916                 __isl_take isl_union_set *uset,
2917                 __isl_take isl_union_set *context);
2918         __isl_give isl_union_set *isl_union_set_gist_params(
2919                 __isl_take isl_union_set *uset,
2920                 __isl_take isl_set *set);
2921         __isl_give isl_basic_map *isl_basic_map_gist(
2922                 __isl_take isl_basic_map *bmap,
2923                 __isl_take isl_basic_map *context);
2924         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2925                 __isl_take isl_map *context);
2926         __isl_give isl_map *isl_map_gist_params(
2927                 __isl_take isl_map *map,
2928                 __isl_take isl_set *context);
2929         __isl_give isl_map *isl_map_gist_domain(
2930                 __isl_take isl_map *map,
2931                 __isl_take isl_set *context);
2932         __isl_give isl_map *isl_map_gist_range(
2933                 __isl_take isl_map *map,
2934                 __isl_take isl_set *context);
2935         __isl_give isl_union_map *isl_union_map_gist(
2936                 __isl_take isl_union_map *umap,
2937                 __isl_take isl_union_map *context);
2938         __isl_give isl_union_map *isl_union_map_gist_params(
2939                 __isl_take isl_union_map *umap,
2940                 __isl_take isl_set *set);
2941         __isl_give isl_union_map *isl_union_map_gist_domain(
2942                 __isl_take isl_union_map *umap,
2943                 __isl_take isl_union_set *uset);
2944         __isl_give isl_union_map *isl_union_map_gist_range(
2945                 __isl_take isl_union_map *umap,
2946                 __isl_take isl_union_set *uset);
2948 The gist operation returns a set or relation that has the
2949 same intersection with the context as the input set or relation.
2950 Any implicit equality in the intersection is made explicit in the result,
2951 while all inequalities that are redundant with respect to the intersection
2952 are removed.
2953 In case of union sets and relations, the gist operation is performed
2954 per space.
2956 =back
2958 =head3 Lexicographic Optimization
2960 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2961 the following functions
2962 compute a set that contains the lexicographic minimum or maximum
2963 of the elements in C<set> (or C<bset>) for those values of the parameters
2964 that satisfy C<dom>.
2965 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2966 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2967 has no elements.
2968 In other words, the union of the parameter values
2969 for which the result is non-empty and of C<*empty>
2970 is equal to C<dom>.
2972         __isl_give isl_set *isl_basic_set_partial_lexmin(
2973                 __isl_take isl_basic_set *bset,
2974                 __isl_take isl_basic_set *dom,
2975                 __isl_give isl_set **empty);
2976         __isl_give isl_set *isl_basic_set_partial_lexmax(
2977                 __isl_take isl_basic_set *bset,
2978                 __isl_take isl_basic_set *dom,
2979                 __isl_give isl_set **empty);
2980         __isl_give isl_set *isl_set_partial_lexmin(
2981                 __isl_take isl_set *set, __isl_take isl_set *dom,
2982                 __isl_give isl_set **empty);
2983         __isl_give isl_set *isl_set_partial_lexmax(
2984                 __isl_take isl_set *set, __isl_take isl_set *dom,
2985                 __isl_give isl_set **empty);
2987 Given a (basic) set C<set> (or C<bset>), the following functions simply
2988 return a set containing the lexicographic minimum or maximum
2989 of the elements in C<set> (or C<bset>).
2990 In case of union sets, the optimum is computed per space.
2992         __isl_give isl_set *isl_basic_set_lexmin(
2993                 __isl_take isl_basic_set *bset);
2994         __isl_give isl_set *isl_basic_set_lexmax(
2995                 __isl_take isl_basic_set *bset);
2996         __isl_give isl_set *isl_set_lexmin(
2997                 __isl_take isl_set *set);
2998         __isl_give isl_set *isl_set_lexmax(
2999                 __isl_take isl_set *set);
3000         __isl_give isl_union_set *isl_union_set_lexmin(
3001                 __isl_take isl_union_set *uset);
3002         __isl_give isl_union_set *isl_union_set_lexmax(
3003                 __isl_take isl_union_set *uset);
3005 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3006 the following functions
3007 compute a relation that maps each element of C<dom>
3008 to the single lexicographic minimum or maximum
3009 of the elements that are associated to that same
3010 element in C<map> (or C<bmap>).
3011 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3012 that contains the elements in C<dom> that do not map
3013 to any elements in C<map> (or C<bmap>).
3014 In other words, the union of the domain of the result and of C<*empty>
3015 is equal to C<dom>.
3017         __isl_give isl_map *isl_basic_map_partial_lexmax(
3018                 __isl_take isl_basic_map *bmap,
3019                 __isl_take isl_basic_set *dom,
3020                 __isl_give isl_set **empty);
3021         __isl_give isl_map *isl_basic_map_partial_lexmin(
3022                 __isl_take isl_basic_map *bmap,
3023                 __isl_take isl_basic_set *dom,
3024                 __isl_give isl_set **empty);
3025         __isl_give isl_map *isl_map_partial_lexmax(
3026                 __isl_take isl_map *map, __isl_take isl_set *dom,
3027                 __isl_give isl_set **empty);
3028         __isl_give isl_map *isl_map_partial_lexmin(
3029                 __isl_take isl_map *map, __isl_take isl_set *dom,
3030                 __isl_give isl_set **empty);
3032 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3033 return a map mapping each element in the domain of
3034 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3035 of all elements associated to that element.
3036 In case of union relations, the optimum is computed per space.
3038         __isl_give isl_map *isl_basic_map_lexmin(
3039                 __isl_take isl_basic_map *bmap);
3040         __isl_give isl_map *isl_basic_map_lexmax(
3041                 __isl_take isl_basic_map *bmap);
3042         __isl_give isl_map *isl_map_lexmin(
3043                 __isl_take isl_map *map);
3044         __isl_give isl_map *isl_map_lexmax(
3045                 __isl_take isl_map *map);
3046         __isl_give isl_union_map *isl_union_map_lexmin(
3047                 __isl_take isl_union_map *umap);
3048         __isl_give isl_union_map *isl_union_map_lexmax(
3049                 __isl_take isl_union_map *umap);
3051 The following functions return their result in the form of
3052 a piecewise multi-affine expression
3053 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3054 but are otherwise equivalent to the corresponding functions
3055 returning a basic set or relation.
3057         __isl_give isl_pw_multi_aff *
3058         isl_basic_map_lexmin_pw_multi_aff(
3059                 __isl_take isl_basic_map *bmap);
3060         __isl_give isl_pw_multi_aff *
3061         isl_basic_set_partial_lexmin_pw_multi_aff(
3062                 __isl_take isl_basic_set *bset,
3063                 __isl_take isl_basic_set *dom,
3064                 __isl_give isl_set **empty);
3065         __isl_give isl_pw_multi_aff *
3066         isl_basic_set_partial_lexmax_pw_multi_aff(
3067                 __isl_take isl_basic_set *bset,
3068                 __isl_take isl_basic_set *dom,
3069                 __isl_give isl_set **empty);
3070         __isl_give isl_pw_multi_aff *
3071         isl_basic_map_partial_lexmin_pw_multi_aff(
3072                 __isl_take isl_basic_map *bmap,
3073                 __isl_take isl_basic_set *dom,
3074                 __isl_give isl_set **empty);
3075         __isl_give isl_pw_multi_aff *
3076         isl_basic_map_partial_lexmax_pw_multi_aff(
3077                 __isl_take isl_basic_map *bmap,
3078                 __isl_take isl_basic_set *dom,
3079                 __isl_give isl_set **empty);
3080         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3081                 __isl_take isl_set *set);
3082         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3083                 __isl_take isl_set *set);
3084         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3085                 __isl_take isl_map *map);
3086         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3087                 __isl_take isl_map *map);
3089 =head2 Lists
3091 Lists are defined over several element types, including
3092 C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3093 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3094 Here we take lists of C<isl_set>s as an example.
3095 Lists can be created, copied, modified and freed using the following functions.
3097         #include <isl/list.h>
3098         __isl_give isl_set_list *isl_set_list_from_set(
3099                 __isl_take isl_set *el);
3100         __isl_give isl_set_list *isl_set_list_alloc(
3101                 isl_ctx *ctx, int n);
3102         __isl_give isl_set_list *isl_set_list_copy(
3103                 __isl_keep isl_set_list *list);
3104         __isl_give isl_set_list *isl_set_list_insert(
3105                 __isl_take isl_set_list *list, unsigned pos,
3106                 __isl_take isl_set *el);
3107         __isl_give isl_set_list *isl_set_list_add(
3108                 __isl_take isl_set_list *list,
3109                 __isl_take isl_set *el);
3110         __isl_give isl_set_list *isl_set_list_drop(
3111                 __isl_take isl_set_list *list,
3112                 unsigned first, unsigned n);
3113         __isl_give isl_set_list *isl_set_list_set_set(
3114                 __isl_take isl_set_list *list, int index,
3115                 __isl_take isl_set *set);
3116         __isl_give isl_set_list *isl_set_list_concat(
3117                 __isl_take isl_set_list *list1,
3118                 __isl_take isl_set_list *list2);
3119         __isl_give isl_set_list *isl_set_list_sort(
3120                 __isl_take isl_set_list *list,
3121                 int (*cmp)(__isl_keep isl_set *a,
3122                         __isl_keep isl_set *b, void *user),
3123                 void *user);
3124         void *isl_set_list_free(__isl_take isl_set_list *list);
3126 C<isl_set_list_alloc> creates an empty list with a capacity for
3127 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3128 element.
3130 Lists can be inspected using the following functions.
3132         #include <isl/list.h>
3133         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3134         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3135         __isl_give isl_set *isl_set_list_get_set(
3136                 __isl_keep isl_set_list *list, int index);
3137         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3138                 int (*fn)(__isl_take isl_set *el, void *user),
3139                 void *user);
3140         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3141                 int (*follows)(__isl_keep isl_set *a,
3142                         __isl_keep isl_set *b, void *user),
3143                 void *follows_user
3144                 int (*fn)(__isl_take isl_set *el, void *user),
3145                 void *fn_user);
3147 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3148 strongly connected components of the graph with as vertices the elements
3149 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3150 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
3151 should return C<-1> on error.
3153 Lists can be printed using
3155         #include <isl/list.h>
3156         __isl_give isl_printer *isl_printer_print_set_list(
3157                 __isl_take isl_printer *p,
3158                 __isl_keep isl_set_list *list);
3160 =head2 Vectors
3162 Vectors can be created, copied and freed using the following functions.
3164         #include <isl/vec.h>
3165         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3166                 unsigned size);
3167         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3168         void *isl_vec_free(__isl_take isl_vec *vec);
3170 Note that the elements of a newly created vector may have arbitrary values.
3171 The elements can be changed and inspected using the following functions.
3173         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3174         int isl_vec_size(__isl_keep isl_vec *vec);
3175         int isl_vec_get_element(__isl_keep isl_vec *vec,
3176                 int pos, isl_int *v);
3177         __isl_give isl_vec *isl_vec_set_element(
3178                 __isl_take isl_vec *vec, int pos, isl_int v);
3179         __isl_give isl_vec *isl_vec_set_element_si(
3180                 __isl_take isl_vec *vec, int pos, int v);
3181         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3182                 isl_int v);
3183         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3184                 int v);
3185         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3186                 isl_int m);
3188 C<isl_vec_get_element> will return a negative value if anything went wrong.
3189 In that case, the value of C<*v> is undefined.
3191 The following function can be used to concatenate two vectors.
3193         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3194                 __isl_take isl_vec *vec2);
3196 =head2 Matrices
3198 Matrices can be created, copied and freed using the following functions.
3200         #include <isl/mat.h>
3201         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3202                 unsigned n_row, unsigned n_col);
3203         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3204         void *isl_mat_free(__isl_take isl_mat *mat);
3206 Note that the elements of a newly created matrix may have arbitrary values.
3207 The elements can be changed and inspected using the following functions.
3209         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3210         int isl_mat_rows(__isl_keep isl_mat *mat);
3211         int isl_mat_cols(__isl_keep isl_mat *mat);
3212         int isl_mat_get_element(__isl_keep isl_mat *mat,
3213                 int row, int col, isl_int *v);
3214         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3215                 int row, int col, isl_int v);
3216         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3217                 int row, int col, int v);
3219 C<isl_mat_get_element> will return a negative value if anything went wrong.
3220 In that case, the value of C<*v> is undefined.
3222 The following function can be used to compute the (right) inverse
3223 of a matrix, i.e., a matrix such that the product of the original
3224 and the inverse (in that order) is a multiple of the identity matrix.
3225 The input matrix is assumed to be of full row-rank.
3227         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3229 The following function can be used to compute the (right) kernel
3230 (or null space) of a matrix, i.e., a matrix such that the product of
3231 the original and the kernel (in that order) is the zero matrix.
3233         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3235 =head2 Piecewise Quasi Affine Expressions
3237 The zero quasi affine expression or the quasi affine expression
3238 that is equal to a specified dimension on a given domain can be created using
3240         __isl_give isl_aff *isl_aff_zero_on_domain(
3241                 __isl_take isl_local_space *ls);
3242         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3243                 __isl_take isl_local_space *ls);
3244         __isl_give isl_aff *isl_aff_var_on_domain(
3245                 __isl_take isl_local_space *ls,
3246                 enum isl_dim_type type, unsigned pos);
3247         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3248                 __isl_take isl_local_space *ls,
3249                 enum isl_dim_type type, unsigned pos);
3251 Note that the space in which the resulting objects live is a map space
3252 with the given space as domain and a one-dimensional range.
3254 An empty piecewise quasi affine expression (one with no cells)
3255 or a piecewise quasi affine expression with a single cell can
3256 be created using the following functions.
3258         #include <isl/aff.h>
3259         __isl_give isl_pw_aff *isl_pw_aff_empty(
3260                 __isl_take isl_space *space);
3261         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3262                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3263         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3264                 __isl_take isl_aff *aff);
3266 A piecewise quasi affine expression that is equal to 1 on a set
3267 and 0 outside the set can be created using the following function.
3269         #include <isl/aff.h>
3270         __isl_give isl_pw_aff *isl_set_indicator_function(
3271                 __isl_take isl_set *set);
3273 Quasi affine expressions can be copied and freed using
3275         #include <isl/aff.h>
3276         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3277         void *isl_aff_free(__isl_take isl_aff *aff);
3279         __isl_give isl_pw_aff *isl_pw_aff_copy(
3280                 __isl_keep isl_pw_aff *pwaff);
3281         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3283 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3284 using the following function.  The constraint is required to have
3285 a non-zero coefficient for the specified dimension.
3287         #include <isl/constraint.h>
3288         __isl_give isl_aff *isl_constraint_get_bound(
3289                 __isl_keep isl_constraint *constraint,
3290                 enum isl_dim_type type, int pos);
3292 The entire affine expression of the constraint can also be extracted
3293 using the following function.
3295         #include <isl/constraint.h>
3296         __isl_give isl_aff *isl_constraint_get_aff(
3297                 __isl_keep isl_constraint *constraint);
3299 Conversely, an equality constraint equating
3300 the affine expression to zero or an inequality constraint enforcing
3301 the affine expression to be non-negative, can be constructed using
3303         __isl_give isl_constraint *isl_equality_from_aff(
3304                 __isl_take isl_aff *aff);
3305         __isl_give isl_constraint *isl_inequality_from_aff(
3306                 __isl_take isl_aff *aff);
3308 The expression can be inspected using
3310         #include <isl/aff.h>
3311         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3312         int isl_aff_dim(__isl_keep isl_aff *aff,
3313                 enum isl_dim_type type);
3314         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3315                 __isl_keep isl_aff *aff);
3316         __isl_give isl_local_space *isl_aff_get_local_space(
3317                 __isl_keep isl_aff *aff);
3318         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3319                 enum isl_dim_type type, unsigned pos);
3320         const char *isl_pw_aff_get_dim_name(
3321                 __isl_keep isl_pw_aff *pa,
3322                 enum isl_dim_type type, unsigned pos);
3323         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3324                 enum isl_dim_type type, unsigned pos);
3325         __isl_give isl_id *isl_pw_aff_get_dim_id(
3326                 __isl_keep isl_pw_aff *pa,
3327                 enum isl_dim_type type, unsigned pos);
3328         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3329                 __isl_keep isl_pw_aff *pa,
3330                 enum isl_dim_type type);
3331         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3332                 isl_int *v);
3333         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3334                 enum isl_dim_type type, int pos, isl_int *v);
3335         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3336                 isl_int *v);
3337         __isl_give isl_aff *isl_aff_get_div(
3338                 __isl_keep isl_aff *aff, int pos);
3340         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3341         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3342                 int (*fn)(__isl_take isl_set *set,
3343                           __isl_take isl_aff *aff,
3344                           void *user), void *user);
3346         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3347         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3349         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3350                 enum isl_dim_type type, unsigned first, unsigned n);
3351         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3352                 enum isl_dim_type type, unsigned first, unsigned n);
3354         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3355         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3356                 enum isl_dim_type type);
3357         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3359 It can be modified using
3361         #include <isl/aff.h>
3362         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3363                 __isl_take isl_pw_aff *pwaff,
3364                 enum isl_dim_type type, __isl_take isl_id *id);
3365         __isl_give isl_aff *isl_aff_set_dim_name(
3366                 __isl_take isl_aff *aff, enum isl_dim_type type,
3367                 unsigned pos, const char *s);
3368         __isl_give isl_aff *isl_aff_set_dim_id(
3369                 __isl_take isl_aff *aff, enum isl_dim_type type,
3370                 unsigned pos, __isl_take isl_id *id);
3371         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3372                 __isl_take isl_pw_aff *pma,
3373                 enum isl_dim_type type, unsigned pos,
3374                 __isl_take isl_id *id);
3375         __isl_give isl_aff *isl_aff_set_constant(
3376                 __isl_take isl_aff *aff, isl_int v);
3377         __isl_give isl_aff *isl_aff_set_constant_si(
3378                 __isl_take isl_aff *aff, int v);
3379         __isl_give isl_aff *isl_aff_set_coefficient(
3380                 __isl_take isl_aff *aff,
3381                 enum isl_dim_type type, int pos, isl_int v);
3382         __isl_give isl_aff *isl_aff_set_coefficient_si(
3383                 __isl_take isl_aff *aff,
3384                 enum isl_dim_type type, int pos, int v);
3385         __isl_give isl_aff *isl_aff_set_denominator(
3386                 __isl_take isl_aff *aff, isl_int v);
3388         __isl_give isl_aff *isl_aff_add_constant(
3389                 __isl_take isl_aff *aff, isl_int v);
3390         __isl_give isl_aff *isl_aff_add_constant_si(
3391                 __isl_take isl_aff *aff, int v);
3392         __isl_give isl_aff *isl_aff_add_constant_num(
3393                 __isl_take isl_aff *aff, isl_int v);
3394         __isl_give isl_aff *isl_aff_add_constant_num_si(
3395                 __isl_take isl_aff *aff, int v);
3396         __isl_give isl_aff *isl_aff_add_coefficient(
3397                 __isl_take isl_aff *aff,
3398                 enum isl_dim_type type, int pos, isl_int v);
3399         __isl_give isl_aff *isl_aff_add_coefficient_si(
3400                 __isl_take isl_aff *aff,
3401                 enum isl_dim_type type, int pos, int v);
3403         __isl_give isl_aff *isl_aff_insert_dims(
3404                 __isl_take isl_aff *aff,
3405                 enum isl_dim_type type, unsigned first, unsigned n);
3406         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3407                 __isl_take isl_pw_aff *pwaff,
3408                 enum isl_dim_type type, unsigned first, unsigned n);
3409         __isl_give isl_aff *isl_aff_add_dims(
3410                 __isl_take isl_aff *aff,
3411                 enum isl_dim_type type, unsigned n);
3412         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3413                 __isl_take isl_pw_aff *pwaff,
3414                 enum isl_dim_type type, unsigned n);
3415         __isl_give isl_aff *isl_aff_drop_dims(
3416                 __isl_take isl_aff *aff,
3417                 enum isl_dim_type type, unsigned first, unsigned n);
3418         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3419                 __isl_take isl_pw_aff *pwaff,
3420                 enum isl_dim_type type, unsigned first, unsigned n);
3422 Note that the C<set_constant> and C<set_coefficient> functions
3423 set the I<numerator> of the constant or coefficient, while
3424 C<add_constant> and C<add_coefficient> add an integer value to
3425 the possibly rational constant or coefficient.
3426 The C<add_constant_num> functions add an integer value to
3427 the numerator.
3429 To check whether an affine expressions is obviously zero
3430 or obviously equal to some other affine expression, use
3432         #include <isl/aff.h>
3433         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3434         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3435                 __isl_keep isl_aff *aff2);
3436         int isl_pw_aff_plain_is_equal(
3437                 __isl_keep isl_pw_aff *pwaff1,
3438                 __isl_keep isl_pw_aff *pwaff2);
3440 Operations include
3442         #include <isl/aff.h>
3443         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3444                 __isl_take isl_aff *aff2);
3445         __isl_give isl_pw_aff *isl_pw_aff_add(
3446                 __isl_take isl_pw_aff *pwaff1,
3447                 __isl_take isl_pw_aff *pwaff2);
3448         __isl_give isl_pw_aff *isl_pw_aff_min(
3449                 __isl_take isl_pw_aff *pwaff1,
3450                 __isl_take isl_pw_aff *pwaff2);
3451         __isl_give isl_pw_aff *isl_pw_aff_max(
3452                 __isl_take isl_pw_aff *pwaff1,
3453                 __isl_take isl_pw_aff *pwaff2);
3454         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3455                 __isl_take isl_aff *aff2);
3456         __isl_give isl_pw_aff *isl_pw_aff_sub(
3457                 __isl_take isl_pw_aff *pwaff1,
3458                 __isl_take isl_pw_aff *pwaff2);
3459         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3460         __isl_give isl_pw_aff *isl_pw_aff_neg(
3461                 __isl_take isl_pw_aff *pwaff);
3462         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3463         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3464                 __isl_take isl_pw_aff *pwaff);
3465         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3466         __isl_give isl_pw_aff *isl_pw_aff_floor(
3467                 __isl_take isl_pw_aff *pwaff);
3468         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3469                 isl_int mod);
3470         __isl_give isl_pw_aff *isl_pw_aff_mod(
3471                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3472         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3473                 isl_int f);
3474         __isl_give isl_pw_aff *isl_pw_aff_scale(
3475                 __isl_take isl_pw_aff *pwaff, isl_int f);
3476         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3477                 isl_int f);
3478         __isl_give isl_aff *isl_aff_scale_down_ui(
3479                 __isl_take isl_aff *aff, unsigned f);
3480         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3481                 __isl_take isl_pw_aff *pwaff, isl_int f);
3483         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3484                 __isl_take isl_pw_aff_list *list);
3485         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3486                 __isl_take isl_pw_aff_list *list);
3488         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3489                 __isl_take isl_pw_aff *pwqp);
3491         __isl_give isl_aff *isl_aff_align_params(
3492                 __isl_take isl_aff *aff,
3493                 __isl_take isl_space *model);
3494         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3495                 __isl_take isl_pw_aff *pwaff,
3496                 __isl_take isl_space *model);
3498         __isl_give isl_aff *isl_aff_project_domain_on_params(
3499                 __isl_take isl_aff *aff);
3501         __isl_give isl_aff *isl_aff_gist_params(
3502                 __isl_take isl_aff *aff,
3503                 __isl_take isl_set *context);
3504         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3505                 __isl_take isl_set *context);
3506         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3507                 __isl_take isl_pw_aff *pwaff,
3508                 __isl_take isl_set *context);
3509         __isl_give isl_pw_aff *isl_pw_aff_gist(
3510                 __isl_take isl_pw_aff *pwaff,
3511                 __isl_take isl_set *context);
3513         __isl_give isl_set *isl_pw_aff_domain(
3514                 __isl_take isl_pw_aff *pwaff);
3515         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3516                 __isl_take isl_pw_aff *pa,
3517                 __isl_take isl_set *set);
3518         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3519                 __isl_take isl_pw_aff *pa,
3520                 __isl_take isl_set *set);
3522         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3523                 __isl_take isl_aff *aff2);
3524         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3525                 __isl_take isl_aff *aff2);
3526         __isl_give isl_pw_aff *isl_pw_aff_mul(
3527                 __isl_take isl_pw_aff *pwaff1,
3528                 __isl_take isl_pw_aff *pwaff2);
3529         __isl_give isl_pw_aff *isl_pw_aff_div(
3530                 __isl_take isl_pw_aff *pa1,
3531                 __isl_take isl_pw_aff *pa2);
3532         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3533                 __isl_take isl_pw_aff *pa1,
3534                 __isl_take isl_pw_aff *pa2);
3535         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3536                 __isl_take isl_pw_aff *pa1,
3537                 __isl_take isl_pw_aff *pa2);
3539 When multiplying two affine expressions, at least one of the two needs
3540 to be a constant.  Similarly, when dividing an affine expression by another,
3541 the second expression needs to be a constant.
3542 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3543 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3544 remainder.
3546         #include <isl/aff.h>
3547         __isl_give isl_aff *isl_aff_pullback_multi_aff(
3548                 __isl_take isl_aff *aff,
3549                 __isl_take isl_multi_aff *ma);
3550         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3551                 __isl_take isl_pw_aff *pa,
3552                 __isl_take isl_multi_aff *ma);
3553         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3554                 __isl_take isl_pw_aff *pa,
3555                 __isl_take isl_pw_multi_aff *pma);
3557 These functions precompose the input expression by the given
3558 C<isl_multi_aff> or C<isl_pw_multi_aff>.  In other words,
3559 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3560 into the (piecewise) affine expression.
3561 Objects of type C<isl_multi_aff> are described in
3562 L</"Piecewise Multiple Quasi Affine Expressions">.
3564         #include <isl/aff.h>
3565         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3566                 __isl_take isl_aff *aff);
3567         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3568                 __isl_take isl_aff *aff);
3569         __isl_give isl_basic_set *isl_aff_le_basic_set(
3570                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3571         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3572                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3573         __isl_give isl_set *isl_pw_aff_eq_set(
3574                 __isl_take isl_pw_aff *pwaff1,
3575                 __isl_take isl_pw_aff *pwaff2);
3576         __isl_give isl_set *isl_pw_aff_ne_set(
3577                 __isl_take isl_pw_aff *pwaff1,
3578                 __isl_take isl_pw_aff *pwaff2);
3579         __isl_give isl_set *isl_pw_aff_le_set(
3580                 __isl_take isl_pw_aff *pwaff1,
3581                 __isl_take isl_pw_aff *pwaff2);
3582         __isl_give isl_set *isl_pw_aff_lt_set(
3583                 __isl_take isl_pw_aff *pwaff1,
3584                 __isl_take isl_pw_aff *pwaff2);
3585         __isl_give isl_set *isl_pw_aff_ge_set(
3586                 __isl_take isl_pw_aff *pwaff1,
3587                 __isl_take isl_pw_aff *pwaff2);
3588         __isl_give isl_set *isl_pw_aff_gt_set(
3589                 __isl_take isl_pw_aff *pwaff1,
3590                 __isl_take isl_pw_aff *pwaff2);
3592         __isl_give isl_set *isl_pw_aff_list_eq_set(
3593                 __isl_take isl_pw_aff_list *list1,
3594                 __isl_take isl_pw_aff_list *list2);
3595         __isl_give isl_set *isl_pw_aff_list_ne_set(
3596                 __isl_take isl_pw_aff_list *list1,
3597                 __isl_take isl_pw_aff_list *list2);
3598         __isl_give isl_set *isl_pw_aff_list_le_set(
3599                 __isl_take isl_pw_aff_list *list1,
3600                 __isl_take isl_pw_aff_list *list2);
3601         __isl_give isl_set *isl_pw_aff_list_lt_set(
3602                 __isl_take isl_pw_aff_list *list1,
3603                 __isl_take isl_pw_aff_list *list2);
3604         __isl_give isl_set *isl_pw_aff_list_ge_set(
3605                 __isl_take isl_pw_aff_list *list1,
3606                 __isl_take isl_pw_aff_list *list2);
3607         __isl_give isl_set *isl_pw_aff_list_gt_set(
3608                 __isl_take isl_pw_aff_list *list1,
3609                 __isl_take isl_pw_aff_list *list2);
3611 The function C<isl_aff_neg_basic_set> returns a basic set
3612 containing those elements in the domain space
3613 of C<aff> where C<aff> is negative.
3614 The function C<isl_aff_ge_basic_set> returns a basic set
3615 containing those elements in the shared space
3616 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3617 The function C<isl_pw_aff_ge_set> returns a set
3618 containing those elements in the shared domain
3619 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3620 The functions operating on C<isl_pw_aff_list> apply the corresponding
3621 C<isl_pw_aff> function to each pair of elements in the two lists.
3623         #include <isl/aff.h>
3624         __isl_give isl_set *isl_pw_aff_nonneg_set(
3625                 __isl_take isl_pw_aff *pwaff);
3626         __isl_give isl_set *isl_pw_aff_zero_set(
3627                 __isl_take isl_pw_aff *pwaff);
3628         __isl_give isl_set *isl_pw_aff_non_zero_set(
3629                 __isl_take isl_pw_aff *pwaff);
3631 The function C<isl_pw_aff_nonneg_set> returns a set
3632 containing those elements in the domain
3633 of C<pwaff> where C<pwaff> is non-negative.
3635         #include <isl/aff.h>
3636         __isl_give isl_pw_aff *isl_pw_aff_cond(
3637                 __isl_take isl_pw_aff *cond,
3638                 __isl_take isl_pw_aff *pwaff_true,
3639                 __isl_take isl_pw_aff *pwaff_false);
3641 The function C<isl_pw_aff_cond> performs a conditional operator
3642 and returns an expression that is equal to C<pwaff_true>
3643 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3644 where C<cond> is zero.
3646         #include <isl/aff.h>
3647         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3648                 __isl_take isl_pw_aff *pwaff1,
3649                 __isl_take isl_pw_aff *pwaff2);
3650         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3651                 __isl_take isl_pw_aff *pwaff1,
3652                 __isl_take isl_pw_aff *pwaff2);
3653         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3654                 __isl_take isl_pw_aff *pwaff1,
3655                 __isl_take isl_pw_aff *pwaff2);
3657 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3658 expression with a domain that is the union of those of C<pwaff1> and
3659 C<pwaff2> and such that on each cell, the quasi-affine expression is
3660 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3661 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3662 associated expression is the defined one.
3664 An expression can be read from input using
3666         #include <isl/aff.h>
3667         __isl_give isl_aff *isl_aff_read_from_str(
3668                 isl_ctx *ctx, const char *str);
3669         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3670                 isl_ctx *ctx, const char *str);
3672 An expression can be printed using
3674         #include <isl/aff.h>
3675         __isl_give isl_printer *isl_printer_print_aff(
3676                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3678         __isl_give isl_printer *isl_printer_print_pw_aff(
3679                 __isl_take isl_printer *p,
3680                 __isl_keep isl_pw_aff *pwaff);
3682 =head2 Piecewise Multiple Quasi Affine Expressions
3684 An C<isl_multi_aff> object represents a sequence of
3685 zero or more affine expressions, all defined on the same domain space.
3686 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
3687 zero or more piecewise affine expressions.
3689 An C<isl_multi_aff> can be constructed from a single
3690 C<isl_aff> or an C<isl_aff_list> using the
3691 following functions.  Similarly for C<isl_multi_pw_aff>.
3693         #include <isl/aff.h>
3694         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
3695                 __isl_take isl_aff *aff);
3696         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
3697                 __isl_take isl_pw_aff *pa);
3698         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3699                 __isl_take isl_space *space,
3700                 __isl_take isl_aff_list *list);
3702 An empty piecewise multiple quasi affine expression (one with no cells),
3703 the zero piecewise multiple quasi affine expression (with value zero
3704 for each output dimension),
3705 a piecewise multiple quasi affine expression with a single cell (with
3706 either a universe or a specified domain) or
3707 a zero-dimensional piecewise multiple quasi affine expression
3708 on a given domain
3709 can be created using the following functions.
3711         #include <isl/aff.h>
3712         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3713                 __isl_take isl_space *space);
3714         __isl_give isl_multi_aff *isl_multi_aff_zero(
3715                 __isl_take isl_space *space);
3716         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
3717                 __isl_take isl_space *space);
3718         __isl_give isl_multi_aff *isl_multi_aff_identity(
3719                 __isl_take isl_space *space);
3720         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3721                 __isl_take isl_space *space);
3722         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
3723                 __isl_take isl_space *space);
3724         __isl_give isl_pw_multi_aff *
3725         isl_pw_multi_aff_from_multi_aff(
3726                 __isl_take isl_multi_aff *ma);
3727         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3728                 __isl_take isl_set *set,
3729                 __isl_take isl_multi_aff *maff);
3730         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3731                 __isl_take isl_set *set);
3733         __isl_give isl_union_pw_multi_aff *
3734         isl_union_pw_multi_aff_empty(
3735                 __isl_take isl_space *space);
3736         __isl_give isl_union_pw_multi_aff *
3737         isl_union_pw_multi_aff_add_pw_multi_aff(
3738                 __isl_take isl_union_pw_multi_aff *upma,
3739                 __isl_take isl_pw_multi_aff *pma);
3740         __isl_give isl_union_pw_multi_aff *
3741         isl_union_pw_multi_aff_from_domain(
3742                 __isl_take isl_union_set *uset);
3744 A piecewise multiple quasi affine expression can also be initialized
3745 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3746 and the C<isl_map> is single-valued.
3747 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
3748 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
3750         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3751                 __isl_take isl_set *set);
3752         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3753                 __isl_take isl_map *map);
3755         __isl_give isl_union_pw_multi_aff *
3756         isl_union_pw_multi_aff_from_union_set(
3757                 __isl_take isl_union_set *uset);
3758         __isl_give isl_union_pw_multi_aff *
3759         isl_union_pw_multi_aff_from_union_map(
3760                 __isl_take isl_union_map *umap);
3762 Multiple quasi affine expressions can be copied and freed using
3764         #include <isl/aff.h>
3765         __isl_give isl_multi_aff *isl_multi_aff_copy(
3766                 __isl_keep isl_multi_aff *maff);
3767         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3769         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3770                 __isl_keep isl_pw_multi_aff *pma);
3771         void *isl_pw_multi_aff_free(
3772                 __isl_take isl_pw_multi_aff *pma);
3774         __isl_give isl_union_pw_multi_aff *
3775         isl_union_pw_multi_aff_copy(
3776                 __isl_keep isl_union_pw_multi_aff *upma);
3777         void *isl_union_pw_multi_aff_free(
3778                 __isl_take isl_union_pw_multi_aff *upma);
3780         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
3781                 __isl_keep isl_multi_pw_aff *mpa);
3782         void *isl_multi_pw_aff_free(
3783                 __isl_take isl_multi_pw_aff *mpa);
3785 The expression can be inspected using
3787         #include <isl/aff.h>
3788         isl_ctx *isl_multi_aff_get_ctx(
3789                 __isl_keep isl_multi_aff *maff);
3790         isl_ctx *isl_pw_multi_aff_get_ctx(
3791                 __isl_keep isl_pw_multi_aff *pma);
3792         isl_ctx *isl_union_pw_multi_aff_get_ctx(
3793                 __isl_keep isl_union_pw_multi_aff *upma);
3794         isl_ctx *isl_multi_pw_aff_get_ctx(
3795                 __isl_keep isl_multi_pw_aff *mpa);
3796         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3797                 enum isl_dim_type type);
3798         unsigned isl_pw_multi_aff_dim(
3799                 __isl_keep isl_pw_multi_aff *pma,
3800                 enum isl_dim_type type);
3801         unsigned isl_multi_pw_aff_dim(
3802                 __isl_keep isl_multi_pw_aff *mpa,
3803                 enum isl_dim_type type);
3804         __isl_give isl_aff *isl_multi_aff_get_aff(
3805                 __isl_keep isl_multi_aff *multi, int pos);
3806         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3807                 __isl_keep isl_pw_multi_aff *pma, int pos);
3808         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
3809                 __isl_keep isl_multi_pw_aff *mpa, int pos);
3810         const char *isl_pw_multi_aff_get_dim_name(
3811                 __isl_keep isl_pw_multi_aff *pma,
3812                 enum isl_dim_type type, unsigned pos);
3813         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3814                 __isl_keep isl_pw_multi_aff *pma,
3815                 enum isl_dim_type type, unsigned pos);
3816         const char *isl_multi_aff_get_tuple_name(
3817                 __isl_keep isl_multi_aff *multi,
3818                 enum isl_dim_type type);
3819         int isl_pw_multi_aff_has_tuple_name(
3820                 __isl_keep isl_pw_multi_aff *pma,
3821                 enum isl_dim_type type);
3822         const char *isl_pw_multi_aff_get_tuple_name(
3823                 __isl_keep isl_pw_multi_aff *pma,
3824                 enum isl_dim_type type);
3825         int isl_pw_multi_aff_has_tuple_id(
3826                 __isl_keep isl_pw_multi_aff *pma,
3827                 enum isl_dim_type type);
3828         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3829                 __isl_keep isl_pw_multi_aff *pma,
3830                 enum isl_dim_type type);
3832         int isl_pw_multi_aff_foreach_piece(
3833                 __isl_keep isl_pw_multi_aff *pma,
3834                 int (*fn)(__isl_take isl_set *set,
3835                             __isl_take isl_multi_aff *maff,
3836                             void *user), void *user);
3838         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
3839                 __isl_keep isl_union_pw_multi_aff *upma,
3840                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
3841                             void *user), void *user);
3843 It can be modified using
3845         #include <isl/aff.h>
3846         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
3847                 __isl_take isl_multi_aff *multi, int pos,
3848                 __isl_take isl_aff *aff);
3849         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
3850                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
3851                 __isl_take isl_pw_aff *pa);
3852         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3853                 __isl_take isl_multi_aff *maff,
3854                 enum isl_dim_type type, unsigned pos, const char *s);
3855         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
3856                 __isl_take isl_multi_aff *maff,
3857                 enum isl_dim_type type, const char *s);
3858         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
3859                 __isl_take isl_multi_aff *maff,
3860                 enum isl_dim_type type, __isl_take isl_id *id);
3861         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3862                 __isl_take isl_pw_multi_aff *pma,
3863                 enum isl_dim_type type, __isl_take isl_id *id);
3865         __isl_give isl_multi_pw_aff *
3866         isl_multi_pw_aff_set_dim_name(
3867                 __isl_take isl_multi_pw_aff *mpa,
3868                 enum isl_dim_type type, unsigned pos, const char *s);
3869         __isl_give isl_multi_pw_aff *
3870         isl_multi_pw_aff_set_tuple_name(
3871                 __isl_take isl_multi_pw_aff *mpa,
3872                 enum isl_dim_type type, const char *s);
3874         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
3875                 __isl_take isl_multi_aff *ma,
3876                 enum isl_dim_type type, unsigned first, unsigned n);
3877         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
3878                 __isl_take isl_multi_aff *ma,
3879                 enum isl_dim_type type, unsigned n);
3880         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
3881                 __isl_take isl_multi_aff *maff,
3882                 enum isl_dim_type type, unsigned first, unsigned n);
3883         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
3884                 __isl_take isl_pw_multi_aff *pma,
3885                 enum isl_dim_type type, unsigned first, unsigned n);
3887         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
3888                 __isl_take isl_multi_pw_aff *mpa,
3889                 enum isl_dim_type type, unsigned first, unsigned n);
3890         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
3891                 __isl_take isl_multi_pw_aff *mpa,
3892                 enum isl_dim_type type, unsigned n);
3894 To check whether two multiple affine expressions are
3895 obviously equal to each other, use
3897         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3898                 __isl_keep isl_multi_aff *maff2);
3899         int isl_pw_multi_aff_plain_is_equal(
3900                 __isl_keep isl_pw_multi_aff *pma1,
3901                 __isl_keep isl_pw_multi_aff *pma2);
3903 Operations include
3905         #include <isl/aff.h>
3906         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
3907                 __isl_take isl_pw_multi_aff *pma1,
3908                 __isl_take isl_pw_multi_aff *pma2);
3909         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
3910                 __isl_take isl_pw_multi_aff *pma1,
3911                 __isl_take isl_pw_multi_aff *pma2);
3912         __isl_give isl_multi_aff *isl_multi_aff_add(
3913                 __isl_take isl_multi_aff *maff1,
3914                 __isl_take isl_multi_aff *maff2);
3915         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3916                 __isl_take isl_pw_multi_aff *pma1,
3917                 __isl_take isl_pw_multi_aff *pma2);
3918         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
3919                 __isl_take isl_union_pw_multi_aff *upma1,
3920                 __isl_take isl_union_pw_multi_aff *upma2);
3921         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3922                 __isl_take isl_pw_multi_aff *pma1,
3923                 __isl_take isl_pw_multi_aff *pma2);
3924         __isl_give isl_multi_aff *isl_multi_aff_sub(
3925                 __isl_take isl_multi_aff *ma1,
3926                 __isl_take isl_multi_aff *ma2);
3927         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
3928                 __isl_take isl_pw_multi_aff *pma1,
3929                 __isl_take isl_pw_multi_aff *pma2);
3930         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
3931                 __isl_take isl_union_pw_multi_aff *upma1,
3932                 __isl_take isl_union_pw_multi_aff *upma2);
3934 C<isl_multi_aff_sub> subtracts the second argument from the first.
3936         __isl_give isl_multi_aff *isl_multi_aff_scale(
3937                 __isl_take isl_multi_aff *maff,
3938                 isl_int f);
3939         __isl_give isl_multi_aff *isl_multi_aff_scale_vec(
3940                 __isl_take isl_multi_aff *ma,
3941                 __isl_take isl_vec *v);
3942         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_vec(
3943                 __isl_take isl_pw_multi_aff *pma,
3944                 __isl_take isl_vec *v);
3945         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_scale_vec(
3946                 __isl_take isl_union_pw_multi_aff *upma,
3947                 __isl_take isl_vec *v);
3949 C<isl_multi_aff_scale_vec> scales the first elements of C<ma>
3950 by the corresponding elements of C<v>.
3952         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
3953                 __isl_take isl_pw_multi_aff *pma,
3954                 __isl_take isl_set *set);
3955         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3956                 __isl_take isl_pw_multi_aff *pma,
3957                 __isl_take isl_set *set);
3958         __isl_give isl_union_pw_multi_aff *
3959         isl_union_pw_multi_aff_intersect_domain(
3960                 __isl_take isl_union_pw_multi_aff *upma,
3961                 __isl_take isl_union_set *uset);
3962         __isl_give isl_multi_aff *isl_multi_aff_lift(
3963                 __isl_take isl_multi_aff *maff,
3964                 __isl_give isl_local_space **ls);
3965         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
3966                 __isl_take isl_pw_multi_aff *pma);
3967         __isl_give isl_multi_aff *isl_multi_aff_align_params(
3968                 __isl_take isl_multi_aff *multi,
3969                 __isl_take isl_space *model);
3970         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
3971                 __isl_take isl_pw_multi_aff *pma,
3972                 __isl_take isl_space *model);
3973         __isl_give isl_pw_multi_aff *
3974         isl_pw_multi_aff_project_domain_on_params(
3975                 __isl_take isl_pw_multi_aff *pma);
3976         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
3977                 __isl_take isl_multi_aff *maff,
3978                 __isl_take isl_set *context);
3979         __isl_give isl_multi_aff *isl_multi_aff_gist(
3980                 __isl_take isl_multi_aff *maff,
3981                 __isl_take isl_set *context);
3982         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
3983                 __isl_take isl_pw_multi_aff *pma,
3984                 __isl_take isl_set *set);
3985         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
3986                 __isl_take isl_pw_multi_aff *pma,
3987                 __isl_take isl_set *set);
3988         __isl_give isl_set *isl_pw_multi_aff_domain(
3989                 __isl_take isl_pw_multi_aff *pma);
3990         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
3991                 __isl_take isl_union_pw_multi_aff *upma);
3992         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
3993                 __isl_take isl_multi_aff *ma1, unsigned pos,
3994                 __isl_take isl_multi_aff *ma2);
3995         __isl_give isl_multi_aff *isl_multi_aff_splice(
3996                 __isl_take isl_multi_aff *ma1,
3997                 unsigned in_pos, unsigned out_pos,
3998                 __isl_take isl_multi_aff *ma2);
3999         __isl_give isl_multi_aff *isl_multi_aff_range_product(
4000                 __isl_take isl_multi_aff *ma1,
4001                 __isl_take isl_multi_aff *ma2);
4002         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4003                 __isl_take isl_multi_aff *ma1,
4004                 __isl_take isl_multi_aff *ma2);
4005         __isl_give isl_multi_aff *isl_multi_aff_product(
4006                 __isl_take isl_multi_aff *ma1,
4007                 __isl_take isl_multi_aff *ma2);
4008         __isl_give isl_pw_multi_aff *
4009         isl_pw_multi_aff_range_product(
4010                 __isl_take isl_pw_multi_aff *pma1,
4011                 __isl_take isl_pw_multi_aff *pma2);
4012         __isl_give isl_pw_multi_aff *
4013         isl_pw_multi_aff_flat_range_product(
4014                 __isl_take isl_pw_multi_aff *pma1,
4015                 __isl_take isl_pw_multi_aff *pma2);
4016         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4017                 __isl_take isl_pw_multi_aff *pma1,
4018                 __isl_take isl_pw_multi_aff *pma2);
4019         __isl_give isl_union_pw_multi_aff *
4020         isl_union_pw_multi_aff_flat_range_product(
4021                 __isl_take isl_union_pw_multi_aff *upma1,
4022                 __isl_take isl_union_pw_multi_aff *upma2);
4023         __isl_give isl_multi_pw_aff *
4024         isl_multi_pw_aff_range_splice(
4025                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4026                 __isl_take isl_multi_pw_aff *mpa2);
4027         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4028                 __isl_take isl_multi_pw_aff *mpa1,
4029                 unsigned in_pos, unsigned out_pos,
4030                 __isl_take isl_multi_pw_aff *mpa2);
4031         __isl_give isl_multi_pw_aff *
4032         isl_multi_pw_aff_range_product(
4033                 __isl_take isl_multi_pw_aff *mpa1,
4034                 __isl_take isl_multi_pw_aff *mpa2);
4035         __isl_give isl_multi_pw_aff *
4036         isl_multi_pw_aff_flat_range_product(
4037                 __isl_take isl_multi_pw_aff *mpa1,
4038                 __isl_take isl_multi_pw_aff *mpa2);
4040 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4041 then it is assigned the local space that lies at the basis of
4042 the lifting applied.
4044         #include <isl/aff.h>
4045         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4046                 __isl_take isl_multi_aff *ma1,
4047                 __isl_take isl_multi_aff *ma2);
4048         __isl_give isl_pw_multi_aff *
4049         isl_pw_multi_aff_pullback_multi_aff(
4050                 __isl_take isl_pw_multi_aff *pma,
4051                 __isl_take isl_multi_aff *ma);
4052         __isl_give isl_pw_multi_aff *
4053         isl_pw_multi_aff_pullback_pw_multi_aff(
4054                 __isl_take isl_pw_multi_aff *pma1,
4055                 __isl_take isl_pw_multi_aff *pma2);
4057 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4058 In other words, C<ma2> is plugged
4059 into C<ma1>.
4061         __isl_give isl_set *isl_multi_aff_lex_le_set(
4062                 __isl_take isl_multi_aff *ma1,
4063                 __isl_take isl_multi_aff *ma2);
4064         __isl_give isl_set *isl_multi_aff_lex_ge_set(
4065                 __isl_take isl_multi_aff *ma1,
4066                 __isl_take isl_multi_aff *ma2);
4068 The function C<isl_multi_aff_lex_le_set> returns a set
4069 containing those elements in the shared domain space
4070 where C<ma1> is lexicographically smaller than or
4071 equal to C<ma2>.
4073 An expression can be read from input using
4075         #include <isl/aff.h>
4076         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4077                 isl_ctx *ctx, const char *str);
4078         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4079                 isl_ctx *ctx, const char *str);
4080         __isl_give isl_union_pw_multi_aff *
4081         isl_union_pw_multi_aff_read_from_str(
4082                 isl_ctx *ctx, const char *str);
4084 An expression can be printed using
4086         #include <isl/aff.h>
4087         __isl_give isl_printer *isl_printer_print_multi_aff(
4088                 __isl_take isl_printer *p,
4089                 __isl_keep isl_multi_aff *maff);
4090         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4091                 __isl_take isl_printer *p,
4092                 __isl_keep isl_pw_multi_aff *pma);
4093         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4094                 __isl_take isl_printer *p,
4095                 __isl_keep isl_union_pw_multi_aff *upma);
4096         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4097                 __isl_take isl_printer *p,
4098                 __isl_keep isl_multi_pw_aff *mpa);
4100 =head2 Points
4102 Points are elements of a set.  They can be used to construct
4103 simple sets (boxes) or they can be used to represent the
4104 individual elements of a set.
4105 The zero point (the origin) can be created using
4107         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4109 The coordinates of a point can be inspected, set and changed
4110 using
4112         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
4113                 enum isl_dim_type type, int pos, isl_int *v);
4114         __isl_give isl_point *isl_point_set_coordinate(
4115                 __isl_take isl_point *pnt,
4116                 enum isl_dim_type type, int pos, isl_int v);
4118         __isl_give isl_point *isl_point_add_ui(
4119                 __isl_take isl_point *pnt,
4120                 enum isl_dim_type type, int pos, unsigned val);
4121         __isl_give isl_point *isl_point_sub_ui(
4122                 __isl_take isl_point *pnt,
4123                 enum isl_dim_type type, int pos, unsigned val);
4125 Other properties can be obtained using
4127         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4129 Points can be copied or freed using
4131         __isl_give isl_point *isl_point_copy(
4132                 __isl_keep isl_point *pnt);
4133         void isl_point_free(__isl_take isl_point *pnt);
4135 A singleton set can be created from a point using
4137         __isl_give isl_basic_set *isl_basic_set_from_point(
4138                 __isl_take isl_point *pnt);
4139         __isl_give isl_set *isl_set_from_point(
4140                 __isl_take isl_point *pnt);
4142 and a box can be created from two opposite extremal points using
4144         __isl_give isl_basic_set *isl_basic_set_box_from_points(
4145                 __isl_take isl_point *pnt1,
4146                 __isl_take isl_point *pnt2);
4147         __isl_give isl_set *isl_set_box_from_points(
4148                 __isl_take isl_point *pnt1,
4149                 __isl_take isl_point *pnt2);
4151 All elements of a B<bounded> (union) set can be enumerated using
4152 the following functions.
4154         int isl_set_foreach_point(__isl_keep isl_set *set,
4155                 int (*fn)(__isl_take isl_point *pnt, void *user),
4156                 void *user);
4157         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4158                 int (*fn)(__isl_take isl_point *pnt, void *user),
4159                 void *user);
4161 The function C<fn> is called for each integer point in
4162 C<set> with as second argument the last argument of
4163 the C<isl_set_foreach_point> call.  The function C<fn>
4164 should return C<0> on success and C<-1> on failure.
4165 In the latter case, C<isl_set_foreach_point> will stop
4166 enumerating and return C<-1> as well.
4167 If the enumeration is performed successfully and to completion,
4168 then C<isl_set_foreach_point> returns C<0>.
4170 To obtain a single point of a (basic) set, use
4172         __isl_give isl_point *isl_basic_set_sample_point(
4173                 __isl_take isl_basic_set *bset);
4174         __isl_give isl_point *isl_set_sample_point(
4175                 __isl_take isl_set *set);
4177 If C<set> does not contain any (integer) points, then the
4178 resulting point will be ``void'', a property that can be
4179 tested using
4181         int isl_point_is_void(__isl_keep isl_point *pnt);
4183 =head2 Piecewise Quasipolynomials
4185 A piecewise quasipolynomial is a particular kind of function that maps
4186 a parametric point to a rational value.
4187 More specifically, a quasipolynomial is a polynomial expression in greatest
4188 integer parts of affine expressions of parameters and variables.
4189 A piecewise quasipolynomial is a subdivision of a given parametric
4190 domain into disjoint cells with a quasipolynomial associated to
4191 each cell.  The value of the piecewise quasipolynomial at a given
4192 point is the value of the quasipolynomial associated to the cell
4193 that contains the point.  Outside of the union of cells,
4194 the value is assumed to be zero.
4195 For example, the piecewise quasipolynomial
4197         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4199 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4200 A given piecewise quasipolynomial has a fixed domain dimension.
4201 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4202 defined over different domains.
4203 Piecewise quasipolynomials are mainly used by the C<barvinok>
4204 library for representing the number of elements in a parametric set or map.
4205 For example, the piecewise quasipolynomial above represents
4206 the number of points in the map
4208         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4210 =head3 Input and Output
4212 Piecewise quasipolynomials can be read from input using
4214         __isl_give isl_union_pw_qpolynomial *
4215         isl_union_pw_qpolynomial_read_from_str(
4216                 isl_ctx *ctx, const char *str);
4218 Quasipolynomials and piecewise quasipolynomials can be printed
4219 using the following functions.
4221         __isl_give isl_printer *isl_printer_print_qpolynomial(
4222                 __isl_take isl_printer *p,
4223                 __isl_keep isl_qpolynomial *qp);
4225         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4226                 __isl_take isl_printer *p,
4227                 __isl_keep isl_pw_qpolynomial *pwqp);
4229         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4230                 __isl_take isl_printer *p,
4231                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4233 The output format of the printer
4234 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4235 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4236 is supported.
4237 In case of printing in C<ISL_FORMAT_C>, the user may want
4238 to set the names of all dimensions
4240         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4241                 __isl_take isl_qpolynomial *qp,
4242                 enum isl_dim_type type, unsigned pos,
4243                 const char *s);
4244         __isl_give isl_pw_qpolynomial *
4245         isl_pw_qpolynomial_set_dim_name(
4246                 __isl_take isl_pw_qpolynomial *pwqp,
4247                 enum isl_dim_type type, unsigned pos,
4248                 const char *s);
4250 =head3 Creating New (Piecewise) Quasipolynomials
4252 Some simple quasipolynomials can be created using the following functions.
4253 More complicated quasipolynomials can be created by applying
4254 operations such as addition and multiplication
4255 on the resulting quasipolynomials
4257         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4258                 __isl_take isl_space *domain);
4259         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4260                 __isl_take isl_space *domain);
4261         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4262                 __isl_take isl_space *domain);
4263         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4264                 __isl_take isl_space *domain);
4265         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4266                 __isl_take isl_space *domain);
4267         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4268                 __isl_take isl_space *domain,
4269                 const isl_int n, const isl_int d);
4270         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4271                 __isl_take isl_space *domain,
4272                 enum isl_dim_type type, unsigned pos);
4273         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4274                 __isl_take isl_aff *aff);
4276 Note that the space in which a quasipolynomial lives is a map space
4277 with a one-dimensional range.  The C<domain> argument in some of
4278 the functions above corresponds to the domain of this map space.
4280 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4281 with a single cell can be created using the following functions.
4282 Multiple of these single cell piecewise quasipolynomials can
4283 be combined to create more complicated piecewise quasipolynomials.
4285         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4286                 __isl_take isl_space *space);
4287         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4288                 __isl_take isl_set *set,
4289                 __isl_take isl_qpolynomial *qp);
4290         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4291                 __isl_take isl_qpolynomial *qp);
4292         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4293                 __isl_take isl_pw_aff *pwaff);
4295         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4296                 __isl_take isl_space *space);
4297         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4298                 __isl_take isl_pw_qpolynomial *pwqp);
4299         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4300                 __isl_take isl_union_pw_qpolynomial *upwqp,
4301                 __isl_take isl_pw_qpolynomial *pwqp);
4303 Quasipolynomials can be copied and freed again using the following
4304 functions.
4306         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4307                 __isl_keep isl_qpolynomial *qp);
4308         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4310         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4311                 __isl_keep isl_pw_qpolynomial *pwqp);
4312         void *isl_pw_qpolynomial_free(
4313                 __isl_take isl_pw_qpolynomial *pwqp);
4315         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4316                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4317         void *isl_union_pw_qpolynomial_free(
4318                 __isl_take isl_union_pw_qpolynomial *upwqp);
4320 =head3 Inspecting (Piecewise) Quasipolynomials
4322 To iterate over all piecewise quasipolynomials in a union
4323 piecewise quasipolynomial, use the following function
4325         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4326                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4327                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4328                 void *user);
4330 To extract the piecewise quasipolynomial in a given space from a union, use
4332         __isl_give isl_pw_qpolynomial *
4333         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4334                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4335                 __isl_take isl_space *space);
4337 To iterate over the cells in a piecewise quasipolynomial,
4338 use either of the following two functions
4340         int isl_pw_qpolynomial_foreach_piece(
4341                 __isl_keep isl_pw_qpolynomial *pwqp,
4342                 int (*fn)(__isl_take isl_set *set,
4343                           __isl_take isl_qpolynomial *qp,
4344                           void *user), void *user);
4345         int isl_pw_qpolynomial_foreach_lifted_piece(
4346                 __isl_keep isl_pw_qpolynomial *pwqp,
4347                 int (*fn)(__isl_take isl_set *set,
4348                           __isl_take isl_qpolynomial *qp,
4349                           void *user), void *user);
4351 As usual, the function C<fn> should return C<0> on success
4352 and C<-1> on failure.  The difference between
4353 C<isl_pw_qpolynomial_foreach_piece> and
4354 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4355 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4356 compute unique representations for all existentially quantified
4357 variables and then turn these existentially quantified variables
4358 into extra set variables, adapting the associated quasipolynomial
4359 accordingly.  This means that the C<set> passed to C<fn>
4360 will not have any existentially quantified variables, but that
4361 the dimensions of the sets may be different for different
4362 invocations of C<fn>.
4364 To iterate over all terms in a quasipolynomial,
4367         int isl_qpolynomial_foreach_term(
4368                 __isl_keep isl_qpolynomial *qp,
4369                 int (*fn)(__isl_take isl_term *term,
4370                           void *user), void *user);
4372 The terms themselves can be inspected and freed using
4373 these functions
4375         unsigned isl_term_dim(__isl_keep isl_term *term,
4376                 enum isl_dim_type type);
4377         void isl_term_get_num(__isl_keep isl_term *term,
4378                 isl_int *n);
4379         void isl_term_get_den(__isl_keep isl_term *term,
4380                 isl_int *d);
4381         int isl_term_get_exp(__isl_keep isl_term *term,
4382                 enum isl_dim_type type, unsigned pos);
4383         __isl_give isl_aff *isl_term_get_div(
4384                 __isl_keep isl_term *term, unsigned pos);
4385         void isl_term_free(__isl_take isl_term *term);
4387 Each term is a product of parameters, set variables and
4388 integer divisions.  The function C<isl_term_get_exp>
4389 returns the exponent of a given dimensions in the given term.
4390 The C<isl_int>s in the arguments of C<isl_term_get_num>
4391 and C<isl_term_get_den> need to have been initialized
4392 using C<isl_int_init> before calling these functions.
4394 =head3 Properties of (Piecewise) Quasipolynomials
4396 To check whether a quasipolynomial is actually a constant,
4397 use the following function.
4399         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4400                 isl_int *n, isl_int *d);
4402 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4403 then the numerator and denominator of the constant
4404 are returned in C<*n> and C<*d>, respectively.
4406 To check whether two union piecewise quasipolynomials are
4407 obviously equal, use
4409         int isl_union_pw_qpolynomial_plain_is_equal(
4410                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4411                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4413 =head3 Operations on (Piecewise) Quasipolynomials
4415         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4416                 __isl_take isl_qpolynomial *qp, isl_int v);
4417         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4418                 __isl_take isl_qpolynomial *qp);
4419         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4420                 __isl_take isl_qpolynomial *qp1,
4421                 __isl_take isl_qpolynomial *qp2);
4422         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4423                 __isl_take isl_qpolynomial *qp1,
4424                 __isl_take isl_qpolynomial *qp2);
4425         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4426                 __isl_take isl_qpolynomial *qp1,
4427                 __isl_take isl_qpolynomial *qp2);
4428         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4429                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4431         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4432                 __isl_take isl_pw_qpolynomial *pwqp1,
4433                 __isl_take isl_pw_qpolynomial *pwqp2);
4434         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4435                 __isl_take isl_pw_qpolynomial *pwqp1,
4436                 __isl_take isl_pw_qpolynomial *pwqp2);
4437         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4438                 __isl_take isl_pw_qpolynomial *pwqp1,
4439                 __isl_take isl_pw_qpolynomial *pwqp2);
4440         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4441                 __isl_take isl_pw_qpolynomial *pwqp);
4442         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4443                 __isl_take isl_pw_qpolynomial *pwqp1,
4444                 __isl_take isl_pw_qpolynomial *pwqp2);
4445         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4446                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4448         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4449                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4450                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4451         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4452                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4453                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4454         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4455                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4456                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4458         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4459                 __isl_take isl_pw_qpolynomial *pwqp,
4460                 __isl_take isl_point *pnt);
4462         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4463                 __isl_take isl_union_pw_qpolynomial *upwqp,
4464                 __isl_take isl_point *pnt);
4466         __isl_give isl_set *isl_pw_qpolynomial_domain(
4467                 __isl_take isl_pw_qpolynomial *pwqp);
4468         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4469                 __isl_take isl_pw_qpolynomial *pwpq,
4470                 __isl_take isl_set *set);
4471         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4472                 __isl_take isl_pw_qpolynomial *pwpq,
4473                 __isl_take isl_set *set);
4475         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4476                 __isl_take isl_union_pw_qpolynomial *upwqp);
4477         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4478                 __isl_take isl_union_pw_qpolynomial *upwpq,
4479                 __isl_take isl_union_set *uset);
4480         __isl_give isl_union_pw_qpolynomial *
4481         isl_union_pw_qpolynomial_intersect_params(
4482                 __isl_take isl_union_pw_qpolynomial *upwpq,
4483                 __isl_take isl_set *set);
4485         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4486                 __isl_take isl_qpolynomial *qp,
4487                 __isl_take isl_space *model);
4489         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4490                 __isl_take isl_qpolynomial *qp);
4491         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4492                 __isl_take isl_pw_qpolynomial *pwqp);
4494         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4495                 __isl_take isl_union_pw_qpolynomial *upwqp);
4497         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4498                 __isl_take isl_qpolynomial *qp,
4499                 __isl_take isl_set *context);
4500         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4501                 __isl_take isl_qpolynomial *qp,
4502                 __isl_take isl_set *context);
4504         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4505                 __isl_take isl_pw_qpolynomial *pwqp,
4506                 __isl_take isl_set *context);
4507         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4508                 __isl_take isl_pw_qpolynomial *pwqp,
4509                 __isl_take isl_set *context);
4511         __isl_give isl_union_pw_qpolynomial *
4512         isl_union_pw_qpolynomial_gist_params(
4513                 __isl_take isl_union_pw_qpolynomial *upwqp,
4514                 __isl_take isl_set *context);
4515         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4516                 __isl_take isl_union_pw_qpolynomial *upwqp,
4517                 __isl_take isl_union_set *context);
4519 The gist operation applies the gist operation to each of
4520 the cells in the domain of the input piecewise quasipolynomial.
4521 The context is also exploited
4522 to simplify the quasipolynomials associated to each cell.
4524         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4525                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4526         __isl_give isl_union_pw_qpolynomial *
4527         isl_union_pw_qpolynomial_to_polynomial(
4528                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4530 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4531 the polynomial will be an overapproximation.  If C<sign> is negative,
4532 it will be an underapproximation.  If C<sign> is zero, the approximation
4533 will lie somewhere in between.
4535 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4537 A piecewise quasipolynomial reduction is a piecewise
4538 reduction (or fold) of quasipolynomials.
4539 In particular, the reduction can be maximum or a minimum.
4540 The objects are mainly used to represent the result of
4541 an upper or lower bound on a quasipolynomial over its domain,
4542 i.e., as the result of the following function.
4544         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4545                 __isl_take isl_pw_qpolynomial *pwqp,
4546                 enum isl_fold type, int *tight);
4548         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4549                 __isl_take isl_union_pw_qpolynomial *upwqp,
4550                 enum isl_fold type, int *tight);
4552 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4553 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4554 is the returned bound is known be tight, i.e., for each value
4555 of the parameters there is at least
4556 one element in the domain that reaches the bound.
4557 If the domain of C<pwqp> is not wrapping, then the bound is computed
4558 over all elements in that domain and the result has a purely parametric
4559 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4560 computed over the range of the wrapped relation.  The domain of the
4561 wrapped relation becomes the domain of the result.
4563 A (piecewise) quasipolynomial reduction can be copied or freed using the
4564 following functions.
4566         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4567                 __isl_keep isl_qpolynomial_fold *fold);
4568         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4569                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4570         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4571                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4572         void isl_qpolynomial_fold_free(
4573                 __isl_take isl_qpolynomial_fold *fold);
4574         void *isl_pw_qpolynomial_fold_free(
4575                 __isl_take isl_pw_qpolynomial_fold *pwf);
4576         void *isl_union_pw_qpolynomial_fold_free(
4577                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4579 =head3 Printing Piecewise Quasipolynomial Reductions
4581 Piecewise quasipolynomial reductions can be printed
4582 using the following function.
4584         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4585                 __isl_take isl_printer *p,
4586                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4587         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4588                 __isl_take isl_printer *p,
4589                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4591 For C<isl_printer_print_pw_qpolynomial_fold>,
4592 output format of the printer
4593 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4594 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4595 output format of the printer
4596 needs to be set to C<ISL_FORMAT_ISL>.
4597 In case of printing in C<ISL_FORMAT_C>, the user may want
4598 to set the names of all dimensions
4600         __isl_give isl_pw_qpolynomial_fold *
4601         isl_pw_qpolynomial_fold_set_dim_name(
4602                 __isl_take isl_pw_qpolynomial_fold *pwf,
4603                 enum isl_dim_type type, unsigned pos,
4604                 const char *s);
4606 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4608 To iterate over all piecewise quasipolynomial reductions in a union
4609 piecewise quasipolynomial reduction, use the following function
4611         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4612                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4613                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4614                             void *user), void *user);
4616 To iterate over the cells in a piecewise quasipolynomial reduction,
4617 use either of the following two functions
4619         int isl_pw_qpolynomial_fold_foreach_piece(
4620                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4621                 int (*fn)(__isl_take isl_set *set,
4622                           __isl_take isl_qpolynomial_fold *fold,
4623                           void *user), void *user);
4624         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4625                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4626                 int (*fn)(__isl_take isl_set *set,
4627                           __isl_take isl_qpolynomial_fold *fold,
4628                           void *user), void *user);
4630 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4631 of the difference between these two functions.
4633 To iterate over all quasipolynomials in a reduction, use
4635         int isl_qpolynomial_fold_foreach_qpolynomial(
4636                 __isl_keep isl_qpolynomial_fold *fold,
4637                 int (*fn)(__isl_take isl_qpolynomial *qp,
4638                           void *user), void *user);
4640 =head3 Properties of Piecewise Quasipolynomial Reductions
4642 To check whether two union piecewise quasipolynomial reductions are
4643 obviously equal, use
4645         int isl_union_pw_qpolynomial_fold_plain_is_equal(
4646                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4647                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4649 =head3 Operations on Piecewise Quasipolynomial Reductions
4651         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4652                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4654         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4655                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4656                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4658         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4659                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4660                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4662         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4663                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4664                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4666         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4667                 __isl_take isl_pw_qpolynomial_fold *pwf,
4668                 __isl_take isl_point *pnt);
4670         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4671                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4672                 __isl_take isl_point *pnt);
4674         __isl_give isl_pw_qpolynomial_fold *
4675         isl_pw_qpolynomial_fold_intersect_params(
4676                 __isl_take isl_pw_qpolynomial_fold *pwf,
4677                 __isl_take isl_set *set);
4679         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4680                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4681         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4682                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4683                 __isl_take isl_union_set *uset);
4684         __isl_give isl_union_pw_qpolynomial_fold *
4685         isl_union_pw_qpolynomial_fold_intersect_params(
4686                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4687                 __isl_take isl_set *set);
4689         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4690                 __isl_take isl_pw_qpolynomial_fold *pwf);
4692         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4693                 __isl_take isl_pw_qpolynomial_fold *pwf);
4695         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4696                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4698         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4699                 __isl_take isl_qpolynomial_fold *fold,
4700                 __isl_take isl_set *context);
4701         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4702                 __isl_take isl_qpolynomial_fold *fold,
4703                 __isl_take isl_set *context);
4705         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4706                 __isl_take isl_pw_qpolynomial_fold *pwf,
4707                 __isl_take isl_set *context);
4708         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4709                 __isl_take isl_pw_qpolynomial_fold *pwf,
4710                 __isl_take isl_set *context);
4712         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4713                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4714                 __isl_take isl_union_set *context);
4715         __isl_give isl_union_pw_qpolynomial_fold *
4716         isl_union_pw_qpolynomial_fold_gist_params(
4717                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4718                 __isl_take isl_set *context);
4720 The gist operation applies the gist operation to each of
4721 the cells in the domain of the input piecewise quasipolynomial reduction.
4722 In future, the operation will also exploit the context
4723 to simplify the quasipolynomial reductions associated to each cell.
4725         __isl_give isl_pw_qpolynomial_fold *
4726         isl_set_apply_pw_qpolynomial_fold(
4727                 __isl_take isl_set *set,
4728                 __isl_take isl_pw_qpolynomial_fold *pwf,
4729                 int *tight);
4730         __isl_give isl_pw_qpolynomial_fold *
4731         isl_map_apply_pw_qpolynomial_fold(
4732                 __isl_take isl_map *map,
4733                 __isl_take isl_pw_qpolynomial_fold *pwf,
4734                 int *tight);
4735         __isl_give isl_union_pw_qpolynomial_fold *
4736         isl_union_set_apply_union_pw_qpolynomial_fold(
4737                 __isl_take isl_union_set *uset,
4738                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4739                 int *tight);
4740         __isl_give isl_union_pw_qpolynomial_fold *
4741         isl_union_map_apply_union_pw_qpolynomial_fold(
4742                 __isl_take isl_union_map *umap,
4743                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4744                 int *tight);
4746 The functions taking a map
4747 compose the given map with the given piecewise quasipolynomial reduction.
4748 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
4749 over all elements in the intersection of the range of the map
4750 and the domain of the piecewise quasipolynomial reduction
4751 as a function of an element in the domain of the map.
4752 The functions taking a set compute a bound over all elements in the
4753 intersection of the set and the domain of the
4754 piecewise quasipolynomial reduction.
4756 =head2 Parametric Vertex Enumeration
4758 The parametric vertex enumeration described in this section
4759 is mainly intended to be used internally and by the C<barvinok>
4760 library.
4762         #include <isl/vertices.h>
4763         __isl_give isl_vertices *isl_basic_set_compute_vertices(
4764                 __isl_keep isl_basic_set *bset);
4766 The function C<isl_basic_set_compute_vertices> performs the
4767 actual computation of the parametric vertices and the chamber
4768 decomposition and store the result in an C<isl_vertices> object.
4769 This information can be queried by either iterating over all
4770 the vertices or iterating over all the chambers or cells
4771 and then iterating over all vertices that are active on the chamber.
4773         int isl_vertices_foreach_vertex(
4774                 __isl_keep isl_vertices *vertices,
4775                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4776                 void *user);
4778         int isl_vertices_foreach_cell(
4779                 __isl_keep isl_vertices *vertices,
4780                 int (*fn)(__isl_take isl_cell *cell, void *user),
4781                 void *user);
4782         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
4783                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4784                 void *user);
4786 Other operations that can be performed on an C<isl_vertices> object are
4787 the following.
4789         isl_ctx *isl_vertices_get_ctx(
4790                 __isl_keep isl_vertices *vertices);
4791         int isl_vertices_get_n_vertices(
4792                 __isl_keep isl_vertices *vertices);
4793         void isl_vertices_free(__isl_take isl_vertices *vertices);
4795 Vertices can be inspected and destroyed using the following functions.
4797         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
4798         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
4799         __isl_give isl_basic_set *isl_vertex_get_domain(
4800                 __isl_keep isl_vertex *vertex);
4801         __isl_give isl_basic_set *isl_vertex_get_expr(
4802                 __isl_keep isl_vertex *vertex);
4803         void isl_vertex_free(__isl_take isl_vertex *vertex);
4805 C<isl_vertex_get_expr> returns a singleton parametric set describing
4806 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4807 of the vertex.
4808 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4809 B<rational> basic sets, so they should mainly be used for inspection
4810 and should not be mixed with integer sets.
4812 Chambers can be inspected and destroyed using the following functions.
4814         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4815         __isl_give isl_basic_set *isl_cell_get_domain(
4816                 __isl_keep isl_cell *cell);
4817         void isl_cell_free(__isl_take isl_cell *cell);
4819 =head1 Polyhedral Compilation Library
4821 This section collects functionality in C<isl> that has been specifically
4822 designed for use during polyhedral compilation.
4824 =head2 Dependence Analysis
4826 C<isl> contains specialized functionality for performing
4827 array dataflow analysis.  That is, given a I<sink> access relation
4828 and a collection of possible I<source> access relations,
4829 C<isl> can compute relations that describe
4830 for each iteration of the sink access, which iteration
4831 of which of the source access relations was the last
4832 to access the same data element before the given iteration
4833 of the sink access.
4834 The resulting dependence relations map source iterations
4835 to the corresponding sink iterations.
4836 To compute standard flow dependences, the sink should be
4837 a read, while the sources should be writes.
4838 If any of the source accesses are marked as being I<may>
4839 accesses, then there will be a dependence from the last
4840 I<must> access B<and> from any I<may> access that follows
4841 this last I<must> access.
4842 In particular, if I<all> sources are I<may> accesses,
4843 then memory based dependence analysis is performed.
4844 If, on the other hand, all sources are I<must> accesses,
4845 then value based dependence analysis is performed.
4847         #include <isl/flow.h>
4849         typedef int (*isl_access_level_before)(void *first, void *second);
4851         __isl_give isl_access_info *isl_access_info_alloc(
4852                 __isl_take isl_map *sink,
4853                 void *sink_user, isl_access_level_before fn,
4854                 int max_source);
4855         __isl_give isl_access_info *isl_access_info_add_source(
4856                 __isl_take isl_access_info *acc,
4857                 __isl_take isl_map *source, int must,
4858                 void *source_user);
4859         void *isl_access_info_free(__isl_take isl_access_info *acc);
4861         __isl_give isl_flow *isl_access_info_compute_flow(
4862                 __isl_take isl_access_info *acc);
4864         int isl_flow_foreach(__isl_keep isl_flow *deps,
4865                 int (*fn)(__isl_take isl_map *dep, int must,
4866                           void *dep_user, void *user),
4867                 void *user);
4868         __isl_give isl_map *isl_flow_get_no_source(
4869                 __isl_keep isl_flow *deps, int must);
4870         void isl_flow_free(__isl_take isl_flow *deps);
4872 The function C<isl_access_info_compute_flow> performs the actual
4873 dependence analysis.  The other functions are used to construct
4874 the input for this function or to read off the output.
4876 The input is collected in an C<isl_access_info>, which can
4877 be created through a call to C<isl_access_info_alloc>.
4878 The arguments to this functions are the sink access relation
4879 C<sink>, a token C<sink_user> used to identify the sink
4880 access to the user, a callback function for specifying the
4881 relative order of source and sink accesses, and the number
4882 of source access relations that will be added.
4883 The callback function has type C<int (*)(void *first, void *second)>.
4884 The function is called with two user supplied tokens identifying
4885 either a source or the sink and it should return the shared nesting
4886 level and the relative order of the two accesses.
4887 In particular, let I<n> be the number of loops shared by
4888 the two accesses.  If C<first> precedes C<second> textually,
4889 then the function should return I<2 * n + 1>; otherwise,
4890 it should return I<2 * n>.
4891 The sources can be added to the C<isl_access_info> by performing
4892 (at most) C<max_source> calls to C<isl_access_info_add_source>.
4893 C<must> indicates whether the source is a I<must> access
4894 or a I<may> access.  Note that a multi-valued access relation
4895 should only be marked I<must> if every iteration in the domain
4896 of the relation accesses I<all> elements in its image.
4897 The C<source_user> token is again used to identify
4898 the source access.  The range of the source access relation
4899 C<source> should have the same dimension as the range
4900 of the sink access relation.
4901 The C<isl_access_info_free> function should usually not be
4902 called explicitly, because it is called implicitly by
4903 C<isl_access_info_compute_flow>.
4905 The result of the dependence analysis is collected in an
4906 C<isl_flow>.  There may be elements of
4907 the sink access for which no preceding source access could be
4908 found or for which all preceding sources are I<may> accesses.
4909 The relations containing these elements can be obtained through
4910 calls to C<isl_flow_get_no_source>, the first with C<must> set
4911 and the second with C<must> unset.
4912 In the case of standard flow dependence analysis,
4913 with the sink a read and the sources I<must> writes,
4914 the first relation corresponds to the reads from uninitialized
4915 array elements and the second relation is empty.
4916 The actual flow dependences can be extracted using
4917 C<isl_flow_foreach>.  This function will call the user-specified
4918 callback function C<fn> for each B<non-empty> dependence between
4919 a source and the sink.  The callback function is called
4920 with four arguments, the actual flow dependence relation
4921 mapping source iterations to sink iterations, a boolean that
4922 indicates whether it is a I<must> or I<may> dependence, a token
4923 identifying the source and an additional C<void *> with value
4924 equal to the third argument of the C<isl_flow_foreach> call.
4925 A dependence is marked I<must> if it originates from a I<must>
4926 source and if it is not followed by any I<may> sources.
4928 After finishing with an C<isl_flow>, the user should call
4929 C<isl_flow_free> to free all associated memory.
4931 A higher-level interface to dependence analysis is provided
4932 by the following function.
4934         #include <isl/flow.h>
4936         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
4937                 __isl_take isl_union_map *must_source,
4938                 __isl_take isl_union_map *may_source,
4939                 __isl_take isl_union_map *schedule,
4940                 __isl_give isl_union_map **must_dep,
4941                 __isl_give isl_union_map **may_dep,
4942                 __isl_give isl_union_map **must_no_source,
4943                 __isl_give isl_union_map **may_no_source);
4945 The arrays are identified by the tuple names of the ranges
4946 of the accesses.  The iteration domains by the tuple names
4947 of the domains of the accesses and of the schedule.
4948 The relative order of the iteration domains is given by the
4949 schedule.  The relations returned through C<must_no_source>
4950 and C<may_no_source> are subsets of C<sink>.
4951 Any of C<must_dep>, C<may_dep>, C<must_no_source>
4952 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
4953 any of the other arguments is treated as an error.
4955 =head3 Interaction with Dependence Analysis
4957 During the dependence analysis, we frequently need to perform
4958 the following operation.  Given a relation between sink iterations
4959 and potential source iterations from a particular source domain,
4960 what is the last potential source iteration corresponding to each
4961 sink iteration.  It can sometimes be convenient to adjust
4962 the set of potential source iterations before or after each such operation.
4963 The prototypical example is fuzzy array dataflow analysis,
4964 where we need to analyze if, based on data-dependent constraints,
4965 the sink iteration can ever be executed without one or more of
4966 the corresponding potential source iterations being executed.
4967 If so, we can introduce extra parameters and select an unknown
4968 but fixed source iteration from the potential source iterations.
4969 To be able to perform such manipulations, C<isl> provides the following
4970 function.
4972         #include <isl/flow.h>
4974         typedef __isl_give isl_restriction *(*isl_access_restrict)(
4975                 __isl_keep isl_map *source_map,
4976                 __isl_keep isl_set *sink, void *source_user,
4977                 void *user);
4978         __isl_give isl_access_info *isl_access_info_set_restrict(
4979                 __isl_take isl_access_info *acc,
4980                 isl_access_restrict fn, void *user);
4982 The function C<isl_access_info_set_restrict> should be called
4983 before calling C<isl_access_info_compute_flow> and registers a callback function
4984 that will be called any time C<isl> is about to compute the last
4985 potential source.  The first argument is the (reverse) proto-dependence,
4986 mapping sink iterations to potential source iterations.
4987 The second argument represents the sink iterations for which
4988 we want to compute the last source iteration.
4989 The third argument is the token corresponding to the source
4990 and the final argument is the token passed to C<isl_access_info_set_restrict>.
4991 The callback is expected to return a restriction on either the input or
4992 the output of the operation computing the last potential source.
4993 If the input needs to be restricted then restrictions are needed
4994 for both the source and the sink iterations.  The sink iterations
4995 and the potential source iterations will be intersected with these sets.
4996 If the output needs to be restricted then only a restriction on the source
4997 iterations is required.
4998 If any error occurs, the callback should return C<NULL>.
4999 An C<isl_restriction> object can be created, freed and inspected
5000 using the following functions.
5002         #include <isl/flow.h>
5004         __isl_give isl_restriction *isl_restriction_input(
5005                 __isl_take isl_set *source_restr,
5006                 __isl_take isl_set *sink_restr);
5007         __isl_give isl_restriction *isl_restriction_output(
5008                 __isl_take isl_set *source_restr);
5009         __isl_give isl_restriction *isl_restriction_none(
5010                 __isl_take isl_map *source_map);
5011         __isl_give isl_restriction *isl_restriction_empty(
5012                 __isl_take isl_map *source_map);
5013         void *isl_restriction_free(
5014                 __isl_take isl_restriction *restr);
5015         isl_ctx *isl_restriction_get_ctx(
5016                 __isl_keep isl_restriction *restr);
5018 C<isl_restriction_none> and C<isl_restriction_empty> are special
5019 cases of C<isl_restriction_input>.  C<isl_restriction_none>
5020 is essentially equivalent to
5022         isl_restriction_input(isl_set_universe(
5023             isl_space_range(isl_map_get_space(source_map))),
5024                             isl_set_universe(
5025             isl_space_domain(isl_map_get_space(source_map))));
5027 whereas C<isl_restriction_empty> is essentially equivalent to
5029         isl_restriction_input(isl_set_empty(
5030             isl_space_range(isl_map_get_space(source_map))),
5031                             isl_set_universe(
5032             isl_space_domain(isl_map_get_space(source_map))));
5034 =head2 Scheduling
5036 B<The functionality described in this section is fairly new
5037 and may be subject to change.>
5039 The following function can be used to compute a schedule
5040 for a union of domains.
5041 By default, the algorithm used to construct the schedule is similar
5042 to that of C<Pluto>.
5043 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5044 be selected.
5045 The generated schedule respects all C<validity> dependences.
5046 That is, all dependence distances over these dependences in the
5047 scheduled space are lexicographically positive.
5048 The default algorithm tries to minimize the dependence distances over
5049 C<proximity> dependences.
5050 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5051 for groups of domains where the dependence distances have only
5052 non-negative values.
5053 When using Feautrier's algorithm, the C<proximity> dependence
5054 distances are only minimized during the extension to a
5055 full-dimensional schedule.
5057         #include <isl/schedule.h>
5058         __isl_give isl_schedule *isl_union_set_compute_schedule(
5059                 __isl_take isl_union_set *domain,
5060                 __isl_take isl_union_map *validity,
5061                 __isl_take isl_union_map *proximity);
5062         void *isl_schedule_free(__isl_take isl_schedule *sched);
5064 A mapping from the domains to the scheduled space can be obtained
5065 from an C<isl_schedule> using the following function.
5067         __isl_give isl_union_map *isl_schedule_get_map(
5068                 __isl_keep isl_schedule *sched);
5070 A representation of the schedule can be printed using
5071          
5072         __isl_give isl_printer *isl_printer_print_schedule(
5073                 __isl_take isl_printer *p,
5074                 __isl_keep isl_schedule *schedule);
5076 A representation of the schedule as a forest of bands can be obtained
5077 using the following function.
5079         __isl_give isl_band_list *isl_schedule_get_band_forest(
5080                 __isl_keep isl_schedule *schedule);
5082 The individual bands can be visited in depth-first post-order
5083 using the following function.
5085         #include <isl/schedule.h>
5086         int isl_schedule_foreach_band(
5087                 __isl_keep isl_schedule *sched,
5088                 int (*fn)(__isl_keep isl_band *band, void *user),
5089                 void *user);
5091 The list can be manipulated as explained in L<"Lists">.
5092 The bands inside the list can be copied and freed using the following
5093 functions.
5095         #include <isl/band.h>
5096         __isl_give isl_band *isl_band_copy(
5097                 __isl_keep isl_band *band);
5098         void *isl_band_free(__isl_take isl_band *band);
5100 Each band contains zero or more scheduling dimensions.
5101 These are referred to as the members of the band.
5102 The section of the schedule that corresponds to the band is
5103 referred to as the partial schedule of the band.
5104 For those nodes that participate in a band, the outer scheduling
5105 dimensions form the prefix schedule, while the inner scheduling
5106 dimensions form the suffix schedule.
5107 That is, if we take a cut of the band forest, then the union of
5108 the concatenations of the prefix, partial and suffix schedules of
5109 each band in the cut is equal to the entire schedule (modulo
5110 some possible padding at the end with zero scheduling dimensions).
5111 The properties of a band can be inspected using the following functions.
5113         #include <isl/band.h>
5114         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5116         int isl_band_has_children(__isl_keep isl_band *band);
5117         __isl_give isl_band_list *isl_band_get_children(
5118                 __isl_keep isl_band *band);
5120         __isl_give isl_union_map *isl_band_get_prefix_schedule(
5121                 __isl_keep isl_band *band);
5122         __isl_give isl_union_map *isl_band_get_partial_schedule(
5123                 __isl_keep isl_band *band);
5124         __isl_give isl_union_map *isl_band_get_suffix_schedule(
5125                 __isl_keep isl_band *band);
5127         int isl_band_n_member(__isl_keep isl_band *band);
5128         int isl_band_member_is_zero_distance(
5129                 __isl_keep isl_band *band, int pos);
5131         int isl_band_list_foreach_band(
5132                 __isl_keep isl_band_list *list,
5133                 int (*fn)(__isl_keep isl_band *band, void *user),
5134                 void *user);
5136 Note that a scheduling dimension is considered to be ``zero
5137 distance'' if it does not carry any proximity dependences
5138 within its band.
5139 That is, if the dependence distances of the proximity
5140 dependences are all zero in that direction (for fixed
5141 iterations of outer bands).
5142 Like C<isl_schedule_foreach_band>,
5143 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5144 in depth-first post-order.
5146 A band can be tiled using the following function.
5148         #include <isl/band.h>
5149         int isl_band_tile(__isl_keep isl_band *band,
5150                 __isl_take isl_vec *sizes);
5152         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5153                 int val);
5154         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5155         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5156                 int val);
5157         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5159 The C<isl_band_tile> function tiles the band using the given tile sizes
5160 inside its schedule.
5161 A new child band is created to represent the point loops and it is
5162 inserted between the modified band and its children.
5163 The C<tile_scale_tile_loops> option specifies whether the tile
5164 loops iterators should be scaled by the tile sizes.
5165 If the C<tile_shift_point_loops> option is set, then the point loops
5166 are shifted to start at zero.
5168 A band can be split into two nested bands using the following function.
5170         int isl_band_split(__isl_keep isl_band *band, int pos);
5172 The resulting outer band contains the first C<pos> dimensions of C<band>
5173 while the inner band contains the remaining dimensions.
5175 A representation of the band can be printed using
5177         #include <isl/band.h>
5178         __isl_give isl_printer *isl_printer_print_band(
5179                 __isl_take isl_printer *p,
5180                 __isl_keep isl_band *band);
5182 =head3 Options
5184         #include <isl/schedule.h>
5185         int isl_options_set_schedule_max_coefficient(
5186                 isl_ctx *ctx, int val);
5187         int isl_options_get_schedule_max_coefficient(
5188                 isl_ctx *ctx);
5189         int isl_options_set_schedule_max_constant_term(
5190                 isl_ctx *ctx, int val);
5191         int isl_options_get_schedule_max_constant_term(
5192                 isl_ctx *ctx);
5193         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5194         int isl_options_get_schedule_fuse(isl_ctx *ctx);
5195         int isl_options_set_schedule_maximize_band_depth(
5196                 isl_ctx *ctx, int val);
5197         int isl_options_get_schedule_maximize_band_depth(
5198                 isl_ctx *ctx);
5199         int isl_options_set_schedule_outer_zero_distance(
5200                 isl_ctx *ctx, int val);
5201         int isl_options_get_schedule_outer_zero_distance(
5202                 isl_ctx *ctx);
5203         int isl_options_set_schedule_split_scaled(
5204                 isl_ctx *ctx, int val);
5205         int isl_options_get_schedule_split_scaled(
5206                 isl_ctx *ctx);
5207         int isl_options_set_schedule_algorithm(
5208                 isl_ctx *ctx, int val);
5209         int isl_options_get_schedule_algorithm(
5210                 isl_ctx *ctx);
5211         int isl_options_set_schedule_separate_components(
5212                 isl_ctx *ctx, int val);
5213         int isl_options_get_schedule_separate_components(
5214                 isl_ctx *ctx);
5216 =over
5218 =item * schedule_max_coefficient
5220 This option enforces that the coefficients for variable and parameter
5221 dimensions in the calculated schedule are not larger than the specified value.
5222 This option can significantly increase the speed of the scheduling calculation
5223 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5224 this option does not introduce bounds on the variable or parameter
5225 coefficients.
5227 =item * schedule_max_constant_term
5229 This option enforces that the constant coefficients in the calculated schedule
5230 are not larger than the maximal constant term. This option can significantly
5231 increase the speed of the scheduling calculation and may also prevent fusing of
5232 unrelated dimensions. A value of -1 means that this option does not introduce
5233 bounds on the constant coefficients.
5235 =item * schedule_fuse
5237 This option controls the level of fusion.
5238 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5239 resulting schedule will be distributed as much as possible.
5240 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5241 try to fuse loops in the resulting schedule.
5243 =item * schedule_maximize_band_depth
5245 If this option is set, we do not split bands at the point
5246 where we detect splitting is necessary. Instead, we
5247 backtrack and split bands as early as possible. This
5248 reduces the number of splits and maximizes the width of
5249 the bands. Wider bands give more possibilities for tiling.
5250 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5251 then bands will be split as early as possible, even if there is no need.
5252 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5254 =item * schedule_outer_zero_distance
5256 If this option is set, then we try to construct schedules
5257 where the outermost scheduling dimension in each band
5258 results in a zero dependence distance over the proximity
5259 dependences.
5261 =item * schedule_split_scaled
5263 If this option is set, then we try to construct schedules in which the
5264 constant term is split off from the linear part if the linear parts of
5265 the scheduling rows for all nodes in the graphs have a common non-trivial
5266 divisor.
5267 The constant term is then placed in a separate band and the linear
5268 part is reduced.
5270 =item * schedule_algorithm
5272 Selects the scheduling algorithm to be used.
5273 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5274 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5276 =item * schedule_separate_components
5278 If at any point the dependence graph contains any (weakly connected) components,
5279 then these components are scheduled separately.
5280 If this option is not set, then some iterations of the domains
5281 in these components may be scheduled together.
5282 If this option is set, then the components are given consecutive
5283 schedules.
5285 =back
5287 =head2 AST Generation
5289 This section describes the C<isl> functionality for generating
5290 ASTs that visit all the elements
5291 in a domain in an order specified by a schedule.
5292 In particular, given a C<isl_union_map>, an AST is generated
5293 that visits all the elements in the domain of the C<isl_union_map>
5294 according to the lexicographic order of the corresponding image
5295 element(s).  If the range of the C<isl_union_map> consists of
5296 elements in more than one space, then each of these spaces is handled
5297 separately in an arbitrary order.
5298 It should be noted that the image elements only specify the I<order>
5299 in which the corresponding domain elements should be visited.
5300 No direct relation between the image elements and the loop iterators
5301 in the generated AST should be assumed.
5303 Each AST is generated within a build.  The initial build
5304 simply specifies the constraints on the parameters (if any)
5305 and can be created, inspected, copied and freed using the following functions.
5307         #include <isl/ast_build.h>
5308         __isl_give isl_ast_build *isl_ast_build_from_context(
5309                 __isl_take isl_set *set);
5310         isl_ctx *isl_ast_build_get_ctx(
5311                 __isl_keep isl_ast_build *build);
5312         __isl_give isl_ast_build *isl_ast_build_copy(
5313                 __isl_keep isl_ast_build *build);
5314         void *isl_ast_build_free(
5315                 __isl_take isl_ast_build *build);
5317 The C<set> argument is usually a parameter set with zero or more parameters.
5318 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5319 and L</"Fine-grained Control over AST Generation">.
5320 Finally, the AST itself can be constructed using the following
5321 function.
5323         #include <isl/ast_build.h>
5324         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5325                 __isl_keep isl_ast_build *build,
5326                 __isl_take isl_union_map *schedule);
5328 =head3 Inspecting the AST
5330 The basic properties of an AST node can be obtained as follows.
5332         #include <isl/ast.h>
5333         isl_ctx *isl_ast_node_get_ctx(
5334                 __isl_keep isl_ast_node *node);
5335         enum isl_ast_node_type isl_ast_node_get_type(
5336                 __isl_keep isl_ast_node *node);
5338 The type of an AST node is one of
5339 C<isl_ast_node_for>,
5340 C<isl_ast_node_if>,
5341 C<isl_ast_node_block> or
5342 C<isl_ast_node_user>.
5343 An C<isl_ast_node_for> represents a for node.
5344 An C<isl_ast_node_if> represents an if node.
5345 An C<isl_ast_node_block> represents a compound node.
5346 An C<isl_ast_node_user> represents an expression statement.
5347 An expression statement typically corresponds to a domain element, i.e.,
5348 one of the elements that is visited by the AST.
5350 Each type of node has its own additional properties.
5352         #include <isl/ast.h>
5353         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5354                 __isl_keep isl_ast_node *node);
5355         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5356                 __isl_keep isl_ast_node *node);
5357         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5358                 __isl_keep isl_ast_node *node);
5359         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5360                 __isl_keep isl_ast_node *node);
5361         __isl_give isl_ast_node *isl_ast_node_for_get_body(
5362                 __isl_keep isl_ast_node *node);
5363         int isl_ast_node_for_is_degenerate(
5364                 __isl_keep isl_ast_node *node);
5366 An C<isl_ast_for> is considered degenerate if it is known to execute
5367 exactly once.
5369         #include <isl/ast.h>
5370         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5371                 __isl_keep isl_ast_node *node);
5372         __isl_give isl_ast_node *isl_ast_node_if_get_then(
5373                 __isl_keep isl_ast_node *node);
5374         int isl_ast_node_if_has_else(
5375                 __isl_keep isl_ast_node *node);
5376         __isl_give isl_ast_node *isl_ast_node_if_get_else(
5377                 __isl_keep isl_ast_node *node);
5379         __isl_give isl_ast_node_list *
5380         isl_ast_node_block_get_children(
5381                 __isl_keep isl_ast_node *node);
5383         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5384                 __isl_keep isl_ast_node *node);
5386 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5387 the following functions.
5389         #include <isl/ast.h>
5390         isl_ctx *isl_ast_expr_get_ctx(
5391                 __isl_keep isl_ast_expr *expr);
5392         enum isl_ast_expr_type isl_ast_expr_get_type(
5393                 __isl_keep isl_ast_expr *expr);
5395 The type of an AST expression is one of
5396 C<isl_ast_expr_op>,
5397 C<isl_ast_expr_id> or
5398 C<isl_ast_expr_int>.
5399 An C<isl_ast_expr_op> represents the result of an operation.
5400 An C<isl_ast_expr_id> represents an identifier.
5401 An C<isl_ast_expr_int> represents an integer value.
5403 Each type of expression has its own additional properties.
5405         #include <isl/ast.h>
5406         enum isl_ast_op_type isl_ast_expr_get_op_type(
5407                 __isl_keep isl_ast_expr *expr);
5408         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5409         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5410                 __isl_keep isl_ast_expr *expr, int pos);
5411         int isl_ast_node_foreach_ast_op_type(
5412                 __isl_keep isl_ast_node *node,
5413                 int (*fn)(enum isl_ast_op_type type, void *user),
5414                 void *user);
5416 C<isl_ast_expr_get_op_type> returns the type of the operation
5417 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
5418 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
5419 argument.
5420 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5421 C<isl_ast_op_type> that appears in C<node>.
5422 The operation type is one of the following.
5424 =over
5426 =item C<isl_ast_op_and>
5428 Logical I<and> of two arguments.
5429 Both arguments can be evaluated.
5431 =item C<isl_ast_op_and_then>
5433 Logical I<and> of two arguments.
5434 The second argument can only be evaluated if the first evaluates to true.
5436 =item C<isl_ast_op_or>
5438 Logical I<or> of two arguments.
5439 Both arguments can be evaluated.
5441 =item C<isl_ast_op_or_else>
5443 Logical I<or> of two arguments.
5444 The second argument can only be evaluated if the first evaluates to false.
5446 =item C<isl_ast_op_max>
5448 Maximum of two or more arguments.
5450 =item C<isl_ast_op_min>
5452 Minimum of two or more arguments.
5454 =item C<isl_ast_op_minus>
5456 Change sign.
5458 =item C<isl_ast_op_add>
5460 Sum of two arguments.
5462 =item C<isl_ast_op_sub>
5464 Difference of two arguments.
5466 =item C<isl_ast_op_mul>
5468 Product of two arguments.
5470 =item C<isl_ast_op_div>
5472 Exact division.  That is, the result is known to be an integer.
5474 =item C<isl_ast_op_fdiv_q>
5476 Result of integer division, rounded towards negative
5477 infinity.
5479 =item C<isl_ast_op_pdiv_q>
5481 Result of integer division, where dividend is known to be non-negative.
5483 =item C<isl_ast_op_pdiv_r>
5485 Remainder of integer division, where dividend is known to be non-negative.
5487 =item C<isl_ast_op_cond>
5489 Conditional operator defined on three arguments.
5490 If the first argument evaluates to true, then the result
5491 is equal to the second argument.  Otherwise, the result
5492 is equal to the third argument.
5493 The second and third argument may only be evaluated if
5494 the first argument evaluates to true and false, respectively.
5495 Corresponds to C<a ? b : c> in C.
5497 =item C<isl_ast_op_select>
5499 Conditional operator defined on three arguments.
5500 If the first argument evaluates to true, then the result
5501 is equal to the second argument.  Otherwise, the result
5502 is equal to the third argument.
5503 The second and third argument may be evaluated independently
5504 of the value of the first argument.
5505 Corresponds to C<a * b + (1 - a) * c> in C.
5507 =item C<isl_ast_op_eq>
5509 Equality relation.
5511 =item C<isl_ast_op_le>
5513 Less than or equal relation.
5515 =item C<isl_ast_op_lt>
5517 Less than relation.
5519 =item C<isl_ast_op_ge>
5521 Greater than or equal relation.
5523 =item C<isl_ast_op_gt>
5525 Greater than relation.
5527 =item C<isl_ast_op_call>
5529 A function call.
5530 The number of arguments of the C<isl_ast_expr> is one more than
5531 the number of arguments in the function call, the first argument
5532 representing the function being called.
5534 =back
5536         #include <isl/ast.h>
5537         __isl_give isl_id *isl_ast_expr_get_id(
5538                 __isl_keep isl_ast_expr *expr);
5540 Return the identifier represented by the AST expression.
5542         #include <isl/ast.h>
5543         int isl_ast_expr_get_int(__isl_keep isl_ast_expr *expr,
5544                 isl_int *v);
5546 Return the integer represented by the AST expression.
5547 Note that the integer is returned through the C<v> argument.
5548 The return value of the function itself indicates whether the
5549 operation was performed successfully.
5551 =head3 Manipulating and printing the AST
5553 AST nodes can be copied and freed using the following functions.
5555         #include <isl/ast.h>
5556         __isl_give isl_ast_node *isl_ast_node_copy(
5557                 __isl_keep isl_ast_node *node);
5558         void *isl_ast_node_free(__isl_take isl_ast_node *node);
5560 AST expressions can be copied and freed using the following functions.
5562         #include <isl/ast.h>
5563         __isl_give isl_ast_expr *isl_ast_expr_copy(
5564                 __isl_keep isl_ast_expr *expr);
5565         void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5567 New AST expressions can be created either directly or within
5568 the context of an C<isl_ast_build>.
5570         #include <isl/ast.h>
5571         __isl_give isl_ast_expr *isl_ast_expr_from_id(
5572                 __isl_take isl_id *id);
5573         __isl_give isl_ast_expr *isl_ast_expr_neg(
5574                 __isl_take isl_ast_expr *expr);
5575         __isl_give isl_ast_expr *isl_ast_expr_add(
5576                 __isl_take isl_ast_expr *expr1,
5577                 __isl_take isl_ast_expr *expr2);
5578         __isl_give isl_ast_expr *isl_ast_expr_sub(
5579                 __isl_take isl_ast_expr *expr1,
5580                 __isl_take isl_ast_expr *expr2);
5581         __isl_give isl_ast_expr *isl_ast_expr_mul(
5582                 __isl_take isl_ast_expr *expr1,
5583                 __isl_take isl_ast_expr *expr2);
5584         __isl_give isl_ast_expr *isl_ast_expr_div(
5585                 __isl_take isl_ast_expr *expr1,
5586                 __isl_take isl_ast_expr *expr2);
5587         __isl_give isl_ast_expr *isl_ast_expr_and(
5588                 __isl_take isl_ast_expr *expr1,
5589                 __isl_take isl_ast_expr *expr2)
5590         __isl_give isl_ast_expr *isl_ast_expr_or(
5591                 __isl_take isl_ast_expr *expr1,
5592                 __isl_take isl_ast_expr *expr2)
5594         #include <isl/ast_build.h>
5595         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5596                 __isl_keep isl_ast_build *build,
5597                 __isl_take isl_pw_aff *pa);
5598         __isl_give isl_ast_expr *
5599         isl_ast_build_call_from_pw_multi_aff(
5600                 __isl_keep isl_ast_build *build,
5601                 __isl_take isl_pw_multi_aff *pma);
5603 The domains of C<pa> and C<pma> should correspond
5604 to the schedule space of C<build>.
5605 The tuple id of C<pma> is used as the function being called.
5607 User specified data can be attached to an C<isl_ast_node> and obtained
5608 from the same C<isl_ast_node> using the following functions.
5610         #include <isl/ast.h>
5611         __isl_give isl_ast_node *isl_ast_node_set_annotation(
5612                 __isl_take isl_ast_node *node,
5613                 __isl_take isl_id *annotation);
5614         __isl_give isl_id *isl_ast_node_get_annotation(
5615                 __isl_keep isl_ast_node *node);
5617 Basic printing can be performed using the following functions.
5619         #include <isl/ast.h>
5620         __isl_give isl_printer *isl_printer_print_ast_expr(
5621                 __isl_take isl_printer *p,
5622                 __isl_keep isl_ast_expr *expr);
5623         __isl_give isl_printer *isl_printer_print_ast_node(
5624                 __isl_take isl_printer *p,
5625                 __isl_keep isl_ast_node *node);
5627 More advanced printing can be performed using the following functions.
5629         #include <isl/ast.h>
5630         __isl_give isl_printer *isl_ast_op_type_print_macro(
5631                 enum isl_ast_op_type type,
5632                 __isl_take isl_printer *p);
5633         __isl_give isl_printer *isl_ast_node_print_macros(
5634                 __isl_keep isl_ast_node *node,
5635                 __isl_take isl_printer *p);
5636         __isl_give isl_printer *isl_ast_node_print(
5637                 __isl_keep isl_ast_node *node,
5638                 __isl_take isl_printer *p,
5639                 __isl_take isl_ast_print_options *options);
5640         __isl_give isl_printer *isl_ast_node_for_print(
5641                 __isl_keep isl_ast_node *node,
5642                 __isl_take isl_printer *p,
5643                 __isl_take isl_ast_print_options *options);
5644         __isl_give isl_printer *isl_ast_node_if_print(
5645                 __isl_keep isl_ast_node *node,
5646                 __isl_take isl_printer *p,
5647                 __isl_take isl_ast_print_options *options);
5649 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
5650 C<isl> may print out an AST that makes use of macros such
5651 as C<floord>, C<min> and C<max>.
5652 C<isl_ast_op_type_print_macro> prints out the macro
5653 corresponding to a specific C<isl_ast_op_type>.
5654 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
5655 for expressions where these macros would be used and prints
5656 out the required macro definitions.
5657 Essentially, C<isl_ast_node_print_macros> calls
5658 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
5659 as function argument.
5660 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
5661 C<isl_ast_node_if_print> print an C<isl_ast_node>
5662 in C<ISL_FORMAT_C>, but allow for some extra control
5663 through an C<isl_ast_print_options> object.
5664 This object can be created using the following functions.
5666         #include <isl/ast.h>
5667         __isl_give isl_ast_print_options *
5668         isl_ast_print_options_alloc(isl_ctx *ctx);
5669         __isl_give isl_ast_print_options *
5670         isl_ast_print_options_copy(
5671                 __isl_keep isl_ast_print_options *options);
5672         void *isl_ast_print_options_free(
5673                 __isl_take isl_ast_print_options *options);
5675         __isl_give isl_ast_print_options *
5676         isl_ast_print_options_set_print_user(
5677                 __isl_take isl_ast_print_options *options,
5678                 __isl_give isl_printer *(*print_user)(
5679                         __isl_take isl_printer *p,
5680                         __isl_take isl_ast_print_options *options,
5681                         __isl_keep isl_ast_node *node, void *user),
5682                 void *user);
5683         __isl_give isl_ast_print_options *
5684         isl_ast_print_options_set_print_for(
5685                 __isl_take isl_ast_print_options *options,
5686                 __isl_give isl_printer *(*print_for)(
5687                         __isl_take isl_printer *p,
5688                         __isl_take isl_ast_print_options *options,
5689                         __isl_keep isl_ast_node *node, void *user),
5690                 void *user);
5692 The callback set by C<isl_ast_print_options_set_print_user>
5693 is called whenever a node of type C<isl_ast_node_user> needs to
5694 be printed.
5695 The callback set by C<isl_ast_print_options_set_print_for>
5696 is called whenever a node of type C<isl_ast_node_for> needs to
5697 be printed.
5698 Note that C<isl_ast_node_for_print> will I<not> call the
5699 callback set by C<isl_ast_print_options_set_print_for> on the node
5700 on which C<isl_ast_node_for_print> is called, but only on nested
5701 nodes of type C<isl_ast_node_for>.  It is therefore safe to
5702 call C<isl_ast_node_for_print> from within the callback set by
5703 C<isl_ast_print_options_set_print_for>.
5705 The following option determines the type to be used for iterators
5706 while printing the AST.
5708         int isl_options_set_ast_iterator_type(
5709                 isl_ctx *ctx, const char *val);
5710         const char *isl_options_get_ast_iterator_type(
5711                 isl_ctx *ctx);
5713 =head3 Options
5715         #include <isl/ast_build.h>
5716         int isl_options_set_ast_build_atomic_upper_bound(
5717                 isl_ctx *ctx, int val);
5718         int isl_options_get_ast_build_atomic_upper_bound(
5719                 isl_ctx *ctx);
5720         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
5721                 int val);
5722         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
5723         int isl_options_set_ast_build_exploit_nested_bounds(
5724                 isl_ctx *ctx, int val);
5725         int isl_options_get_ast_build_exploit_nested_bounds(
5726                 isl_ctx *ctx);
5727         int isl_options_set_ast_build_group_coscheduled(
5728                 isl_ctx *ctx, int val);
5729         int isl_options_get_ast_build_group_coscheduled(
5730                 isl_ctx *ctx);
5731         int isl_options_set_ast_build_scale_strides(
5732                 isl_ctx *ctx, int val);
5733         int isl_options_get_ast_build_scale_strides(
5734                 isl_ctx *ctx);
5735         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
5736                 int val);
5737         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
5738         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
5739                 int val);
5740         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
5742 =over
5744 =item * ast_build_atomic_upper_bound
5746 Generate loop upper bounds that consist of the current loop iterator,
5747 an operator and an expression not involving the iterator.
5748 If this option is not set, then the current loop iterator may appear
5749 several times in the upper bound.
5750 For example, when this option is turned off, AST generation
5751 for the schedule
5753         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
5755 produces
5757         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
5758           A(c0);
5760 When the option is turned on, the following AST is generated
5762         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
5763           A(c0);
5765 =item * ast_build_prefer_pdiv
5767 If this option is turned off, then the AST generation will
5768 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
5769 operators, but no C<isl_ast_op_pdiv_q> or
5770 C<isl_ast_op_pdiv_r> operators.
5771 If this options is turned on, then C<isl> will try to convert
5772 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
5773 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
5775 =item * ast_build_exploit_nested_bounds
5777 Simplify conditions based on bounds of nested for loops.
5778 In particular, remove conditions that are implied by the fact
5779 that one or more nested loops have at least one iteration,
5780 meaning that the upper bound is at least as large as the lower bound.
5781 For example, when this option is turned off, AST generation
5782 for the schedule
5784         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
5785                                         0 <= j <= M }
5787 produces
5789         if (M >= 0)
5790           for (int c0 = 0; c0 <= N; c0 += 1)
5791             for (int c1 = 0; c1 <= M; c1 += 1)
5792               A(c0, c1);
5794 When the option is turned on, the following AST is generated
5796         for (int c0 = 0; c0 <= N; c0 += 1)
5797           for (int c1 = 0; c1 <= M; c1 += 1)
5798             A(c0, c1);
5800 =item * ast_build_group_coscheduled
5802 If two domain elements are assigned the same schedule point, then
5803 they may be executed in any order and they may even appear in different
5804 loops.  If this options is set, then the AST generator will make
5805 sure that coscheduled domain elements do not appear in separate parts
5806 of the AST.  This is useful in case of nested AST generation
5807 if the outer AST generation is given only part of a schedule
5808 and the inner AST generation should handle the domains that are
5809 coscheduled by this initial part of the schedule together.
5810 For example if an AST is generated for a schedule
5812         { A[i] -> [0]; B[i] -> [0] }
5814 then the C<isl_ast_build_set_create_leaf> callback described
5815 below may get called twice, once for each domain.
5816 Setting this option ensures that the callback is only called once
5817 on both domains together.
5819 =item * ast_build_separation_bounds
5821 This option specifies which bounds to use during separation.
5822 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
5823 then all (possibly implicit) bounds on the current dimension will
5824 be used during separation.
5825 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
5826 then only those bounds that are explicitly available will
5827 be used during separation.
5829 =item * ast_build_scale_strides
5831 This option specifies whether the AST generator is allowed
5832 to scale down iterators of strided loops.
5834 =item * ast_build_allow_else
5836 This option specifies whether the AST generator is allowed
5837 to construct if statements with else branches.
5839 =item * ast_build_allow_or
5841 This option specifies whether the AST generator is allowed
5842 to construct if conditions with disjunctions.
5844 =back
5846 =head3 Fine-grained Control over AST Generation
5848 Besides specifying the constraints on the parameters,
5849 an C<isl_ast_build> object can be used to control
5850 various aspects of the AST generation process.
5851 The most prominent way of control is through ``options'',
5852 which can be set using the following function.
5854         #include <isl/ast_build.h>
5855         __isl_give isl_ast_build *
5856         isl_ast_build_set_options(
5857                 __isl_take isl_ast_build *control,
5858                 __isl_take isl_union_map *options);
5860 The options are encoded in an <isl_union_map>.
5861 The domain of this union relation refers to the schedule domain,
5862 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
5863 In the case of nested AST generation (see L</"Nested AST Generation">),
5864 the domain of C<options> should refer to the extra piece of the schedule.
5865 That is, it should be equal to the range of the wrapped relation in the
5866 range of the schedule.
5867 The range of the options can consist of elements in one or more spaces,
5868 the names of which determine the effect of the option.
5869 The values of the range typically also refer to the schedule dimension
5870 to which the option applies.  In case of nested AST generation
5871 (see L</"Nested AST Generation">), these values refer to the position
5872 of the schedule dimension within the innermost AST generation.
5873 The constraints on the domain elements of
5874 the option should only refer to this dimension and earlier dimensions.
5875 We consider the following spaces.
5877 =over
5879 =item C<separation_class>
5881 This space is a wrapped relation between two one dimensional spaces.
5882 The input space represents the schedule dimension to which the option
5883 applies and the output space represents the separation class.
5884 While constructing a loop corresponding to the specified schedule
5885 dimension(s), the AST generator will try to generate separate loops
5886 for domain elements that are assigned different classes.
5887 If only some of the elements are assigned a class, then those elements
5888 that are not assigned any class will be treated as belonging to a class
5889 that is separate from the explicitly assigned classes.
5890 The typical use case for this option is to separate full tiles from
5891 partial tiles.
5892 The other options, described below, are applied after the separation
5893 into classes.
5895 As an example, consider the separation into full and partial tiles
5896 of a tiling of a triangular domain.
5897 Take, for example, the domain
5899         { A[i,j] : 0 <= i,j and i + j <= 100 }
5901 and a tiling into tiles of 10 by 10.  The input to the AST generator
5902 is then the schedule
5904         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
5905                                                 i + j <= 100 }
5907 Without any options, the following AST is generated
5909         for (int c0 = 0; c0 <= 10; c0 += 1)
5910           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
5911             for (int c2 = 10 * c0;
5912                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
5913                  c2 += 1)
5914               for (int c3 = 10 * c1;
5915                    c3 <= min(10 * c1 + 9, -c2 + 100);
5916                    c3 += 1)
5917                 A(c2, c3);
5919 Separation into full and partial tiles can be obtained by assigning
5920 a class, say C<0>, to the full tiles.  The full tiles are represented by those
5921 values of the first and second schedule dimensions for which there are
5922 values of the third and fourth dimensions to cover an entire tile.
5923 That is, we need to specify the following option
5925         { [a,b,c,d] -> separation_class[[0]->[0]] :
5926                 exists b': 0 <= 10a,10b' and
5927                            10a+9+10b'+9 <= 100;
5928           [a,b,c,d] -> separation_class[[1]->[0]] :
5929                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
5931 which simplifies to
5933         { [a, b, c, d] -> separation_class[[1] -> [0]] :
5934                 a >= 0 and b >= 0 and b <= 8 - a;
5935           [a, b, c, d] -> separation_class[[0] -> [0]] :
5936                 a >= 0 and a <= 8 }
5938 With this option, the generated AST is as follows
5940         {
5941           for (int c0 = 0; c0 <= 8; c0 += 1) {
5942             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
5943               for (int c2 = 10 * c0;
5944                    c2 <= 10 * c0 + 9; c2 += 1)
5945                 for (int c3 = 10 * c1;
5946                      c3 <= 10 * c1 + 9; c3 += 1)
5947                   A(c2, c3);
5948             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
5949               for (int c2 = 10 * c0;
5950                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
5951                    c2 += 1)
5952                 for (int c3 = 10 * c1;
5953                      c3 <= min(-c2 + 100, 10 * c1 + 9);
5954                      c3 += 1)
5955                   A(c2, c3);
5956           }
5957           for (int c0 = 9; c0 <= 10; c0 += 1)
5958             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
5959               for (int c2 = 10 * c0;
5960                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
5961                    c2 += 1)
5962                 for (int c3 = 10 * c1;
5963                      c3 <= min(10 * c1 + 9, -c2 + 100);
5964                      c3 += 1)
5965                   A(c2, c3);
5966         }
5968 =item C<separate>
5970 This is a single-dimensional space representing the schedule dimension(s)
5971 to which ``separation'' should be applied.  Separation tries to split
5972 a loop into several pieces if this can avoid the generation of guards
5973 inside the loop.
5974 See also the C<atomic> option.
5976 =item C<atomic>
5978 This is a single-dimensional space representing the schedule dimension(s)
5979 for which the domains should be considered ``atomic''.  That is, the
5980 AST generator will make sure that any given domain space will only appear
5981 in a single loop at the specified level.
5983 Consider the following schedule
5985         { a[i] -> [i] : 0 <= i < 10;
5986           b[i] -> [i+1] : 0 <= i < 10 }
5988 If the following option is specified
5990         { [i] -> separate[x] }
5992 then the following AST will be generated
5994         {
5995           a(0);
5996           for (int c0 = 1; c0 <= 9; c0 += 1) {
5997             a(c0);
5998             b(c0 - 1);
5999           }
6000           b(9);
6001         }
6003 If, on the other hand, the following option is specified
6005         { [i] -> atomic[x] }
6007 then the following AST will be generated
6009         for (int c0 = 0; c0 <= 10; c0 += 1) {
6010           if (c0 <= 9)
6011             a(c0);
6012           if (c0 >= 1)
6013             b(c0 - 1);
6014         }
6016 If neither C<atomic> nor C<separate> is specified, then the AST generator
6017 may produce either of these two results or some intermediate form.
6019 =item C<unroll>
6021 This is a single-dimensional space representing the schedule dimension(s)
6022 that should be I<completely> unrolled.
6023 To obtain a partial unrolling, the user should apply an additional
6024 strip-mining to the schedule and fully unroll the inner loop.
6026 =back
6028 Additional control is available through the following functions.
6030         #include <isl/ast_build.h>
6031         __isl_give isl_ast_build *
6032         isl_ast_build_set_iterators(
6033                 __isl_take isl_ast_build *control,
6034                 __isl_take isl_id_list *iterators);
6036 The function C<isl_ast_build_set_iterators> allows the user to
6037 specify a list of iterator C<isl_id>s to be used as iterators.
6038 If the input schedule is injective, then
6039 the number of elements in this list should be as large as the dimension
6040 of the schedule space, but no direct correspondence should be assumed
6041 between dimensions and elements.
6042 If the input schedule is not injective, then an additional number
6043 of C<isl_id>s equal to the largest dimension of the input domains
6044 may be required.
6045 If the number of provided C<isl_id>s is insufficient, then additional
6046 names are automatically generated.
6048         #include <isl/ast_build.h>
6049         __isl_give isl_ast_build *
6050         isl_ast_build_set_create_leaf(
6051                 __isl_take isl_ast_build *control,
6052                 __isl_give isl_ast_node *(*fn)(
6053                         __isl_take isl_ast_build *build,
6054                         void *user), void *user);
6057 C<isl_ast_build_set_create_leaf> function allows for the
6058 specification of a callback that should be called whenever the AST
6059 generator arrives at an element of the schedule domain.
6060 The callback should return an AST node that should be inserted
6061 at the corresponding position of the AST.  The default action (when
6062 the callback is not set) is to continue generating parts of the AST to scan
6063 all the domain elements associated to the schedule domain element
6064 and to insert user nodes, ``calling'' the domain element, for each of them.
6065 The C<build> argument contains the current state of the C<isl_ast_build>.
6066 To ease nested AST generation (see L</"Nested AST Generation">),
6067 all control information that is
6068 specific to the current AST generation such as the options and
6069 the callbacks has been removed from this C<isl_ast_build>.
6070 The callback would typically return the result of a nested
6071 AST generation or a
6072 user defined node created using the following function.
6074         #include <isl/ast.h>
6075         __isl_give isl_ast_node *isl_ast_node_alloc_user(
6076                 __isl_take isl_ast_expr *expr);
6078         #include <isl/ast_build.h>
6079         __isl_give isl_ast_build *
6080         isl_ast_build_set_at_each_domain(
6081                 __isl_take isl_ast_build *build,
6082                 __isl_give isl_ast_node *(*fn)(
6083                         __isl_take isl_ast_node *node,
6084                         __isl_keep isl_ast_build *build,
6085                         void *user), void *user);
6086         __isl_give isl_ast_build *
6087         isl_ast_build_set_before_each_for(
6088                 __isl_take isl_ast_build *build,
6089                 __isl_give isl_id *(*fn)(
6090                         __isl_keep isl_ast_build *build,
6091                         void *user), void *user);
6092         __isl_give isl_ast_build *
6093         isl_ast_build_set_after_each_for(
6094                 __isl_take isl_ast_build *build,
6095                 __isl_give isl_ast_node *(*fn)(
6096                         __isl_take isl_ast_node *node,
6097                         __isl_keep isl_ast_build *build,
6098                         void *user), void *user);
6100 The callback set by C<isl_ast_build_set_at_each_domain> will
6101 be called for each domain AST node.
6102 The callbacks set by C<isl_ast_build_set_before_each_for>
6103 and C<isl_ast_build_set_after_each_for> will be called
6104 for each for AST node.  The first will be called in depth-first
6105 pre-order, while the second will be called in depth-first post-order.
6106 Since C<isl_ast_build_set_before_each_for> is called before the for
6107 node is actually constructed, it is only passed an C<isl_ast_build>.
6108 The returned C<isl_id> will be added as an annotation (using
6109 C<isl_ast_node_set_annotation>) to the constructed for node.
6110 In particular, if the user has also specified an C<after_each_for>
6111 callback, then the annotation can be retrieved from the node passed to
6112 that callback using C<isl_ast_node_get_annotation>.
6113 All callbacks should C<NULL> on failure.
6114 The given C<isl_ast_build> can be used to create new
6115 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6116 or C<isl_ast_build_call_from_pw_multi_aff>.
6118 =head3 Nested AST Generation
6120 C<isl> allows the user to create an AST within the context
6121 of another AST.  These nested ASTs are created using the
6122 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6123 outer AST.  The C<build> argument should be an C<isl_ast_build>
6124 passed to a callback set by
6125 C<isl_ast_build_set_create_leaf>.
6126 The space of the range of the C<schedule> argument should refer
6127 to this build.  In particular, the space should be a wrapped
6128 relation and the domain of this wrapped relation should be the
6129 same as that of the range of the schedule returned by
6130 C<isl_ast_build_get_schedule> below.
6131 In practice, the new schedule is typically
6132 created by calling C<isl_union_map_range_product> on the old schedule
6133 and some extra piece of the schedule.
6134 The space of the schedule domain is also available from
6135 the C<isl_ast_build>.
6137         #include <isl/ast_build.h>
6138         __isl_give isl_union_map *isl_ast_build_get_schedule(
6139                 __isl_keep isl_ast_build *build);
6140         __isl_give isl_space *isl_ast_build_get_schedule_space(
6141                 __isl_keep isl_ast_build *build);
6142         __isl_give isl_ast_build *isl_ast_build_restrict(
6143                 __isl_take isl_ast_build *build,
6144                 __isl_take isl_set *set);
6146 The C<isl_ast_build_get_schedule> function returns a (partial)
6147 schedule for the domains elements for which part of the AST still needs to
6148 be generated in the current build.
6149 In particular, the domain elements are mapped to those iterations of the loops
6150 enclosing the current point of the AST generation inside which
6151 the domain elements are executed.
6152 No direct correspondence between
6153 the input schedule and this schedule should be assumed.
6154 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6155 to create a set for C<isl_ast_build_restrict> to intersect
6156 with the current build.  In particular, the set passed to
6157 C<isl_ast_build_restrict> can have additional parameters.
6158 The ids of the set dimensions in the space returned by
6159 C<isl_ast_build_get_schedule_space> correspond to the
6160 iterators of the already generated loops.
6161 The user should not rely on the ids of the output dimensions
6162 of the relations in the union relation returned by
6163 C<isl_ast_build_get_schedule> having any particular value.
6165 =head1 Applications
6167 Although C<isl> is mainly meant to be used as a library,
6168 it also contains some basic applications that use some
6169 of the functionality of C<isl>.
6170 The input may be specified in either the L<isl format>
6171 or the L<PolyLib format>.
6173 =head2 C<isl_polyhedron_sample>
6175 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6176 an integer element of the polyhedron, if there is any.
6177 The first column in the output is the denominator and is always
6178 equal to 1.  If the polyhedron contains no integer points,
6179 then a vector of length zero is printed.
6181 =head2 C<isl_pip>
6183 C<isl_pip> takes the same input as the C<example> program
6184 from the C<piplib> distribution, i.e., a set of constraints
6185 on the parameters, a line containing only -1 and finally a set
6186 of constraints on a parametric polyhedron.
6187 The coefficients of the parameters appear in the last columns
6188 (but before the final constant column).
6189 The output is the lexicographic minimum of the parametric polyhedron.
6190 As C<isl> currently does not have its own output format, the output
6191 is just a dump of the internal state.
6193 =head2 C<isl_polyhedron_minimize>
6195 C<isl_polyhedron_minimize> computes the minimum of some linear
6196 or affine objective function over the integer points in a polyhedron.
6197 If an affine objective function
6198 is given, then the constant should appear in the last column.
6200 =head2 C<isl_polytope_scan>
6202 Given a polytope, C<isl_polytope_scan> prints
6203 all integer points in the polytope.
6205 =head2 C<isl_codegen>
6207 Given a schedule, a context set and an options relation,
6208 C<isl_codegen> prints out an AST that scans the domain elements
6209 of the schedule in the order of their image(s) taking into account
6210 the constraints in the context set.