add isl_union_map_subtract_range
[platform/upstream/isl.git] / doc / user.pod
1 =head1 Introduction
2
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.
12
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>.
22
23 =head2 Backward Incompatible Changes
24
25 =head3 Changes since isl-0.02
26
27 =over
28
29 =item * The old printing functions have been deprecated
30 and replaced by C<isl_printer> functions, see L<Input and Output>.
31
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>.
35
36 =back
37
38 =head3 Changes since isl-0.03
39
40 =over
41
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>.
46
47 =back
48
49 =head3 Changes since isl-0.04
50
51 =over
52
53 =item * All header files have been renamed from C<isl_header.h>
54 to C<isl/header.h>.
55
56 =back
57
58 =head3 Changes since isl-0.05
59
60 =over
61
62 =item * The functions C<isl_printer_print_basic_set> and
63 C<isl_printer_print_basic_map> no longer print a newline.
64
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.
69
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))>.
74
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.
78
79 =back
80
81 =head3 Changes since isl-0.06
82
83 =over
84
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.
88
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.
92
93 =back
94
95 =head3 Changes since isl-0.07
96
97 =over
98
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>.
103
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.
108
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>.
116
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.
125
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>.
130
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
141
142         isl_qpolynomial_from_aff(isl_aff_floor(div))
143
144 The function C<isl_constraint_div> has also been renamed
145 to C<isl_constraint_get_div>.
146
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.
153
154 =back
155
156 =head3 Changes since isl-0.09
157
158 =over
159
160 =item * The C<schedule_split_parallel> option has been replaced
161 by the C<schedule_split_scaled> option.
162
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
166
167         isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
168
169 =back
170
171 =head3 Changes since isl-0.10
172
173 =over
174
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
180 =back
181
182 =head1 License
183
184 C<isl> is released under the MIT license.
185
186 =over
187
188 Permission is hereby granted, free of charge, to any person obtaining a copy of
189 this software and associated documentation files (the "Software"), to deal in
190 the Software without restriction, including without limitation the rights to
191 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
192 of the Software, and to permit persons to whom the Software is furnished to do
193 so, subject to the following conditions:
194
195 The above copyright notice and this permission notice shall be included in all
196 copies or substantial portions of the Software.
197
198 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
199 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
200 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
201 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
202 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
203 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
204 SOFTWARE.
205
206 =back
207
208 Note that C<isl> currently requires C<GMP>, which is released
209 under the GNU Lesser General Public License (LGPL).  This means
210 that code linked against C<isl> is also linked against LGPL code.
211
212 =head1 Installation
213
214 The source of C<isl> can be obtained either as a tarball
215 or from the git repository.  Both are available from
216 L<http://freshmeat.net/projects/isl/>.
217 The installation process depends on how you obtained
218 the source.
219
220 =head2 Installation from the git repository
221
222 =over
223
224 =item 1 Clone or update the repository
225
226 The first time the source is obtained, you need to clone
227 the repository.
228
229         git clone git://repo.or.cz/isl.git
230
231 To obtain updates, you need to pull in the latest changes
232
233         git pull
234
235 =item 2 Generate C<configure>
236
237         ./autogen.sh
238
239 =back
240
241 After performing the above steps, continue
242 with the L<Common installation instructions>.
243
244 =head2 Common installation instructions
245
246 =over
247
248 =item 1 Obtain C<GMP>
249
250 Building C<isl> requires C<GMP>, including its headers files.
251 Your distribution may not provide these header files by default
252 and you may need to install a package called C<gmp-devel> or something
253 similar.  Alternatively, C<GMP> can be built from
254 source, available from L<http://gmplib.org/>.
255
256 =item 2 Configure
257
258 C<isl> uses the standard C<autoconf> C<configure> script.
259 To run it, just type
260
261         ./configure
262
263 optionally followed by some configure options.
264 A complete list of options can be obtained by running
265
266         ./configure --help
267
268 Below we discuss some of the more common options.
269
270 C<isl> can optionally use C<piplib>, but no
271 C<piplib> functionality is currently used by default.
272 The C<--with-piplib> option can
273 be used to specify which C<piplib>
274 library to use, either an installed version (C<system>),
275 an externally built version (C<build>)
276 or no version (C<no>).  The option C<build> is mostly useful
277 in C<configure> scripts of larger projects that bundle both C<isl>
278 and C<piplib>.
279
280 =over
281
282 =item C<--prefix>
283
284 Installation prefix for C<isl>
285
286 =item C<--with-gmp-prefix>
287
288 Installation prefix for C<GMP> (architecture-independent files).
289
290 =item C<--with-gmp-exec-prefix>
291
292 Installation prefix for C<GMP> (architecture-dependent files).
293
294 =item C<--with-piplib>
295
296 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
297
298 =item C<--with-piplib-prefix>
299
300 Installation prefix for C<system> C<piplib> (architecture-independent files).
301
302 =item C<--with-piplib-exec-prefix>
303
304 Installation prefix for C<system> C<piplib> (architecture-dependent files).
305
306 =item C<--with-piplib-builddir>
307
308 Location where C<build> C<piplib> was built.
309
310 =back
311
312 =item 3 Compile
313
314         make
315
316 =item 4 Install (optional)
317
318         make install
319
320 =back
321
322 =head1 Library
323
324 =head2 Initialization
325
326 All manipulations of integer sets and relations occur within
327 the context of an C<isl_ctx>.
328 A given C<isl_ctx> can only be used within a single thread.
329 All arguments of a function are required to have been allocated
330 within the same context.
331 There are currently no functions available for moving an object
332 from one C<isl_ctx> to another C<isl_ctx>.  This means that
333 there is currently no way of safely moving an object from one
334 thread to another, unless the whole C<isl_ctx> is moved.
335
336 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
337 freed using C<isl_ctx_free>.
338 All objects allocated within an C<isl_ctx> should be freed
339 before the C<isl_ctx> itself is freed.
340
341         isl_ctx *isl_ctx_alloc();
342         void isl_ctx_free(isl_ctx *ctx);
343
344 =head2 Integers
345
346 All operations on integers, mainly the coefficients
347 of the constraints describing the sets and relations,
348 are performed in exact integer arithmetic using C<GMP>.
349 However, to allow future versions of C<isl> to optionally
350 support fixed integer arithmetic, all calls to C<GMP>
351 are wrapped inside C<isl> specific macros.
352 The basic type is C<isl_int> and the operations below
353 are available on this type.
354 The meanings of these operations are essentially the same
355 as their C<GMP> C<mpz_> counterparts.
356 As always with C<GMP> types, C<isl_int>s need to be
357 initialized with C<isl_int_init> before they can be used
358 and they need to be released with C<isl_int_clear>
359 after the last use.
360 The user should not assume that an C<isl_int> is represented
361 as a C<mpz_t>, but should instead explicitly convert between
362 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
363 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
364
365 =over
366
367 =item isl_int_init(i)
368
369 =item isl_int_clear(i)
370
371 =item isl_int_set(r,i)
372
373 =item isl_int_set_si(r,i)
374
375 =item isl_int_set_gmp(r,g)
376
377 =item isl_int_get_gmp(i,g)
378
379 =item isl_int_abs(r,i)
380
381 =item isl_int_neg(r,i)
382
383 =item isl_int_swap(i,j)
384
385 =item isl_int_swap_or_set(i,j)
386
387 =item isl_int_add_ui(r,i,j)
388
389 =item isl_int_sub_ui(r,i,j)
390
391 =item isl_int_add(r,i,j)
392
393 =item isl_int_sub(r,i,j)
394
395 =item isl_int_mul(r,i,j)
396
397 =item isl_int_mul_ui(r,i,j)
398
399 =item isl_int_addmul(r,i,j)
400
401 =item isl_int_submul(r,i,j)
402
403 =item isl_int_gcd(r,i,j)
404
405 =item isl_int_lcm(r,i,j)
406
407 =item isl_int_divexact(r,i,j)
408
409 =item isl_int_cdiv_q(r,i,j)
410
411 =item isl_int_fdiv_q(r,i,j)
412
413 =item isl_int_fdiv_r(r,i,j)
414
415 =item isl_int_fdiv_q_ui(r,i,j)
416
417 =item isl_int_read(r,s)
418
419 =item isl_int_print(out,i,width)
420
421 =item isl_int_sgn(i)
422
423 =item isl_int_cmp(i,j)
424
425 =item isl_int_cmp_si(i,si)
426
427 =item isl_int_eq(i,j)
428
429 =item isl_int_ne(i,j)
430
431 =item isl_int_lt(i,j)
432
433 =item isl_int_le(i,j)
434
435 =item isl_int_gt(i,j)
436
437 =item isl_int_ge(i,j)
438
439 =item isl_int_abs_eq(i,j)
440
441 =item isl_int_abs_ne(i,j)
442
443 =item isl_int_abs_lt(i,j)
444
445 =item isl_int_abs_gt(i,j)
446
447 =item isl_int_abs_ge(i,j)
448
449 =item isl_int_is_zero(i)
450
451 =item isl_int_is_one(i)
452
453 =item isl_int_is_negone(i)
454
455 =item isl_int_is_pos(i)
456
457 =item isl_int_is_neg(i)
458
459 =item isl_int_is_nonpos(i)
460
461 =item isl_int_is_nonneg(i)
462
463 =item isl_int_is_divisible_by(i,j)
464
465 =back
466
467 =head2 Sets and Relations
468
469 C<isl> uses six types of objects for representing sets and relations,
470 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
471 C<isl_union_set> and C<isl_union_map>.
472 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
473 can be described as a conjunction of affine constraints, while
474 C<isl_set> and C<isl_map> represent unions of
475 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
476 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
477 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
478 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
479 where spaces are considered different if they have a different number
480 of dimensions and/or different names (see L<"Spaces">).
481 The difference between sets and relations (maps) is that sets have
482 one set of variables, while relations have two sets of variables,
483 input variables and output variables.
484
485 =head2 Memory Management
486
487 Since a high-level operation on sets and/or relations usually involves
488 several substeps and since the user is usually not interested in
489 the intermediate results, most functions that return a new object
490 will also release all the objects passed as arguments.
491 If the user still wants to use one or more of these arguments
492 after the function call, she should pass along a copy of the
493 object rather than the object itself.
494 The user is then responsible for making sure that the original
495 object gets used somewhere else or is explicitly freed.
496
497 The arguments and return values of all documented functions are
498 annotated to make clear which arguments are released and which
499 arguments are preserved.  In particular, the following annotations
500 are used
501
502 =over
503
504 =item C<__isl_give>
505
506 C<__isl_give> means that a new object is returned.
507 The user should make sure that the returned pointer is
508 used exactly once as a value for an C<__isl_take> argument.
509 In between, it can be used as a value for as many
510 C<__isl_keep> arguments as the user likes.
511 There is one exception, and that is the case where the
512 pointer returned is C<NULL>.  Is this case, the user
513 is free to use it as an C<__isl_take> argument or not.
514
515 =item C<__isl_take>
516
517 C<__isl_take> means that the object the argument points to
518 is taken over by the function and may no longer be used
519 by the user as an argument to any other function.
520 The pointer value must be one returned by a function
521 returning an C<__isl_give> pointer.
522 If the user passes in a C<NULL> value, then this will
523 be treated as an error in the sense that the function will
524 not perform its usual operation.  However, it will still
525 make sure that all the other C<__isl_take> arguments
526 are released.
527
528 =item C<__isl_keep>
529
530 C<__isl_keep> means that the function will only use the object
531 temporarily.  After the function has finished, the user
532 can still use it as an argument to other functions.
533 A C<NULL> value will be treated in the same way as
534 a C<NULL> value for an C<__isl_take> argument.
535
536 =back
537
538 =head2 Error Handling
539
540 C<isl> supports different ways to react in case a runtime error is triggered.
541 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
542 with two maps that have incompatible spaces. There are three possible ways
543 to react on error: to warn, to continue or to abort.
544
545 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
546 the last error in the corresponding C<isl_ctx> and the function in which the
547 error was triggered returns C<NULL>. An error does not corrupt internal state,
548 such that isl can continue to be used. C<isl> also provides functions to
549 read the last error and to reset the memory that stores the last error. The
550 last error is only stored for information purposes. Its presence does not
551 change the behavior of C<isl>. Hence, resetting an error is not required to
552 continue to use isl, but only to observe new errors.
553
554         #include <isl/ctx.h>
555         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
556         void isl_ctx_reset_error(isl_ctx *ctx);
557
558 Another option is to continue on error. This is similar to warn on error mode,
559 except that C<isl> does not print any warning. This allows a program to
560 implement its own error reporting.
561
562 The last option is to directly abort the execution of the program from within
563 the isl library. This makes it obviously impossible to recover from an error,
564 but it allows to directly spot the error location. By aborting on error,
565 debuggers break at the location the error occurred and can provide a stack
566 trace. Other tools that automatically provide stack traces on abort or that do
567 not want to continue execution after an error was triggered may also prefer to
568 abort on error.
569
570 The on error behavior of isl can be specified by calling
571 C<isl_options_set_on_error> or by setting the command line option
572 C<--isl-on-error>. Valid arguments for the function call are
573 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
574 choices for the command line option are C<warn>, C<continue> and C<abort>.
575 It is also possible to query the current error mode.
576
577         #include <isl/options.h>
578         int isl_options_set_on_error(isl_ctx *ctx, int val);
579         int isl_options_get_on_error(isl_ctx *ctx);
580
581 =head2 Identifiers
582
583 Identifiers are used to identify both individual dimensions
584 and tuples of dimensions.  They consist of an optional name and an optional
585 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
586 Identifiers with the same name but different pointer values
587 are considered to be distinct.
588 Similarly, identifiers with different names but the same pointer value
589 are also considered to be distinct.
590 Equal identifiers are represented using the same object.
591 Pairs of identifiers can therefore be tested for equality using the
592 C<==> operator.
593 Identifiers can be constructed, copied, freed, inspected and printed
594 using the following functions.
595
596         #include <isl/id.h>
597         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
598                 __isl_keep const char *name, void *user);
599         __isl_give isl_id *isl_id_copy(isl_id *id);
600         void *isl_id_free(__isl_take isl_id *id);
601
602         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
603         void *isl_id_get_user(__isl_keep isl_id *id);
604         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
605
606         __isl_give isl_printer *isl_printer_print_id(
607                 __isl_take isl_printer *p, __isl_keep isl_id *id);
608
609 Note that C<isl_id_get_name> returns a pointer to some internal
610 data structure, so the result can only be used while the
611 corresponding C<isl_id> is alive.
612
613 =head2 Spaces
614
615 Whenever a new set, relation or similiar object is created from scratch,
616 the space in which it lives needs to be specified using an C<isl_space>.
617 Each space involves zero or more parameters and zero, one or two
618 tuples of set or input/output dimensions.  The parameters and dimensions
619 are identified by an C<isl_dim_type> and a position.
620 The type C<isl_dim_param> refers to parameters,
621 the type C<isl_dim_set> refers to set dimensions (for spaces
622 with a single tuple of dimensions) and the types C<isl_dim_in>
623 and C<isl_dim_out> refer to input and output dimensions
624 (for spaces with two tuples of dimensions).
625 Local spaces (see L</"Local Spaces">) also contain dimensions
626 of type C<isl_dim_div>.
627 Note that parameters are only identified by their position within
628 a given object.  Across different objects, parameters are (usually)
629 identified by their names or identifiers.  Only unnamed parameters
630 are identified by their positions across objects.  The use of unnamed
631 parameters is discouraged.
632
633         #include <isl/space.h>
634         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
635                 unsigned nparam, unsigned n_in, unsigned n_out);
636         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
637                 unsigned nparam);
638         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
639                 unsigned nparam, unsigned dim);
640         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
641         void *isl_space_free(__isl_take isl_space *space);
642         unsigned isl_space_dim(__isl_keep isl_space *space,
643                 enum isl_dim_type type);
644
645 The space used for creating a parameter domain
646 needs to be created using C<isl_space_params_alloc>.
647 For other sets, the space
648 needs to be created using C<isl_space_set_alloc>, while
649 for a relation, the space
650 needs to be created using C<isl_space_alloc>.
651 C<isl_space_dim> can be used
652 to find out the number of dimensions of each type in
653 a space, where type may be
654 C<isl_dim_param>, C<isl_dim_in> (only for relations),
655 C<isl_dim_out> (only for relations), C<isl_dim_set>
656 (only for sets) or C<isl_dim_all>.
657
658 To check whether a given space is that of a set or a map
659 or whether it is a parameter space, use these functions:
660
661         #include <isl/space.h>
662         int isl_space_is_params(__isl_keep isl_space *space);
663         int isl_space_is_set(__isl_keep isl_space *space);
664         int isl_space_is_map(__isl_keep isl_space *space);
665
666 Spaces can be compared using the following functions:
667
668         #include <isl/space.h>
669         int isl_space_is_equal(__isl_keep isl_space *space1,
670                 __isl_keep isl_space *space2);
671         int isl_space_is_domain(__isl_keep isl_space *space1,
672                 __isl_keep isl_space *space2);
673         int isl_space_is_range(__isl_keep isl_space *space1,
674                 __isl_keep isl_space *space2);
675
676 C<isl_space_is_domain> checks whether the first argument is equal
677 to the domain of the second argument.  This requires in particular that
678 the first argument is a set space and that the second argument
679 is a map space.
680
681 It is often useful to create objects that live in the
682 same space as some other object.  This can be accomplished
683 by creating the new objects
684 (see L<Creating New Sets and Relations> or
685 L<Creating New (Piecewise) Quasipolynomials>) based on the space
686 of the original object.
687
688         #include <isl/set.h>
689         __isl_give isl_space *isl_basic_set_get_space(
690                 __isl_keep isl_basic_set *bset);
691         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
692
693         #include <isl/union_set.h>
694         __isl_give isl_space *isl_union_set_get_space(
695                 __isl_keep isl_union_set *uset);
696
697         #include <isl/map.h>
698         __isl_give isl_space *isl_basic_map_get_space(
699                 __isl_keep isl_basic_map *bmap);
700         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
701
702         #include <isl/union_map.h>
703         __isl_give isl_space *isl_union_map_get_space(
704                 __isl_keep isl_union_map *umap);
705
706         #include <isl/constraint.h>
707         __isl_give isl_space *isl_constraint_get_space(
708                 __isl_keep isl_constraint *constraint);
709
710         #include <isl/polynomial.h>
711         __isl_give isl_space *isl_qpolynomial_get_domain_space(
712                 __isl_keep isl_qpolynomial *qp);
713         __isl_give isl_space *isl_qpolynomial_get_space(
714                 __isl_keep isl_qpolynomial *qp);
715         __isl_give isl_space *isl_qpolynomial_fold_get_space(
716                 __isl_keep isl_qpolynomial_fold *fold);
717         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
718                 __isl_keep isl_pw_qpolynomial *pwqp);
719         __isl_give isl_space *isl_pw_qpolynomial_get_space(
720                 __isl_keep isl_pw_qpolynomial *pwqp);
721         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
722                 __isl_keep isl_pw_qpolynomial_fold *pwf);
723         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
724                 __isl_keep isl_pw_qpolynomial_fold *pwf);
725         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
726                 __isl_keep isl_union_pw_qpolynomial *upwqp);
727         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
728                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
729
730         #include <isl/aff.h>
731         __isl_give isl_space *isl_aff_get_domain_space(
732                 __isl_keep isl_aff *aff);
733         __isl_give isl_space *isl_aff_get_space(
734                 __isl_keep isl_aff *aff);
735         __isl_give isl_space *isl_pw_aff_get_domain_space(
736                 __isl_keep isl_pw_aff *pwaff);
737         __isl_give isl_space *isl_pw_aff_get_space(
738                 __isl_keep isl_pw_aff *pwaff);
739         __isl_give isl_space *isl_multi_aff_get_domain_space(
740                 __isl_keep isl_multi_aff *maff);
741         __isl_give isl_space *isl_multi_aff_get_space(
742                 __isl_keep isl_multi_aff *maff);
743         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
744                 __isl_keep isl_pw_multi_aff *pma);
745         __isl_give isl_space *isl_pw_multi_aff_get_space(
746                 __isl_keep isl_pw_multi_aff *pma);
747         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
748                 __isl_keep isl_union_pw_multi_aff *upma);
749
750         #include <isl/point.h>
751         __isl_give isl_space *isl_point_get_space(
752                 __isl_keep isl_point *pnt);
753
754 The identifiers or names of the individual dimensions may be set or read off
755 using the following functions.
756
757         #include <isl/space.h>
758         __isl_give isl_space *isl_space_set_dim_id(
759                 __isl_take isl_space *space,
760                 enum isl_dim_type type, unsigned pos,
761                 __isl_take isl_id *id);
762         int isl_space_has_dim_id(__isl_keep isl_space *space,
763                 enum isl_dim_type type, unsigned pos);
764         __isl_give isl_id *isl_space_get_dim_id(
765                 __isl_keep isl_space *space,
766                 enum isl_dim_type type, unsigned pos);
767         __isl_give isl_space *isl_space_set_dim_name(
768                 __isl_take isl_space *space,
769                  enum isl_dim_type type, unsigned pos,
770                  __isl_keep const char *name);
771         int isl_space_has_dim_name(__isl_keep isl_space *space,
772                 enum isl_dim_type type, unsigned pos);
773         __isl_keep const char *isl_space_get_dim_name(
774                 __isl_keep isl_space *space,
775                 enum isl_dim_type type, unsigned pos);
776
777 Note that C<isl_space_get_name> returns a pointer to some internal
778 data structure, so the result can only be used while the
779 corresponding C<isl_space> is alive.
780 Also note that every function that operates on two sets or relations
781 requires that both arguments have the same parameters.  This also
782 means that if one of the arguments has named parameters, then the
783 other needs to have named parameters too and the names need to match.
784 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
785 arguments may have different parameters (as long as they are named),
786 in which case the result will have as parameters the union of the parameters of
787 the arguments.
788
789 Given the identifier or name of a dimension (typically a parameter),
790 its position can be obtained from the following function.
791
792         #include <isl/space.h>
793         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
794                 enum isl_dim_type type, __isl_keep isl_id *id);
795         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
796                 enum isl_dim_type type, const char *name);
797
798 The identifiers or names of entire spaces may be set or read off
799 using the following functions.
800
801         #include <isl/space.h>
802         __isl_give isl_space *isl_space_set_tuple_id(
803                 __isl_take isl_space *space,
804                 enum isl_dim_type type, __isl_take isl_id *id);
805         __isl_give isl_space *isl_space_reset_tuple_id(
806                 __isl_take isl_space *space, enum isl_dim_type type);
807         int isl_space_has_tuple_id(__isl_keep isl_space *space,
808                 enum isl_dim_type type);
809         __isl_give isl_id *isl_space_get_tuple_id(
810                 __isl_keep isl_space *space, enum isl_dim_type type);
811         __isl_give isl_space *isl_space_set_tuple_name(
812                 __isl_take isl_space *space,
813                 enum isl_dim_type type, const char *s);
814         int isl_space_has_tuple_name(__isl_keep isl_space *space,
815                 enum isl_dim_type type);
816         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
817                 enum isl_dim_type type);
818
819 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
820 or C<isl_dim_set>.  As with C<isl_space_get_name>,
821 the C<isl_space_get_tuple_name> function returns a pointer to some internal
822 data structure.
823 Binary operations require the corresponding spaces of their arguments
824 to have the same name.
825
826 Spaces can be nested.  In particular, the domain of a set or
827 the domain or range of a relation can be a nested relation.
828 The following functions can be used to construct and deconstruct
829 such nested spaces.
830
831         #include <isl/space.h>
832         int isl_space_is_wrapping(__isl_keep isl_space *space);
833         __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
834         __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
835
836 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
837 be the space of a set, while that of
838 C<isl_space_wrap> should be the space of a relation.
839 Conversely, the output of C<isl_space_unwrap> is the space
840 of a relation, while that of C<isl_space_wrap> is the space of a set.
841
842 Spaces can be created from other spaces
843 using the following functions.
844
845         __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
846         __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
847         __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
848         __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
849         __isl_give isl_space *isl_space_params(
850                 __isl_take isl_space *space);
851         __isl_give isl_space *isl_space_set_from_params(
852                 __isl_take isl_space *space);
853         __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
854         __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
855                 __isl_take isl_space *right);
856         __isl_give isl_space *isl_space_align_params(
857                 __isl_take isl_space *space1, __isl_take isl_space *space2)
858         __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
859                 enum isl_dim_type type, unsigned pos, unsigned n);
860         __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
861                 enum isl_dim_type type, unsigned n);
862         __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
863                 enum isl_dim_type type, unsigned first, unsigned n);
864         __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
865                 enum isl_dim_type dst_type, unsigned dst_pos,
866                 enum isl_dim_type src_type, unsigned src_pos,
867                 unsigned n);
868         __isl_give isl_space *isl_space_map_from_set(
869                 __isl_take isl_space *space);
870         __isl_give isl_space *isl_space_map_from_domain_and_range(
871                 __isl_take isl_space *domain,
872                 __isl_take isl_space *range);
873         __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
874         __isl_give isl_space *isl_space_curry(
875                 __isl_take isl_space *space);
876         __isl_give isl_space *isl_space_uncurry(
877                 __isl_take isl_space *space);
878
879 Note that if dimensions are added or removed from a space, then
880 the name and the internal structure are lost.
881
882 =head2 Local Spaces
883
884 A local space is essentially a space with
885 zero or more existentially quantified variables.
886 The local space of a (constraint of a) basic set or relation can be obtained
887 using the following functions.
888
889         #include <isl/constraint.h>
890         __isl_give isl_local_space *isl_constraint_get_local_space(
891                 __isl_keep isl_constraint *constraint);
892
893         #include <isl/set.h>
894         __isl_give isl_local_space *isl_basic_set_get_local_space(
895                 __isl_keep isl_basic_set *bset);
896
897         #include <isl/map.h>
898         __isl_give isl_local_space *isl_basic_map_get_local_space(
899                 __isl_keep isl_basic_map *bmap);
900
901 A new local space can be created from a space using
902
903         #include <isl/local_space.h>
904         __isl_give isl_local_space *isl_local_space_from_space(
905                 __isl_take isl_space *space);
906
907 They can be inspected, modified, copied and freed using the following functions.
908
909         #include <isl/local_space.h>
910         isl_ctx *isl_local_space_get_ctx(
911                 __isl_keep isl_local_space *ls);
912         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
913         int isl_local_space_dim(__isl_keep isl_local_space *ls,
914                 enum isl_dim_type type);
915         int isl_local_space_has_dim_id(
916                 __isl_keep isl_local_space *ls,
917                 enum isl_dim_type type, unsigned pos);
918         __isl_give isl_id *isl_local_space_get_dim_id(
919                 __isl_keep isl_local_space *ls,
920                 enum isl_dim_type type, unsigned pos);
921         int isl_local_space_has_dim_name(
922                 __isl_keep isl_local_space *ls,
923                 enum isl_dim_type type, unsigned pos)
924         const char *isl_local_space_get_dim_name(
925                 __isl_keep isl_local_space *ls,
926                 enum isl_dim_type type, unsigned pos);
927         __isl_give isl_local_space *isl_local_space_set_dim_name(
928                 __isl_take isl_local_space *ls,
929                 enum isl_dim_type type, unsigned pos, const char *s);
930         __isl_give isl_local_space *isl_local_space_set_dim_id(
931                 __isl_take isl_local_space *ls,
932                 enum isl_dim_type type, unsigned pos,
933                 __isl_take isl_id *id);
934         __isl_give isl_space *isl_local_space_get_space(
935                 __isl_keep isl_local_space *ls);
936         __isl_give isl_aff *isl_local_space_get_div(
937                 __isl_keep isl_local_space *ls, int pos);
938         __isl_give isl_local_space *isl_local_space_copy(
939                 __isl_keep isl_local_space *ls);
940         void *isl_local_space_free(__isl_take isl_local_space *ls);
941
942 Two local spaces can be compared using
943
944         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
945                 __isl_keep isl_local_space *ls2);
946
947 Local spaces can be created from other local spaces
948 using the following functions.
949
950         __isl_give isl_local_space *isl_local_space_domain(
951                 __isl_take isl_local_space *ls);
952         __isl_give isl_local_space *isl_local_space_range(
953                 __isl_take isl_local_space *ls);
954         __isl_give isl_local_space *isl_local_space_from_domain(
955                 __isl_take isl_local_space *ls);
956         __isl_give isl_local_space *isl_local_space_intersect(
957                 __isl_take isl_local_space *ls1,
958                 __isl_take isl_local_space *ls2);
959         __isl_give isl_local_space *isl_local_space_add_dims(
960                 __isl_take isl_local_space *ls,
961                 enum isl_dim_type type, unsigned n);
962         __isl_give isl_local_space *isl_local_space_insert_dims(
963                 __isl_take isl_local_space *ls,
964                 enum isl_dim_type type, unsigned first, unsigned n);
965         __isl_give isl_local_space *isl_local_space_drop_dims(
966                 __isl_take isl_local_space *ls,
967                 enum isl_dim_type type, unsigned first, unsigned n);
968
969 =head2 Input and Output
970
971 C<isl> supports its own input/output format, which is similar
972 to the C<Omega> format, but also supports the C<PolyLib> format
973 in some cases.
974
975 =head3 C<isl> format
976
977 The C<isl> format is similar to that of C<Omega>, but has a different
978 syntax for describing the parameters and allows for the definition
979 of an existentially quantified variable as the integer division
980 of an affine expression.
981 For example, the set of integers C<i> between C<0> and C<n>
982 such that C<i % 10 <= 6> can be described as
983
984         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
985                                 i - 10 a <= 6) }
986
987 A set or relation can have several disjuncts, separated
988 by the keyword C<or>.  Each disjunct is either a conjunction
989 of constraints or a projection (C<exists>) of a conjunction
990 of constraints.  The constraints are separated by the keyword
991 C<and>.
992
993 =head3 C<PolyLib> format
994
995 If the represented set is a union, then the first line
996 contains a single number representing the number of disjuncts.
997 Otherwise, a line containing the number C<1> is optional.
998
999 Each disjunct is represented by a matrix of constraints.
1000 The first line contains two numbers representing
1001 the number of rows and columns,
1002 where the number of rows is equal to the number of constraints
1003 and the number of columns is equal to two plus the number of variables.
1004 The following lines contain the actual rows of the constraint matrix.
1005 In each row, the first column indicates whether the constraint
1006 is an equality (C<0>) or inequality (C<1>).  The final column
1007 corresponds to the constant term.
1008
1009 If the set is parametric, then the coefficients of the parameters
1010 appear in the last columns before the constant column.
1011 The coefficients of any existentially quantified variables appear
1012 between those of the set variables and those of the parameters.
1013
1014 =head3 Extended C<PolyLib> format
1015
1016 The extended C<PolyLib> format is nearly identical to the
1017 C<PolyLib> format.  The only difference is that the line
1018 containing the number of rows and columns of a constraint matrix
1019 also contains four additional numbers:
1020 the number of output dimensions, the number of input dimensions,
1021 the number of local dimensions (i.e., the number of existentially
1022 quantified variables) and the number of parameters.
1023 For sets, the number of ``output'' dimensions is equal
1024 to the number of set dimensions, while the number of ``input''
1025 dimensions is zero.
1026
1027 =head3 Input
1028
1029         #include <isl/set.h>
1030         __isl_give isl_basic_set *isl_basic_set_read_from_file(
1031                 isl_ctx *ctx, FILE *input);
1032         __isl_give isl_basic_set *isl_basic_set_read_from_str(
1033                 isl_ctx *ctx, const char *str);
1034         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
1035                 FILE *input);
1036         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
1037                 const char *str);
1038
1039         #include <isl/map.h>
1040         __isl_give isl_basic_map *isl_basic_map_read_from_file(
1041                 isl_ctx *ctx, FILE *input);
1042         __isl_give isl_basic_map *isl_basic_map_read_from_str(
1043                 isl_ctx *ctx, const char *str);
1044         __isl_give isl_map *isl_map_read_from_file(
1045                 isl_ctx *ctx, FILE *input);
1046         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
1047                 const char *str);
1048
1049         #include <isl/union_set.h>
1050         __isl_give isl_union_set *isl_union_set_read_from_file(
1051                 isl_ctx *ctx, FILE *input);
1052         __isl_give isl_union_set *isl_union_set_read_from_str(
1053                 isl_ctx *ctx, const char *str);
1054
1055         #include <isl/union_map.h>
1056         __isl_give isl_union_map *isl_union_map_read_from_file(
1057                 isl_ctx *ctx, FILE *input);
1058         __isl_give isl_union_map *isl_union_map_read_from_str(
1059                 isl_ctx *ctx, const char *str);
1060
1061 The input format is autodetected and may be either the C<PolyLib> format
1062 or the C<isl> format.
1063
1064 =head3 Output
1065
1066 Before anything can be printed, an C<isl_printer> needs to
1067 be created.
1068
1069         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1070                 FILE *file);
1071         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1072         void *isl_printer_free(__isl_take isl_printer *printer);
1073         __isl_give char *isl_printer_get_str(
1074                 __isl_keep isl_printer *printer);
1075
1076 The printer can be inspected using the following functions.
1077
1078         FILE *isl_printer_get_file(
1079                 __isl_keep isl_printer *printer);
1080         int isl_printer_get_output_format(
1081                 __isl_keep isl_printer *p);
1082
1083 The behavior of the printer can be modified in various ways
1084
1085         __isl_give isl_printer *isl_printer_set_output_format(
1086                 __isl_take isl_printer *p, int output_format);
1087         __isl_give isl_printer *isl_printer_set_indent(
1088                 __isl_take isl_printer *p, int indent);
1089         __isl_give isl_printer *isl_printer_indent(
1090                 __isl_take isl_printer *p, int indent);
1091         __isl_give isl_printer *isl_printer_set_prefix(
1092                 __isl_take isl_printer *p, const char *prefix);
1093         __isl_give isl_printer *isl_printer_set_suffix(
1094                 __isl_take isl_printer *p, const char *suffix);
1095
1096 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1097 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1098 and defaults to C<ISL_FORMAT_ISL>.
1099 Each line in the output is indented by C<indent> (set by
1100 C<isl_printer_set_indent>) spaces
1101 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1102 In the C<PolyLib> format output,
1103 the coefficients of the existentially quantified variables
1104 appear between those of the set variables and those
1105 of the parameters.
1106 The function C<isl_printer_indent> increases the indentation
1107 by the specified amount (which may be negative).
1108
1109 To actually print something, use
1110
1111         #include <isl/printer.h>
1112         __isl_give isl_printer *isl_printer_print_double(
1113                 __isl_take isl_printer *p, double d);
1114
1115         #include <isl/set.h>
1116         __isl_give isl_printer *isl_printer_print_basic_set(
1117                 __isl_take isl_printer *printer,
1118                 __isl_keep isl_basic_set *bset);
1119         __isl_give isl_printer *isl_printer_print_set(
1120                 __isl_take isl_printer *printer,
1121                 __isl_keep isl_set *set);
1122
1123         #include <isl/map.h>
1124         __isl_give isl_printer *isl_printer_print_basic_map(
1125                 __isl_take isl_printer *printer,
1126                 __isl_keep isl_basic_map *bmap);
1127         __isl_give isl_printer *isl_printer_print_map(
1128                 __isl_take isl_printer *printer,
1129                 __isl_keep isl_map *map);
1130
1131         #include <isl/union_set.h>
1132         __isl_give isl_printer *isl_printer_print_union_set(
1133                 __isl_take isl_printer *p,
1134                 __isl_keep isl_union_set *uset);
1135
1136         #include <isl/union_map.h>
1137         __isl_give isl_printer *isl_printer_print_union_map(
1138                 __isl_take isl_printer *p,
1139                 __isl_keep isl_union_map *umap);
1140
1141 When called on a file printer, the following function flushes
1142 the file.  When called on a string printer, the buffer is cleared.
1143
1144         __isl_give isl_printer *isl_printer_flush(
1145                 __isl_take isl_printer *p);
1146
1147 =head2 Creating New Sets and Relations
1148
1149 C<isl> has functions for creating some standard sets and relations.
1150
1151 =over
1152
1153 =item * Empty sets and relations
1154
1155         __isl_give isl_basic_set *isl_basic_set_empty(
1156                 __isl_take isl_space *space);
1157         __isl_give isl_basic_map *isl_basic_map_empty(
1158                 __isl_take isl_space *space);
1159         __isl_give isl_set *isl_set_empty(
1160                 __isl_take isl_space *space);
1161         __isl_give isl_map *isl_map_empty(
1162                 __isl_take isl_space *space);
1163         __isl_give isl_union_set *isl_union_set_empty(
1164                 __isl_take isl_space *space);
1165         __isl_give isl_union_map *isl_union_map_empty(
1166                 __isl_take isl_space *space);
1167
1168 For C<isl_union_set>s and C<isl_union_map>s, the space
1169 is only used to specify the parameters.
1170
1171 =item * Universe sets and relations
1172
1173         __isl_give isl_basic_set *isl_basic_set_universe(
1174                 __isl_take isl_space *space);
1175         __isl_give isl_basic_map *isl_basic_map_universe(
1176                 __isl_take isl_space *space);
1177         __isl_give isl_set *isl_set_universe(
1178                 __isl_take isl_space *space);
1179         __isl_give isl_map *isl_map_universe(
1180                 __isl_take isl_space *space);
1181         __isl_give isl_union_set *isl_union_set_universe(
1182                 __isl_take isl_union_set *uset);
1183         __isl_give isl_union_map *isl_union_map_universe(
1184                 __isl_take isl_union_map *umap);
1185
1186 The sets and relations constructed by the functions above
1187 contain all integer values, while those constructed by the
1188 functions below only contain non-negative values.
1189
1190         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1191                 __isl_take isl_space *space);
1192         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1193                 __isl_take isl_space *space);
1194         __isl_give isl_set *isl_set_nat_universe(
1195                 __isl_take isl_space *space);
1196         __isl_give isl_map *isl_map_nat_universe(
1197                 __isl_take isl_space *space);
1198
1199 =item * Identity relations
1200
1201         __isl_give isl_basic_map *isl_basic_map_identity(
1202                 __isl_take isl_space *space);
1203         __isl_give isl_map *isl_map_identity(
1204                 __isl_take isl_space *space);
1205
1206 The number of input and output dimensions in C<space> needs
1207 to be the same.
1208
1209 =item * Lexicographic order
1210
1211         __isl_give isl_map *isl_map_lex_lt(
1212                 __isl_take isl_space *set_space);
1213         __isl_give isl_map *isl_map_lex_le(
1214                 __isl_take isl_space *set_space);
1215         __isl_give isl_map *isl_map_lex_gt(
1216                 __isl_take isl_space *set_space);
1217         __isl_give isl_map *isl_map_lex_ge(
1218                 __isl_take isl_space *set_space);
1219         __isl_give isl_map *isl_map_lex_lt_first(
1220                 __isl_take isl_space *space, unsigned n);
1221         __isl_give isl_map *isl_map_lex_le_first(
1222                 __isl_take isl_space *space, unsigned n);
1223         __isl_give isl_map *isl_map_lex_gt_first(
1224                 __isl_take isl_space *space, unsigned n);
1225         __isl_give isl_map *isl_map_lex_ge_first(
1226                 __isl_take isl_space *space, unsigned n);
1227
1228 The first four functions take a space for a B<set>
1229 and return relations that express that the elements in the domain
1230 are lexicographically less
1231 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1232 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1233 than the elements in the range.
1234 The last four functions take a space for a map
1235 and return relations that express that the first C<n> dimensions
1236 in the domain are lexicographically less
1237 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1238 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1239 than the first C<n> dimensions in the range.
1240
1241 =back
1242
1243 A basic set or relation can be converted to a set or relation
1244 using the following functions.
1245
1246         __isl_give isl_set *isl_set_from_basic_set(
1247                 __isl_take isl_basic_set *bset);
1248         __isl_give isl_map *isl_map_from_basic_map(
1249                 __isl_take isl_basic_map *bmap);
1250
1251 Sets and relations can be converted to union sets and relations
1252 using the following functions.
1253
1254         __isl_give isl_union_set *isl_union_set_from_basic_set(
1255                 __isl_take isl_basic_set *bset);
1256         __isl_give isl_union_map *isl_union_map_from_basic_map(
1257                 __isl_take isl_basic_map *bmap);
1258         __isl_give isl_union_set *isl_union_set_from_set(
1259                 __isl_take isl_set *set);
1260         __isl_give isl_union_map *isl_union_map_from_map(
1261                 __isl_take isl_map *map);
1262
1263 The inverse conversions below can only be used if the input
1264 union set or relation is known to contain elements in exactly one
1265 space.
1266
1267         __isl_give isl_set *isl_set_from_union_set(
1268                 __isl_take isl_union_set *uset);
1269         __isl_give isl_map *isl_map_from_union_map(
1270                 __isl_take isl_union_map *umap);
1271
1272 A zero-dimensional set can be constructed on a given parameter domain
1273 using the following function.
1274
1275         __isl_give isl_set *isl_set_from_params(
1276                 __isl_take isl_set *set);
1277
1278 Sets and relations can be copied and freed again using the following
1279 functions.
1280
1281         __isl_give isl_basic_set *isl_basic_set_copy(
1282                 __isl_keep isl_basic_set *bset);
1283         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1284         __isl_give isl_union_set *isl_union_set_copy(
1285                 __isl_keep isl_union_set *uset);
1286         __isl_give isl_basic_map *isl_basic_map_copy(
1287                 __isl_keep isl_basic_map *bmap);
1288         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1289         __isl_give isl_union_map *isl_union_map_copy(
1290                 __isl_keep isl_union_map *umap);
1291         void *isl_basic_set_free(__isl_take isl_basic_set *bset);
1292         void *isl_set_free(__isl_take isl_set *set);
1293         void *isl_union_set_free(__isl_take isl_union_set *uset);
1294         void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
1295         void *isl_map_free(__isl_take isl_map *map);
1296         void *isl_union_map_free(__isl_take isl_union_map *umap);
1297
1298 Other sets and relations can be constructed by starting
1299 from a universe set or relation, adding equality and/or
1300 inequality constraints and then projecting out the
1301 existentially quantified variables, if any.
1302 Constraints can be constructed, manipulated and
1303 added to (or removed from) (basic) sets and relations
1304 using the following functions.
1305
1306         #include <isl/constraint.h>
1307         __isl_give isl_constraint *isl_equality_alloc(
1308                 __isl_take isl_local_space *ls);
1309         __isl_give isl_constraint *isl_inequality_alloc(
1310                 __isl_take isl_local_space *ls);
1311         __isl_give isl_constraint *isl_constraint_set_constant(
1312                 __isl_take isl_constraint *constraint, isl_int v);
1313         __isl_give isl_constraint *isl_constraint_set_constant_si(
1314                 __isl_take isl_constraint *constraint, int v);
1315         __isl_give isl_constraint *isl_constraint_set_coefficient(
1316                 __isl_take isl_constraint *constraint,
1317                 enum isl_dim_type type, int pos, isl_int v);
1318         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1319                 __isl_take isl_constraint *constraint,
1320                 enum isl_dim_type type, int pos, int v);
1321         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1322                 __isl_take isl_basic_map *bmap,
1323                 __isl_take isl_constraint *constraint);
1324         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1325                 __isl_take isl_basic_set *bset,
1326                 __isl_take isl_constraint *constraint);
1327         __isl_give isl_map *isl_map_add_constraint(
1328                 __isl_take isl_map *map,
1329                 __isl_take isl_constraint *constraint);
1330         __isl_give isl_set *isl_set_add_constraint(
1331                 __isl_take isl_set *set,
1332                 __isl_take isl_constraint *constraint);
1333         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1334                 __isl_take isl_basic_set *bset,
1335                 __isl_take isl_constraint *constraint);
1336
1337 For example, to create a set containing the even integers
1338 between 10 and 42, you would use the following code.
1339
1340         isl_space *space;
1341         isl_local_space *ls;
1342         isl_constraint *c;
1343         isl_basic_set *bset;
1344
1345         space = isl_space_set_alloc(ctx, 0, 2);
1346         bset = isl_basic_set_universe(isl_space_copy(space));
1347         ls = isl_local_space_from_space(space);
1348
1349         c = isl_equality_alloc(isl_local_space_copy(ls));
1350         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1351         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1352         bset = isl_basic_set_add_constraint(bset, c);
1353
1354         c = isl_inequality_alloc(isl_local_space_copy(ls));
1355         c = isl_constraint_set_constant_si(c, -10);
1356         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1357         bset = isl_basic_set_add_constraint(bset, c);
1358
1359         c = isl_inequality_alloc(ls);
1360         c = isl_constraint_set_constant_si(c, 42);
1361         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1362         bset = isl_basic_set_add_constraint(bset, c);
1363
1364         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1365
1366 Or, alternatively,
1367
1368         isl_basic_set *bset;
1369         bset = isl_basic_set_read_from_str(ctx,
1370                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1371
1372 A basic set or relation can also be constructed from two matrices
1373 describing the equalities and the inequalities.
1374
1375         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1376                 __isl_take isl_space *space,
1377                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1378                 enum isl_dim_type c1,
1379                 enum isl_dim_type c2, enum isl_dim_type c3,
1380                 enum isl_dim_type c4);
1381         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1382                 __isl_take isl_space *space,
1383                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1384                 enum isl_dim_type c1,
1385                 enum isl_dim_type c2, enum isl_dim_type c3,
1386                 enum isl_dim_type c4, enum isl_dim_type c5);
1387
1388 The C<isl_dim_type> arguments indicate the order in which
1389 different kinds of variables appear in the input matrices
1390 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1391 C<isl_dim_set> and C<isl_dim_div> for sets and
1392 of C<isl_dim_cst>, C<isl_dim_param>,
1393 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1394
1395 A (basic or union) set or relation can also be constructed from a
1396 (union) (piecewise) (multiple) affine expression
1397 or a list of affine expressions
1398 (See L<"Piecewise Quasi Affine Expressions"> and
1399 L<"Piecewise Multiple Quasi Affine Expressions">).
1400
1401         __isl_give isl_basic_map *isl_basic_map_from_aff(
1402                 __isl_take isl_aff *aff);
1403         __isl_give isl_map *isl_map_from_aff(
1404                 __isl_take isl_aff *aff);
1405         __isl_give isl_set *isl_set_from_pw_aff(
1406                 __isl_take isl_pw_aff *pwaff);
1407         __isl_give isl_map *isl_map_from_pw_aff(
1408                 __isl_take isl_pw_aff *pwaff);
1409         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1410                 __isl_take isl_space *domain_space,
1411                 __isl_take isl_aff_list *list);
1412         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1413                 __isl_take isl_multi_aff *maff)
1414         __isl_give isl_map *isl_map_from_multi_aff(
1415                 __isl_take isl_multi_aff *maff)
1416         __isl_give isl_set *isl_set_from_pw_multi_aff(
1417                 __isl_take isl_pw_multi_aff *pma);
1418         __isl_give isl_map *isl_map_from_pw_multi_aff(
1419                 __isl_take isl_pw_multi_aff *pma);
1420         __isl_give isl_union_map *
1421         isl_union_map_from_union_pw_multi_aff(
1422                 __isl_take isl_union_pw_multi_aff *upma);
1423
1424 The C<domain_dim> argument describes the domain of the resulting
1425 basic relation.  It is required because the C<list> may consist
1426 of zero affine expressions.
1427
1428 =head2 Inspecting Sets and Relations
1429
1430 Usually, the user should not have to care about the actual constraints
1431 of the sets and maps, but should instead apply the abstract operations
1432 explained in the following sections.
1433 Occasionally, however, it may be required to inspect the individual
1434 coefficients of the constraints.  This section explains how to do so.
1435 In these cases, it may also be useful to have C<isl> compute
1436 an explicit representation of the existentially quantified variables.
1437
1438         __isl_give isl_set *isl_set_compute_divs(
1439                 __isl_take isl_set *set);
1440         __isl_give isl_map *isl_map_compute_divs(
1441                 __isl_take isl_map *map);
1442         __isl_give isl_union_set *isl_union_set_compute_divs(
1443                 __isl_take isl_union_set *uset);
1444         __isl_give isl_union_map *isl_union_map_compute_divs(
1445                 __isl_take isl_union_map *umap);
1446
1447 This explicit representation defines the existentially quantified
1448 variables as integer divisions of the other variables, possibly
1449 including earlier existentially quantified variables.
1450 An explicitly represented existentially quantified variable therefore
1451 has a unique value when the values of the other variables are known.
1452 If, furthermore, the same existentials, i.e., existentials
1453 with the same explicit representations, should appear in the
1454 same order in each of the disjuncts of a set or map, then the user should call
1455 either of the following functions.
1456
1457         __isl_give isl_set *isl_set_align_divs(
1458                 __isl_take isl_set *set);
1459         __isl_give isl_map *isl_map_align_divs(
1460                 __isl_take isl_map *map);
1461
1462 Alternatively, the existentially quantified variables can be removed
1463 using the following functions, which compute an overapproximation.
1464
1465         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1466                 __isl_take isl_basic_set *bset);
1467         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1468                 __isl_take isl_basic_map *bmap);
1469         __isl_give isl_set *isl_set_remove_divs(
1470                 __isl_take isl_set *set);
1471         __isl_give isl_map *isl_map_remove_divs(
1472                 __isl_take isl_map *map);
1473
1474 It is also possible to only remove those divs that are defined
1475 in terms of a given range of dimensions or only those for which
1476 no explicit representation is known.
1477
1478         __isl_give isl_basic_set *
1479         isl_basic_set_remove_divs_involving_dims(
1480                 __isl_take isl_basic_set *bset,
1481                 enum isl_dim_type type,
1482                 unsigned first, unsigned n);
1483         __isl_give isl_basic_map *
1484         isl_basic_map_remove_divs_involving_dims(
1485                 __isl_take isl_basic_map *bmap,
1486                 enum isl_dim_type type,
1487                 unsigned first, unsigned n);
1488         __isl_give isl_set *isl_set_remove_divs_involving_dims(
1489                 __isl_take isl_set *set, enum isl_dim_type type,
1490                 unsigned first, unsigned n);
1491         __isl_give isl_map *isl_map_remove_divs_involving_dims(
1492                 __isl_take isl_map *map, enum isl_dim_type type,
1493                 unsigned first, unsigned n);
1494
1495         __isl_give isl_basic_set *
1496         isl_basic_set_remove_unknown_divs(
1497                 __isl_take isl_basic_set *bset);
1498         __isl_give isl_set *isl_set_remove_unknown_divs(
1499                 __isl_take isl_set *set);
1500         __isl_give isl_map *isl_map_remove_unknown_divs(
1501                 __isl_take isl_map *map);
1502
1503 To iterate over all the sets or maps in a union set or map, use
1504
1505         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1506                 int (*fn)(__isl_take isl_set *set, void *user),
1507                 void *user);
1508         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1509                 int (*fn)(__isl_take isl_map *map, void *user),
1510                 void *user);
1511
1512 The number of sets or maps in a union set or map can be obtained
1513 from
1514
1515         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1516         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1517
1518 To extract the set or map in a given space from a union, use
1519
1520         __isl_give isl_set *isl_union_set_extract_set(
1521                 __isl_keep isl_union_set *uset,
1522                 __isl_take isl_space *space);
1523         __isl_give isl_map *isl_union_map_extract_map(
1524                 __isl_keep isl_union_map *umap,
1525                 __isl_take isl_space *space);
1526
1527 To iterate over all the basic sets or maps in a set or map, use
1528
1529         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1530                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1531                 void *user);
1532         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1533                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1534                 void *user);
1535
1536 The callback function C<fn> should return 0 if successful and
1537 -1 if an error occurs.  In the latter case, or if any other error
1538 occurs, the above functions will return -1.
1539
1540 It should be noted that C<isl> does not guarantee that
1541 the basic sets or maps passed to C<fn> are disjoint.
1542 If this is required, then the user should call one of
1543 the following functions first.
1544
1545         __isl_give isl_set *isl_set_make_disjoint(
1546                 __isl_take isl_set *set);
1547         __isl_give isl_map *isl_map_make_disjoint(
1548                 __isl_take isl_map *map);
1549
1550 The number of basic sets in a set can be obtained
1551 from
1552
1553         int isl_set_n_basic_set(__isl_keep isl_set *set);
1554
1555 To iterate over the constraints of a basic set or map, use
1556
1557         #include <isl/constraint.h>
1558
1559         int isl_basic_set_n_constraint(
1560                 __isl_keep isl_basic_set *bset);
1561         int isl_basic_set_foreach_constraint(
1562                 __isl_keep isl_basic_set *bset,
1563                 int (*fn)(__isl_take isl_constraint *c, void *user),
1564                 void *user);
1565         int isl_basic_map_foreach_constraint(
1566                 __isl_keep isl_basic_map *bmap,
1567                 int (*fn)(__isl_take isl_constraint *c, void *user),
1568                 void *user);
1569         void *isl_constraint_free(__isl_take isl_constraint *c);
1570
1571 Again, the callback function C<fn> should return 0 if successful and
1572 -1 if an error occurs.  In the latter case, or if any other error
1573 occurs, the above functions will return -1.
1574 The constraint C<c> represents either an equality or an inequality.
1575 Use the following function to find out whether a constraint
1576 represents an equality.  If not, it represents an inequality.
1577
1578         int isl_constraint_is_equality(
1579                 __isl_keep isl_constraint *constraint);
1580
1581 The coefficients of the constraints can be inspected using
1582 the following functions.
1583
1584         int isl_constraint_is_lower_bound(
1585                 __isl_keep isl_constraint *constraint,
1586                 enum isl_dim_type type, unsigned pos);
1587         int isl_constraint_is_upper_bound(
1588                 __isl_keep isl_constraint *constraint,
1589                 enum isl_dim_type type, unsigned pos);
1590         void isl_constraint_get_constant(
1591                 __isl_keep isl_constraint *constraint, isl_int *v);
1592         void isl_constraint_get_coefficient(
1593                 __isl_keep isl_constraint *constraint,
1594                 enum isl_dim_type type, int pos, isl_int *v);
1595         int isl_constraint_involves_dims(
1596                 __isl_keep isl_constraint *constraint,
1597                 enum isl_dim_type type, unsigned first, unsigned n);
1598
1599 The explicit representations of the existentially quantified
1600 variables can be inspected using the following function.
1601 Note that the user is only allowed to use this function
1602 if the inspected set or map is the result of a call
1603 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1604 The existentially quantified variable is equal to the floor
1605 of the returned affine expression.  The affine expression
1606 itself can be inspected using the functions in
1607 L<"Piecewise Quasi Affine Expressions">.
1608
1609         __isl_give isl_aff *isl_constraint_get_div(
1610                 __isl_keep isl_constraint *constraint, int pos);
1611
1612 To obtain the constraints of a basic set or map in matrix
1613 form, use the following functions.
1614
1615         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1616                 __isl_keep isl_basic_set *bset,
1617                 enum isl_dim_type c1, enum isl_dim_type c2,
1618                 enum isl_dim_type c3, enum isl_dim_type c4);
1619         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1620                 __isl_keep isl_basic_set *bset,
1621                 enum isl_dim_type c1, enum isl_dim_type c2,
1622                 enum isl_dim_type c3, enum isl_dim_type c4);
1623         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1624                 __isl_keep isl_basic_map *bmap,
1625                 enum isl_dim_type c1,
1626                 enum isl_dim_type c2, enum isl_dim_type c3,
1627                 enum isl_dim_type c4, enum isl_dim_type c5);
1628         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1629                 __isl_keep isl_basic_map *bmap,
1630                 enum isl_dim_type c1,
1631                 enum isl_dim_type c2, enum isl_dim_type c3,
1632                 enum isl_dim_type c4, enum isl_dim_type c5);
1633
1634 The C<isl_dim_type> arguments dictate the order in which
1635 different kinds of variables appear in the resulting matrix
1636 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1637 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1638
1639 The number of parameters, input, output or set dimensions can
1640 be obtained using the following functions.
1641
1642         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1643                 enum isl_dim_type type);
1644         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1645                 enum isl_dim_type type);
1646         unsigned isl_set_dim(__isl_keep isl_set *set,
1647                 enum isl_dim_type type);
1648         unsigned isl_map_dim(__isl_keep isl_map *map,
1649                 enum isl_dim_type type);
1650
1651 To check whether the description of a set or relation depends
1652 on one or more given dimensions, it is not necessary to iterate over all
1653 constraints.  Instead the following functions can be used.
1654
1655         int isl_basic_set_involves_dims(
1656                 __isl_keep isl_basic_set *bset,
1657                 enum isl_dim_type type, unsigned first, unsigned n);
1658         int isl_set_involves_dims(__isl_keep isl_set *set,
1659                 enum isl_dim_type type, unsigned first, unsigned n);
1660         int isl_basic_map_involves_dims(
1661                 __isl_keep isl_basic_map *bmap,
1662                 enum isl_dim_type type, unsigned first, unsigned n);
1663         int isl_map_involves_dims(__isl_keep isl_map *map,
1664                 enum isl_dim_type type, unsigned first, unsigned n);
1665
1666 Similarly, the following functions can be used to check whether
1667 a given dimension is involved in any lower or upper bound.
1668
1669         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1670                 enum isl_dim_type type, unsigned pos);
1671         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1672                 enum isl_dim_type type, unsigned pos);
1673
1674 The identifiers or names of the domain and range spaces of a set
1675 or relation can be read off or set using the following functions.
1676
1677         __isl_give isl_set *isl_set_set_tuple_id(
1678                 __isl_take isl_set *set, __isl_take isl_id *id);
1679         __isl_give isl_set *isl_set_reset_tuple_id(
1680                 __isl_take isl_set *set);
1681         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1682         __isl_give isl_id *isl_set_get_tuple_id(
1683                 __isl_keep isl_set *set);
1684         __isl_give isl_map *isl_map_set_tuple_id(
1685                 __isl_take isl_map *map, enum isl_dim_type type,
1686                 __isl_take isl_id *id);
1687         __isl_give isl_map *isl_map_reset_tuple_id(
1688                 __isl_take isl_map *map, enum isl_dim_type type);
1689         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1690                 enum isl_dim_type type);
1691         __isl_give isl_id *isl_map_get_tuple_id(
1692                 __isl_keep isl_map *map, enum isl_dim_type type);
1693
1694         const char *isl_basic_set_get_tuple_name(
1695                 __isl_keep isl_basic_set *bset);
1696         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1697                 __isl_take isl_basic_set *set, const char *s);
1698         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1699         const char *isl_set_get_tuple_name(
1700                 __isl_keep isl_set *set);
1701         const char *isl_basic_map_get_tuple_name(
1702                 __isl_keep isl_basic_map *bmap,
1703                 enum isl_dim_type type);
1704         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1705                 __isl_take isl_basic_map *bmap,
1706                 enum isl_dim_type type, const char *s);
1707         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1708                 enum isl_dim_type type);
1709         const char *isl_map_get_tuple_name(
1710                 __isl_keep isl_map *map,
1711                 enum isl_dim_type type);
1712
1713 As with C<isl_space_get_tuple_name>, the value returned points to
1714 an internal data structure.
1715 The identifiers, positions or names of individual dimensions can be
1716 read off using the following functions.
1717
1718         __isl_give isl_id *isl_basic_set_get_dim_id(
1719                 __isl_keep isl_basic_set *bset,
1720                 enum isl_dim_type type, unsigned pos);
1721         __isl_give isl_set *isl_set_set_dim_id(
1722                 __isl_take isl_set *set, enum isl_dim_type type,
1723                 unsigned pos, __isl_take isl_id *id);
1724         int isl_set_has_dim_id(__isl_keep isl_set *set,
1725                 enum isl_dim_type type, unsigned pos);
1726         __isl_give isl_id *isl_set_get_dim_id(
1727                 __isl_keep isl_set *set, enum isl_dim_type type,
1728                 unsigned pos);
1729         int isl_basic_map_has_dim_id(
1730                 __isl_keep isl_basic_map *bmap,
1731                 enum isl_dim_type type, unsigned pos);
1732         __isl_give isl_map *isl_map_set_dim_id(
1733                 __isl_take isl_map *map, enum isl_dim_type type,
1734                 unsigned pos, __isl_take isl_id *id);
1735         int isl_map_has_dim_id(__isl_keep isl_map *map,
1736                 enum isl_dim_type type, unsigned pos);
1737         __isl_give isl_id *isl_map_get_dim_id(
1738                 __isl_keep isl_map *map, enum isl_dim_type type,
1739                 unsigned pos);
1740
1741         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1742                 enum isl_dim_type type, __isl_keep isl_id *id);
1743         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1744                 enum isl_dim_type type, __isl_keep isl_id *id);
1745         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1746                 enum isl_dim_type type, const char *name);
1747         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1748                 enum isl_dim_type type, const char *name);
1749
1750         const char *isl_constraint_get_dim_name(
1751                 __isl_keep isl_constraint *constraint,
1752                 enum isl_dim_type type, unsigned pos);
1753         const char *isl_basic_set_get_dim_name(
1754                 __isl_keep isl_basic_set *bset,
1755                 enum isl_dim_type type, unsigned pos);
1756         int isl_set_has_dim_name(__isl_keep isl_set *set,
1757                 enum isl_dim_type type, unsigned pos);
1758         const char *isl_set_get_dim_name(
1759                 __isl_keep isl_set *set,
1760                 enum isl_dim_type type, unsigned pos);
1761         const char *isl_basic_map_get_dim_name(
1762                 __isl_keep isl_basic_map *bmap,
1763                 enum isl_dim_type type, unsigned pos);
1764         int isl_map_has_dim_name(__isl_keep isl_map *map,
1765                 enum isl_dim_type type, unsigned pos);
1766         const char *isl_map_get_dim_name(
1767                 __isl_keep isl_map *map,
1768                 enum isl_dim_type type, unsigned pos);
1769
1770 These functions are mostly useful to obtain the identifiers, positions
1771 or names of the parameters.  Identifiers of individual dimensions are
1772 essentially only useful for printing.  They are ignored by all other
1773 operations and may not be preserved across those operations.
1774
1775 =head2 Properties
1776
1777 =head3 Unary Properties
1778
1779 =over
1780
1781 =item * Emptiness
1782
1783 The following functions test whether the given set or relation
1784 contains any integer points.  The ``plain'' variants do not perform
1785 any computations, but simply check if the given set or relation
1786 is already known to be empty.
1787
1788         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1789         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1790         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1791         int isl_set_is_empty(__isl_keep isl_set *set);
1792         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1793         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1794         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1795         int isl_map_plain_is_empty(__isl_keep isl_map *map);
1796         int isl_map_is_empty(__isl_keep isl_map *map);
1797         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1798
1799 =item * Universality
1800
1801         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1802         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1803         int isl_set_plain_is_universe(__isl_keep isl_set *set);
1804
1805 =item * Single-valuedness
1806
1807         int isl_basic_map_is_single_valued(
1808                 __isl_keep isl_basic_map *bmap);
1809         int isl_map_plain_is_single_valued(
1810                 __isl_keep isl_map *map);
1811         int isl_map_is_single_valued(__isl_keep isl_map *map);
1812         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1813
1814 =item * Injectivity
1815
1816         int isl_map_plain_is_injective(__isl_keep isl_map *map);
1817         int isl_map_is_injective(__isl_keep isl_map *map);
1818         int isl_union_map_plain_is_injective(
1819                 __isl_keep isl_union_map *umap);
1820         int isl_union_map_is_injective(
1821                 __isl_keep isl_union_map *umap);
1822
1823 =item * Bijectivity
1824
1825         int isl_map_is_bijective(__isl_keep isl_map *map);
1826         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1827
1828 =item * Position
1829
1830         int isl_basic_map_plain_is_fixed(
1831                 __isl_keep isl_basic_map *bmap,
1832                 enum isl_dim_type type, unsigned pos,
1833                 isl_int *val);
1834         int isl_set_plain_is_fixed(__isl_keep isl_set *set,
1835                 enum isl_dim_type type, unsigned pos,
1836                 isl_int *val);
1837         int isl_map_plain_is_fixed(__isl_keep isl_map *map,
1838                 enum isl_dim_type type, unsigned pos,
1839                 isl_int *val);
1840
1841 Check if the relation obviously lies on a hyperplane where the given dimension
1842 has a fixed value and if so, return that value in C<*val>.
1843
1844 =item * Space
1845
1846 To check whether a set is a parameter domain, use this function:
1847
1848         int isl_set_is_params(__isl_keep isl_set *set);
1849         int isl_union_set_is_params(
1850                 __isl_keep isl_union_set *uset);
1851
1852 =item * Wrapping
1853
1854 The following functions check whether the domain of the given
1855 (basic) set is a wrapped relation.
1856
1857         int isl_basic_set_is_wrapping(
1858                 __isl_keep isl_basic_set *bset);
1859         int isl_set_is_wrapping(__isl_keep isl_set *set);
1860
1861 =item * Internal Product
1862
1863         int isl_basic_map_can_zip(
1864                 __isl_keep isl_basic_map *bmap);
1865         int isl_map_can_zip(__isl_keep isl_map *map);
1866
1867 Check whether the product of domain and range of the given relation
1868 can be computed,
1869 i.e., whether both domain and range are nested relations.
1870
1871 =item * Currying
1872
1873         int isl_basic_map_can_curry(
1874                 __isl_keep isl_basic_map *bmap);
1875         int isl_map_can_curry(__isl_keep isl_map *map);
1876
1877 Check whether the domain of the (basic) relation is a wrapped relation.
1878
1879         int isl_basic_map_can_uncurry(
1880                 __isl_keep isl_basic_map *bmap);
1881         int isl_map_can_uncurry(__isl_keep isl_map *map);
1882
1883 Check whether the range of the (basic) relation is a wrapped relation.
1884
1885 =back
1886
1887 =head3 Binary Properties
1888
1889 =over
1890
1891 =item * Equality
1892
1893         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
1894                 __isl_keep isl_set *set2);
1895         int isl_set_is_equal(__isl_keep isl_set *set1,
1896                 __isl_keep isl_set *set2);
1897         int isl_union_set_is_equal(
1898                 __isl_keep isl_union_set *uset1,
1899                 __isl_keep isl_union_set *uset2);
1900         int isl_basic_map_is_equal(
1901                 __isl_keep isl_basic_map *bmap1,
1902                 __isl_keep isl_basic_map *bmap2);
1903         int isl_map_is_equal(__isl_keep isl_map *map1,
1904                 __isl_keep isl_map *map2);
1905         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
1906                 __isl_keep isl_map *map2);
1907         int isl_union_map_is_equal(
1908                 __isl_keep isl_union_map *umap1,
1909                 __isl_keep isl_union_map *umap2);
1910
1911 =item * Disjointness
1912
1913         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
1914                 __isl_keep isl_set *set2);
1915         int isl_set_is_disjoint(__isl_keep isl_set *set1,
1916                 __isl_keep isl_set *set2);
1917         int isl_map_is_disjoint(__isl_keep isl_map *map1,
1918                 __isl_keep isl_map *map2);
1919
1920 =item * Subset
1921
1922         int isl_basic_set_is_subset(
1923                 __isl_keep isl_basic_set *bset1,
1924                 __isl_keep isl_basic_set *bset2);
1925         int isl_set_is_subset(__isl_keep isl_set *set1,
1926                 __isl_keep isl_set *set2);
1927         int isl_set_is_strict_subset(
1928                 __isl_keep isl_set *set1,
1929                 __isl_keep isl_set *set2);
1930         int isl_union_set_is_subset(
1931                 __isl_keep isl_union_set *uset1,
1932                 __isl_keep isl_union_set *uset2);
1933         int isl_union_set_is_strict_subset(
1934                 __isl_keep isl_union_set *uset1,
1935                 __isl_keep isl_union_set *uset2);
1936         int isl_basic_map_is_subset(
1937                 __isl_keep isl_basic_map *bmap1,
1938                 __isl_keep isl_basic_map *bmap2);
1939         int isl_basic_map_is_strict_subset(
1940                 __isl_keep isl_basic_map *bmap1,
1941                 __isl_keep isl_basic_map *bmap2);
1942         int isl_map_is_subset(
1943                 __isl_keep isl_map *map1,
1944                 __isl_keep isl_map *map2);
1945         int isl_map_is_strict_subset(
1946                 __isl_keep isl_map *map1,
1947                 __isl_keep isl_map *map2);
1948         int isl_union_map_is_subset(
1949                 __isl_keep isl_union_map *umap1,
1950                 __isl_keep isl_union_map *umap2);
1951         int isl_union_map_is_strict_subset(
1952                 __isl_keep isl_union_map *umap1,
1953                 __isl_keep isl_union_map *umap2);
1954
1955 Check whether the first argument is a (strict) subset of the
1956 second argument.
1957
1958 =item * Order
1959
1960         int isl_set_plain_cmp(__isl_keep isl_set *set1,
1961                 __isl_keep isl_set *set2);
1962
1963 This function is useful for sorting C<isl_set>s.
1964 The order depends on the internal representation of the inputs.
1965 The order is fixed over different calls to the function (assuming
1966 the internal representation of the inputs has not changed), but may
1967 change over different versions of C<isl>.
1968
1969 =back
1970
1971 =head2 Unary Operations
1972
1973 =over
1974
1975 =item * Complement
1976
1977         __isl_give isl_set *isl_set_complement(
1978                 __isl_take isl_set *set);
1979         __isl_give isl_map *isl_map_complement(
1980                 __isl_take isl_map *map);
1981
1982 =item * Inverse map
1983
1984         __isl_give isl_basic_map *isl_basic_map_reverse(
1985                 __isl_take isl_basic_map *bmap);
1986         __isl_give isl_map *isl_map_reverse(
1987                 __isl_take isl_map *map);
1988         __isl_give isl_union_map *isl_union_map_reverse(
1989                 __isl_take isl_union_map *umap);
1990
1991 =item * Projection
1992
1993         __isl_give isl_basic_set *isl_basic_set_project_out(
1994                 __isl_take isl_basic_set *bset,
1995                 enum isl_dim_type type, unsigned first, unsigned n);
1996         __isl_give isl_basic_map *isl_basic_map_project_out(
1997                 __isl_take isl_basic_map *bmap,
1998                 enum isl_dim_type type, unsigned first, unsigned n);
1999         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2000                 enum isl_dim_type type, unsigned first, unsigned n);
2001         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2002                 enum isl_dim_type type, unsigned first, unsigned n);
2003         __isl_give isl_basic_set *isl_basic_set_params(
2004                 __isl_take isl_basic_set *bset);
2005         __isl_give isl_basic_set *isl_basic_map_domain(
2006                 __isl_take isl_basic_map *bmap);
2007         __isl_give isl_basic_set *isl_basic_map_range(
2008                 __isl_take isl_basic_map *bmap);
2009         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2010         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2011         __isl_give isl_set *isl_map_domain(
2012                 __isl_take isl_map *bmap);
2013         __isl_give isl_set *isl_map_range(
2014                 __isl_take isl_map *map);
2015         __isl_give isl_set *isl_union_set_params(
2016                 __isl_take isl_union_set *uset);
2017         __isl_give isl_set *isl_union_map_params(
2018                 __isl_take isl_union_map *umap);
2019         __isl_give isl_union_set *isl_union_map_domain(
2020                 __isl_take isl_union_map *umap);
2021         __isl_give isl_union_set *isl_union_map_range(
2022                 __isl_take isl_union_map *umap);
2023
2024         __isl_give isl_basic_map *isl_basic_map_domain_map(
2025                 __isl_take isl_basic_map *bmap);
2026         __isl_give isl_basic_map *isl_basic_map_range_map(
2027                 __isl_take isl_basic_map *bmap);
2028         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2029         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2030         __isl_give isl_union_map *isl_union_map_domain_map(
2031                 __isl_take isl_union_map *umap);
2032         __isl_give isl_union_map *isl_union_map_range_map(
2033                 __isl_take isl_union_map *umap);
2034
2035 The functions above construct a (basic, regular or union) relation
2036 that maps (a wrapped version of) the input relation to its domain or range.
2037
2038 =item * Elimination
2039
2040         __isl_give isl_basic_set *isl_basic_set_eliminate(
2041                 __isl_take isl_basic_set *bset,
2042                 enum isl_dim_type type,
2043                 unsigned first, unsigned n);
2044         __isl_give isl_set *isl_set_eliminate(
2045                 __isl_take isl_set *set, enum isl_dim_type type,
2046                 unsigned first, unsigned n);
2047         __isl_give isl_basic_map *isl_basic_map_eliminate(
2048                 __isl_take isl_basic_map *bmap,
2049                 enum isl_dim_type type,
2050                 unsigned first, unsigned n);
2051         __isl_give isl_map *isl_map_eliminate(
2052                 __isl_take isl_map *map, enum isl_dim_type type,
2053                 unsigned first, unsigned n);
2054
2055 Eliminate the coefficients for the given dimensions from the constraints,
2056 without removing the dimensions.
2057
2058 =item * Slicing
2059
2060         __isl_give isl_basic_set *isl_basic_set_fix(
2061                 __isl_take isl_basic_set *bset,
2062                 enum isl_dim_type type, unsigned pos,
2063                 isl_int value);
2064         __isl_give isl_basic_set *isl_basic_set_fix_si(
2065                 __isl_take isl_basic_set *bset,
2066                 enum isl_dim_type type, unsigned pos, int value);
2067         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
2068                 enum isl_dim_type type, unsigned pos,
2069                 isl_int value);
2070         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2071                 enum isl_dim_type type, unsigned pos, int value);
2072         __isl_give isl_basic_map *isl_basic_map_fix_si(
2073                 __isl_take isl_basic_map *bmap,
2074                 enum isl_dim_type type, unsigned pos, int value);
2075         __isl_give isl_map *isl_map_fix(__isl_take isl_map *map,
2076                 enum isl_dim_type type, unsigned pos,
2077                 isl_int value);
2078         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2079                 enum isl_dim_type type, unsigned pos, int value);
2080
2081 Intersect the set or relation with the hyperplane where the given
2082 dimension has the fixed given value.
2083
2084         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2085                 __isl_take isl_basic_map *bmap,
2086                 enum isl_dim_type type, unsigned pos, int value);
2087         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2088                 __isl_take isl_basic_map *bmap,
2089                 enum isl_dim_type type, unsigned pos, int value);
2090         __isl_give isl_set *isl_set_lower_bound(
2091                 __isl_take isl_set *set,
2092                 enum isl_dim_type type, unsigned pos,
2093                 isl_int value);
2094         __isl_give isl_set *isl_set_lower_bound_si(
2095                 __isl_take isl_set *set,
2096                 enum isl_dim_type type, unsigned pos, int value);
2097         __isl_give isl_map *isl_map_lower_bound_si(
2098                 __isl_take isl_map *map,
2099                 enum isl_dim_type type, unsigned pos, int value);
2100         __isl_give isl_set *isl_set_upper_bound(
2101                 __isl_take isl_set *set,
2102                 enum isl_dim_type type, unsigned pos,
2103                 isl_int value);
2104         __isl_give isl_set *isl_set_upper_bound_si(
2105                 __isl_take isl_set *set,
2106                 enum isl_dim_type type, unsigned pos, int value);
2107         __isl_give isl_map *isl_map_upper_bound_si(
2108                 __isl_take isl_map *map,
2109                 enum isl_dim_type type, unsigned pos, int value);
2110
2111 Intersect the set or relation with the half-space where the given
2112 dimension has a value bounded by the fixed given value.
2113
2114         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2115                 enum isl_dim_type type1, int pos1,
2116                 enum isl_dim_type type2, int pos2);
2117         __isl_give isl_basic_map *isl_basic_map_equate(
2118                 __isl_take isl_basic_map *bmap,
2119                 enum isl_dim_type type1, int pos1,
2120                 enum isl_dim_type type2, int pos2);
2121         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2122                 enum isl_dim_type type1, int pos1,
2123                 enum isl_dim_type type2, int pos2);
2124
2125 Intersect the set or relation with the hyperplane where the given
2126 dimensions are equal to each other.
2127
2128         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
2129                 enum isl_dim_type type1, int pos1,
2130                 enum isl_dim_type type2, int pos2);
2131
2132 Intersect the relation with the hyperplane where the given
2133 dimensions have opposite values.
2134
2135         __isl_give isl_basic_map *isl_basic_map_order_ge(
2136                 __isl_take isl_basic_map *bmap,
2137                 enum isl_dim_type type1, int pos1,
2138                 enum isl_dim_type type2, int pos2);
2139         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2140                 enum isl_dim_type type1, int pos1,
2141                 enum isl_dim_type type2, int pos2);
2142         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2143                 enum isl_dim_type type1, int pos1,
2144                 enum isl_dim_type type2, int pos2);
2145
2146 Intersect the relation with the half-space where the given
2147 dimensions satisfy the given ordering.
2148
2149 =item * Identity
2150
2151         __isl_give isl_map *isl_set_identity(
2152                 __isl_take isl_set *set);
2153         __isl_give isl_union_map *isl_union_set_identity(
2154                 __isl_take isl_union_set *uset);
2155
2156 Construct an identity relation on the given (union) set.
2157
2158 =item * Deltas
2159
2160         __isl_give isl_basic_set *isl_basic_map_deltas(
2161                 __isl_take isl_basic_map *bmap);
2162         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2163         __isl_give isl_union_set *isl_union_map_deltas(
2164                 __isl_take isl_union_map *umap);
2165
2166 These functions return a (basic) set containing the differences
2167 between image elements and corresponding domain elements in the input.
2168
2169         __isl_give isl_basic_map *isl_basic_map_deltas_map(
2170                 __isl_take isl_basic_map *bmap);
2171         __isl_give isl_map *isl_map_deltas_map(
2172                 __isl_take isl_map *map);
2173         __isl_give isl_union_map *isl_union_map_deltas_map(
2174                 __isl_take isl_union_map *umap);
2175
2176 The functions above construct a (basic, regular or union) relation
2177 that maps (a wrapped version of) the input relation to its delta set.
2178
2179 =item * Coalescing
2180
2181 Simplify the representation of a set or relation by trying
2182 to combine pairs of basic sets or relations into a single
2183 basic set or relation.
2184
2185         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2186         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2187         __isl_give isl_union_set *isl_union_set_coalesce(
2188                 __isl_take isl_union_set *uset);
2189         __isl_give isl_union_map *isl_union_map_coalesce(
2190                 __isl_take isl_union_map *umap);
2191
2192 One of the methods for combining pairs of basic sets or relations
2193 can result in coefficients that are much larger than those that appear
2194 in the constraints of the input.  By default, the coefficients are
2195 not allowed to grow larger, but this can be changed by unsetting
2196 the following option.
2197
2198         int isl_options_set_coalesce_bounded_wrapping(
2199                 isl_ctx *ctx, int val);
2200         int isl_options_get_coalesce_bounded_wrapping(
2201                 isl_ctx *ctx);
2202
2203 =item * Detecting equalities
2204
2205         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2206                 __isl_take isl_basic_set *bset);
2207         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2208                 __isl_take isl_basic_map *bmap);
2209         __isl_give isl_set *isl_set_detect_equalities(
2210                 __isl_take isl_set *set);
2211         __isl_give isl_map *isl_map_detect_equalities(
2212                 __isl_take isl_map *map);
2213         __isl_give isl_union_set *isl_union_set_detect_equalities(
2214                 __isl_take isl_union_set *uset);
2215         __isl_give isl_union_map *isl_union_map_detect_equalities(
2216                 __isl_take isl_union_map *umap);
2217
2218 Simplify the representation of a set or relation by detecting implicit
2219 equalities.
2220
2221 =item * Removing redundant constraints
2222
2223         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2224                 __isl_take isl_basic_set *bset);
2225         __isl_give isl_set *isl_set_remove_redundancies(
2226                 __isl_take isl_set *set);
2227         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2228                 __isl_take isl_basic_map *bmap);
2229         __isl_give isl_map *isl_map_remove_redundancies(
2230                 __isl_take isl_map *map);
2231
2232 =item * Convex hull
2233
2234         __isl_give isl_basic_set *isl_set_convex_hull(
2235                 __isl_take isl_set *set);
2236         __isl_give isl_basic_map *isl_map_convex_hull(
2237                 __isl_take isl_map *map);
2238
2239 If the input set or relation has any existentially quantified
2240 variables, then the result of these operations is currently undefined.
2241
2242 =item * Simple hull
2243
2244         __isl_give isl_basic_set *isl_set_simple_hull(
2245                 __isl_take isl_set *set);
2246         __isl_give isl_basic_map *isl_map_simple_hull(
2247                 __isl_take isl_map *map);
2248         __isl_give isl_union_map *isl_union_map_simple_hull(
2249                 __isl_take isl_union_map *umap);
2250
2251 These functions compute a single basic set or relation
2252 that contains the whole input set or relation.
2253 In particular, the output is described by translates
2254 of the constraints describing the basic sets or relations in the input.
2255
2256 =begin latex
2257
2258 (See \autoref{s:simple hull}.)
2259
2260 =end latex
2261
2262 =item * Affine hull
2263
2264         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2265                 __isl_take isl_basic_set *bset);
2266         __isl_give isl_basic_set *isl_set_affine_hull(
2267                 __isl_take isl_set *set);
2268         __isl_give isl_union_set *isl_union_set_affine_hull(
2269                 __isl_take isl_union_set *uset);
2270         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2271                 __isl_take isl_basic_map *bmap);
2272         __isl_give isl_basic_map *isl_map_affine_hull(
2273                 __isl_take isl_map *map);
2274         __isl_give isl_union_map *isl_union_map_affine_hull(
2275                 __isl_take isl_union_map *umap);
2276
2277 In case of union sets and relations, the affine hull is computed
2278 per space.
2279
2280 =item * Polyhedral hull
2281
2282         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2283                 __isl_take isl_set *set);
2284         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2285                 __isl_take isl_map *map);
2286         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2287                 __isl_take isl_union_set *uset);
2288         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2289                 __isl_take isl_union_map *umap);
2290
2291 These functions compute a single basic set or relation
2292 not involving any existentially quantified variables
2293 that contains the whole input set or relation.
2294 In case of union sets and relations, the polyhedral hull is computed
2295 per space.
2296
2297 =item * Feasibility
2298
2299         __isl_give isl_basic_set *isl_basic_set_sample(
2300                 __isl_take isl_basic_set *bset);
2301         __isl_give isl_basic_set *isl_set_sample(
2302                 __isl_take isl_set *set);
2303         __isl_give isl_basic_map *isl_basic_map_sample(
2304                 __isl_take isl_basic_map *bmap);
2305         __isl_give isl_basic_map *isl_map_sample(
2306                 __isl_take isl_map *map);
2307
2308 If the input (basic) set or relation is non-empty, then return
2309 a singleton subset of the input.  Otherwise, return an empty set.
2310
2311 =item * Optimization
2312
2313         #include <isl/ilp.h>
2314         enum isl_lp_result isl_basic_set_max(
2315                 __isl_keep isl_basic_set *bset,
2316                 __isl_keep isl_aff *obj, isl_int *opt)
2317         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2318                 __isl_keep isl_aff *obj, isl_int *opt);
2319         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2320                 __isl_keep isl_aff *obj, isl_int *opt);
2321
2322 Compute the minimum or maximum of the integer affine expression C<obj>
2323 over the points in C<set>, returning the result in C<opt>.
2324 The return value may be one of C<isl_lp_error>,
2325 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2326
2327 =item * Parametric optimization
2328
2329         __isl_give isl_pw_aff *isl_set_dim_min(
2330                 __isl_take isl_set *set, int pos);
2331         __isl_give isl_pw_aff *isl_set_dim_max(
2332                 __isl_take isl_set *set, int pos);
2333         __isl_give isl_pw_aff *isl_map_dim_max(
2334                 __isl_take isl_map *map, int pos);
2335
2336 Compute the minimum or maximum of the given set or output dimension
2337 as a function of the parameters (and input dimensions), but independently
2338 of the other set or output dimensions.
2339 For lexicographic optimization, see L<"Lexicographic Optimization">.
2340
2341 =item * Dual
2342
2343 The following functions compute either the set of (rational) coefficient
2344 values of valid constraints for the given set or the set of (rational)
2345 values satisfying the constraints with coefficients from the given set.
2346 Internally, these two sets of functions perform essentially the
2347 same operations, except that the set of coefficients is assumed to
2348 be a cone, while the set of values may be any polyhedron.
2349 The current implementation is based on the Farkas lemma and
2350 Fourier-Motzkin elimination, but this may change or be made optional
2351 in future.  In particular, future implementations may use different
2352 dualization algorithms or skip the elimination step.
2353
2354         __isl_give isl_basic_set *isl_basic_set_coefficients(
2355                 __isl_take isl_basic_set *bset);
2356         __isl_give isl_basic_set *isl_set_coefficients(
2357                 __isl_take isl_set *set);
2358         __isl_give isl_union_set *isl_union_set_coefficients(
2359                 __isl_take isl_union_set *bset);
2360         __isl_give isl_basic_set *isl_basic_set_solutions(
2361                 __isl_take isl_basic_set *bset);
2362         __isl_give isl_basic_set *isl_set_solutions(
2363                 __isl_take isl_set *set);
2364         __isl_give isl_union_set *isl_union_set_solutions(
2365                 __isl_take isl_union_set *bset);
2366
2367 =item * Power
2368
2369         __isl_give isl_map *isl_map_fixed_power(
2370                 __isl_take isl_map *map, isl_int exp);
2371         __isl_give isl_union_map *isl_union_map_fixed_power(
2372                 __isl_take isl_union_map *umap, isl_int exp);
2373
2374 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2375 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2376 of C<map> is computed.
2377
2378         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2379                 int *exact);
2380         __isl_give isl_union_map *isl_union_map_power(
2381                 __isl_take isl_union_map *umap, int *exact);
2382
2383 Compute a parametric representation for all positive powers I<k> of C<map>.
2384 The result maps I<k> to a nested relation corresponding to the
2385 I<k>th power of C<map>.
2386 The result may be an overapproximation.  If the result is known to be exact,
2387 then C<*exact> is set to C<1>.
2388
2389 =item * Transitive closure
2390
2391         __isl_give isl_map *isl_map_transitive_closure(
2392                 __isl_take isl_map *map, int *exact);
2393         __isl_give isl_union_map *isl_union_map_transitive_closure(
2394                 __isl_take isl_union_map *umap, int *exact);
2395
2396 Compute the transitive closure of C<map>.
2397 The result may be an overapproximation.  If the result is known to be exact,
2398 then C<*exact> is set to C<1>.
2399
2400 =item * Reaching path lengths
2401
2402         __isl_give isl_map *isl_map_reaching_path_lengths(
2403                 __isl_take isl_map *map, int *exact);
2404
2405 Compute a relation that maps each element in the range of C<map>
2406 to the lengths of all paths composed of edges in C<map> that
2407 end up in the given element.
2408 The result may be an overapproximation.  If the result is known to be exact,
2409 then C<*exact> is set to C<1>.
2410 To compute the I<maximal> path length, the resulting relation
2411 should be postprocessed by C<isl_map_lexmax>.
2412 In particular, if the input relation is a dependence relation
2413 (mapping sources to sinks), then the maximal path length corresponds
2414 to the free schedule.
2415 Note, however, that C<isl_map_lexmax> expects the maximum to be
2416 finite, so if the path lengths are unbounded (possibly due to
2417 the overapproximation), then you will get an error message.
2418
2419 =item * Wrapping
2420
2421         __isl_give isl_basic_set *isl_basic_map_wrap(
2422                 __isl_take isl_basic_map *bmap);
2423         __isl_give isl_set *isl_map_wrap(
2424                 __isl_take isl_map *map);
2425         __isl_give isl_union_set *isl_union_map_wrap(
2426                 __isl_take isl_union_map *umap);
2427         __isl_give isl_basic_map *isl_basic_set_unwrap(
2428                 __isl_take isl_basic_set *bset);
2429         __isl_give isl_map *isl_set_unwrap(
2430                 __isl_take isl_set *set);
2431         __isl_give isl_union_map *isl_union_set_unwrap(
2432                 __isl_take isl_union_set *uset);
2433
2434 =item * Flattening
2435
2436 Remove any internal structure of domain (and range) of the given
2437 set or relation.  If there is any such internal structure in the input,
2438 then the name of the space is also removed.
2439
2440         __isl_give isl_basic_set *isl_basic_set_flatten(
2441                 __isl_take isl_basic_set *bset);
2442         __isl_give isl_set *isl_set_flatten(
2443                 __isl_take isl_set *set);
2444         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2445                 __isl_take isl_basic_map *bmap);
2446         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2447                 __isl_take isl_basic_map *bmap);
2448         __isl_give isl_map *isl_map_flatten_range(
2449                 __isl_take isl_map *map);
2450         __isl_give isl_map *isl_map_flatten_domain(
2451                 __isl_take isl_map *map);
2452         __isl_give isl_basic_map *isl_basic_map_flatten(
2453                 __isl_take isl_basic_map *bmap);
2454         __isl_give isl_map *isl_map_flatten(
2455                 __isl_take isl_map *map);
2456
2457         __isl_give isl_map *isl_set_flatten_map(
2458                 __isl_take isl_set *set);
2459
2460 The function above constructs a relation
2461 that maps the input set to a flattened version of the set.
2462
2463 =item * Lifting
2464
2465 Lift the input set to a space with extra dimensions corresponding
2466 to the existentially quantified variables in the input.
2467 In particular, the result lives in a wrapped map where the domain
2468 is the original space and the range corresponds to the original
2469 existentially quantified variables.
2470
2471         __isl_give isl_basic_set *isl_basic_set_lift(
2472                 __isl_take isl_basic_set *bset);
2473         __isl_give isl_set *isl_set_lift(
2474                 __isl_take isl_set *set);
2475         __isl_give isl_union_set *isl_union_set_lift(
2476                 __isl_take isl_union_set *uset);
2477
2478 Given a local space that contains the existentially quantified
2479 variables of a set, a basic relation that, when applied to
2480 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2481 can be constructed using the following function.
2482
2483         #include <isl/local_space.h>
2484         __isl_give isl_basic_map *isl_local_space_lifting(
2485                 __isl_take isl_local_space *ls);
2486
2487 =item * Internal Product
2488
2489         __isl_give isl_basic_map *isl_basic_map_zip(
2490                 __isl_take isl_basic_map *bmap);
2491         __isl_give isl_map *isl_map_zip(
2492                 __isl_take isl_map *map);
2493         __isl_give isl_union_map *isl_union_map_zip(
2494                 __isl_take isl_union_map *umap);
2495
2496 Given a relation with nested relations for domain and range,
2497 interchange the range of the domain with the domain of the range.
2498
2499 =item * Currying
2500
2501         __isl_give isl_basic_map *isl_basic_map_curry(
2502                 __isl_take isl_basic_map *bmap);
2503         __isl_give isl_basic_map *isl_basic_map_uncurry(
2504                 __isl_take isl_basic_map *bmap);
2505         __isl_give isl_map *isl_map_curry(
2506                 __isl_take isl_map *map);
2507         __isl_give isl_map *isl_map_uncurry(
2508                 __isl_take isl_map *map);
2509         __isl_give isl_union_map *isl_union_map_curry(
2510                 __isl_take isl_union_map *umap);
2511
2512 Given a relation with a nested relation for domain,
2513 the C<curry> functions
2514 move the range of the nested relation out of the domain
2515 and use it as the domain of a nested relation in the range,
2516 with the original range as range of this nested relation.
2517 The C<uncurry> functions perform the inverse operation.
2518
2519 =item * Aligning parameters
2520
2521         __isl_give isl_basic_set *isl_basic_set_align_params(
2522                 __isl_take isl_basic_set *bset,
2523                 __isl_take isl_space *model);
2524         __isl_give isl_set *isl_set_align_params(
2525                 __isl_take isl_set *set,
2526                 __isl_take isl_space *model);
2527         __isl_give isl_basic_map *isl_basic_map_align_params(
2528                 __isl_take isl_basic_map *bmap,
2529                 __isl_take isl_space *model);
2530         __isl_give isl_map *isl_map_align_params(
2531                 __isl_take isl_map *map,
2532                 __isl_take isl_space *model);
2533
2534 Change the order of the parameters of the given set or relation
2535 such that the first parameters match those of C<model>.
2536 This may involve the introduction of extra parameters.
2537 All parameters need to be named.
2538
2539 =item * Dimension manipulation
2540
2541         __isl_give isl_set *isl_set_add_dims(
2542                 __isl_take isl_set *set,
2543                 enum isl_dim_type type, unsigned n);
2544         __isl_give isl_map *isl_map_add_dims(
2545                 __isl_take isl_map *map,
2546                 enum isl_dim_type type, unsigned n);
2547         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2548                 __isl_take isl_basic_set *bset,
2549                 enum isl_dim_type type, unsigned pos,
2550                 unsigned n);
2551         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2552                 __isl_take isl_basic_map *bmap,
2553                 enum isl_dim_type type, unsigned pos,
2554                 unsigned n);
2555         __isl_give isl_set *isl_set_insert_dims(
2556                 __isl_take isl_set *set,
2557                 enum isl_dim_type type, unsigned pos, unsigned n);
2558         __isl_give isl_map *isl_map_insert_dims(
2559                 __isl_take isl_map *map,
2560                 enum isl_dim_type type, unsigned pos, unsigned n);
2561         __isl_give isl_basic_set *isl_basic_set_move_dims(
2562                 __isl_take isl_basic_set *bset,
2563                 enum isl_dim_type dst_type, unsigned dst_pos,
2564                 enum isl_dim_type src_type, unsigned src_pos,
2565                 unsigned n);
2566         __isl_give isl_basic_map *isl_basic_map_move_dims(
2567                 __isl_take isl_basic_map *bmap,
2568                 enum isl_dim_type dst_type, unsigned dst_pos,
2569                 enum isl_dim_type src_type, unsigned src_pos,
2570                 unsigned n);
2571         __isl_give isl_set *isl_set_move_dims(
2572                 __isl_take isl_set *set,
2573                 enum isl_dim_type dst_type, unsigned dst_pos,
2574                 enum isl_dim_type src_type, unsigned src_pos,
2575                 unsigned n);
2576         __isl_give isl_map *isl_map_move_dims(
2577                 __isl_take isl_map *map,
2578                 enum isl_dim_type dst_type, unsigned dst_pos,
2579                 enum isl_dim_type src_type, unsigned src_pos,
2580                 unsigned n);
2581
2582 It is usually not advisable to directly change the (input or output)
2583 space of a set or a relation as this removes the name and the internal
2584 structure of the space.  However, the above functions can be useful
2585 to add new parameters, assuming
2586 C<isl_set_align_params> and C<isl_map_align_params>
2587 are not sufficient.
2588
2589 =back
2590
2591 =head2 Binary Operations
2592
2593 The two arguments of a binary operation not only need to live
2594 in the same C<isl_ctx>, they currently also need to have
2595 the same (number of) parameters.
2596
2597 =head3 Basic Operations
2598
2599 =over
2600
2601 =item * Intersection
2602
2603         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2604                 __isl_take isl_basic_set *bset1,
2605                 __isl_take isl_basic_set *bset2);
2606         __isl_give isl_basic_set *isl_basic_set_intersect(
2607                 __isl_take isl_basic_set *bset1,
2608                 __isl_take isl_basic_set *bset2);
2609         __isl_give isl_set *isl_set_intersect_params(
2610                 __isl_take isl_set *set,
2611                 __isl_take isl_set *params);
2612         __isl_give isl_set *isl_set_intersect(
2613                 __isl_take isl_set *set1,
2614                 __isl_take isl_set *set2);
2615         __isl_give isl_union_set *isl_union_set_intersect_params(
2616                 __isl_take isl_union_set *uset,
2617                 __isl_take isl_set *set);
2618         __isl_give isl_union_map *isl_union_map_intersect_params(
2619                 __isl_take isl_union_map *umap,
2620                 __isl_take isl_set *set);
2621         __isl_give isl_union_set *isl_union_set_intersect(
2622                 __isl_take isl_union_set *uset1,
2623                 __isl_take isl_union_set *uset2);
2624         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2625                 __isl_take isl_basic_map *bmap,
2626                 __isl_take isl_basic_set *bset);
2627         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2628                 __isl_take isl_basic_map *bmap,
2629                 __isl_take isl_basic_set *bset);
2630         __isl_give isl_basic_map *isl_basic_map_intersect(
2631                 __isl_take isl_basic_map *bmap1,
2632                 __isl_take isl_basic_map *bmap2);
2633         __isl_give isl_map *isl_map_intersect_params(
2634                 __isl_take isl_map *map,
2635                 __isl_take isl_set *params);
2636         __isl_give isl_map *isl_map_intersect_domain(
2637                 __isl_take isl_map *map,
2638                 __isl_take isl_set *set);
2639         __isl_give isl_map *isl_map_intersect_range(
2640                 __isl_take isl_map *map,
2641                 __isl_take isl_set *set);
2642         __isl_give isl_map *isl_map_intersect(
2643                 __isl_take isl_map *map1,
2644                 __isl_take isl_map *map2);
2645         __isl_give isl_union_map *isl_union_map_intersect_domain(
2646                 __isl_take isl_union_map *umap,
2647                 __isl_take isl_union_set *uset);
2648         __isl_give isl_union_map *isl_union_map_intersect_range(
2649                 __isl_take isl_union_map *umap,
2650                 __isl_take isl_union_set *uset);
2651         __isl_give isl_union_map *isl_union_map_intersect(
2652                 __isl_take isl_union_map *umap1,
2653                 __isl_take isl_union_map *umap2);
2654
2655 The second argument to the C<_params> functions needs to be
2656 a parametric (basic) set.  For the other functions, a parametric set
2657 for either argument is only allowed if the other argument is
2658 a parametric set as well.
2659
2660 =item * Union
2661
2662         __isl_give isl_set *isl_basic_set_union(
2663                 __isl_take isl_basic_set *bset1,
2664                 __isl_take isl_basic_set *bset2);
2665         __isl_give isl_map *isl_basic_map_union(
2666                 __isl_take isl_basic_map *bmap1,
2667                 __isl_take isl_basic_map *bmap2);
2668         __isl_give isl_set *isl_set_union(
2669                 __isl_take isl_set *set1,
2670                 __isl_take isl_set *set2);
2671         __isl_give isl_map *isl_map_union(
2672                 __isl_take isl_map *map1,
2673                 __isl_take isl_map *map2);
2674         __isl_give isl_union_set *isl_union_set_union(
2675                 __isl_take isl_union_set *uset1,
2676                 __isl_take isl_union_set *uset2);
2677         __isl_give isl_union_map *isl_union_map_union(
2678                 __isl_take isl_union_map *umap1,
2679                 __isl_take isl_union_map *umap2);
2680
2681 =item * Set difference
2682
2683         __isl_give isl_set *isl_set_subtract(
2684                 __isl_take isl_set *set1,
2685                 __isl_take isl_set *set2);
2686         __isl_give isl_map *isl_map_subtract(
2687                 __isl_take isl_map *map1,
2688                 __isl_take isl_map *map2);
2689         __isl_give isl_map *isl_map_subtract_domain(
2690                 __isl_take isl_map *map,
2691                 __isl_take isl_set *dom);
2692         __isl_give isl_map *isl_map_subtract_range(
2693                 __isl_take isl_map *map,
2694                 __isl_take isl_set *dom);
2695         __isl_give isl_union_set *isl_union_set_subtract(
2696                 __isl_take isl_union_set *uset1,
2697                 __isl_take isl_union_set *uset2);
2698         __isl_give isl_union_map *isl_union_map_subtract(
2699                 __isl_take isl_union_map *umap1,
2700                 __isl_take isl_union_map *umap2);
2701         __isl_give isl_union_map *isl_union_map_subtract_domain(
2702                 __isl_take isl_union_map *umap,
2703                 __isl_take isl_union_set *dom);
2704         __isl_give isl_union_map *isl_union_map_subtract_range(
2705                 __isl_take isl_union_map *umap,
2706                 __isl_take isl_union_set *dom);
2707
2708 =item * Application
2709
2710         __isl_give isl_basic_set *isl_basic_set_apply(
2711                 __isl_take isl_basic_set *bset,
2712                 __isl_take isl_basic_map *bmap);
2713         __isl_give isl_set *isl_set_apply(
2714                 __isl_take isl_set *set,
2715                 __isl_take isl_map *map);
2716         __isl_give isl_union_set *isl_union_set_apply(
2717                 __isl_take isl_union_set *uset,
2718                 __isl_take isl_union_map *umap);
2719         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2720                 __isl_take isl_basic_map *bmap1,
2721                 __isl_take isl_basic_map *bmap2);
2722         __isl_give isl_basic_map *isl_basic_map_apply_range(
2723                 __isl_take isl_basic_map *bmap1,
2724                 __isl_take isl_basic_map *bmap2);
2725         __isl_give isl_map *isl_map_apply_domain(
2726                 __isl_take isl_map *map1,
2727                 __isl_take isl_map *map2);
2728         __isl_give isl_union_map *isl_union_map_apply_domain(
2729                 __isl_take isl_union_map *umap1,
2730                 __isl_take isl_union_map *umap2);
2731         __isl_give isl_map *isl_map_apply_range(
2732                 __isl_take isl_map *map1,
2733                 __isl_take isl_map *map2);
2734         __isl_give isl_union_map *isl_union_map_apply_range(
2735                 __isl_take isl_union_map *umap1,
2736                 __isl_take isl_union_map *umap2);
2737
2738 =item * Cartesian Product
2739
2740         __isl_give isl_set *isl_set_product(
2741                 __isl_take isl_set *set1,
2742                 __isl_take isl_set *set2);
2743         __isl_give isl_union_set *isl_union_set_product(
2744                 __isl_take isl_union_set *uset1,
2745                 __isl_take isl_union_set *uset2);
2746         __isl_give isl_basic_map *isl_basic_map_domain_product(
2747                 __isl_take isl_basic_map *bmap1,
2748                 __isl_take isl_basic_map *bmap2);
2749         __isl_give isl_basic_map *isl_basic_map_range_product(
2750                 __isl_take isl_basic_map *bmap1,
2751                 __isl_take isl_basic_map *bmap2);
2752         __isl_give isl_basic_map *isl_basic_map_product(
2753                 __isl_take isl_basic_map *bmap1,
2754                 __isl_take isl_basic_map *bmap2);
2755         __isl_give isl_map *isl_map_domain_product(
2756                 __isl_take isl_map *map1,
2757                 __isl_take isl_map *map2);
2758         __isl_give isl_map *isl_map_range_product(
2759                 __isl_take isl_map *map1,
2760                 __isl_take isl_map *map2);
2761         __isl_give isl_union_map *isl_union_map_domain_product(
2762                 __isl_take isl_union_map *umap1,
2763                 __isl_take isl_union_map *umap2);
2764         __isl_give isl_union_map *isl_union_map_range_product(
2765                 __isl_take isl_union_map *umap1,
2766                 __isl_take isl_union_map *umap2);
2767         __isl_give isl_map *isl_map_product(
2768                 __isl_take isl_map *map1,
2769                 __isl_take isl_map *map2);
2770         __isl_give isl_union_map *isl_union_map_product(
2771                 __isl_take isl_union_map *umap1,
2772                 __isl_take isl_union_map *umap2);
2773
2774 The above functions compute the cross product of the given
2775 sets or relations.  The domains and ranges of the results
2776 are wrapped maps between domains and ranges of the inputs.
2777 To obtain a ``flat'' product, use the following functions
2778 instead.
2779
2780         __isl_give isl_basic_set *isl_basic_set_flat_product(
2781                 __isl_take isl_basic_set *bset1,
2782                 __isl_take isl_basic_set *bset2);
2783         __isl_give isl_set *isl_set_flat_product(
2784                 __isl_take isl_set *set1,
2785                 __isl_take isl_set *set2);
2786         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2787                 __isl_take isl_basic_map *bmap1,
2788                 __isl_take isl_basic_map *bmap2);
2789         __isl_give isl_map *isl_map_flat_domain_product(
2790                 __isl_take isl_map *map1,
2791                 __isl_take isl_map *map2);
2792         __isl_give isl_map *isl_map_flat_range_product(
2793                 __isl_take isl_map *map1,
2794                 __isl_take isl_map *map2);
2795         __isl_give isl_union_map *isl_union_map_flat_range_product(
2796                 __isl_take isl_union_map *umap1,
2797                 __isl_take isl_union_map *umap2);
2798         __isl_give isl_basic_map *isl_basic_map_flat_product(
2799                 __isl_take isl_basic_map *bmap1,
2800                 __isl_take isl_basic_map *bmap2);
2801         __isl_give isl_map *isl_map_flat_product(
2802                 __isl_take isl_map *map1,
2803                 __isl_take isl_map *map2);
2804
2805 =item * Simplification
2806
2807         __isl_give isl_basic_set *isl_basic_set_gist(
2808                 __isl_take isl_basic_set *bset,
2809                 __isl_take isl_basic_set *context);
2810         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2811                 __isl_take isl_set *context);
2812         __isl_give isl_set *isl_set_gist_params(
2813                 __isl_take isl_set *set,
2814                 __isl_take isl_set *context);
2815         __isl_give isl_union_set *isl_union_set_gist(
2816                 __isl_take isl_union_set *uset,
2817                 __isl_take isl_union_set *context);
2818         __isl_give isl_union_set *isl_union_set_gist_params(
2819                 __isl_take isl_union_set *uset,
2820                 __isl_take isl_set *set);
2821         __isl_give isl_basic_map *isl_basic_map_gist(
2822                 __isl_take isl_basic_map *bmap,
2823                 __isl_take isl_basic_map *context);
2824         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2825                 __isl_take isl_map *context);
2826         __isl_give isl_map *isl_map_gist_params(
2827                 __isl_take isl_map *map,
2828                 __isl_take isl_set *context);
2829         __isl_give isl_map *isl_map_gist_domain(
2830                 __isl_take isl_map *map,
2831                 __isl_take isl_set *context);
2832         __isl_give isl_map *isl_map_gist_range(
2833                 __isl_take isl_map *map,
2834                 __isl_take isl_set *context);
2835         __isl_give isl_union_map *isl_union_map_gist(
2836                 __isl_take isl_union_map *umap,
2837                 __isl_take isl_union_map *context);
2838         __isl_give isl_union_map *isl_union_map_gist_params(
2839                 __isl_take isl_union_map *umap,
2840                 __isl_take isl_set *set);
2841         __isl_give isl_union_map *isl_union_map_gist_domain(
2842                 __isl_take isl_union_map *umap,
2843                 __isl_take isl_union_set *uset);
2844         __isl_give isl_union_map *isl_union_map_gist_range(
2845                 __isl_take isl_union_map *umap,
2846                 __isl_take isl_union_set *uset);
2847
2848 The gist operation returns a set or relation that has the
2849 same intersection with the context as the input set or relation.
2850 Any implicit equality in the intersection is made explicit in the result,
2851 while all inequalities that are redundant with respect to the intersection
2852 are removed.
2853 In case of union sets and relations, the gist operation is performed
2854 per space.
2855
2856 =back
2857
2858 =head3 Lexicographic Optimization
2859
2860 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2861 the following functions
2862 compute a set that contains the lexicographic minimum or maximum
2863 of the elements in C<set> (or C<bset>) for those values of the parameters
2864 that satisfy C<dom>.
2865 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2866 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2867 has no elements.
2868 In other words, the union of the parameter values
2869 for which the result is non-empty and of C<*empty>
2870 is equal to C<dom>.
2871
2872         __isl_give isl_set *isl_basic_set_partial_lexmin(
2873                 __isl_take isl_basic_set *bset,
2874                 __isl_take isl_basic_set *dom,
2875                 __isl_give isl_set **empty);
2876         __isl_give isl_set *isl_basic_set_partial_lexmax(
2877                 __isl_take isl_basic_set *bset,
2878                 __isl_take isl_basic_set *dom,
2879                 __isl_give isl_set **empty);
2880         __isl_give isl_set *isl_set_partial_lexmin(
2881                 __isl_take isl_set *set, __isl_take isl_set *dom,
2882                 __isl_give isl_set **empty);
2883         __isl_give isl_set *isl_set_partial_lexmax(
2884                 __isl_take isl_set *set, __isl_take isl_set *dom,
2885                 __isl_give isl_set **empty);
2886
2887 Given a (basic) set C<set> (or C<bset>), the following functions simply
2888 return a set containing the lexicographic minimum or maximum
2889 of the elements in C<set> (or C<bset>).
2890 In case of union sets, the optimum is computed per space.
2891
2892         __isl_give isl_set *isl_basic_set_lexmin(
2893                 __isl_take isl_basic_set *bset);
2894         __isl_give isl_set *isl_basic_set_lexmax(
2895                 __isl_take isl_basic_set *bset);
2896         __isl_give isl_set *isl_set_lexmin(
2897                 __isl_take isl_set *set);
2898         __isl_give isl_set *isl_set_lexmax(
2899                 __isl_take isl_set *set);
2900         __isl_give isl_union_set *isl_union_set_lexmin(
2901                 __isl_take isl_union_set *uset);
2902         __isl_give isl_union_set *isl_union_set_lexmax(
2903                 __isl_take isl_union_set *uset);
2904
2905 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2906 the following functions
2907 compute a relation that maps each element of C<dom>
2908 to the single lexicographic minimum or maximum
2909 of the elements that are associated to that same
2910 element in C<map> (or C<bmap>).
2911 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2912 that contains the elements in C<dom> that do not map
2913 to any elements in C<map> (or C<bmap>).
2914 In other words, the union of the domain of the result and of C<*empty>
2915 is equal to C<dom>.
2916
2917         __isl_give isl_map *isl_basic_map_partial_lexmax(
2918                 __isl_take isl_basic_map *bmap,
2919                 __isl_take isl_basic_set *dom,
2920                 __isl_give isl_set **empty);
2921         __isl_give isl_map *isl_basic_map_partial_lexmin(
2922                 __isl_take isl_basic_map *bmap,
2923                 __isl_take isl_basic_set *dom,
2924                 __isl_give isl_set **empty);
2925         __isl_give isl_map *isl_map_partial_lexmax(
2926                 __isl_take isl_map *map, __isl_take isl_set *dom,
2927                 __isl_give isl_set **empty);
2928         __isl_give isl_map *isl_map_partial_lexmin(
2929                 __isl_take isl_map *map, __isl_take isl_set *dom,
2930                 __isl_give isl_set **empty);
2931
2932 Given a (basic) map C<map> (or C<bmap>), the following functions simply
2933 return a map mapping each element in the domain of
2934 C<map> (or C<bmap>) to the lexicographic minimum or maximum
2935 of all elements associated to that element.
2936 In case of union relations, the optimum is computed per space.
2937
2938         __isl_give isl_map *isl_basic_map_lexmin(
2939                 __isl_take isl_basic_map *bmap);
2940         __isl_give isl_map *isl_basic_map_lexmax(
2941                 __isl_take isl_basic_map *bmap);
2942         __isl_give isl_map *isl_map_lexmin(
2943                 __isl_take isl_map *map);
2944         __isl_give isl_map *isl_map_lexmax(
2945                 __isl_take isl_map *map);
2946         __isl_give isl_union_map *isl_union_map_lexmin(
2947                 __isl_take isl_union_map *umap);
2948         __isl_give isl_union_map *isl_union_map_lexmax(
2949                 __isl_take isl_union_map *umap);
2950
2951 The following functions return their result in the form of
2952 a piecewise multi-affine expression
2953 (See L<"Piecewise Multiple Quasi Affine Expressions">),
2954 but are otherwise equivalent to the corresponding functions
2955 returning a basic set or relation.
2956
2957         __isl_give isl_pw_multi_aff *
2958         isl_basic_map_lexmin_pw_multi_aff(
2959                 __isl_take isl_basic_map *bmap);
2960         __isl_give isl_pw_multi_aff *
2961         isl_basic_set_partial_lexmin_pw_multi_aff(
2962                 __isl_take isl_basic_set *bset,
2963                 __isl_take isl_basic_set *dom,
2964                 __isl_give isl_set **empty);
2965         __isl_give isl_pw_multi_aff *
2966         isl_basic_set_partial_lexmax_pw_multi_aff(
2967                 __isl_take isl_basic_set *bset,
2968                 __isl_take isl_basic_set *dom,
2969                 __isl_give isl_set **empty);
2970         __isl_give isl_pw_multi_aff *
2971         isl_basic_map_partial_lexmin_pw_multi_aff(
2972                 __isl_take isl_basic_map *bmap,
2973                 __isl_take isl_basic_set *dom,
2974                 __isl_give isl_set **empty);
2975         __isl_give isl_pw_multi_aff *
2976         isl_basic_map_partial_lexmax_pw_multi_aff(
2977                 __isl_take isl_basic_map *bmap,
2978                 __isl_take isl_basic_set *dom,
2979                 __isl_give isl_set **empty);
2980         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
2981                 __isl_take isl_map *map);
2982         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
2983                 __isl_take isl_map *map);
2984
2985 =head2 Lists
2986
2987 Lists are defined over several element types, including
2988 C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
2989 C<isl_basic_set> and C<isl_set>.
2990 Here we take lists of C<isl_set>s as an example.
2991 Lists can be created, copied, modified and freed using the following functions.
2992
2993         #include <isl/list.h>
2994         __isl_give isl_set_list *isl_set_list_from_set(
2995                 __isl_take isl_set *el);
2996         __isl_give isl_set_list *isl_set_list_alloc(
2997                 isl_ctx *ctx, int n);
2998         __isl_give isl_set_list *isl_set_list_copy(
2999                 __isl_keep isl_set_list *list);
3000         __isl_give isl_set_list *isl_set_list_insert(
3001                 __isl_take isl_set_list *list, unsigned pos,
3002                 __isl_take isl_set *el);
3003         __isl_give isl_set_list *isl_set_list_add(
3004                 __isl_take isl_set_list *list,
3005                 __isl_take isl_set *el);
3006         __isl_give isl_set_list *isl_set_list_drop(
3007                 __isl_take isl_set_list *list,
3008                 unsigned first, unsigned n);
3009         __isl_give isl_set_list *isl_set_list_set_set(
3010                 __isl_take isl_set_list *list, int index,
3011                 __isl_take isl_set *set);
3012         __isl_give isl_set_list *isl_set_list_concat(
3013                 __isl_take isl_set_list *list1,
3014                 __isl_take isl_set_list *list2);
3015         void *isl_set_list_free(__isl_take isl_set_list *list);
3016
3017 C<isl_set_list_alloc> creates an empty list with a capacity for
3018 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3019 element.
3020
3021 Lists can be inspected using the following functions.
3022
3023         #include <isl/list.h>
3024         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3025         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3026         __isl_give isl_set *isl_set_list_get_set(
3027                 __isl_keep isl_set_list *list, int index);
3028         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3029                 int (*fn)(__isl_take isl_set *el, void *user),
3030                 void *user);
3031
3032 Lists can be printed using
3033
3034         #include <isl/list.h>
3035         __isl_give isl_printer *isl_printer_print_set_list(
3036                 __isl_take isl_printer *p,
3037                 __isl_keep isl_set_list *list);
3038
3039 =head2 Vectors
3040
3041 Vectors can be created, copied and freed using the following functions.
3042
3043         #include <isl/vec.h>
3044         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3045                 unsigned size);
3046         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3047         void *isl_vec_free(__isl_take isl_vec *vec);
3048
3049 Note that the elements of a newly created vector may have arbitrary values.
3050 The elements can be changed and inspected using the following functions.
3051
3052         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3053         int isl_vec_size(__isl_keep isl_vec *vec);
3054         int isl_vec_get_element(__isl_keep isl_vec *vec,
3055                 int pos, isl_int *v);
3056         __isl_give isl_vec *isl_vec_set_element(
3057                 __isl_take isl_vec *vec, int pos, isl_int v);
3058         __isl_give isl_vec *isl_vec_set_element_si(
3059                 __isl_take isl_vec *vec, int pos, int v);
3060         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3061                 isl_int v);
3062         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3063                 int v);
3064         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3065                 isl_int m);
3066
3067 C<isl_vec_get_element> will return a negative value if anything went wrong.
3068 In that case, the value of C<*v> is undefined.
3069
3070 The following function can be used to concatenate two vectors.
3071
3072         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3073                 __isl_take isl_vec *vec2);
3074
3075 =head2 Matrices
3076
3077 Matrices can be created, copied and freed using the following functions.
3078
3079         #include <isl/mat.h>
3080         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3081                 unsigned n_row, unsigned n_col);
3082         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3083         void isl_mat_free(__isl_take isl_mat *mat);
3084
3085 Note that the elements of a newly created matrix may have arbitrary values.
3086 The elements can be changed and inspected using the following functions.
3087
3088         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3089         int isl_mat_rows(__isl_keep isl_mat *mat);
3090         int isl_mat_cols(__isl_keep isl_mat *mat);
3091         int isl_mat_get_element(__isl_keep isl_mat *mat,
3092                 int row, int col, isl_int *v);
3093         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3094                 int row, int col, isl_int v);
3095         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3096                 int row, int col, int v);
3097
3098 C<isl_mat_get_element> will return a negative value if anything went wrong.
3099 In that case, the value of C<*v> is undefined.
3100
3101 The following function can be used to compute the (right) inverse
3102 of a matrix, i.e., a matrix such that the product of the original
3103 and the inverse (in that order) is a multiple of the identity matrix.
3104 The input matrix is assumed to be of full row-rank.
3105
3106         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3107
3108 The following function can be used to compute the (right) kernel
3109 (or null space) of a matrix, i.e., a matrix such that the product of
3110 the original and the kernel (in that order) is the zero matrix.
3111
3112         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3113
3114 =head2 Piecewise Quasi Affine Expressions
3115
3116 The zero quasi affine expression on a given domain can be created using
3117
3118         __isl_give isl_aff *isl_aff_zero_on_domain(
3119                 __isl_take isl_local_space *ls);
3120
3121 Note that the space in which the resulting object lives is a map space
3122 with the given space as domain and a one-dimensional range.
3123
3124 An empty piecewise quasi affine expression (one with no cells)
3125 or a piecewise quasi affine expression with a single cell can
3126 be created using the following functions.
3127
3128         #include <isl/aff.h>
3129         __isl_give isl_pw_aff *isl_pw_aff_empty(
3130                 __isl_take isl_space *space);
3131         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3132                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3133         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3134                 __isl_take isl_aff *aff);
3135
3136 A piecewise quasi affine expression that is equal to 1 on a set
3137 and 0 outside the set can be created using the following function.
3138
3139         #include <isl/aff.h>
3140         __isl_give isl_pw_aff *isl_set_indicator_function(
3141                 __isl_take isl_set *set);
3142
3143 Quasi affine expressions can be copied and freed using
3144
3145         #include <isl/aff.h>
3146         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3147         void *isl_aff_free(__isl_take isl_aff *aff);
3148
3149         __isl_give isl_pw_aff *isl_pw_aff_copy(
3150                 __isl_keep isl_pw_aff *pwaff);
3151         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3152
3153 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3154 using the following function.  The constraint is required to have
3155 a non-zero coefficient for the specified dimension.
3156
3157         #include <isl/constraint.h>
3158         __isl_give isl_aff *isl_constraint_get_bound(
3159                 __isl_keep isl_constraint *constraint,
3160                 enum isl_dim_type type, int pos);
3161
3162 The entire affine expression of the constraint can also be extracted
3163 using the following function.
3164
3165         #include <isl/constraint.h>
3166         __isl_give isl_aff *isl_constraint_get_aff(
3167                 __isl_keep isl_constraint *constraint);
3168
3169 Conversely, an equality constraint equating
3170 the affine expression to zero or an inequality constraint enforcing
3171 the affine expression to be non-negative, can be constructed using
3172
3173         __isl_give isl_constraint *isl_equality_from_aff(
3174                 __isl_take isl_aff *aff);
3175         __isl_give isl_constraint *isl_inequality_from_aff(
3176                 __isl_take isl_aff *aff);
3177
3178 The expression can be inspected using
3179
3180         #include <isl/aff.h>
3181         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3182         int isl_aff_dim(__isl_keep isl_aff *aff,
3183                 enum isl_dim_type type);
3184         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3185                 __isl_keep isl_aff *aff);
3186         __isl_give isl_local_space *isl_aff_get_local_space(
3187                 __isl_keep isl_aff *aff);
3188         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3189                 enum isl_dim_type type, unsigned pos);
3190         const char *isl_pw_aff_get_dim_name(
3191                 __isl_keep isl_pw_aff *pa,
3192                 enum isl_dim_type type, unsigned pos);
3193         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3194                 enum isl_dim_type type, unsigned pos);
3195         __isl_give isl_id *isl_pw_aff_get_dim_id(
3196                 __isl_keep isl_pw_aff *pa,
3197                 enum isl_dim_type type, unsigned pos);
3198         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3199                 __isl_keep isl_pw_aff *pa,
3200                 enum isl_dim_type type);
3201         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3202                 isl_int *v);
3203         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3204                 enum isl_dim_type type, int pos, isl_int *v);
3205         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3206                 isl_int *v);
3207         __isl_give isl_aff *isl_aff_get_div(
3208                 __isl_keep isl_aff *aff, int pos);
3209
3210         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3211         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3212                 int (*fn)(__isl_take isl_set *set,
3213                           __isl_take isl_aff *aff,
3214                           void *user), void *user);
3215
3216         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3217         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3218
3219         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3220                 enum isl_dim_type type, unsigned first, unsigned n);
3221         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3222                 enum isl_dim_type type, unsigned first, unsigned n);
3223
3224         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3225         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3226                 enum isl_dim_type type);
3227         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3228
3229 It can be modified using
3230
3231         #include <isl/aff.h>
3232         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3233                 __isl_take isl_pw_aff *pwaff,
3234                 enum isl_dim_type type, __isl_take isl_id *id);
3235         __isl_give isl_aff *isl_aff_set_dim_name(
3236                 __isl_take isl_aff *aff, enum isl_dim_type type,
3237                 unsigned pos, const char *s);
3238         __isl_give isl_aff *isl_aff_set_dim_id(
3239                 __isl_take isl_aff *aff, enum isl_dim_type type,
3240                 unsigned pos, __isl_take isl_id *id);
3241         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3242                 __isl_take isl_pw_aff *pma,
3243                 enum isl_dim_type type, unsigned pos,
3244                 __isl_take isl_id *id);
3245         __isl_give isl_aff *isl_aff_set_constant(
3246                 __isl_take isl_aff *aff, isl_int v);
3247         __isl_give isl_aff *isl_aff_set_constant_si(
3248                 __isl_take isl_aff *aff, int v);
3249         __isl_give isl_aff *isl_aff_set_coefficient(
3250                 __isl_take isl_aff *aff,
3251                 enum isl_dim_type type, int pos, isl_int v);
3252         __isl_give isl_aff *isl_aff_set_coefficient_si(
3253                 __isl_take isl_aff *aff,
3254                 enum isl_dim_type type, int pos, int v);
3255         __isl_give isl_aff *isl_aff_set_denominator(
3256                 __isl_take isl_aff *aff, isl_int v);
3257
3258         __isl_give isl_aff *isl_aff_add_constant(
3259                 __isl_take isl_aff *aff, isl_int v);
3260         __isl_give isl_aff *isl_aff_add_constant_si(
3261                 __isl_take isl_aff *aff, int v);
3262         __isl_give isl_aff *isl_aff_add_constant_num(
3263                 __isl_take isl_aff *aff, isl_int v);
3264         __isl_give isl_aff *isl_aff_add_constant_num_si(
3265                 __isl_take isl_aff *aff, int v);
3266         __isl_give isl_aff *isl_aff_add_coefficient(
3267                 __isl_take isl_aff *aff,
3268                 enum isl_dim_type type, int pos, isl_int v);
3269         __isl_give isl_aff *isl_aff_add_coefficient_si(
3270                 __isl_take isl_aff *aff,
3271                 enum isl_dim_type type, int pos, int v);
3272
3273         __isl_give isl_aff *isl_aff_insert_dims(
3274                 __isl_take isl_aff *aff,
3275                 enum isl_dim_type type, unsigned first, unsigned n);
3276         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3277                 __isl_take isl_pw_aff *pwaff,
3278                 enum isl_dim_type type, unsigned first, unsigned n);
3279         __isl_give isl_aff *isl_aff_add_dims(
3280                 __isl_take isl_aff *aff,
3281                 enum isl_dim_type type, unsigned n);
3282         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3283                 __isl_take isl_pw_aff *pwaff,
3284                 enum isl_dim_type type, unsigned n);
3285         __isl_give isl_aff *isl_aff_drop_dims(
3286                 __isl_take isl_aff *aff,
3287                 enum isl_dim_type type, unsigned first, unsigned n);
3288         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3289                 __isl_take isl_pw_aff *pwaff,
3290                 enum isl_dim_type type, unsigned first, unsigned n);
3291
3292 Note that the C<set_constant> and C<set_coefficient> functions
3293 set the I<numerator> of the constant or coefficient, while
3294 C<add_constant> and C<add_coefficient> add an integer value to
3295 the possibly rational constant or coefficient.
3296 The C<add_constant_num> functions add an integer value to
3297 the numerator.
3298
3299 To check whether an affine expressions is obviously zero
3300 or obviously equal to some other affine expression, use
3301
3302         #include <isl/aff.h>
3303         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3304         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3305                 __isl_keep isl_aff *aff2);
3306         int isl_pw_aff_plain_is_equal(
3307                 __isl_keep isl_pw_aff *pwaff1,
3308                 __isl_keep isl_pw_aff *pwaff2);
3309
3310 Operations include
3311
3312         #include <isl/aff.h>
3313         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3314                 __isl_take isl_aff *aff2);
3315         __isl_give isl_pw_aff *isl_pw_aff_add(
3316                 __isl_take isl_pw_aff *pwaff1,
3317                 __isl_take isl_pw_aff *pwaff2);
3318         __isl_give isl_pw_aff *isl_pw_aff_min(
3319                 __isl_take isl_pw_aff *pwaff1,
3320                 __isl_take isl_pw_aff *pwaff2);
3321         __isl_give isl_pw_aff *isl_pw_aff_max(
3322                 __isl_take isl_pw_aff *pwaff1,
3323                 __isl_take isl_pw_aff *pwaff2);
3324         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3325                 __isl_take isl_aff *aff2);
3326         __isl_give isl_pw_aff *isl_pw_aff_sub(
3327                 __isl_take isl_pw_aff *pwaff1,
3328                 __isl_take isl_pw_aff *pwaff2);
3329         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3330         __isl_give isl_pw_aff *isl_pw_aff_neg(
3331                 __isl_take isl_pw_aff *pwaff);
3332         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3333         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3334                 __isl_take isl_pw_aff *pwaff);
3335         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3336         __isl_give isl_pw_aff *isl_pw_aff_floor(
3337                 __isl_take isl_pw_aff *pwaff);
3338         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3339                 isl_int mod);
3340         __isl_give isl_pw_aff *isl_pw_aff_mod(
3341                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3342         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3343                 isl_int f);
3344         __isl_give isl_pw_aff *isl_pw_aff_scale(
3345                 __isl_take isl_pw_aff *pwaff, isl_int f);
3346         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3347                 isl_int f);
3348         __isl_give isl_aff *isl_aff_scale_down_ui(
3349                 __isl_take isl_aff *aff, unsigned f);
3350         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3351                 __isl_take isl_pw_aff *pwaff, isl_int f);
3352
3353         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3354                 __isl_take isl_pw_aff_list *list);
3355         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3356                 __isl_take isl_pw_aff_list *list);
3357
3358         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3359                 __isl_take isl_pw_aff *pwqp);
3360
3361         __isl_give isl_aff *isl_aff_align_params(
3362                 __isl_take isl_aff *aff,
3363                 __isl_take isl_space *model);
3364         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3365                 __isl_take isl_pw_aff *pwaff,
3366                 __isl_take isl_space *model);
3367
3368         __isl_give isl_aff *isl_aff_project_domain_on_params(
3369                 __isl_take isl_aff *aff);
3370
3371         __isl_give isl_aff *isl_aff_gist_params(
3372                 __isl_take isl_aff *aff,
3373                 __isl_take isl_set *context);
3374         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3375                 __isl_take isl_set *context);
3376         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3377                 __isl_take isl_pw_aff *pwaff,
3378                 __isl_take isl_set *context);
3379         __isl_give isl_pw_aff *isl_pw_aff_gist(
3380                 __isl_take isl_pw_aff *pwaff,
3381                 __isl_take isl_set *context);
3382
3383         __isl_give isl_set *isl_pw_aff_domain(
3384                 __isl_take isl_pw_aff *pwaff);
3385         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3386                 __isl_take isl_pw_aff *pa,
3387                 __isl_take isl_set *set);
3388         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3389                 __isl_take isl_pw_aff *pa,
3390                 __isl_take isl_set *set);
3391
3392         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3393                 __isl_take isl_aff *aff2);
3394         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3395                 __isl_take isl_aff *aff2);
3396         __isl_give isl_pw_aff *isl_pw_aff_mul(
3397                 __isl_take isl_pw_aff *pwaff1,
3398                 __isl_take isl_pw_aff *pwaff2);
3399         __isl_give isl_pw_aff *isl_pw_aff_div(
3400                 __isl_take isl_pw_aff *pa1,
3401                 __isl_take isl_pw_aff *pa2);
3402         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3403                 __isl_take isl_pw_aff *pa1,
3404                 __isl_take isl_pw_aff *pa2);
3405         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3406                 __isl_take isl_pw_aff *pa1,
3407                 __isl_take isl_pw_aff *pa2);
3408
3409 When multiplying two affine expressions, at least one of the two needs
3410 to be a constant.  Similarly, when dividing an affine expression by another,
3411 the second expression needs to be a constant.
3412 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3413 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3414 remainder.
3415
3416         #include <isl/aff.h>
3417         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3418                 __isl_take isl_aff *aff);
3419         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3420                 __isl_take isl_aff *aff);
3421         __isl_give isl_basic_set *isl_aff_le_basic_set(
3422                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3423         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3424                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3425         __isl_give isl_set *isl_pw_aff_eq_set(
3426                 __isl_take isl_pw_aff *pwaff1,
3427                 __isl_take isl_pw_aff *pwaff2);
3428         __isl_give isl_set *isl_pw_aff_ne_set(
3429                 __isl_take isl_pw_aff *pwaff1,
3430                 __isl_take isl_pw_aff *pwaff2);
3431         __isl_give isl_set *isl_pw_aff_le_set(
3432                 __isl_take isl_pw_aff *pwaff1,
3433                 __isl_take isl_pw_aff *pwaff2);
3434         __isl_give isl_set *isl_pw_aff_lt_set(
3435                 __isl_take isl_pw_aff *pwaff1,
3436                 __isl_take isl_pw_aff *pwaff2);
3437         __isl_give isl_set *isl_pw_aff_ge_set(
3438                 __isl_take isl_pw_aff *pwaff1,
3439                 __isl_take isl_pw_aff *pwaff2);
3440         __isl_give isl_set *isl_pw_aff_gt_set(
3441                 __isl_take isl_pw_aff *pwaff1,
3442                 __isl_take isl_pw_aff *pwaff2);
3443
3444         __isl_give isl_set *isl_pw_aff_list_eq_set(
3445                 __isl_take isl_pw_aff_list *list1,
3446                 __isl_take isl_pw_aff_list *list2);
3447         __isl_give isl_set *isl_pw_aff_list_ne_set(
3448                 __isl_take isl_pw_aff_list *list1,
3449                 __isl_take isl_pw_aff_list *list2);
3450         __isl_give isl_set *isl_pw_aff_list_le_set(
3451                 __isl_take isl_pw_aff_list *list1,
3452                 __isl_take isl_pw_aff_list *list2);
3453         __isl_give isl_set *isl_pw_aff_list_lt_set(
3454                 __isl_take isl_pw_aff_list *list1,
3455                 __isl_take isl_pw_aff_list *list2);
3456         __isl_give isl_set *isl_pw_aff_list_ge_set(
3457                 __isl_take isl_pw_aff_list *list1,
3458                 __isl_take isl_pw_aff_list *list2);
3459         __isl_give isl_set *isl_pw_aff_list_gt_set(
3460                 __isl_take isl_pw_aff_list *list1,
3461                 __isl_take isl_pw_aff_list *list2);
3462
3463 The function C<isl_aff_neg_basic_set> returns a basic set
3464 containing those elements in the domain space
3465 of C<aff> where C<aff> is negative.
3466 The function C<isl_aff_ge_basic_set> returns a basic set
3467 containing those elements in the shared space
3468 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3469 The function C<isl_pw_aff_ge_set> returns a set
3470 containing those elements in the shared domain
3471 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3472 The functions operating on C<isl_pw_aff_list> apply the corresponding
3473 C<isl_pw_aff> function to each pair of elements in the two lists.
3474
3475         #include <isl/aff.h>
3476         __isl_give isl_set *isl_pw_aff_nonneg_set(
3477                 __isl_take isl_pw_aff *pwaff);
3478         __isl_give isl_set *isl_pw_aff_zero_set(
3479                 __isl_take isl_pw_aff *pwaff);
3480         __isl_give isl_set *isl_pw_aff_non_zero_set(
3481                 __isl_take isl_pw_aff *pwaff);
3482
3483 The function C<isl_pw_aff_nonneg_set> returns a set
3484 containing those elements in the domain
3485 of C<pwaff> where C<pwaff> is non-negative.
3486
3487         #include <isl/aff.h>
3488         __isl_give isl_pw_aff *isl_pw_aff_cond(
3489                 __isl_take isl_pw_aff *cond,
3490                 __isl_take isl_pw_aff *pwaff_true,
3491                 __isl_take isl_pw_aff *pwaff_false);
3492
3493 The function C<isl_pw_aff_cond> performs a conditional operator
3494 and returns an expression that is equal to C<pwaff_true>
3495 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3496 where C<cond> is zero.
3497
3498         #include <isl/aff.h>
3499         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3500                 __isl_take isl_pw_aff *pwaff1,
3501                 __isl_take isl_pw_aff *pwaff2);
3502         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3503                 __isl_take isl_pw_aff *pwaff1,
3504                 __isl_take isl_pw_aff *pwaff2);
3505         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3506                 __isl_take isl_pw_aff *pwaff1,
3507                 __isl_take isl_pw_aff *pwaff2);
3508
3509 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3510 expression with a domain that is the union of those of C<pwaff1> and
3511 C<pwaff2> and such that on each cell, the quasi-affine expression is
3512 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3513 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3514 associated expression is the defined one.
3515
3516 An expression can be read from input using
3517
3518         #include <isl/aff.h>
3519         __isl_give isl_aff *isl_aff_read_from_str(
3520                 isl_ctx *ctx, const char *str);
3521         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3522                 isl_ctx *ctx, const char *str);
3523
3524 An expression can be printed using
3525
3526         #include <isl/aff.h>
3527         __isl_give isl_printer *isl_printer_print_aff(
3528                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3529
3530         __isl_give isl_printer *isl_printer_print_pw_aff(
3531                 __isl_take isl_printer *p,
3532                 __isl_keep isl_pw_aff *pwaff);
3533
3534 =head2 Piecewise Multiple Quasi Affine Expressions
3535
3536 An C<isl_multi_aff> object represents a sequence of
3537 zero or more affine expressions, all defined on the same domain space.
3538
3539 An C<isl_multi_aff> can be constructed from a C<isl_aff_list> using the
3540 following function.
3541
3542         #include <isl/aff.h>
3543         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3544                 __isl_take isl_space *space,
3545                 __isl_take isl_aff_list *list);
3546
3547 An empty piecewise multiple quasi affine expression (one with no cells),
3548 the zero piecewise multiple quasi affine expression (with value zero
3549 for each output dimension),
3550 a piecewise multiple quasi affine expression with a single cell (with
3551 either a universe or a specified domain) or
3552 a zero-dimensional piecewise multiple quasi affine expression
3553 on a given domain
3554 can be created using the following functions.
3555
3556         #include <isl/aff.h>
3557         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3558                 __isl_take isl_space *space);
3559         __isl_give isl_multi_aff *isl_multi_aff_zero(
3560                 __isl_take isl_space *space);
3561         __isl_give isl_multi_aff *isl_multi_aff_identity(
3562                 __isl_take isl_space *space);
3563         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3564                 __isl_take isl_space *space);
3565         __isl_give isl_pw_multi_aff *
3566         isl_pw_multi_aff_from_multi_aff(
3567                 __isl_take isl_multi_aff *ma);
3568         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3569                 __isl_take isl_set *set,
3570                 __isl_take isl_multi_aff *maff);
3571         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3572                 __isl_take isl_set *set);
3573
3574         __isl_give isl_union_pw_multi_aff *
3575         isl_union_pw_multi_aff_empty(
3576                 __isl_take isl_space *space);
3577         __isl_give isl_union_pw_multi_aff *
3578         isl_union_pw_multi_aff_add_pw_multi_aff(
3579                 __isl_take isl_union_pw_multi_aff *upma,
3580                 __isl_take isl_pw_multi_aff *pma);
3581         __isl_give isl_union_pw_multi_aff *
3582         isl_union_pw_multi_aff_from_domain(
3583                 __isl_take isl_union_set *uset);
3584
3585 A piecewise multiple quasi affine expression can also be initialized
3586 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3587 and the C<isl_map> is single-valued.
3588
3589         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3590                 __isl_take isl_set *set);
3591         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3592                 __isl_take isl_map *map);
3593
3594 Multiple quasi affine expressions can be copied and freed using
3595
3596         #include <isl/aff.h>
3597         __isl_give isl_multi_aff *isl_multi_aff_copy(
3598                 __isl_keep isl_multi_aff *maff);
3599         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3600
3601         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3602                 __isl_keep isl_pw_multi_aff *pma);
3603         void *isl_pw_multi_aff_free(
3604                 __isl_take isl_pw_multi_aff *pma);
3605
3606         __isl_give isl_union_pw_multi_aff *
3607         isl_union_pw_multi_aff_copy(
3608                 __isl_keep isl_union_pw_multi_aff *upma);
3609         void *isl_union_pw_multi_aff_free(
3610                 __isl_take isl_union_pw_multi_aff *upma);
3611
3612 The expression can be inspected using
3613
3614         #include <isl/aff.h>
3615         isl_ctx *isl_multi_aff_get_ctx(
3616                 __isl_keep isl_multi_aff *maff);
3617         isl_ctx *isl_pw_multi_aff_get_ctx(
3618                 __isl_keep isl_pw_multi_aff *pma);
3619         isl_ctx *isl_union_pw_multi_aff_get_ctx(
3620                 __isl_keep isl_union_pw_multi_aff *upma);
3621         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3622                 enum isl_dim_type type);
3623         unsigned isl_pw_multi_aff_dim(
3624                 __isl_keep isl_pw_multi_aff *pma,
3625                 enum isl_dim_type type);
3626         __isl_give isl_aff *isl_multi_aff_get_aff(
3627                 __isl_keep isl_multi_aff *multi, int pos);
3628         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3629                 __isl_keep isl_pw_multi_aff *pma, int pos);
3630         const char *isl_pw_multi_aff_get_dim_name(
3631                 __isl_keep isl_pw_multi_aff *pma,
3632                 enum isl_dim_type type, unsigned pos);
3633         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3634                 __isl_keep isl_pw_multi_aff *pma,
3635                 enum isl_dim_type type, unsigned pos);
3636         const char *isl_multi_aff_get_tuple_name(
3637                 __isl_keep isl_multi_aff *multi,
3638                 enum isl_dim_type type);
3639         int isl_pw_multi_aff_has_tuple_name(
3640                 __isl_keep isl_pw_multi_aff *pma,
3641                 enum isl_dim_type type);
3642         const char *isl_pw_multi_aff_get_tuple_name(
3643                 __isl_keep isl_pw_multi_aff *pma,
3644                 enum isl_dim_type type);
3645         int isl_pw_multi_aff_has_tuple_id(
3646                 __isl_keep isl_pw_multi_aff *pma,
3647                 enum isl_dim_type type);
3648         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3649                 __isl_keep isl_pw_multi_aff *pma,
3650                 enum isl_dim_type type);
3651
3652         int isl_pw_multi_aff_foreach_piece(
3653                 __isl_keep isl_pw_multi_aff *pma,
3654                 int (*fn)(__isl_take isl_set *set,
3655                             __isl_take isl_multi_aff *maff,
3656                             void *user), void *user);
3657
3658         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
3659                 __isl_keep isl_union_pw_multi_aff *upma,
3660                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
3661                             void *user), void *user);
3662
3663 It can be modified using
3664
3665         #include <isl/aff.h>
3666         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
3667                 __isl_take isl_multi_aff *multi, int pos,
3668                 __isl_take isl_aff *aff);
3669         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
3670                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
3671                 __isl_take isl_pw_aff *pa);
3672         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3673                 __isl_take isl_multi_aff *maff,
3674                 enum isl_dim_type type, unsigned pos, const char *s);
3675         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
3676                 __isl_take isl_multi_aff *maff,
3677                 enum isl_dim_type type, __isl_take isl_id *id);
3678         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3679                 __isl_take isl_pw_multi_aff *pma,
3680                 enum isl_dim_type type, __isl_take isl_id *id);
3681
3682         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
3683                 __isl_take isl_multi_aff *maff,
3684                 enum isl_dim_type type, unsigned first, unsigned n);
3685         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
3686                 __isl_take isl_pw_multi_aff *pma,
3687                 enum isl_dim_type type, unsigned first, unsigned n);
3688
3689 To check whether two multiple affine expressions are
3690 obviously equal to each other, use
3691
3692         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3693                 __isl_keep isl_multi_aff *maff2);
3694         int isl_pw_multi_aff_plain_is_equal(
3695                 __isl_keep isl_pw_multi_aff *pma1,
3696                 __isl_keep isl_pw_multi_aff *pma2);
3697
3698 Operations include
3699
3700         #include <isl/aff.h>
3701         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
3702                 __isl_take isl_pw_multi_aff *pma1,
3703                 __isl_take isl_pw_multi_aff *pma2);
3704         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
3705                 __isl_take isl_pw_multi_aff *pma1,
3706                 __isl_take isl_pw_multi_aff *pma2);
3707         __isl_give isl_multi_aff *isl_multi_aff_add(
3708                 __isl_take isl_multi_aff *maff1,
3709                 __isl_take isl_multi_aff *maff2);
3710         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3711                 __isl_take isl_pw_multi_aff *pma1,
3712                 __isl_take isl_pw_multi_aff *pma2);
3713         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
3714                 __isl_take isl_union_pw_multi_aff *upma1,
3715                 __isl_take isl_union_pw_multi_aff *upma2);
3716         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3717                 __isl_take isl_pw_multi_aff *pma1,
3718                 __isl_take isl_pw_multi_aff *pma2);
3719         __isl_give isl_multi_aff *isl_multi_aff_scale(
3720                 __isl_take isl_multi_aff *maff,
3721                 isl_int f);
3722         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
3723                 __isl_take isl_pw_multi_aff *pma,
3724                 __isl_take isl_set *set);
3725         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3726                 __isl_take isl_pw_multi_aff *pma,
3727                 __isl_take isl_set *set);
3728         __isl_give isl_multi_aff *isl_multi_aff_lift(
3729                 __isl_take isl_multi_aff *maff,
3730                 __isl_give isl_local_space **ls);
3731         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
3732                 __isl_take isl_pw_multi_aff *pma);
3733         __isl_give isl_multi_aff *isl_multi_aff_align_params(
3734                 __isl_take isl_multi_aff *multi,
3735                 __isl_take isl_space *model);
3736         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
3737                 __isl_take isl_pw_multi_aff *pma,
3738                 __isl_take isl_space *model);
3739         __isl_give isl_pw_multi_aff *
3740         isl_pw_multi_aff_project_domain_on_params(
3741                 __isl_take isl_pw_multi_aff *pma);
3742         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
3743                 __isl_take isl_multi_aff *maff,
3744                 __isl_take isl_set *context);
3745         __isl_give isl_multi_aff *isl_multi_aff_gist(
3746                 __isl_take isl_multi_aff *maff,
3747                 __isl_take isl_set *context);
3748         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
3749                 __isl_take isl_pw_multi_aff *pma,
3750                 __isl_take isl_set *set);
3751         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
3752                 __isl_take isl_pw_multi_aff *pma,
3753                 __isl_take isl_set *set);
3754         __isl_give isl_set *isl_pw_multi_aff_domain(
3755                 __isl_take isl_pw_multi_aff *pma);
3756         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
3757                 __isl_take isl_union_pw_multi_aff *upma);
3758         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
3759                 __isl_take isl_multi_aff *ma1,
3760                 __isl_take isl_multi_aff *ma2);
3761         __isl_give isl_multi_aff *isl_multi_aff_product(
3762                 __isl_take isl_multi_aff *ma1,
3763                 __isl_take isl_multi_aff *ma2);
3764         __isl_give isl_pw_multi_aff *
3765         isl_pw_multi_aff_flat_range_product(
3766                 __isl_take isl_pw_multi_aff *pma1,
3767                 __isl_take isl_pw_multi_aff *pma2);
3768         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
3769                 __isl_take isl_pw_multi_aff *pma1,
3770                 __isl_take isl_pw_multi_aff *pma2);
3771         __isl_give isl_union_pw_multi_aff *
3772         isl_union_pw_multi_aff_flat_range_product(
3773                 __isl_take isl_union_pw_multi_aff *upma1,
3774                 __isl_take isl_union_pw_multi_aff *upma2);
3775
3776 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
3777 then it is assigned the local space that lies at the basis of
3778 the lifting applied.
3779
3780         __isl_give isl_set *isl_multi_aff_lex_le_set(
3781                 __isl_take isl_multi_aff *ma1,
3782                 __isl_take isl_multi_aff *ma2);
3783         __isl_give isl_set *isl_multi_aff_lex_ge_set(
3784                 __isl_take isl_multi_aff *ma1,
3785                 __isl_take isl_multi_aff *ma2);
3786
3787 The function C<isl_multi_aff_lex_le_set> returns a set
3788 containing those elements in the shared domain space
3789 where C<ma1> is lexicographically smaller than or
3790 equal to C<ma2>.
3791
3792 An expression can be read from input using
3793
3794         #include <isl/aff.h>
3795         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3796                 isl_ctx *ctx, const char *str);
3797         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3798                 isl_ctx *ctx, const char *str);
3799
3800 An expression can be printed using
3801
3802         #include <isl/aff.h>
3803         __isl_give isl_printer *isl_printer_print_multi_aff(
3804                 __isl_take isl_printer *p,
3805                 __isl_keep isl_multi_aff *maff);
3806         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3807                 __isl_take isl_printer *p,
3808                 __isl_keep isl_pw_multi_aff *pma);
3809         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
3810                 __isl_take isl_printer *p,
3811                 __isl_keep isl_union_pw_multi_aff *upma);
3812
3813 =head2 Points
3814
3815 Points are elements of a set.  They can be used to construct
3816 simple sets (boxes) or they can be used to represent the
3817 individual elements of a set.
3818 The zero point (the origin) can be created using
3819
3820         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
3821
3822 The coordinates of a point can be inspected, set and changed
3823 using
3824
3825         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
3826                 enum isl_dim_type type, int pos, isl_int *v);
3827         __isl_give isl_point *isl_point_set_coordinate(
3828                 __isl_take isl_point *pnt,
3829                 enum isl_dim_type type, int pos, isl_int v);
3830
3831         __isl_give isl_point *isl_point_add_ui(
3832                 __isl_take isl_point *pnt,
3833                 enum isl_dim_type type, int pos, unsigned val);
3834         __isl_give isl_point *isl_point_sub_ui(
3835                 __isl_take isl_point *pnt,
3836                 enum isl_dim_type type, int pos, unsigned val);
3837
3838 Other properties can be obtained using
3839
3840         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
3841
3842 Points can be copied or freed using
3843
3844         __isl_give isl_point *isl_point_copy(
3845                 __isl_keep isl_point *pnt);
3846         void isl_point_free(__isl_take isl_point *pnt);
3847
3848 A singleton set can be created from a point using
3849
3850         __isl_give isl_basic_set *isl_basic_set_from_point(
3851                 __isl_take isl_point *pnt);
3852         __isl_give isl_set *isl_set_from_point(
3853                 __isl_take isl_point *pnt);
3854
3855 and a box can be created from two opposite extremal points using
3856
3857         __isl_give isl_basic_set *isl_basic_set_box_from_points(
3858                 __isl_take isl_point *pnt1,
3859                 __isl_take isl_point *pnt2);
3860         __isl_give isl_set *isl_set_box_from_points(
3861                 __isl_take isl_point *pnt1,
3862                 __isl_take isl_point *pnt2);
3863
3864 All elements of a B<bounded> (union) set can be enumerated using
3865 the following functions.
3866
3867         int isl_set_foreach_point(__isl_keep isl_set *set,
3868                 int (*fn)(__isl_take isl_point *pnt, void *user),
3869                 void *user);
3870         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
3871                 int (*fn)(__isl_take isl_point *pnt, void *user),
3872                 void *user);
3873
3874 The function C<fn> is called for each integer point in
3875 C<set> with as second argument the last argument of
3876 the C<isl_set_foreach_point> call.  The function C<fn>
3877 should return C<0> on success and C<-1> on failure.
3878 In the latter case, C<isl_set_foreach_point> will stop
3879 enumerating and return C<-1> as well.
3880 If the enumeration is performed successfully and to completion,
3881 then C<isl_set_foreach_point> returns C<0>.
3882
3883 To obtain a single point of a (basic) set, use
3884
3885         __isl_give isl_point *isl_basic_set_sample_point(
3886                 __isl_take isl_basic_set *bset);
3887         __isl_give isl_point *isl_set_sample_point(
3888                 __isl_take isl_set *set);
3889
3890 If C<set> does not contain any (integer) points, then the
3891 resulting point will be ``void'', a property that can be
3892 tested using
3893
3894         int isl_point_is_void(__isl_keep isl_point *pnt);
3895
3896 =head2 Piecewise Quasipolynomials
3897
3898 A piecewise quasipolynomial is a particular kind of function that maps
3899 a parametric point to a rational value.
3900 More specifically, a quasipolynomial is a polynomial expression in greatest
3901 integer parts of affine expressions of parameters and variables.
3902 A piecewise quasipolynomial is a subdivision of a given parametric
3903 domain into disjoint cells with a quasipolynomial associated to
3904 each cell.  The value of the piecewise quasipolynomial at a given
3905 point is the value of the quasipolynomial associated to the cell
3906 that contains the point.  Outside of the union of cells,
3907 the value is assumed to be zero.
3908 For example, the piecewise quasipolynomial
3909
3910         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
3911
3912 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
3913 A given piecewise quasipolynomial has a fixed domain dimension.
3914 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
3915 defined over different domains.
3916 Piecewise quasipolynomials are mainly used by the C<barvinok>
3917 library for representing the number of elements in a parametric set or map.
3918 For example, the piecewise quasipolynomial above represents
3919 the number of points in the map
3920
3921         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
3922
3923 =head3 Input and Output
3924
3925 Piecewise quasipolynomials can be read from input using
3926
3927         __isl_give isl_union_pw_qpolynomial *
3928         isl_union_pw_qpolynomial_read_from_str(
3929                 isl_ctx *ctx, const char *str);
3930
3931 Quasipolynomials and piecewise quasipolynomials can be printed
3932 using the following functions.
3933
3934         __isl_give isl_printer *isl_printer_print_qpolynomial(
3935                 __isl_take isl_printer *p,
3936                 __isl_keep isl_qpolynomial *qp);
3937
3938         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3939                 __isl_take isl_printer *p,
3940                 __isl_keep isl_pw_qpolynomial *pwqp);
3941
3942         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3943                 __isl_take isl_printer *p,
3944                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3945
3946 The output format of the printer
3947 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3948 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
3949 is supported.
3950 In case of printing in C<ISL_FORMAT_C>, the user may want
3951 to set the names of all dimensions
3952
3953         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
3954                 __isl_take isl_qpolynomial *qp,
3955                 enum isl_dim_type type, unsigned pos,
3956                 const char *s);
3957         __isl_give isl_pw_qpolynomial *
3958         isl_pw_qpolynomial_set_dim_name(
3959                 __isl_take isl_pw_qpolynomial *pwqp,
3960                 enum isl_dim_type type, unsigned pos,
3961                 const char *s);
3962
3963 =head3 Creating New (Piecewise) Quasipolynomials
3964
3965 Some simple quasipolynomials can be created using the following functions.
3966 More complicated quasipolynomials can be created by applying
3967 operations such as addition and multiplication
3968 on the resulting quasipolynomials
3969
3970         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
3971                 __isl_take isl_space *domain);
3972         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
3973                 __isl_take isl_space *domain);
3974         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
3975                 __isl_take isl_space *domain);
3976         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
3977                 __isl_take isl_space *domain);
3978         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
3979                 __isl_take isl_space *domain);
3980         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
3981                 __isl_take isl_space *domain,
3982                 const isl_int n, const isl_int d);
3983         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
3984                 __isl_take isl_space *domain,
3985                 enum isl_dim_type type, unsigned pos);
3986         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
3987                 __isl_take isl_aff *aff);
3988
3989 Note that the space in which a quasipolynomial lives is a map space
3990 with a one-dimensional range.  The C<domain> argument in some of
3991 the functions above corresponds to the domain of this map space.
3992
3993 The zero piecewise quasipolynomial or a piecewise quasipolynomial
3994 with a single cell can be created using the following functions.
3995 Multiple of these single cell piecewise quasipolynomials can
3996 be combined to create more complicated piecewise quasipolynomials.
3997
3998         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
3999                 __isl_take isl_space *space);
4000         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4001                 __isl_take isl_set *set,
4002                 __isl_take isl_qpolynomial *qp);
4003         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4004                 __isl_take isl_qpolynomial *qp);
4005         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4006                 __isl_take isl_pw_aff *pwaff);
4007
4008         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4009                 __isl_take isl_space *space);
4010         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4011                 __isl_take isl_pw_qpolynomial *pwqp);
4012         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4013                 __isl_take isl_union_pw_qpolynomial *upwqp,
4014                 __isl_take isl_pw_qpolynomial *pwqp);
4015
4016 Quasipolynomials can be copied and freed again using the following
4017 functions.
4018
4019         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4020                 __isl_keep isl_qpolynomial *qp);
4021         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4022
4023         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4024                 __isl_keep isl_pw_qpolynomial *pwqp);
4025         void *isl_pw_qpolynomial_free(
4026                 __isl_take isl_pw_qpolynomial *pwqp);
4027
4028         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4029                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4030         void *isl_union_pw_qpolynomial_free(
4031                 __isl_take isl_union_pw_qpolynomial *upwqp);
4032
4033 =head3 Inspecting (Piecewise) Quasipolynomials
4034
4035 To iterate over all piecewise quasipolynomials in a union
4036 piecewise quasipolynomial, use the following function
4037
4038         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4039                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4040                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4041                 void *user);
4042
4043 To extract the piecewise quasipolynomial in a given space from a union, use
4044
4045         __isl_give isl_pw_qpolynomial *
4046         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4047                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4048                 __isl_take isl_space *space);
4049
4050 To iterate over the cells in a piecewise quasipolynomial,
4051 use either of the following two functions
4052
4053         int isl_pw_qpolynomial_foreach_piece(
4054                 __isl_keep isl_pw_qpolynomial *pwqp,
4055                 int (*fn)(__isl_take isl_set *set,
4056                           __isl_take isl_qpolynomial *qp,
4057                           void *user), void *user);
4058         int isl_pw_qpolynomial_foreach_lifted_piece(
4059                 __isl_keep isl_pw_qpolynomial *pwqp,
4060                 int (*fn)(__isl_take isl_set *set,
4061                           __isl_take isl_qpolynomial *qp,
4062                           void *user), void *user);
4063
4064 As usual, the function C<fn> should return C<0> on success
4065 and C<-1> on failure.  The difference between
4066 C<isl_pw_qpolynomial_foreach_piece> and
4067 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4068 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4069 compute unique representations for all existentially quantified
4070 variables and then turn these existentially quantified variables
4071 into extra set variables, adapting the associated quasipolynomial
4072 accordingly.  This means that the C<set> passed to C<fn>
4073 will not have any existentially quantified variables, but that
4074 the dimensions of the sets may be different for different
4075 invocations of C<fn>.
4076
4077 To iterate over all terms in a quasipolynomial,
4078 use
4079
4080         int isl_qpolynomial_foreach_term(
4081                 __isl_keep isl_qpolynomial *qp,
4082                 int (*fn)(__isl_take isl_term *term,
4083                           void *user), void *user);
4084
4085 The terms themselves can be inspected and freed using
4086 these functions
4087
4088         unsigned isl_term_dim(__isl_keep isl_term *term,
4089                 enum isl_dim_type type);
4090         void isl_term_get_num(__isl_keep isl_term *term,
4091                 isl_int *n);
4092         void isl_term_get_den(__isl_keep isl_term *term,
4093                 isl_int *d);
4094         int isl_term_get_exp(__isl_keep isl_term *term,
4095                 enum isl_dim_type type, unsigned pos);
4096         __isl_give isl_aff *isl_term_get_div(
4097                 __isl_keep isl_term *term, unsigned pos);
4098         void isl_term_free(__isl_take isl_term *term);
4099
4100 Each term is a product of parameters, set variables and
4101 integer divisions.  The function C<isl_term_get_exp>
4102 returns the exponent of a given dimensions in the given term.
4103 The C<isl_int>s in the arguments of C<isl_term_get_num>
4104 and C<isl_term_get_den> need to have been initialized
4105 using C<isl_int_init> before calling these functions.
4106
4107 =head3 Properties of (Piecewise) Quasipolynomials
4108
4109 To check whether a quasipolynomial is actually a constant,
4110 use the following function.
4111
4112         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4113                 isl_int *n, isl_int *d);
4114
4115 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4116 then the numerator and denominator of the constant
4117 are returned in C<*n> and C<*d>, respectively.
4118
4119 To check whether two union piecewise quasipolynomials are
4120 obviously equal, use
4121
4122         int isl_union_pw_qpolynomial_plain_is_equal(
4123                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4124                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4125
4126 =head3 Operations on (Piecewise) Quasipolynomials
4127
4128         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4129                 __isl_take isl_qpolynomial *qp, isl_int v);
4130         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4131                 __isl_take isl_qpolynomial *qp);
4132         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4133                 __isl_take isl_qpolynomial *qp1,
4134                 __isl_take isl_qpolynomial *qp2);
4135         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4136                 __isl_take isl_qpolynomial *qp1,
4137                 __isl_take isl_qpolynomial *qp2);
4138         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4139                 __isl_take isl_qpolynomial *qp1,
4140                 __isl_take isl_qpolynomial *qp2);
4141         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4142                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4143
4144         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4145                 __isl_take isl_pw_qpolynomial *pwqp1,
4146                 __isl_take isl_pw_qpolynomial *pwqp2);
4147         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4148                 __isl_take isl_pw_qpolynomial *pwqp1,
4149                 __isl_take isl_pw_qpolynomial *pwqp2);
4150         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4151                 __isl_take isl_pw_qpolynomial *pwqp1,
4152                 __isl_take isl_pw_qpolynomial *pwqp2);
4153         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4154                 __isl_take isl_pw_qpolynomial *pwqp);
4155         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4156                 __isl_take isl_pw_qpolynomial *pwqp1,
4157                 __isl_take isl_pw_qpolynomial *pwqp2);
4158         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4159                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4160
4161         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4162                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4163                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4164         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4165                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4166                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4167         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4168                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4169                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4170
4171         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4172                 __isl_take isl_pw_qpolynomial *pwqp,
4173                 __isl_take isl_point *pnt);
4174
4175         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4176                 __isl_take isl_union_pw_qpolynomial *upwqp,
4177                 __isl_take isl_point *pnt);
4178
4179         __isl_give isl_set *isl_pw_qpolynomial_domain(
4180                 __isl_take isl_pw_qpolynomial *pwqp);
4181         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4182                 __isl_take isl_pw_qpolynomial *pwpq,
4183                 __isl_take isl_set *set);
4184         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4185                 __isl_take isl_pw_qpolynomial *pwpq,
4186                 __isl_take isl_set *set);
4187
4188         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4189                 __isl_take isl_union_pw_qpolynomial *upwqp);
4190         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4191                 __isl_take isl_union_pw_qpolynomial *upwpq,
4192                 __isl_take isl_union_set *uset);
4193         __isl_give isl_union_pw_qpolynomial *
4194         isl_union_pw_qpolynomial_intersect_params(
4195                 __isl_take isl_union_pw_qpolynomial *upwpq,
4196                 __isl_take isl_set *set);
4197
4198         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4199                 __isl_take isl_qpolynomial *qp,
4200                 __isl_take isl_space *model);
4201
4202         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4203                 __isl_take isl_qpolynomial *qp);
4204         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4205                 __isl_take isl_pw_qpolynomial *pwqp);
4206
4207         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4208                 __isl_take isl_union_pw_qpolynomial *upwqp);
4209
4210         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4211                 __isl_take isl_qpolynomial *qp,
4212                 __isl_take isl_set *context);
4213         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4214                 __isl_take isl_qpolynomial *qp,
4215                 __isl_take isl_set *context);
4216
4217         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4218                 __isl_take isl_pw_qpolynomial *pwqp,
4219                 __isl_take isl_set *context);
4220         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4221                 __isl_take isl_pw_qpolynomial *pwqp,
4222                 __isl_take isl_set *context);
4223
4224         __isl_give isl_union_pw_qpolynomial *
4225         isl_union_pw_qpolynomial_gist_params(
4226                 __isl_take isl_union_pw_qpolynomial *upwqp,
4227                 __isl_take isl_set *context);
4228         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4229                 __isl_take isl_union_pw_qpolynomial *upwqp,
4230                 __isl_take isl_union_set *context);
4231
4232 The gist operation applies the gist operation to each of
4233 the cells in the domain of the input piecewise quasipolynomial.
4234 The context is also exploited
4235 to simplify the quasipolynomials associated to each cell.
4236
4237         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4238                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4239         __isl_give isl_union_pw_qpolynomial *
4240         isl_union_pw_qpolynomial_to_polynomial(
4241                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4242
4243 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4244 the polynomial will be an overapproximation.  If C<sign> is negative,
4245 it will be an underapproximation.  If C<sign> is zero, the approximation
4246 will lie somewhere in between.
4247
4248 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4249
4250 A piecewise quasipolynomial reduction is a piecewise
4251 reduction (or fold) of quasipolynomials.
4252 In particular, the reduction can be maximum or a minimum.
4253 The objects are mainly used to represent the result of
4254 an upper or lower bound on a quasipolynomial over its domain,
4255 i.e., as the result of the following function.
4256
4257         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4258                 __isl_take isl_pw_qpolynomial *pwqp,
4259                 enum isl_fold type, int *tight);
4260
4261         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4262                 __isl_take isl_union_pw_qpolynomial *upwqp,
4263                 enum isl_fold type, int *tight);
4264
4265 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4266 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4267 is the returned bound is known be tight, i.e., for each value
4268 of the parameters there is at least
4269 one element in the domain that reaches the bound.
4270 If the domain of C<pwqp> is not wrapping, then the bound is computed
4271 over all elements in that domain and the result has a purely parametric
4272 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4273 computed over the range of the wrapped relation.  The domain of the
4274 wrapped relation becomes the domain of the result.
4275
4276 A (piecewise) quasipolynomial reduction can be copied or freed using the
4277 following functions.
4278
4279         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4280                 __isl_keep isl_qpolynomial_fold *fold);
4281         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4282                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4283         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4284                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4285         void isl_qpolynomial_fold_free(
4286                 __isl_take isl_qpolynomial_fold *fold);
4287         void *isl_pw_qpolynomial_fold_free(
4288                 __isl_take isl_pw_qpolynomial_fold *pwf);
4289         void *isl_union_pw_qpolynomial_fold_free(
4290                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4291
4292 =head3 Printing Piecewise Quasipolynomial Reductions
4293
4294 Piecewise quasipolynomial reductions can be printed
4295 using the following function.
4296
4297         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4298                 __isl_take isl_printer *p,
4299                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4300         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4301                 __isl_take isl_printer *p,
4302                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4303
4304 For C<isl_printer_print_pw_qpolynomial_fold>,
4305 output format of the printer
4306 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4307 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4308 output format of the printer
4309 needs to be set to C<ISL_FORMAT_ISL>.
4310 In case of printing in C<ISL_FORMAT_C>, the user may want
4311 to set the names of all dimensions
4312
4313         __isl_give isl_pw_qpolynomial_fold *
4314         isl_pw_qpolynomial_fold_set_dim_name(
4315                 __isl_take isl_pw_qpolynomial_fold *pwf,
4316                 enum isl_dim_type type, unsigned pos,
4317                 const char *s);
4318
4319 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4320
4321 To iterate over all piecewise quasipolynomial reductions in a union
4322 piecewise quasipolynomial reduction, use the following function
4323
4324         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4325                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4326                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4327                             void *user), void *user);
4328
4329 To iterate over the cells in a piecewise quasipolynomial reduction,
4330 use either of the following two functions
4331
4332         int isl_pw_qpolynomial_fold_foreach_piece(
4333                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4334                 int (*fn)(__isl_take isl_set *set,
4335                           __isl_take isl_qpolynomial_fold *fold,
4336                           void *user), void *user);
4337         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4338                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4339                 int (*fn)(__isl_take isl_set *set,
4340                           __isl_take isl_qpolynomial_fold *fold,
4341                           void *user), void *user);
4342
4343 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4344 of the difference between these two functions.
4345
4346 To iterate over all quasipolynomials in a reduction, use
4347
4348         int isl_qpolynomial_fold_foreach_qpolynomial(
4349                 __isl_keep isl_qpolynomial_fold *fold,
4350                 int (*fn)(__isl_take isl_qpolynomial *qp,
4351                           void *user), void *user);
4352
4353 =head3 Properties of Piecewise Quasipolynomial Reductions
4354
4355 To check whether two union piecewise quasipolynomial reductions are
4356 obviously equal, use
4357
4358         int isl_union_pw_qpolynomial_fold_plain_is_equal(
4359                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4360                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4361
4362 =head3 Operations on Piecewise Quasipolynomial Reductions
4363
4364         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4365                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4366
4367         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4368                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4369                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4370
4371         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4372                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4373                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4374
4375         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4376                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4377                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4378
4379         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4380                 __isl_take isl_pw_qpolynomial_fold *pwf,
4381                 __isl_take isl_point *pnt);
4382
4383         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4384                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4385                 __isl_take isl_point *pnt);
4386
4387         __isl_give isl_pw_qpolynomial_fold *
4388         isl_pw_qpolynomial_fold_intersect_params(
4389                 __isl_take isl_pw_qpolynomial_fold *pwf,
4390                 __isl_take isl_set *set);
4391
4392         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4393                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4394         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4395                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4396                 __isl_take isl_union_set *uset);
4397         __isl_give isl_union_pw_qpolynomial_fold *
4398         isl_union_pw_qpolynomial_fold_intersect_params(
4399                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4400                 __isl_take isl_set *set);
4401
4402         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4403                 __isl_take isl_pw_qpolynomial_fold *pwf);
4404
4405         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4406                 __isl_take isl_pw_qpolynomial_fold *pwf);
4407
4408         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4409                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4410
4411         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4412                 __isl_take isl_qpolynomial_fold *fold,
4413                 __isl_take isl_set *context);
4414         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4415                 __isl_take isl_qpolynomial_fold *fold,
4416                 __isl_take isl_set *context);
4417
4418         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4419                 __isl_take isl_pw_qpolynomial_fold *pwf,
4420                 __isl_take isl_set *context);
4421         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4422                 __isl_take isl_pw_qpolynomial_fold *pwf,
4423                 __isl_take isl_set *context);
4424
4425         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4426                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4427                 __isl_take isl_union_set *context);
4428         __isl_give isl_union_pw_qpolynomial_fold *
4429         isl_union_pw_qpolynomial_fold_gist_params(
4430                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4431                 __isl_take isl_set *context);
4432
4433 The gist operation applies the gist operation to each of
4434 the cells in the domain of the input piecewise quasipolynomial reduction.
4435 In future, the operation will also exploit the context
4436 to simplify the quasipolynomial reductions associated to each cell.
4437
4438         __isl_give isl_pw_qpolynomial_fold *
4439         isl_set_apply_pw_qpolynomial_fold(
4440                 __isl_take isl_set *set,
4441                 __isl_take isl_pw_qpolynomial_fold *pwf,
4442                 int *tight);
4443         __isl_give isl_pw_qpolynomial_fold *
4444         isl_map_apply_pw_qpolynomial_fold(
4445                 __isl_take isl_map *map,
4446                 __isl_take isl_pw_qpolynomial_fold *pwf,
4447                 int *tight);
4448         __isl_give isl_union_pw_qpolynomial_fold *
4449         isl_union_set_apply_union_pw_qpolynomial_fold(
4450                 __isl_take isl_union_set *uset,
4451                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4452                 int *tight);
4453         __isl_give isl_union_pw_qpolynomial_fold *
4454         isl_union_map_apply_union_pw_qpolynomial_fold(
4455                 __isl_take isl_union_map *umap,
4456                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4457                 int *tight);
4458
4459 The functions taking a map
4460 compose the given map with the given piecewise quasipolynomial reduction.
4461 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
4462 over all elements in the intersection of the range of the map
4463 and the domain of the piecewise quasipolynomial reduction
4464 as a function of an element in the domain of the map.
4465 The functions taking a set compute a bound over all elements in the
4466 intersection of the set and the domain of the
4467 piecewise quasipolynomial reduction.
4468
4469 =head2 Dependence Analysis
4470
4471 C<isl> contains specialized functionality for performing
4472 array dataflow analysis.  That is, given a I<sink> access relation
4473 and a collection of possible I<source> access relations,
4474 C<isl> can compute relations that describe
4475 for each iteration of the sink access, which iteration
4476 of which of the source access relations was the last
4477 to access the same data element before the given iteration
4478 of the sink access.
4479 The resulting dependence relations map source iterations
4480 to the corresponding sink iterations.
4481 To compute standard flow dependences, the sink should be
4482 a read, while the sources should be writes.
4483 If any of the source accesses are marked as being I<may>
4484 accesses, then there will be a dependence from the last
4485 I<must> access B<and> from any I<may> access that follows
4486 this last I<must> access.
4487 In particular, if I<all> sources are I<may> accesses,
4488 then memory based dependence analysis is performed.
4489 If, on the other hand, all sources are I<must> accesses,
4490 then value based dependence analysis is performed.
4491
4492         #include <isl/flow.h>
4493
4494         typedef int (*isl_access_level_before)(void *first, void *second);
4495
4496         __isl_give isl_access_info *isl_access_info_alloc(
4497                 __isl_take isl_map *sink,
4498                 void *sink_user, isl_access_level_before fn,
4499                 int max_source);
4500         __isl_give isl_access_info *isl_access_info_add_source(
4501                 __isl_take isl_access_info *acc,
4502                 __isl_take isl_map *source, int must,
4503                 void *source_user);
4504         void *isl_access_info_free(__isl_take isl_access_info *acc);
4505
4506         __isl_give isl_flow *isl_access_info_compute_flow(
4507                 __isl_take isl_access_info *acc);
4508
4509         int isl_flow_foreach(__isl_keep isl_flow *deps,
4510                 int (*fn)(__isl_take isl_map *dep, int must,
4511                           void *dep_user, void *user),
4512                 void *user);
4513         __isl_give isl_map *isl_flow_get_no_source(
4514                 __isl_keep isl_flow *deps, int must);
4515         void isl_flow_free(__isl_take isl_flow *deps);
4516
4517 The function C<isl_access_info_compute_flow> performs the actual
4518 dependence analysis.  The other functions are used to construct
4519 the input for this function or to read off the output.
4520
4521 The input is collected in an C<isl_access_info>, which can
4522 be created through a call to C<isl_access_info_alloc>.
4523 The arguments to this functions are the sink access relation
4524 C<sink>, a token C<sink_user> used to identify the sink
4525 access to the user, a callback function for specifying the
4526 relative order of source and sink accesses, and the number
4527 of source access relations that will be added.
4528 The callback function has type C<int (*)(void *first, void *second)>.
4529 The function is called with two user supplied tokens identifying
4530 either a source or the sink and it should return the shared nesting
4531 level and the relative order of the two accesses.
4532 In particular, let I<n> be the number of loops shared by
4533 the two accesses.  If C<first> precedes C<second> textually,
4534 then the function should return I<2 * n + 1>; otherwise,
4535 it should return I<2 * n>.
4536 The sources can be added to the C<isl_access_info> by performing
4537 (at most) C<max_source> calls to C<isl_access_info_add_source>.
4538 C<must> indicates whether the source is a I<must> access
4539 or a I<may> access.  Note that a multi-valued access relation
4540 should only be marked I<must> if every iteration in the domain
4541 of the relation accesses I<all> elements in its image.
4542 The C<source_user> token is again used to identify
4543 the source access.  The range of the source access relation
4544 C<source> should have the same dimension as the range
4545 of the sink access relation.
4546 The C<isl_access_info_free> function should usually not be
4547 called explicitly, because it is called implicitly by
4548 C<isl_access_info_compute_flow>.
4549
4550 The result of the dependence analysis is collected in an
4551 C<isl_flow>.  There may be elements of
4552 the sink access for which no preceding source access could be
4553 found or for which all preceding sources are I<may> accesses.
4554 The relations containing these elements can be obtained through
4555 calls to C<isl_flow_get_no_source>, the first with C<must> set
4556 and the second with C<must> unset.
4557 In the case of standard flow dependence analysis,
4558 with the sink a read and the sources I<must> writes,
4559 the first relation corresponds to the reads from uninitialized
4560 array elements and the second relation is empty.
4561 The actual flow dependences can be extracted using
4562 C<isl_flow_foreach>.  This function will call the user-specified
4563 callback function C<fn> for each B<non-empty> dependence between
4564 a source and the sink.  The callback function is called
4565 with four arguments, the actual flow dependence relation
4566 mapping source iterations to sink iterations, a boolean that
4567 indicates whether it is a I<must> or I<may> dependence, a token
4568 identifying the source and an additional C<void *> with value
4569 equal to the third argument of the C<isl_flow_foreach> call.
4570 A dependence is marked I<must> if it originates from a I<must>
4571 source and if it is not followed by any I<may> sources.
4572
4573 After finishing with an C<isl_flow>, the user should call
4574 C<isl_flow_free> to free all associated memory.
4575
4576 A higher-level interface to dependence analysis is provided
4577 by the following function.
4578
4579         #include <isl/flow.h>
4580
4581         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
4582                 __isl_take isl_union_map *must_source,
4583                 __isl_take isl_union_map *may_source,
4584                 __isl_take isl_union_map *schedule,
4585                 __isl_give isl_union_map **must_dep,
4586                 __isl_give isl_union_map **may_dep,
4587                 __isl_give isl_union_map **must_no_source,
4588                 __isl_give isl_union_map **may_no_source);
4589
4590 The arrays are identified by the tuple names of the ranges
4591 of the accesses.  The iteration domains by the tuple names
4592 of the domains of the accesses and of the schedule.
4593 The relative order of the iteration domains is given by the
4594 schedule.  The relations returned through C<must_no_source>
4595 and C<may_no_source> are subsets of C<sink>.
4596 Any of C<must_dep>, C<may_dep>, C<must_no_source>
4597 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
4598 any of the other arguments is treated as an error.
4599
4600 =head3 Interaction with Dependence Analysis
4601
4602 During the dependence analysis, we frequently need to perform
4603 the following operation.  Given a relation between sink iterations
4604 and potential source iterations from a particular source domain,
4605 what is the last potential source iteration corresponding to each
4606 sink iteration.  It can sometimes be convenient to adjust
4607 the set of potential source iterations before or after each such operation.
4608 The prototypical example is fuzzy array dataflow analysis,
4609 where we need to analyze if, based on data-dependent constraints,
4610 the sink iteration can ever be executed without one or more of
4611 the corresponding potential source iterations being executed.
4612 If so, we can introduce extra parameters and select an unknown
4613 but fixed source iteration from the potential source iterations.
4614 To be able to perform such manipulations, C<isl> provides the following
4615 function.
4616
4617         #include <isl/flow.h>
4618
4619         typedef __isl_give isl_restriction *(*isl_access_restrict)(
4620                 __isl_keep isl_map *source_map,
4621                 __isl_keep isl_set *sink, void *source_user,
4622                 void *user);
4623         __isl_give isl_access_info *isl_access_info_set_restrict(
4624                 __isl_take isl_access_info *acc,
4625                 isl_access_restrict fn, void *user);
4626
4627 The function C<isl_access_info_set_restrict> should be called
4628 before calling C<isl_access_info_compute_flow> and registers a callback function
4629 that will be called any time C<isl> is about to compute the last
4630 potential source.  The first argument is the (reverse) proto-dependence,
4631 mapping sink iterations to potential source iterations.
4632 The second argument represents the sink iterations for which
4633 we want to compute the last source iteration.
4634 The third argument is the token corresponding to the source
4635 and the final argument is the token passed to C<isl_access_info_set_restrict>.
4636 The callback is expected to return a restriction on either the input or
4637 the output of the operation computing the last potential source.
4638 If the input needs to be restricted then restrictions are needed
4639 for both the source and the sink iterations.  The sink iterations
4640 and the potential source iterations will be intersected with these sets.
4641 If the output needs to be restricted then only a restriction on the source
4642 iterations is required.
4643 If any error occurs, the callback should return C<NULL>.
4644 An C<isl_restriction> object can be created, freed and inspected
4645 using the following functions.
4646
4647         #include <isl/flow.h>
4648
4649         __isl_give isl_restriction *isl_restriction_input(
4650                 __isl_take isl_set *source_restr,
4651                 __isl_take isl_set *sink_restr);
4652         __isl_give isl_restriction *isl_restriction_output(
4653                 __isl_take isl_set *source_restr);
4654         __isl_give isl_restriction *isl_restriction_none(
4655                 __isl_take isl_map *source_map);
4656         __isl_give isl_restriction *isl_restriction_empty(
4657                 __isl_take isl_map *source_map);
4658         void *isl_restriction_free(
4659                 __isl_take isl_restriction *restr);
4660         isl_ctx *isl_restriction_get_ctx(
4661                 __isl_keep isl_restriction *restr);
4662
4663 C<isl_restriction_none> and C<isl_restriction_empty> are special
4664 cases of C<isl_restriction_input>.  C<isl_restriction_none>
4665 is essentially equivalent to
4666
4667         isl_restriction_input(isl_set_universe(
4668             isl_space_range(isl_map_get_space(source_map))),
4669                             isl_set_universe(
4670             isl_space_domain(isl_map_get_space(source_map))));
4671
4672 whereas C<isl_restriction_empty> is essentially equivalent to
4673
4674         isl_restriction_input(isl_set_empty(
4675             isl_space_range(isl_map_get_space(source_map))),
4676                             isl_set_universe(
4677             isl_space_domain(isl_map_get_space(source_map))));
4678
4679 =head2 Scheduling
4680
4681 B<The functionality described in this section is fairly new
4682 and may be subject to change.>
4683
4684 The following function can be used to compute a schedule
4685 for a union of domains.
4686 By default, the algorithm used to construct the schedule is similar
4687 to that of C<Pluto>.
4688 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
4689 be selected.
4690 The generated schedule respects all C<validity> dependences.
4691 That is, all dependence distances over these dependences in the
4692 scheduled space are lexicographically positive.
4693 The default algorithm tries to minimize the dependence distances over
4694 C<proximity> dependences.
4695 Moreover, it tries to obtain sequences (bands) of schedule dimensions
4696 for groups of domains where the dependence distances have only
4697 non-negative values.
4698 When using Feautrier's algorithm, the C<proximity> dependence
4699 distances are only minimized during the extension to a
4700 full-dimensional schedule.
4701
4702         #include <isl/schedule.h>
4703         __isl_give isl_schedule *isl_union_set_compute_schedule(
4704                 __isl_take isl_union_set *domain,
4705                 __isl_take isl_union_map *validity,
4706                 __isl_take isl_union_map *proximity);
4707         void *isl_schedule_free(__isl_take isl_schedule *sched);
4708
4709 A mapping from the domains to the scheduled space can be obtained
4710 from an C<isl_schedule> using the following function.
4711
4712         __isl_give isl_union_map *isl_schedule_get_map(
4713                 __isl_keep isl_schedule *sched);
4714
4715 A representation of the schedule can be printed using
4716          
4717         __isl_give isl_printer *isl_printer_print_schedule(
4718                 __isl_take isl_printer *p,
4719                 __isl_keep isl_schedule *schedule);
4720
4721 A representation of the schedule as a forest of bands can be obtained
4722 using the following function.
4723
4724         __isl_give isl_band_list *isl_schedule_get_band_forest(
4725                 __isl_keep isl_schedule *schedule);
4726
4727 The individual bands can be visited in depth-first post-order
4728 using the following function.
4729
4730         #include <isl/schedule.h>
4731         int isl_schedule_foreach_band(
4732                 __isl_keep isl_schedule *sched,
4733                 int (*fn)(__isl_keep isl_band *band, void *user),
4734                 void *user);
4735
4736 The list can be manipulated as explained in L<"Lists">.
4737 The bands inside the list can be copied and freed using the following
4738 functions.
4739
4740         #include <isl/band.h>
4741         __isl_give isl_band *isl_band_copy(
4742                 __isl_keep isl_band *band);
4743         void *isl_band_free(__isl_take isl_band *band);
4744
4745 Each band contains zero or more scheduling dimensions.
4746 These are referred to as the members of the band.
4747 The section of the schedule that corresponds to the band is
4748 referred to as the partial schedule of the band.
4749 For those nodes that participate in a band, the outer scheduling
4750 dimensions form the prefix schedule, while the inner scheduling
4751 dimensions form the suffix schedule.
4752 That is, if we take a cut of the band forest, then the union of
4753 the concatenations of the prefix, partial and suffix schedules of
4754 each band in the cut is equal to the entire schedule (modulo
4755 some possible padding at the end with zero scheduling dimensions).
4756 The properties of a band can be inspected using the following functions.
4757
4758         #include <isl/band.h>
4759         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
4760
4761         int isl_band_has_children(__isl_keep isl_band *band);
4762         __isl_give isl_band_list *isl_band_get_children(
4763                 __isl_keep isl_band *band);
4764
4765         __isl_give isl_union_map *isl_band_get_prefix_schedule(
4766                 __isl_keep isl_band *band);
4767         __isl_give isl_union_map *isl_band_get_partial_schedule(
4768                 __isl_keep isl_band *band);
4769         __isl_give isl_union_map *isl_band_get_suffix_schedule(
4770                 __isl_keep isl_band *band);
4771
4772         int isl_band_n_member(__isl_keep isl_band *band);
4773         int isl_band_member_is_zero_distance(
4774                 __isl_keep isl_band *band, int pos);
4775
4776         int isl_band_list_foreach_band(
4777                 __isl_keep isl_band_list *list,
4778                 int (*fn)(__isl_keep isl_band *band, void *user),
4779                 void *user);
4780
4781 Note that a scheduling dimension is considered to be ``zero
4782 distance'' if it does not carry any proximity dependences
4783 within its band.
4784 That is, if the dependence distances of the proximity
4785 dependences are all zero in that direction (for fixed
4786 iterations of outer bands).
4787 Like C<isl_schedule_foreach_band>,
4788 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
4789 in depth-first post-order.
4790
4791 A band can be tiled using the following function.
4792
4793         #include <isl/band.h>
4794         int isl_band_tile(__isl_keep isl_band *band,
4795                 __isl_take isl_vec *sizes);
4796
4797         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
4798                 int val);
4799         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
4800
4801 The C<isl_band_tile> function tiles the band using the given tile sizes
4802 inside its schedule.
4803 A new child band is created to represent the point loops and it is
4804 inserted between the modified band and its children.
4805 The C<tile_scale_tile_loops> option specifies whether the tile
4806 loops iterators should be scaled by the tile sizes.
4807
4808 A representation of the band can be printed using
4809
4810         #include <isl/band.h>
4811         __isl_give isl_printer *isl_printer_print_band(
4812                 __isl_take isl_printer *p,
4813                 __isl_keep isl_band *band);
4814
4815 =head3 Options
4816
4817         #include <isl/schedule.h>
4818         int isl_options_set_schedule_max_coefficient(
4819                 isl_ctx *ctx, int val);
4820         int isl_options_get_schedule_max_coefficient(
4821                 isl_ctx *ctx);
4822         int isl_options_set_schedule_max_constant_term(
4823                 isl_ctx *ctx, int val);
4824         int isl_options_get_schedule_max_constant_term(
4825                 isl_ctx *ctx);
4826         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
4827         int isl_options_get_schedule_fuse(isl_ctx *ctx);
4828         int isl_options_set_schedule_maximize_band_depth(
4829                 isl_ctx *ctx, int val);
4830         int isl_options_get_schedule_maximize_band_depth(
4831                 isl_ctx *ctx);
4832         int isl_options_set_schedule_outer_zero_distance(
4833                 isl_ctx *ctx, int val);
4834         int isl_options_get_schedule_outer_zero_distance(
4835                 isl_ctx *ctx);
4836         int isl_options_set_schedule_split_scaled(
4837                 isl_ctx *ctx, int val);
4838         int isl_options_get_schedule_split_scaled(
4839                 isl_ctx *ctx);
4840         int isl_options_set_schedule_algorithm(
4841                 isl_ctx *ctx, int val);
4842         int isl_options_get_schedule_algorithm(
4843                 isl_ctx *ctx);
4844         int isl_options_set_schedule_separate_components(
4845                 isl_ctx *ctx, int val);
4846         int isl_options_get_schedule_separate_components(
4847                 isl_ctx *ctx);
4848
4849 =over
4850
4851 =item * schedule_max_coefficient
4852
4853 This option enforces that the coefficients for variable and parameter
4854 dimensions in the calculated schedule are not larger than the specified value.
4855 This option can significantly increase the speed of the scheduling calculation
4856 and may also prevent fusing of unrelated dimensions. A value of -1 means that
4857 this option does not introduce bounds on the variable or parameter
4858 coefficients.
4859
4860 =item * schedule_max_constant_term
4861
4862 This option enforces that the constant coefficients in the calculated schedule
4863 are not larger than the maximal constant term. This option can significantly
4864 increase the speed of the scheduling calculation and may also prevent fusing of
4865 unrelated dimensions. A value of -1 means that this option does not introduce
4866 bounds on the constant coefficients.
4867
4868 =item * schedule_fuse
4869
4870 This option controls the level of fusion.
4871 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
4872 resulting schedule will be distributed as much as possible.
4873 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
4874 try to fuse loops in the resulting schedule.
4875
4876 =item * schedule_maximize_band_depth
4877
4878 If this option is set, we do not split bands at the point
4879 where we detect splitting is necessary. Instead, we
4880 backtrack and split bands as early as possible. This
4881 reduces the number of splits and maximizes the width of
4882 the bands. Wider bands give more possibilities for tiling.
4883 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
4884 then bands will be split as early as possible, even if there is no need.
4885 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
4886
4887 =item * schedule_outer_zero_distance
4888
4889 If this option is set, then we try to construct schedules
4890 where the outermost scheduling dimension in each band
4891 results in a zero dependence distance over the proximity
4892 dependences.
4893
4894 =item * schedule_split_scaled
4895
4896 If this option is set, then we try to construct schedules in which the
4897 constant term is split off from the linear part if the linear parts of
4898 the scheduling rows for all nodes in the graphs have a common non-trivial
4899 divisor.
4900 The constant term is then placed in a separate band and the linear
4901 part is reduced.
4902
4903 =item * schedule_algorithm
4904
4905 Selects the scheduling algorithm to be used.
4906 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
4907 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
4908
4909 =item * schedule_separate_components
4910
4911 If at any point the dependence graph contains any (weakly connected) components,
4912 then these components are scheduled separately.
4913 If this option is not set, then some iterations of the domains
4914 in these components may be scheduled together.
4915 If this option is set, then the components are given consecutive
4916 schedules.
4917
4918 =back
4919
4920 =head2 Parametric Vertex Enumeration
4921
4922 The parametric vertex enumeration described in this section
4923 is mainly intended to be used internally and by the C<barvinok>
4924 library.
4925
4926         #include <isl/vertices.h>
4927         __isl_give isl_vertices *isl_basic_set_compute_vertices(
4928                 __isl_keep isl_basic_set *bset);
4929
4930 The function C<isl_basic_set_compute_vertices> performs the
4931 actual computation of the parametric vertices and the chamber
4932 decomposition and store the result in an C<isl_vertices> object.
4933 This information can be queried by either iterating over all
4934 the vertices or iterating over all the chambers or cells
4935 and then iterating over all vertices that are active on the chamber.
4936
4937         int isl_vertices_foreach_vertex(
4938                 __isl_keep isl_vertices *vertices,
4939                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4940                 void *user);
4941
4942         int isl_vertices_foreach_cell(
4943                 __isl_keep isl_vertices *vertices,
4944                 int (*fn)(__isl_take isl_cell *cell, void *user),
4945                 void *user);
4946         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
4947                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4948                 void *user);
4949
4950 Other operations that can be performed on an C<isl_vertices> object are
4951 the following.
4952
4953         isl_ctx *isl_vertices_get_ctx(
4954                 __isl_keep isl_vertices *vertices);
4955         int isl_vertices_get_n_vertices(
4956                 __isl_keep isl_vertices *vertices);
4957         void isl_vertices_free(__isl_take isl_vertices *vertices);
4958
4959 Vertices can be inspected and destroyed using the following functions.
4960
4961         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
4962         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
4963         __isl_give isl_basic_set *isl_vertex_get_domain(
4964                 __isl_keep isl_vertex *vertex);
4965         __isl_give isl_basic_set *isl_vertex_get_expr(
4966                 __isl_keep isl_vertex *vertex);
4967         void isl_vertex_free(__isl_take isl_vertex *vertex);
4968
4969 C<isl_vertex_get_expr> returns a singleton parametric set describing
4970 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4971 of the vertex.
4972 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4973 B<rational> basic sets, so they should mainly be used for inspection
4974 and should not be mixed with integer sets.
4975
4976 Chambers can be inspected and destroyed using the following functions.
4977
4978         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4979         __isl_give isl_basic_set *isl_cell_get_domain(
4980                 __isl_keep isl_cell *cell);
4981         void isl_cell_free(__isl_take isl_cell *cell);
4982
4983 =head1 Applications
4984
4985 Although C<isl> is mainly meant to be used as a library,
4986 it also contains some basic applications that use some
4987 of the functionality of C<isl>.
4988 The input may be specified in either the L<isl format>
4989 or the L<PolyLib format>.
4990
4991 =head2 C<isl_polyhedron_sample>
4992
4993 C<isl_polyhedron_sample> takes a polyhedron as input and prints
4994 an integer element of the polyhedron, if there is any.
4995 The first column in the output is the denominator and is always
4996 equal to 1.  If the polyhedron contains no integer points,
4997 then a vector of length zero is printed.
4998
4999 =head2 C<isl_pip>
5000
5001 C<isl_pip> takes the same input as the C<example> program
5002 from the C<piplib> distribution, i.e., a set of constraints
5003 on the parameters, a line containing only -1 and finally a set
5004 of constraints on a parametric polyhedron.
5005 The coefficients of the parameters appear in the last columns
5006 (but before the final constant column).
5007 The output is the lexicographic minimum of the parametric polyhedron.
5008 As C<isl> currently does not have its own output format, the output
5009 is just a dump of the internal state.
5010
5011 =head2 C<isl_polyhedron_minimize>
5012
5013 C<isl_polyhedron_minimize> computes the minimum of some linear
5014 or affine objective function over the integer points in a polyhedron.
5015 If an affine objective function
5016 is given, then the constant should appear in the last column.
5017
5018 =head2 C<isl_polytope_scan>
5019
5020 Given a polytope, C<isl_polytope_scan> prints
5021 all integer points in the polytope.