add isl_pw_aff_var_on_domain
[isl.git] / doc / user.pod
blob8acb32be83c2200b100011d2e10b3b41221ac0bc
1 =head1 Introduction
3 C<isl> is a thread-safe C library for manipulating
4 sets and relations of integer points bounded by affine constraints.
5 The descriptions of the sets and relations may involve
6 both parameters and existentially quantified variables.
7 All computations are performed in exact integer arithmetic
8 using C<GMP>.
9 The C<isl> library offers functionality that is similar
10 to that offered by the C<Omega> and C<Omega+> libraries,
11 but the underlying algorithms are in most cases completely different.
13 The library is by no means complete and some fairly basic
14 functionality is still missing.
15 Still, even in its current form, the library has been successfully
16 used as a backend polyhedral library for the polyhedral
17 scanner C<CLooG> and as part of an equivalence checker of
18 static affine programs.
19 For bug reports, feature requests and questions,
20 visit the the discussion group at
21 L<http://groups.google.com/group/isl-development>.
23 =head2 Backward Incompatible Changes
25 =head3 Changes since isl-0.02
27 =over
29 =item * The old printing functions have been deprecated
30 and replaced by C<isl_printer> functions, see L<Input and Output>.
32 =item * Most functions related to dependence analysis have acquired
33 an extra C<must> argument.  To obtain the old behavior, this argument
34 should be given the value 1.  See L<Dependence Analysis>.
36 =back
38 =head3 Changes since isl-0.03
40 =over
42 =item * The function C<isl_pw_qpolynomial_fold_add> has been
43 renamed to C<isl_pw_qpolynomial_fold_fold>.
44 Similarly, C<isl_union_pw_qpolynomial_fold_add> has been
45 renamed to C<isl_union_pw_qpolynomial_fold_fold>.
47 =back
49 =head3 Changes since isl-0.04
51 =over
53 =item * All header files have been renamed from C<isl_header.h>
54 to C<isl/header.h>.
56 =back
58 =head3 Changes since isl-0.05
60 =over
62 =item * The functions C<isl_printer_print_basic_set> and
63 C<isl_printer_print_basic_map> no longer print a newline.
65 =item * The functions C<isl_flow_get_no_source>
66 and C<isl_union_map_compute_flow> now return
67 the accesses for which no source could be found instead of
68 the iterations where those accesses occur.
70 =item * The functions C<isl_basic_map_identity> and
71 C<isl_map_identity> now take a B<map> space as input.  An old call
72 C<isl_map_identity(space)> can be rewritten to
73 C<isl_map_identity(isl_space_map_from_set(space))>.
75 =item * The function C<isl_map_power> no longer takes
76 a parameter position as input.  Instead, the exponent
77 is now expressed as the domain of the resulting relation.
79 =back
81 =head3 Changes since isl-0.06
83 =over
85 =item * The format of C<isl_printer_print_qpolynomial>'s
86 C<ISL_FORMAT_ISL> output has changed.
87 Use C<ISL_FORMAT_C> to obtain the old output.
89 =item * The C<*_fast_*> functions have been renamed to C<*_plain_*>.
90 Some of the old names have been kept for backward compatibility,
91 but they will be removed in the future.
93 =back
95 =head3 Changes since isl-0.07
97 =over
99 =item * The function C<isl_pw_aff_max> has been renamed to
100 C<isl_pw_aff_union_max>.
101 Similarly, the function C<isl_pw_aff_add> has been renamed to
102 C<isl_pw_aff_union_add>.
104 =item * The C<isl_dim> type has been renamed to C<isl_space>
105 along with the associated functions.
106 Some of the old names have been kept for backward compatibility,
107 but they will be removed in the future.
109 =item * Spaces of maps, sets and parameter domains are now
110 treated differently.  The distinction between map spaces and set spaces
111 has always been made on a conceptual level, but proper use of such spaces
112 was never checked.  Furthermore, up until isl-0.07 there was no way
113 of explicitly creating a parameter space.  These can now be created
114 directly using C<isl_space_params_alloc> or from other spaces using
115 C<isl_space_params>.
117 =item * The space in which C<isl_aff>, C<isl_pw_aff>, C<isl_qpolynomial>,
118 C<isl_pw_qpolynomial>, C<isl_qpolynomial_fold> and C<isl_pw_qpolynomial_fold>
119 objects live is now a map space
120 instead of a set space.  This means, for example, that the dimensions
121 of the domain of an C<isl_aff> are now considered to be of type
122 C<isl_dim_in> instead of C<isl_dim_set>.  Extra functions have been
123 added to obtain the domain space.  Some of the constructors still
124 take a domain space and have therefore been renamed.
126 =item * The functions C<isl_equality_alloc> and C<isl_inequality_alloc>
127 now take an C<isl_local_space> instead of an C<isl_space>.
128 An C<isl_local_space> can be created from an C<isl_space>
129 using C<isl_local_space_from_space>.
131 =item * The C<isl_div> type has been removed.  Functions that used
132 to return an C<isl_div> now return an C<isl_aff>.
133 Note that the space of an C<isl_aff> is that of relation.
134 When replacing a call to C<isl_div_get_coefficient> by a call to
135 C<isl_aff_get_coefficient> any C<isl_dim_set> argument needs
136 to be replaced by C<isl_dim_in>.
137 A call to C<isl_aff_from_div> can be replaced by a call
138 to C<isl_aff_floor>.
139 A call to C<isl_qpolynomial_div(div)> call be replaced by
140 the nested call
142         isl_qpolynomial_from_aff(isl_aff_floor(div))
144 The function C<isl_constraint_div> has also been renamed
145 to C<isl_constraint_get_div>.
147 =item * The C<nparam> argument has been removed from
148 C<isl_map_read_from_str> and similar functions.
149 When reading input in the original PolyLib format,
150 the result will have no parameters.
151 If parameters are expected, the caller may want to perform
152 dimension manipulation on the result.
154 =back
156 =head3 Changes since isl-0.09
158 =over
160 =item * The C<schedule_split_parallel> option has been replaced
161 by the C<schedule_split_scaled> option.
163 =item * The first argument of C<isl_pw_aff_cond> is now
164 an C<isl_pw_aff> instead of an C<isl_set>.
165 A call C<isl_pw_aff_cond(a, b, c)> can be replaced by
167         isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
169 =back
171 =head3 Changes since isl-0.10
173 =over
175 =item * The functions C<isl_set_dim_has_lower_bound> and
176 C<isl_set_dim_has_upper_bound> have been renamed to
177 C<isl_set_dim_has_any_lower_bound> and
178 C<isl_set_dim_has_any_upper_bound>.
180 =back
182 =head1 License
184 C<isl> is released under the MIT license.
186 =over
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:
195 The above copyright notice and this permission notice shall be included in all
196 copies or substantial portions of the Software.
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.
206 =back
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.
212 =head1 Installation
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.
220 =head2 Installation from the git repository
222 =over
224 =item 1 Clone or update the repository
226 The first time the source is obtained, you need to clone
227 the repository.
229         git clone git://repo.or.cz/isl.git
231 To obtain updates, you need to pull in the latest changes
233         git pull
235 =item 2 Generate C<configure>
237         ./autogen.sh
239 =back
241 After performing the above steps, continue
242 with the L<Common installation instructions>.
244 =head2 Common installation instructions
246 =over
248 =item 1 Obtain C<GMP>
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/>.
256 =item 2 Configure
258 C<isl> uses the standard C<autoconf> C<configure> script.
259 To run it, just type
261         ./configure
263 optionally followed by some configure options.
264 A complete list of options can be obtained by running
266         ./configure --help
268 Below we discuss some of the more common options.
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>.
280 =over
282 =item C<--prefix>
284 Installation prefix for C<isl>
286 =item C<--with-gmp-prefix>
288 Installation prefix for C<GMP> (architecture-independent files).
290 =item C<--with-gmp-exec-prefix>
292 Installation prefix for C<GMP> (architecture-dependent files).
294 =item C<--with-piplib>
296 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
298 =item C<--with-piplib-prefix>
300 Installation prefix for C<system> C<piplib> (architecture-independent files).
302 =item C<--with-piplib-exec-prefix>
304 Installation prefix for C<system> C<piplib> (architecture-dependent files).
306 =item C<--with-piplib-builddir>
308 Location where C<build> C<piplib> was built.
310 =back
312 =item 3 Compile
314         make
316 =item 4 Install (optional)
318         make install
320 =back
322 =head1 Library
324 =head2 Initialization
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.
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.
341         isl_ctx *isl_ctx_alloc();
342         void isl_ctx_free(isl_ctx *ctx);
344 =head2 Integers
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.
365 =over
367 =item isl_int_init(i)
369 =item isl_int_clear(i)
371 =item isl_int_set(r,i)
373 =item isl_int_set_si(r,i)
375 =item isl_int_set_gmp(r,g)
377 =item isl_int_get_gmp(i,g)
379 =item isl_int_abs(r,i)
381 =item isl_int_neg(r,i)
383 =item isl_int_swap(i,j)
385 =item isl_int_swap_or_set(i,j)
387 =item isl_int_add_ui(r,i,j)
389 =item isl_int_sub_ui(r,i,j)
391 =item isl_int_add(r,i,j)
393 =item isl_int_sub(r,i,j)
395 =item isl_int_mul(r,i,j)
397 =item isl_int_mul_ui(r,i,j)
399 =item isl_int_addmul(r,i,j)
401 =item isl_int_submul(r,i,j)
403 =item isl_int_gcd(r,i,j)
405 =item isl_int_lcm(r,i,j)
407 =item isl_int_divexact(r,i,j)
409 =item isl_int_cdiv_q(r,i,j)
411 =item isl_int_fdiv_q(r,i,j)
413 =item isl_int_fdiv_r(r,i,j)
415 =item isl_int_fdiv_q_ui(r,i,j)
417 =item isl_int_read(r,s)
419 =item isl_int_print(out,i,width)
421 =item isl_int_sgn(i)
423 =item isl_int_cmp(i,j)
425 =item isl_int_cmp_si(i,si)
427 =item isl_int_eq(i,j)
429 =item isl_int_ne(i,j)
431 =item isl_int_lt(i,j)
433 =item isl_int_le(i,j)
435 =item isl_int_gt(i,j)
437 =item isl_int_ge(i,j)
439 =item isl_int_abs_eq(i,j)
441 =item isl_int_abs_ne(i,j)
443 =item isl_int_abs_lt(i,j)
445 =item isl_int_abs_gt(i,j)
447 =item isl_int_abs_ge(i,j)
449 =item isl_int_is_zero(i)
451 =item isl_int_is_one(i)
453 =item isl_int_is_negone(i)
455 =item isl_int_is_pos(i)
457 =item isl_int_is_neg(i)
459 =item isl_int_is_nonpos(i)
461 =item isl_int_is_nonneg(i)
463 =item isl_int_is_divisible_by(i,j)
465 =back
467 =head2 Sets and Relations
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.
485 =head2 Memory Management
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.
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
502 =over
504 =item C<__isl_give>
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.
515 =item C<__isl_take>
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.
528 =item C<__isl_keep>
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.
536 =back
538 =head2 Error Handling
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.
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.
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);
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.
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.
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.
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);
581 =head2 Identifiers
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.
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);
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);
606         __isl_give isl_printer *isl_printer_print_id(
607                 __isl_take isl_printer *p, __isl_keep isl_id *id);
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.
613 =head2 Spaces
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.
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);
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>.
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:
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);
666 Spaces can be compared using the following functions:
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);
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.
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.
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);
693         #include <isl/union_set.h>
694         __isl_give isl_space *isl_union_set_get_space(
695                 __isl_keep isl_union_set *uset);
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);
702         #include <isl/union_map.h>
703         __isl_give isl_space *isl_union_map_get_space(
704                 __isl_keep isl_union_map *umap);
706         #include <isl/constraint.h>
707         __isl_give isl_space *isl_constraint_get_space(
708                 __isl_keep isl_constraint *constraint);
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);
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);
750         #include <isl/point.h>
751         __isl_give isl_space *isl_point_get_space(
752                 __isl_keep isl_point *pnt);
754 The identifiers or names of the individual dimensions may be set or read off
755 using the following functions.
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);
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.
789 Given the identifier or name of a dimension (typically a parameter),
790 its position can be obtained from the following function.
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);
798 The identifiers or names of entire spaces may be set or read off
799 using the following functions.
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);
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.
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.
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);
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.
842 Spaces can be created from other spaces
843 using the following functions.
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);
879 Note that if dimensions are added or removed from a space, then
880 the name and the internal structure are lost.
882 =head2 Local Spaces
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.
889         #include <isl/constraint.h>
890         __isl_give isl_local_space *isl_constraint_get_local_space(
891                 __isl_keep isl_constraint *constraint);
893         #include <isl/set.h>
894         __isl_give isl_local_space *isl_basic_set_get_local_space(
895                 __isl_keep isl_basic_set *bset);
897         #include <isl/map.h>
898         __isl_give isl_local_space *isl_basic_map_get_local_space(
899                 __isl_keep isl_basic_map *bmap);
901 A new local space can be created from a space using
903         #include <isl/local_space.h>
904         __isl_give isl_local_space *isl_local_space_from_space(
905                 __isl_take isl_space *space);
907 They can be inspected, modified, copied and freed using the following functions.
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);
942 Two local spaces can be compared using
944         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
945                 __isl_keep isl_local_space *ls2);
947 Local spaces can be created from other local spaces
948 using the following functions.
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);
969 =head2 Input and Output
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.
975 =head3 C<isl> format
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
984         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
985                                 i - 10 a <= 6) }
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>.
993 =head3 C<PolyLib> format
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.
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.
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.
1014 =head3 Extended C<PolyLib> format
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.
1027 =head3 Input
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);
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);
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);
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);
1061 The input format is autodetected and may be either the C<PolyLib> format
1062 or the C<isl> format.
1064 =head3 Output
1066 Before anything can be printed, an C<isl_printer> needs to
1067 be created.
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);
1076 The printer can be inspected using the following functions.
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);
1083 The behavior of the printer can be modified in various ways
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);
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).
1109 To actually print something, use
1111         #include <isl/printer.h>
1112         __isl_give isl_printer *isl_printer_print_double(
1113                 __isl_take isl_printer *p, double d);
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);
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);
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);
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);
1141 When called on a file printer, the following function flushes
1142 the file.  When called on a string printer, the buffer is cleared.
1144         __isl_give isl_printer *isl_printer_flush(
1145                 __isl_take isl_printer *p);
1147 =head2 Creating New Sets and Relations
1149 C<isl> has functions for creating some standard sets and relations.
1151 =over
1153 =item * Empty sets and relations
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);
1168 For C<isl_union_set>s and C<isl_union_map>s, the space
1169 is only used to specify the parameters.
1171 =item * Universe sets and relations
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);
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.
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);
1199 =item * Identity relations
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);
1206 The number of input and output dimensions in C<space> needs
1207 to be the same.
1209 =item * Lexicographic order
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);
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.
1241 =back
1243 A basic set or relation can be converted to a set or relation
1244 using the following functions.
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);
1251 Sets and relations can be converted to union sets and relations
1252 using the following functions.
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);
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.
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);
1272 A zero-dimensional set can be constructed on a given parameter domain
1273 using the following function.
1275         __isl_give isl_set *isl_set_from_params(
1276                 __isl_take isl_set *set);
1278 Sets and relations can be copied and freed again using the following
1279 functions.
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);
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.
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);
1337 For example, to create a set containing the even integers
1338 between 10 and 42, you would use the following code.
1340         isl_space *space;
1341         isl_local_space *ls;
1342         isl_constraint *c;
1343         isl_basic_set *bset;
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);
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);
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);
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);
1364         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1366 Or, alternatively,
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)}");
1372 A basic set or relation can also be constructed from two matrices
1373 describing the equalities and the inequalities.
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);
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.
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">).
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);
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.
1428 =head2 Inspecting Sets and Relations
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.
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);
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.
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);
1462 Alternatively, the existentially quantified variables can be removed
1463 using the following functions, which compute an overapproximation.
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);
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.
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);
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);
1503 To iterate over all the sets or maps in a union set or map, use
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);
1512 The number of sets or maps in a union set or map can be obtained
1513 from
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);
1518 To extract the set or map in a given space from a union, use
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);
1527 To iterate over all the basic sets or maps in a set or map, use
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);
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.
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.
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);
1550 The number of basic sets in a set can be obtained
1551 from
1553         int isl_set_n_basic_set(__isl_keep isl_set *set);
1555 To iterate over the constraints of a basic set or map, use
1557         #include <isl/constraint.h>
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);
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.
1578         int isl_constraint_is_equality(
1579                 __isl_keep isl_constraint *constraint);
1581 The coefficients of the constraints can be inspected using
1582 the following functions.
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);
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">.
1609         __isl_give isl_aff *isl_constraint_get_div(
1610                 __isl_keep isl_constraint *constraint, int pos);
1612 To obtain the constraints of a basic set or map in matrix
1613 form, use the following functions.
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);
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>.
1639 The number of parameters, input, output or set dimensions can
1640 be obtained using the following functions.
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);
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.
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);
1666 Similarly, the following functions can be used to check whether
1667 a given dimension is involved in any lower or upper bound.
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);
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.
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);
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);
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.
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);
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);
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);
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.
1775 =head2 Properties
1777 =head3 Unary Properties
1779 =over
1781 =item * Emptiness
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.
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);
1799 =item * Universality
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);
1805 =item * Single-valuedness
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);
1814 =item * Injectivity
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);
1823 =item * Bijectivity
1825         int isl_map_is_bijective(__isl_keep isl_map *map);
1826         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1828 =item * Position
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);
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>.
1844 =item * Space
1846 To check whether a set is a parameter domain, use this function:
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);
1852 =item * Wrapping
1854 The following functions check whether the domain of the given
1855 (basic) set is a wrapped relation.
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);
1861 =item * Internal Product
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);
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.
1871 =item * Currying
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);
1877 Check whether the domain of the (basic) relation is a wrapped relation.
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);
1883 Check whether the range of the (basic) relation is a wrapped relation.
1885 =back
1887 =head3 Binary Properties
1889 =over
1891 =item * Equality
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);
1911 =item * Disjointness
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);
1920 =item * Subset
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);
1955 Check whether the first argument is a (strict) subset of the
1956 second argument.
1958 =item * Order
1960         int isl_set_plain_cmp(__isl_keep isl_set *set1,
1961                 __isl_keep isl_set *set2);
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>.
1969 =back
1971 =head2 Unary Operations
1973 =over
1975 =item * Complement
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);
1982 =item * Inverse map
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);
1991 =item * Projection
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);
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);
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.
2038 =item * Elimination
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);
2055 Eliminate the coefficients for the given dimensions from the constraints,
2056 without removing the dimensions.
2058 =item * Slicing
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);
2081 Intersect the set or relation with the hyperplane where the given
2082 dimension has the fixed given value.
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);
2111 Intersect the set or relation with the half-space where the given
2112 dimension has a value bounded by the fixed given value.
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);
2125 Intersect the set or relation with the hyperplane where the given
2126 dimensions are equal to each other.
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);
2132 Intersect the relation with the hyperplane where the given
2133 dimensions have opposite values.
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);
2146 Intersect the relation with the half-space where the given
2147 dimensions satisfy the given ordering.
2149 =item * Identity
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);
2156 Construct an identity relation on the given (union) set.
2158 =item * Deltas
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);
2166 These functions return a (basic) set containing the differences
2167 between image elements and corresponding domain elements in the input.
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);
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.
2179 =item * Coalescing
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.
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);
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.
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);
2203 =item * Detecting equalities
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);
2218 Simplify the representation of a set or relation by detecting implicit
2219 equalities.
2221 =item * Removing redundant constraints
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);
2232 =item * Convex hull
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);
2239 If the input set or relation has any existentially quantified
2240 variables, then the result of these operations is currently undefined.
2242 =item * Simple hull
2244         __isl_give isl_basic_set *
2245         isl_set_unshifted_simple_hull(
2246                 __isl_take isl_set *set);
2247         __isl_give isl_basic_map *
2248         isl_map_unshifted_simple_hull(
2249                 __isl_take isl_map *map);
2250         __isl_give isl_basic_set *isl_set_simple_hull(
2251                 __isl_take isl_set *set);
2252         __isl_give isl_basic_map *isl_map_simple_hull(
2253                 __isl_take isl_map *map);
2254         __isl_give isl_union_map *isl_union_map_simple_hull(
2255                 __isl_take isl_union_map *umap);
2257 These functions compute a single basic set or relation
2258 that contains the whole input set or relation.
2259 In particular, the output is described by translates
2260 of the constraints describing the basic sets or relations in the input.
2261 In case of C<isl_set_unshifted_simple_hull>, only the original
2262 constraints are used, without any translation.
2264 =begin latex
2266 (See \autoref{s:simple hull}.)
2268 =end latex
2270 =item * Affine hull
2272         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2273                 __isl_take isl_basic_set *bset);
2274         __isl_give isl_basic_set *isl_set_affine_hull(
2275                 __isl_take isl_set *set);
2276         __isl_give isl_union_set *isl_union_set_affine_hull(
2277                 __isl_take isl_union_set *uset);
2278         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2279                 __isl_take isl_basic_map *bmap);
2280         __isl_give isl_basic_map *isl_map_affine_hull(
2281                 __isl_take isl_map *map);
2282         __isl_give isl_union_map *isl_union_map_affine_hull(
2283                 __isl_take isl_union_map *umap);
2285 In case of union sets and relations, the affine hull is computed
2286 per space.
2288 =item * Polyhedral hull
2290         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2291                 __isl_take isl_set *set);
2292         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2293                 __isl_take isl_map *map);
2294         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2295                 __isl_take isl_union_set *uset);
2296         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2297                 __isl_take isl_union_map *umap);
2299 These functions compute a single basic set or relation
2300 not involving any existentially quantified variables
2301 that contains the whole input set or relation.
2302 In case of union sets and relations, the polyhedral hull is computed
2303 per space.
2305 =item * Other approximations
2307         __isl_give isl_basic_set *
2308         isl_basic_set_drop_constraints_involving_dims(
2309                 __isl_take isl_basic_set *bset,
2310                 enum isl_dim_type type,
2311                 unsigned first, unsigned n);
2312         __isl_give isl_basic_set *
2313         isl_basic_set_drop_constraints_not_involving_dims(
2314                 __isl_take isl_basic_set *bset,
2315                 enum isl_dim_type type,
2316                 unsigned first, unsigned n);
2317         __isl_give isl_set *
2318         isl_set_drop_constraints_involving_dims(
2319                 __isl_take isl_set *set,
2320                 enum isl_dim_type type,
2321                 unsigned first, unsigned n);
2322         __isl_give isl_map *
2323         isl_map_drop_constraints_involving_dims(
2324                 __isl_take isl_map *map,
2325                 enum isl_dim_type type,
2326                 unsigned first, unsigned n);
2328 These functions drop any constraints (not) involving the specified dimensions.
2329 Note that the result depends on the representation of the input.
2331 =item * Feasibility
2333         __isl_give isl_basic_set *isl_basic_set_sample(
2334                 __isl_take isl_basic_set *bset);
2335         __isl_give isl_basic_set *isl_set_sample(
2336                 __isl_take isl_set *set);
2337         __isl_give isl_basic_map *isl_basic_map_sample(
2338                 __isl_take isl_basic_map *bmap);
2339         __isl_give isl_basic_map *isl_map_sample(
2340                 __isl_take isl_map *map);
2342 If the input (basic) set or relation is non-empty, then return
2343 a singleton subset of the input.  Otherwise, return an empty set.
2345 =item * Optimization
2347         #include <isl/ilp.h>
2348         enum isl_lp_result isl_basic_set_max(
2349                 __isl_keep isl_basic_set *bset,
2350                 __isl_keep isl_aff *obj, isl_int *opt)
2351         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2352                 __isl_keep isl_aff *obj, isl_int *opt);
2353         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2354                 __isl_keep isl_aff *obj, isl_int *opt);
2356 Compute the minimum or maximum of the integer affine expression C<obj>
2357 over the points in C<set>, returning the result in C<opt>.
2358 The return value may be one of C<isl_lp_error>,
2359 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2361 =item * Parametric optimization
2363         __isl_give isl_pw_aff *isl_set_dim_min(
2364                 __isl_take isl_set *set, int pos);
2365         __isl_give isl_pw_aff *isl_set_dim_max(
2366                 __isl_take isl_set *set, int pos);
2367         __isl_give isl_pw_aff *isl_map_dim_max(
2368                 __isl_take isl_map *map, int pos);
2370 Compute the minimum or maximum of the given set or output dimension
2371 as a function of the parameters (and input dimensions), but independently
2372 of the other set or output dimensions.
2373 For lexicographic optimization, see L<"Lexicographic Optimization">.
2375 =item * Dual
2377 The following functions compute either the set of (rational) coefficient
2378 values of valid constraints for the given set or the set of (rational)
2379 values satisfying the constraints with coefficients from the given set.
2380 Internally, these two sets of functions perform essentially the
2381 same operations, except that the set of coefficients is assumed to
2382 be a cone, while the set of values may be any polyhedron.
2383 The current implementation is based on the Farkas lemma and
2384 Fourier-Motzkin elimination, but this may change or be made optional
2385 in future.  In particular, future implementations may use different
2386 dualization algorithms or skip the elimination step.
2388         __isl_give isl_basic_set *isl_basic_set_coefficients(
2389                 __isl_take isl_basic_set *bset);
2390         __isl_give isl_basic_set *isl_set_coefficients(
2391                 __isl_take isl_set *set);
2392         __isl_give isl_union_set *isl_union_set_coefficients(
2393                 __isl_take isl_union_set *bset);
2394         __isl_give isl_basic_set *isl_basic_set_solutions(
2395                 __isl_take isl_basic_set *bset);
2396         __isl_give isl_basic_set *isl_set_solutions(
2397                 __isl_take isl_set *set);
2398         __isl_give isl_union_set *isl_union_set_solutions(
2399                 __isl_take isl_union_set *bset);
2401 =item * Power
2403         __isl_give isl_map *isl_map_fixed_power(
2404                 __isl_take isl_map *map, isl_int exp);
2405         __isl_give isl_union_map *isl_union_map_fixed_power(
2406                 __isl_take isl_union_map *umap, isl_int exp);
2408 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2409 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2410 of C<map> is computed.
2412         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2413                 int *exact);
2414         __isl_give isl_union_map *isl_union_map_power(
2415                 __isl_take isl_union_map *umap, int *exact);
2417 Compute a parametric representation for all positive powers I<k> of C<map>.
2418 The result maps I<k> to a nested relation corresponding to the
2419 I<k>th power of C<map>.
2420 The result may be an overapproximation.  If the result is known to be exact,
2421 then C<*exact> is set to C<1>.
2423 =item * Transitive closure
2425         __isl_give isl_map *isl_map_transitive_closure(
2426                 __isl_take isl_map *map, int *exact);
2427         __isl_give isl_union_map *isl_union_map_transitive_closure(
2428                 __isl_take isl_union_map *umap, int *exact);
2430 Compute the transitive closure of C<map>.
2431 The result may be an overapproximation.  If the result is known to be exact,
2432 then C<*exact> is set to C<1>.
2434 =item * Reaching path lengths
2436         __isl_give isl_map *isl_map_reaching_path_lengths(
2437                 __isl_take isl_map *map, int *exact);
2439 Compute a relation that maps each element in the range of C<map>
2440 to the lengths of all paths composed of edges in C<map> that
2441 end up in the given element.
2442 The result may be an overapproximation.  If the result is known to be exact,
2443 then C<*exact> is set to C<1>.
2444 To compute the I<maximal> path length, the resulting relation
2445 should be postprocessed by C<isl_map_lexmax>.
2446 In particular, if the input relation is a dependence relation
2447 (mapping sources to sinks), then the maximal path length corresponds
2448 to the free schedule.
2449 Note, however, that C<isl_map_lexmax> expects the maximum to be
2450 finite, so if the path lengths are unbounded (possibly due to
2451 the overapproximation), then you will get an error message.
2453 =item * Wrapping
2455         __isl_give isl_basic_set *isl_basic_map_wrap(
2456                 __isl_take isl_basic_map *bmap);
2457         __isl_give isl_set *isl_map_wrap(
2458                 __isl_take isl_map *map);
2459         __isl_give isl_union_set *isl_union_map_wrap(
2460                 __isl_take isl_union_map *umap);
2461         __isl_give isl_basic_map *isl_basic_set_unwrap(
2462                 __isl_take isl_basic_set *bset);
2463         __isl_give isl_map *isl_set_unwrap(
2464                 __isl_take isl_set *set);
2465         __isl_give isl_union_map *isl_union_set_unwrap(
2466                 __isl_take isl_union_set *uset);
2468 =item * Flattening
2470 Remove any internal structure of domain (and range) of the given
2471 set or relation.  If there is any such internal structure in the input,
2472 then the name of the space is also removed.
2474         __isl_give isl_basic_set *isl_basic_set_flatten(
2475                 __isl_take isl_basic_set *bset);
2476         __isl_give isl_set *isl_set_flatten(
2477                 __isl_take isl_set *set);
2478         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2479                 __isl_take isl_basic_map *bmap);
2480         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2481                 __isl_take isl_basic_map *bmap);
2482         __isl_give isl_map *isl_map_flatten_range(
2483                 __isl_take isl_map *map);
2484         __isl_give isl_map *isl_map_flatten_domain(
2485                 __isl_take isl_map *map);
2486         __isl_give isl_basic_map *isl_basic_map_flatten(
2487                 __isl_take isl_basic_map *bmap);
2488         __isl_give isl_map *isl_map_flatten(
2489                 __isl_take isl_map *map);
2491         __isl_give isl_map *isl_set_flatten_map(
2492                 __isl_take isl_set *set);
2494 The function above constructs a relation
2495 that maps the input set to a flattened version of the set.
2497 =item * Lifting
2499 Lift the input set to a space with extra dimensions corresponding
2500 to the existentially quantified variables in the input.
2501 In particular, the result lives in a wrapped map where the domain
2502 is the original space and the range corresponds to the original
2503 existentially quantified variables.
2505         __isl_give isl_basic_set *isl_basic_set_lift(
2506                 __isl_take isl_basic_set *bset);
2507         __isl_give isl_set *isl_set_lift(
2508                 __isl_take isl_set *set);
2509         __isl_give isl_union_set *isl_union_set_lift(
2510                 __isl_take isl_union_set *uset);
2512 Given a local space that contains the existentially quantified
2513 variables of a set, a basic relation that, when applied to
2514 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2515 can be constructed using the following function.
2517         #include <isl/local_space.h>
2518         __isl_give isl_basic_map *isl_local_space_lifting(
2519                 __isl_take isl_local_space *ls);
2521 =item * Internal Product
2523         __isl_give isl_basic_map *isl_basic_map_zip(
2524                 __isl_take isl_basic_map *bmap);
2525         __isl_give isl_map *isl_map_zip(
2526                 __isl_take isl_map *map);
2527         __isl_give isl_union_map *isl_union_map_zip(
2528                 __isl_take isl_union_map *umap);
2530 Given a relation with nested relations for domain and range,
2531 interchange the range of the domain with the domain of the range.
2533 =item * Currying
2535         __isl_give isl_basic_map *isl_basic_map_curry(
2536                 __isl_take isl_basic_map *bmap);
2537         __isl_give isl_basic_map *isl_basic_map_uncurry(
2538                 __isl_take isl_basic_map *bmap);
2539         __isl_give isl_map *isl_map_curry(
2540                 __isl_take isl_map *map);
2541         __isl_give isl_map *isl_map_uncurry(
2542                 __isl_take isl_map *map);
2543         __isl_give isl_union_map *isl_union_map_curry(
2544                 __isl_take isl_union_map *umap);
2546 Given a relation with a nested relation for domain,
2547 the C<curry> functions
2548 move the range of the nested relation out of the domain
2549 and use it as the domain of a nested relation in the range,
2550 with the original range as range of this nested relation.
2551 The C<uncurry> functions perform the inverse operation.
2553 =item * Aligning parameters
2555         __isl_give isl_basic_set *isl_basic_set_align_params(
2556                 __isl_take isl_basic_set *bset,
2557                 __isl_take isl_space *model);
2558         __isl_give isl_set *isl_set_align_params(
2559                 __isl_take isl_set *set,
2560                 __isl_take isl_space *model);
2561         __isl_give isl_basic_map *isl_basic_map_align_params(
2562                 __isl_take isl_basic_map *bmap,
2563                 __isl_take isl_space *model);
2564         __isl_give isl_map *isl_map_align_params(
2565                 __isl_take isl_map *map,
2566                 __isl_take isl_space *model);
2568 Change the order of the parameters of the given set or relation
2569 such that the first parameters match those of C<model>.
2570 This may involve the introduction of extra parameters.
2571 All parameters need to be named.
2573 =item * Dimension manipulation
2575         __isl_give isl_set *isl_set_add_dims(
2576                 __isl_take isl_set *set,
2577                 enum isl_dim_type type, unsigned n);
2578         __isl_give isl_map *isl_map_add_dims(
2579                 __isl_take isl_map *map,
2580                 enum isl_dim_type type, unsigned n);
2581         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2582                 __isl_take isl_basic_set *bset,
2583                 enum isl_dim_type type, unsigned pos,
2584                 unsigned n);
2585         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2586                 __isl_take isl_basic_map *bmap,
2587                 enum isl_dim_type type, unsigned pos,
2588                 unsigned n);
2589         __isl_give isl_set *isl_set_insert_dims(
2590                 __isl_take isl_set *set,
2591                 enum isl_dim_type type, unsigned pos, unsigned n);
2592         __isl_give isl_map *isl_map_insert_dims(
2593                 __isl_take isl_map *map,
2594                 enum isl_dim_type type, unsigned pos, unsigned n);
2595         __isl_give isl_basic_set *isl_basic_set_move_dims(
2596                 __isl_take isl_basic_set *bset,
2597                 enum isl_dim_type dst_type, unsigned dst_pos,
2598                 enum isl_dim_type src_type, unsigned src_pos,
2599                 unsigned n);
2600         __isl_give isl_basic_map *isl_basic_map_move_dims(
2601                 __isl_take isl_basic_map *bmap,
2602                 enum isl_dim_type dst_type, unsigned dst_pos,
2603                 enum isl_dim_type src_type, unsigned src_pos,
2604                 unsigned n);
2605         __isl_give isl_set *isl_set_move_dims(
2606                 __isl_take isl_set *set,
2607                 enum isl_dim_type dst_type, unsigned dst_pos,
2608                 enum isl_dim_type src_type, unsigned src_pos,
2609                 unsigned n);
2610         __isl_give isl_map *isl_map_move_dims(
2611                 __isl_take isl_map *map,
2612                 enum isl_dim_type dst_type, unsigned dst_pos,
2613                 enum isl_dim_type src_type, unsigned src_pos,
2614                 unsigned n);
2616 It is usually not advisable to directly change the (input or output)
2617 space of a set or a relation as this removes the name and the internal
2618 structure of the space.  However, the above functions can be useful
2619 to add new parameters, assuming
2620 C<isl_set_align_params> and C<isl_map_align_params>
2621 are not sufficient.
2623 =back
2625 =head2 Binary Operations
2627 The two arguments of a binary operation not only need to live
2628 in the same C<isl_ctx>, they currently also need to have
2629 the same (number of) parameters.
2631 =head3 Basic Operations
2633 =over
2635 =item * Intersection
2637         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2638                 __isl_take isl_basic_set *bset1,
2639                 __isl_take isl_basic_set *bset2);
2640         __isl_give isl_basic_set *isl_basic_set_intersect(
2641                 __isl_take isl_basic_set *bset1,
2642                 __isl_take isl_basic_set *bset2);
2643         __isl_give isl_set *isl_set_intersect_params(
2644                 __isl_take isl_set *set,
2645                 __isl_take isl_set *params);
2646         __isl_give isl_set *isl_set_intersect(
2647                 __isl_take isl_set *set1,
2648                 __isl_take isl_set *set2);
2649         __isl_give isl_union_set *isl_union_set_intersect_params(
2650                 __isl_take isl_union_set *uset,
2651                 __isl_take isl_set *set);
2652         __isl_give isl_union_map *isl_union_map_intersect_params(
2653                 __isl_take isl_union_map *umap,
2654                 __isl_take isl_set *set);
2655         __isl_give isl_union_set *isl_union_set_intersect(
2656                 __isl_take isl_union_set *uset1,
2657                 __isl_take isl_union_set *uset2);
2658         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2659                 __isl_take isl_basic_map *bmap,
2660                 __isl_take isl_basic_set *bset);
2661         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2662                 __isl_take isl_basic_map *bmap,
2663                 __isl_take isl_basic_set *bset);
2664         __isl_give isl_basic_map *isl_basic_map_intersect(
2665                 __isl_take isl_basic_map *bmap1,
2666                 __isl_take isl_basic_map *bmap2);
2667         __isl_give isl_map *isl_map_intersect_params(
2668                 __isl_take isl_map *map,
2669                 __isl_take isl_set *params);
2670         __isl_give isl_map *isl_map_intersect_domain(
2671                 __isl_take isl_map *map,
2672                 __isl_take isl_set *set);
2673         __isl_give isl_map *isl_map_intersect_range(
2674                 __isl_take isl_map *map,
2675                 __isl_take isl_set *set);
2676         __isl_give isl_map *isl_map_intersect(
2677                 __isl_take isl_map *map1,
2678                 __isl_take isl_map *map2);
2679         __isl_give isl_union_map *isl_union_map_intersect_domain(
2680                 __isl_take isl_union_map *umap,
2681                 __isl_take isl_union_set *uset);
2682         __isl_give isl_union_map *isl_union_map_intersect_range(
2683                 __isl_take isl_union_map *umap,
2684                 __isl_take isl_union_set *uset);
2685         __isl_give isl_union_map *isl_union_map_intersect(
2686                 __isl_take isl_union_map *umap1,
2687                 __isl_take isl_union_map *umap2);
2689 The second argument to the C<_params> functions needs to be
2690 a parametric (basic) set.  For the other functions, a parametric set
2691 for either argument is only allowed if the other argument is
2692 a parametric set as well.
2694 =item * Union
2696         __isl_give isl_set *isl_basic_set_union(
2697                 __isl_take isl_basic_set *bset1,
2698                 __isl_take isl_basic_set *bset2);
2699         __isl_give isl_map *isl_basic_map_union(
2700                 __isl_take isl_basic_map *bmap1,
2701                 __isl_take isl_basic_map *bmap2);
2702         __isl_give isl_set *isl_set_union(
2703                 __isl_take isl_set *set1,
2704                 __isl_take isl_set *set2);
2705         __isl_give isl_map *isl_map_union(
2706                 __isl_take isl_map *map1,
2707                 __isl_take isl_map *map2);
2708         __isl_give isl_union_set *isl_union_set_union(
2709                 __isl_take isl_union_set *uset1,
2710                 __isl_take isl_union_set *uset2);
2711         __isl_give isl_union_map *isl_union_map_union(
2712                 __isl_take isl_union_map *umap1,
2713                 __isl_take isl_union_map *umap2);
2715 =item * Set difference
2717         __isl_give isl_set *isl_set_subtract(
2718                 __isl_take isl_set *set1,
2719                 __isl_take isl_set *set2);
2720         __isl_give isl_map *isl_map_subtract(
2721                 __isl_take isl_map *map1,
2722                 __isl_take isl_map *map2);
2723         __isl_give isl_map *isl_map_subtract_domain(
2724                 __isl_take isl_map *map,
2725                 __isl_take isl_set *dom);
2726         __isl_give isl_map *isl_map_subtract_range(
2727                 __isl_take isl_map *map,
2728                 __isl_take isl_set *dom);
2729         __isl_give isl_union_set *isl_union_set_subtract(
2730                 __isl_take isl_union_set *uset1,
2731                 __isl_take isl_union_set *uset2);
2732         __isl_give isl_union_map *isl_union_map_subtract(
2733                 __isl_take isl_union_map *umap1,
2734                 __isl_take isl_union_map *umap2);
2735         __isl_give isl_union_map *isl_union_map_subtract_domain(
2736                 __isl_take isl_union_map *umap,
2737                 __isl_take isl_union_set *dom);
2738         __isl_give isl_union_map *isl_union_map_subtract_range(
2739                 __isl_take isl_union_map *umap,
2740                 __isl_take isl_union_set *dom);
2742 =item * Application
2744         __isl_give isl_basic_set *isl_basic_set_apply(
2745                 __isl_take isl_basic_set *bset,
2746                 __isl_take isl_basic_map *bmap);
2747         __isl_give isl_set *isl_set_apply(
2748                 __isl_take isl_set *set,
2749                 __isl_take isl_map *map);
2750         __isl_give isl_union_set *isl_union_set_apply(
2751                 __isl_take isl_union_set *uset,
2752                 __isl_take isl_union_map *umap);
2753         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2754                 __isl_take isl_basic_map *bmap1,
2755                 __isl_take isl_basic_map *bmap2);
2756         __isl_give isl_basic_map *isl_basic_map_apply_range(
2757                 __isl_take isl_basic_map *bmap1,
2758                 __isl_take isl_basic_map *bmap2);
2759         __isl_give isl_map *isl_map_apply_domain(
2760                 __isl_take isl_map *map1,
2761                 __isl_take isl_map *map2);
2762         __isl_give isl_union_map *isl_union_map_apply_domain(
2763                 __isl_take isl_union_map *umap1,
2764                 __isl_take isl_union_map *umap2);
2765         __isl_give isl_map *isl_map_apply_range(
2766                 __isl_take isl_map *map1,
2767                 __isl_take isl_map *map2);
2768         __isl_give isl_union_map *isl_union_map_apply_range(
2769                 __isl_take isl_union_map *umap1,
2770                 __isl_take isl_union_map *umap2);
2772 =item * Cartesian Product
2774         __isl_give isl_set *isl_set_product(
2775                 __isl_take isl_set *set1,
2776                 __isl_take isl_set *set2);
2777         __isl_give isl_union_set *isl_union_set_product(
2778                 __isl_take isl_union_set *uset1,
2779                 __isl_take isl_union_set *uset2);
2780         __isl_give isl_basic_map *isl_basic_map_domain_product(
2781                 __isl_take isl_basic_map *bmap1,
2782                 __isl_take isl_basic_map *bmap2);
2783         __isl_give isl_basic_map *isl_basic_map_range_product(
2784                 __isl_take isl_basic_map *bmap1,
2785                 __isl_take isl_basic_map *bmap2);
2786         __isl_give isl_basic_map *isl_basic_map_product(
2787                 __isl_take isl_basic_map *bmap1,
2788                 __isl_take isl_basic_map *bmap2);
2789         __isl_give isl_map *isl_map_domain_product(
2790                 __isl_take isl_map *map1,
2791                 __isl_take isl_map *map2);
2792         __isl_give isl_map *isl_map_range_product(
2793                 __isl_take isl_map *map1,
2794                 __isl_take isl_map *map2);
2795         __isl_give isl_union_map *isl_union_map_domain_product(
2796                 __isl_take isl_union_map *umap1,
2797                 __isl_take isl_union_map *umap2);
2798         __isl_give isl_union_map *isl_union_map_range_product(
2799                 __isl_take isl_union_map *umap1,
2800                 __isl_take isl_union_map *umap2);
2801         __isl_give isl_map *isl_map_product(
2802                 __isl_take isl_map *map1,
2803                 __isl_take isl_map *map2);
2804         __isl_give isl_union_map *isl_union_map_product(
2805                 __isl_take isl_union_map *umap1,
2806                 __isl_take isl_union_map *umap2);
2808 The above functions compute the cross product of the given
2809 sets or relations.  The domains and ranges of the results
2810 are wrapped maps between domains and ranges of the inputs.
2811 To obtain a ``flat'' product, use the following functions
2812 instead.
2814         __isl_give isl_basic_set *isl_basic_set_flat_product(
2815                 __isl_take isl_basic_set *bset1,
2816                 __isl_take isl_basic_set *bset2);
2817         __isl_give isl_set *isl_set_flat_product(
2818                 __isl_take isl_set *set1,
2819                 __isl_take isl_set *set2);
2820         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2821                 __isl_take isl_basic_map *bmap1,
2822                 __isl_take isl_basic_map *bmap2);
2823         __isl_give isl_map *isl_map_flat_domain_product(
2824                 __isl_take isl_map *map1,
2825                 __isl_take isl_map *map2);
2826         __isl_give isl_map *isl_map_flat_range_product(
2827                 __isl_take isl_map *map1,
2828                 __isl_take isl_map *map2);
2829         __isl_give isl_union_map *isl_union_map_flat_range_product(
2830                 __isl_take isl_union_map *umap1,
2831                 __isl_take isl_union_map *umap2);
2832         __isl_give isl_basic_map *isl_basic_map_flat_product(
2833                 __isl_take isl_basic_map *bmap1,
2834                 __isl_take isl_basic_map *bmap2);
2835         __isl_give isl_map *isl_map_flat_product(
2836                 __isl_take isl_map *map1,
2837                 __isl_take isl_map *map2);
2839 =item * Simplification
2841         __isl_give isl_basic_set *isl_basic_set_gist(
2842                 __isl_take isl_basic_set *bset,
2843                 __isl_take isl_basic_set *context);
2844         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2845                 __isl_take isl_set *context);
2846         __isl_give isl_set *isl_set_gist_params(
2847                 __isl_take isl_set *set,
2848                 __isl_take isl_set *context);
2849         __isl_give isl_union_set *isl_union_set_gist(
2850                 __isl_take isl_union_set *uset,
2851                 __isl_take isl_union_set *context);
2852         __isl_give isl_union_set *isl_union_set_gist_params(
2853                 __isl_take isl_union_set *uset,
2854                 __isl_take isl_set *set);
2855         __isl_give isl_basic_map *isl_basic_map_gist(
2856                 __isl_take isl_basic_map *bmap,
2857                 __isl_take isl_basic_map *context);
2858         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2859                 __isl_take isl_map *context);
2860         __isl_give isl_map *isl_map_gist_params(
2861                 __isl_take isl_map *map,
2862                 __isl_take isl_set *context);
2863         __isl_give isl_map *isl_map_gist_domain(
2864                 __isl_take isl_map *map,
2865                 __isl_take isl_set *context);
2866         __isl_give isl_map *isl_map_gist_range(
2867                 __isl_take isl_map *map,
2868                 __isl_take isl_set *context);
2869         __isl_give isl_union_map *isl_union_map_gist(
2870                 __isl_take isl_union_map *umap,
2871                 __isl_take isl_union_map *context);
2872         __isl_give isl_union_map *isl_union_map_gist_params(
2873                 __isl_take isl_union_map *umap,
2874                 __isl_take isl_set *set);
2875         __isl_give isl_union_map *isl_union_map_gist_domain(
2876                 __isl_take isl_union_map *umap,
2877                 __isl_take isl_union_set *uset);
2878         __isl_give isl_union_map *isl_union_map_gist_range(
2879                 __isl_take isl_union_map *umap,
2880                 __isl_take isl_union_set *uset);
2882 The gist operation returns a set or relation that has the
2883 same intersection with the context as the input set or relation.
2884 Any implicit equality in the intersection is made explicit in the result,
2885 while all inequalities that are redundant with respect to the intersection
2886 are removed.
2887 In case of union sets and relations, the gist operation is performed
2888 per space.
2890 =back
2892 =head3 Lexicographic Optimization
2894 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2895 the following functions
2896 compute a set that contains the lexicographic minimum or maximum
2897 of the elements in C<set> (or C<bset>) for those values of the parameters
2898 that satisfy C<dom>.
2899 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2900 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2901 has no elements.
2902 In other words, the union of the parameter values
2903 for which the result is non-empty and of C<*empty>
2904 is equal to C<dom>.
2906         __isl_give isl_set *isl_basic_set_partial_lexmin(
2907                 __isl_take isl_basic_set *bset,
2908                 __isl_take isl_basic_set *dom,
2909                 __isl_give isl_set **empty);
2910         __isl_give isl_set *isl_basic_set_partial_lexmax(
2911                 __isl_take isl_basic_set *bset,
2912                 __isl_take isl_basic_set *dom,
2913                 __isl_give isl_set **empty);
2914         __isl_give isl_set *isl_set_partial_lexmin(
2915                 __isl_take isl_set *set, __isl_take isl_set *dom,
2916                 __isl_give isl_set **empty);
2917         __isl_give isl_set *isl_set_partial_lexmax(
2918                 __isl_take isl_set *set, __isl_take isl_set *dom,
2919                 __isl_give isl_set **empty);
2921 Given a (basic) set C<set> (or C<bset>), the following functions simply
2922 return a set containing the lexicographic minimum or maximum
2923 of the elements in C<set> (or C<bset>).
2924 In case of union sets, the optimum is computed per space.
2926         __isl_give isl_set *isl_basic_set_lexmin(
2927                 __isl_take isl_basic_set *bset);
2928         __isl_give isl_set *isl_basic_set_lexmax(
2929                 __isl_take isl_basic_set *bset);
2930         __isl_give isl_set *isl_set_lexmin(
2931                 __isl_take isl_set *set);
2932         __isl_give isl_set *isl_set_lexmax(
2933                 __isl_take isl_set *set);
2934         __isl_give isl_union_set *isl_union_set_lexmin(
2935                 __isl_take isl_union_set *uset);
2936         __isl_give isl_union_set *isl_union_set_lexmax(
2937                 __isl_take isl_union_set *uset);
2939 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2940 the following functions
2941 compute a relation that maps each element of C<dom>
2942 to the single lexicographic minimum or maximum
2943 of the elements that are associated to that same
2944 element in C<map> (or C<bmap>).
2945 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2946 that contains the elements in C<dom> that do not map
2947 to any elements in C<map> (or C<bmap>).
2948 In other words, the union of the domain of the result and of C<*empty>
2949 is equal to C<dom>.
2951         __isl_give isl_map *isl_basic_map_partial_lexmax(
2952                 __isl_take isl_basic_map *bmap,
2953                 __isl_take isl_basic_set *dom,
2954                 __isl_give isl_set **empty);
2955         __isl_give isl_map *isl_basic_map_partial_lexmin(
2956                 __isl_take isl_basic_map *bmap,
2957                 __isl_take isl_basic_set *dom,
2958                 __isl_give isl_set **empty);
2959         __isl_give isl_map *isl_map_partial_lexmax(
2960                 __isl_take isl_map *map, __isl_take isl_set *dom,
2961                 __isl_give isl_set **empty);
2962         __isl_give isl_map *isl_map_partial_lexmin(
2963                 __isl_take isl_map *map, __isl_take isl_set *dom,
2964                 __isl_give isl_set **empty);
2966 Given a (basic) map C<map> (or C<bmap>), the following functions simply
2967 return a map mapping each element in the domain of
2968 C<map> (or C<bmap>) to the lexicographic minimum or maximum
2969 of all elements associated to that element.
2970 In case of union relations, the optimum is computed per space.
2972         __isl_give isl_map *isl_basic_map_lexmin(
2973                 __isl_take isl_basic_map *bmap);
2974         __isl_give isl_map *isl_basic_map_lexmax(
2975                 __isl_take isl_basic_map *bmap);
2976         __isl_give isl_map *isl_map_lexmin(
2977                 __isl_take isl_map *map);
2978         __isl_give isl_map *isl_map_lexmax(
2979                 __isl_take isl_map *map);
2980         __isl_give isl_union_map *isl_union_map_lexmin(
2981                 __isl_take isl_union_map *umap);
2982         __isl_give isl_union_map *isl_union_map_lexmax(
2983                 __isl_take isl_union_map *umap);
2985 The following functions return their result in the form of
2986 a piecewise multi-affine expression
2987 (See L<"Piecewise Multiple Quasi Affine Expressions">),
2988 but are otherwise equivalent to the corresponding functions
2989 returning a basic set or relation.
2991         __isl_give isl_pw_multi_aff *
2992         isl_basic_map_lexmin_pw_multi_aff(
2993                 __isl_take isl_basic_map *bmap);
2994         __isl_give isl_pw_multi_aff *
2995         isl_basic_set_partial_lexmin_pw_multi_aff(
2996                 __isl_take isl_basic_set *bset,
2997                 __isl_take isl_basic_set *dom,
2998                 __isl_give isl_set **empty);
2999         __isl_give isl_pw_multi_aff *
3000         isl_basic_set_partial_lexmax_pw_multi_aff(
3001                 __isl_take isl_basic_set *bset,
3002                 __isl_take isl_basic_set *dom,
3003                 __isl_give isl_set **empty);
3004         __isl_give isl_pw_multi_aff *
3005         isl_basic_map_partial_lexmin_pw_multi_aff(
3006                 __isl_take isl_basic_map *bmap,
3007                 __isl_take isl_basic_set *dom,
3008                 __isl_give isl_set **empty);
3009         __isl_give isl_pw_multi_aff *
3010         isl_basic_map_partial_lexmax_pw_multi_aff(
3011                 __isl_take isl_basic_map *bmap,
3012                 __isl_take isl_basic_set *dom,
3013                 __isl_give isl_set **empty);
3014         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3015                 __isl_take isl_map *map);
3016         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3017                 __isl_take isl_map *map);
3019 =head2 Lists
3021 Lists are defined over several element types, including
3022 C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3023 C<isl_basic_set> and C<isl_set>.
3024 Here we take lists of C<isl_set>s as an example.
3025 Lists can be created, copied, modified and freed using the following functions.
3027         #include <isl/list.h>
3028         __isl_give isl_set_list *isl_set_list_from_set(
3029                 __isl_take isl_set *el);
3030         __isl_give isl_set_list *isl_set_list_alloc(
3031                 isl_ctx *ctx, int n);
3032         __isl_give isl_set_list *isl_set_list_copy(
3033                 __isl_keep isl_set_list *list);
3034         __isl_give isl_set_list *isl_set_list_insert(
3035                 __isl_take isl_set_list *list, unsigned pos,
3036                 __isl_take isl_set *el);
3037         __isl_give isl_set_list *isl_set_list_add(
3038                 __isl_take isl_set_list *list,
3039                 __isl_take isl_set *el);
3040         __isl_give isl_set_list *isl_set_list_drop(
3041                 __isl_take isl_set_list *list,
3042                 unsigned first, unsigned n);
3043         __isl_give isl_set_list *isl_set_list_set_set(
3044                 __isl_take isl_set_list *list, int index,
3045                 __isl_take isl_set *set);
3046         __isl_give isl_set_list *isl_set_list_concat(
3047                 __isl_take isl_set_list *list1,
3048                 __isl_take isl_set_list *list2);
3049         void *isl_set_list_free(__isl_take isl_set_list *list);
3051 C<isl_set_list_alloc> creates an empty list with a capacity for
3052 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3053 element.
3055 Lists can be inspected using the following functions.
3057         #include <isl/list.h>
3058         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3059         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3060         __isl_give isl_set *isl_set_list_get_set(
3061                 __isl_keep isl_set_list *list, int index);
3062         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3063                 int (*fn)(__isl_take isl_set *el, void *user),
3064                 void *user);
3066 Lists can be printed using
3068         #include <isl/list.h>
3069         __isl_give isl_printer *isl_printer_print_set_list(
3070                 __isl_take isl_printer *p,
3071                 __isl_keep isl_set_list *list);
3073 =head2 Vectors
3075 Vectors can be created, copied and freed using the following functions.
3077         #include <isl/vec.h>
3078         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3079                 unsigned size);
3080         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3081         void *isl_vec_free(__isl_take isl_vec *vec);
3083 Note that the elements of a newly created vector may have arbitrary values.
3084 The elements can be changed and inspected using the following functions.
3086         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3087         int isl_vec_size(__isl_keep isl_vec *vec);
3088         int isl_vec_get_element(__isl_keep isl_vec *vec,
3089                 int pos, isl_int *v);
3090         __isl_give isl_vec *isl_vec_set_element(
3091                 __isl_take isl_vec *vec, int pos, isl_int v);
3092         __isl_give isl_vec *isl_vec_set_element_si(
3093                 __isl_take isl_vec *vec, int pos, int v);
3094         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3095                 isl_int v);
3096         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3097                 int v);
3098         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3099                 isl_int m);
3101 C<isl_vec_get_element> will return a negative value if anything went wrong.
3102 In that case, the value of C<*v> is undefined.
3104 The following function can be used to concatenate two vectors.
3106         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3107                 __isl_take isl_vec *vec2);
3109 =head2 Matrices
3111 Matrices can be created, copied and freed using the following functions.
3113         #include <isl/mat.h>
3114         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3115                 unsigned n_row, unsigned n_col);
3116         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3117         void isl_mat_free(__isl_take isl_mat *mat);
3119 Note that the elements of a newly created matrix may have arbitrary values.
3120 The elements can be changed and inspected using the following functions.
3122         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3123         int isl_mat_rows(__isl_keep isl_mat *mat);
3124         int isl_mat_cols(__isl_keep isl_mat *mat);
3125         int isl_mat_get_element(__isl_keep isl_mat *mat,
3126                 int row, int col, isl_int *v);
3127         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3128                 int row, int col, isl_int v);
3129         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3130                 int row, int col, int v);
3132 C<isl_mat_get_element> will return a negative value if anything went wrong.
3133 In that case, the value of C<*v> is undefined.
3135 The following function can be used to compute the (right) inverse
3136 of a matrix, i.e., a matrix such that the product of the original
3137 and the inverse (in that order) is a multiple of the identity matrix.
3138 The input matrix is assumed to be of full row-rank.
3140         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3142 The following function can be used to compute the (right) kernel
3143 (or null space) of a matrix, i.e., a matrix such that the product of
3144 the original and the kernel (in that order) is the zero matrix.
3146         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3148 =head2 Piecewise Quasi Affine Expressions
3150 The zero quasi affine expression or the quasi affine expression
3151 that is equal to a specified dimension on a given domain can be created using
3153         __isl_give isl_aff *isl_aff_zero_on_domain(
3154                 __isl_take isl_local_space *ls);
3155         __isl_give isl_aff *isl_aff_var_on_domain(
3156                 __isl_take isl_local_space *ls,
3157                 enum isl_dim_type type, unsigned pos);
3158         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3159                 __isl_take isl_local_space *ls,
3160                 enum isl_dim_type type, unsigned pos);
3162 Note that the space in which the resulting objects live is a map space
3163 with the given space as domain and a one-dimensional range.
3165 An empty piecewise quasi affine expression (one with no cells)
3166 or a piecewise quasi affine expression with a single cell can
3167 be created using the following functions.
3169         #include <isl/aff.h>
3170         __isl_give isl_pw_aff *isl_pw_aff_empty(
3171                 __isl_take isl_space *space);
3172         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3173                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3174         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3175                 __isl_take isl_aff *aff);
3177 A piecewise quasi affine expression that is equal to 1 on a set
3178 and 0 outside the set can be created using the following function.
3180         #include <isl/aff.h>
3181         __isl_give isl_pw_aff *isl_set_indicator_function(
3182                 __isl_take isl_set *set);
3184 Quasi affine expressions can be copied and freed using
3186         #include <isl/aff.h>
3187         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3188         void *isl_aff_free(__isl_take isl_aff *aff);
3190         __isl_give isl_pw_aff *isl_pw_aff_copy(
3191                 __isl_keep isl_pw_aff *pwaff);
3192         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3194 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3195 using the following function.  The constraint is required to have
3196 a non-zero coefficient for the specified dimension.
3198         #include <isl/constraint.h>
3199         __isl_give isl_aff *isl_constraint_get_bound(
3200                 __isl_keep isl_constraint *constraint,
3201                 enum isl_dim_type type, int pos);
3203 The entire affine expression of the constraint can also be extracted
3204 using the following function.
3206         #include <isl/constraint.h>
3207         __isl_give isl_aff *isl_constraint_get_aff(
3208                 __isl_keep isl_constraint *constraint);
3210 Conversely, an equality constraint equating
3211 the affine expression to zero or an inequality constraint enforcing
3212 the affine expression to be non-negative, can be constructed using
3214         __isl_give isl_constraint *isl_equality_from_aff(
3215                 __isl_take isl_aff *aff);
3216         __isl_give isl_constraint *isl_inequality_from_aff(
3217                 __isl_take isl_aff *aff);
3219 The expression can be inspected using
3221         #include <isl/aff.h>
3222         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3223         int isl_aff_dim(__isl_keep isl_aff *aff,
3224                 enum isl_dim_type type);
3225         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3226                 __isl_keep isl_aff *aff);
3227         __isl_give isl_local_space *isl_aff_get_local_space(
3228                 __isl_keep isl_aff *aff);
3229         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3230                 enum isl_dim_type type, unsigned pos);
3231         const char *isl_pw_aff_get_dim_name(
3232                 __isl_keep isl_pw_aff *pa,
3233                 enum isl_dim_type type, unsigned pos);
3234         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3235                 enum isl_dim_type type, unsigned pos);
3236         __isl_give isl_id *isl_pw_aff_get_dim_id(
3237                 __isl_keep isl_pw_aff *pa,
3238                 enum isl_dim_type type, unsigned pos);
3239         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3240                 __isl_keep isl_pw_aff *pa,
3241                 enum isl_dim_type type);
3242         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3243                 isl_int *v);
3244         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3245                 enum isl_dim_type type, int pos, isl_int *v);
3246         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3247                 isl_int *v);
3248         __isl_give isl_aff *isl_aff_get_div(
3249                 __isl_keep isl_aff *aff, int pos);
3251         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3252         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3253                 int (*fn)(__isl_take isl_set *set,
3254                           __isl_take isl_aff *aff,
3255                           void *user), void *user);
3257         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3258         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3260         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3261                 enum isl_dim_type type, unsigned first, unsigned n);
3262         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3263                 enum isl_dim_type type, unsigned first, unsigned n);
3265         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3266         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3267                 enum isl_dim_type type);
3268         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3270 It can be modified using
3272         #include <isl/aff.h>
3273         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3274                 __isl_take isl_pw_aff *pwaff,
3275                 enum isl_dim_type type, __isl_take isl_id *id);
3276         __isl_give isl_aff *isl_aff_set_dim_name(
3277                 __isl_take isl_aff *aff, enum isl_dim_type type,
3278                 unsigned pos, const char *s);
3279         __isl_give isl_aff *isl_aff_set_dim_id(
3280                 __isl_take isl_aff *aff, enum isl_dim_type type,
3281                 unsigned pos, __isl_take isl_id *id);
3282         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3283                 __isl_take isl_pw_aff *pma,
3284                 enum isl_dim_type type, unsigned pos,
3285                 __isl_take isl_id *id);
3286         __isl_give isl_aff *isl_aff_set_constant(
3287                 __isl_take isl_aff *aff, isl_int v);
3288         __isl_give isl_aff *isl_aff_set_constant_si(
3289                 __isl_take isl_aff *aff, int v);
3290         __isl_give isl_aff *isl_aff_set_coefficient(
3291                 __isl_take isl_aff *aff,
3292                 enum isl_dim_type type, int pos, isl_int v);
3293         __isl_give isl_aff *isl_aff_set_coefficient_si(
3294                 __isl_take isl_aff *aff,
3295                 enum isl_dim_type type, int pos, int v);
3296         __isl_give isl_aff *isl_aff_set_denominator(
3297                 __isl_take isl_aff *aff, isl_int v);
3299         __isl_give isl_aff *isl_aff_add_constant(
3300                 __isl_take isl_aff *aff, isl_int v);
3301         __isl_give isl_aff *isl_aff_add_constant_si(
3302                 __isl_take isl_aff *aff, int v);
3303         __isl_give isl_aff *isl_aff_add_constant_num(
3304                 __isl_take isl_aff *aff, isl_int v);
3305         __isl_give isl_aff *isl_aff_add_constant_num_si(
3306                 __isl_take isl_aff *aff, int v);
3307         __isl_give isl_aff *isl_aff_add_coefficient(
3308                 __isl_take isl_aff *aff,
3309                 enum isl_dim_type type, int pos, isl_int v);
3310         __isl_give isl_aff *isl_aff_add_coefficient_si(
3311                 __isl_take isl_aff *aff,
3312                 enum isl_dim_type type, int pos, int v);
3314         __isl_give isl_aff *isl_aff_insert_dims(
3315                 __isl_take isl_aff *aff,
3316                 enum isl_dim_type type, unsigned first, unsigned n);
3317         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3318                 __isl_take isl_pw_aff *pwaff,
3319                 enum isl_dim_type type, unsigned first, unsigned n);
3320         __isl_give isl_aff *isl_aff_add_dims(
3321                 __isl_take isl_aff *aff,
3322                 enum isl_dim_type type, unsigned n);
3323         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3324                 __isl_take isl_pw_aff *pwaff,
3325                 enum isl_dim_type type, unsigned n);
3326         __isl_give isl_aff *isl_aff_drop_dims(
3327                 __isl_take isl_aff *aff,
3328                 enum isl_dim_type type, unsigned first, unsigned n);
3329         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3330                 __isl_take isl_pw_aff *pwaff,
3331                 enum isl_dim_type type, unsigned first, unsigned n);
3333 Note that the C<set_constant> and C<set_coefficient> functions
3334 set the I<numerator> of the constant or coefficient, while
3335 C<add_constant> and C<add_coefficient> add an integer value to
3336 the possibly rational constant or coefficient.
3337 The C<add_constant_num> functions add an integer value to
3338 the numerator.
3340 To check whether an affine expressions is obviously zero
3341 or obviously equal to some other affine expression, use
3343         #include <isl/aff.h>
3344         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3345         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3346                 __isl_keep isl_aff *aff2);
3347         int isl_pw_aff_plain_is_equal(
3348                 __isl_keep isl_pw_aff *pwaff1,
3349                 __isl_keep isl_pw_aff *pwaff2);
3351 Operations include
3353         #include <isl/aff.h>
3354         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3355                 __isl_take isl_aff *aff2);
3356         __isl_give isl_pw_aff *isl_pw_aff_add(
3357                 __isl_take isl_pw_aff *pwaff1,
3358                 __isl_take isl_pw_aff *pwaff2);
3359         __isl_give isl_pw_aff *isl_pw_aff_min(
3360                 __isl_take isl_pw_aff *pwaff1,
3361                 __isl_take isl_pw_aff *pwaff2);
3362         __isl_give isl_pw_aff *isl_pw_aff_max(
3363                 __isl_take isl_pw_aff *pwaff1,
3364                 __isl_take isl_pw_aff *pwaff2);
3365         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3366                 __isl_take isl_aff *aff2);
3367         __isl_give isl_pw_aff *isl_pw_aff_sub(
3368                 __isl_take isl_pw_aff *pwaff1,
3369                 __isl_take isl_pw_aff *pwaff2);
3370         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3371         __isl_give isl_pw_aff *isl_pw_aff_neg(
3372                 __isl_take isl_pw_aff *pwaff);
3373         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3374         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3375                 __isl_take isl_pw_aff *pwaff);
3376         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3377         __isl_give isl_pw_aff *isl_pw_aff_floor(
3378                 __isl_take isl_pw_aff *pwaff);
3379         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3380                 isl_int mod);
3381         __isl_give isl_pw_aff *isl_pw_aff_mod(
3382                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3383         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3384                 isl_int f);
3385         __isl_give isl_pw_aff *isl_pw_aff_scale(
3386                 __isl_take isl_pw_aff *pwaff, isl_int f);
3387         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3388                 isl_int f);
3389         __isl_give isl_aff *isl_aff_scale_down_ui(
3390                 __isl_take isl_aff *aff, unsigned f);
3391         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3392                 __isl_take isl_pw_aff *pwaff, isl_int f);
3394         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3395                 __isl_take isl_pw_aff_list *list);
3396         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3397                 __isl_take isl_pw_aff_list *list);
3399         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3400                 __isl_take isl_pw_aff *pwqp);
3402         __isl_give isl_aff *isl_aff_align_params(
3403                 __isl_take isl_aff *aff,
3404                 __isl_take isl_space *model);
3405         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3406                 __isl_take isl_pw_aff *pwaff,
3407                 __isl_take isl_space *model);
3409         __isl_give isl_aff *isl_aff_project_domain_on_params(
3410                 __isl_take isl_aff *aff);
3412         __isl_give isl_aff *isl_aff_gist_params(
3413                 __isl_take isl_aff *aff,
3414                 __isl_take isl_set *context);
3415         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3416                 __isl_take isl_set *context);
3417         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3418                 __isl_take isl_pw_aff *pwaff,
3419                 __isl_take isl_set *context);
3420         __isl_give isl_pw_aff *isl_pw_aff_gist(
3421                 __isl_take isl_pw_aff *pwaff,
3422                 __isl_take isl_set *context);
3424         __isl_give isl_set *isl_pw_aff_domain(
3425                 __isl_take isl_pw_aff *pwaff);
3426         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3427                 __isl_take isl_pw_aff *pa,
3428                 __isl_take isl_set *set);
3429         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3430                 __isl_take isl_pw_aff *pa,
3431                 __isl_take isl_set *set);
3433         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3434                 __isl_take isl_aff *aff2);
3435         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3436                 __isl_take isl_aff *aff2);
3437         __isl_give isl_pw_aff *isl_pw_aff_mul(
3438                 __isl_take isl_pw_aff *pwaff1,
3439                 __isl_take isl_pw_aff *pwaff2);
3440         __isl_give isl_pw_aff *isl_pw_aff_div(
3441                 __isl_take isl_pw_aff *pa1,
3442                 __isl_take isl_pw_aff *pa2);
3443         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3444                 __isl_take isl_pw_aff *pa1,
3445                 __isl_take isl_pw_aff *pa2);
3446         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3447                 __isl_take isl_pw_aff *pa1,
3448                 __isl_take isl_pw_aff *pa2);
3450 When multiplying two affine expressions, at least one of the two needs
3451 to be a constant.  Similarly, when dividing an affine expression by another,
3452 the second expression needs to be a constant.
3453 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3454 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3455 remainder.
3457         #include <isl/aff.h>
3458         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3459                 __isl_take isl_aff *aff);
3460         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3461                 __isl_take isl_aff *aff);
3462         __isl_give isl_basic_set *isl_aff_le_basic_set(
3463                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3464         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3465                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3466         __isl_give isl_set *isl_pw_aff_eq_set(
3467                 __isl_take isl_pw_aff *pwaff1,
3468                 __isl_take isl_pw_aff *pwaff2);
3469         __isl_give isl_set *isl_pw_aff_ne_set(
3470                 __isl_take isl_pw_aff *pwaff1,
3471                 __isl_take isl_pw_aff *pwaff2);
3472         __isl_give isl_set *isl_pw_aff_le_set(
3473                 __isl_take isl_pw_aff *pwaff1,
3474                 __isl_take isl_pw_aff *pwaff2);
3475         __isl_give isl_set *isl_pw_aff_lt_set(
3476                 __isl_take isl_pw_aff *pwaff1,
3477                 __isl_take isl_pw_aff *pwaff2);
3478         __isl_give isl_set *isl_pw_aff_ge_set(
3479                 __isl_take isl_pw_aff *pwaff1,
3480                 __isl_take isl_pw_aff *pwaff2);
3481         __isl_give isl_set *isl_pw_aff_gt_set(
3482                 __isl_take isl_pw_aff *pwaff1,
3483                 __isl_take isl_pw_aff *pwaff2);
3485         __isl_give isl_set *isl_pw_aff_list_eq_set(
3486                 __isl_take isl_pw_aff_list *list1,
3487                 __isl_take isl_pw_aff_list *list2);
3488         __isl_give isl_set *isl_pw_aff_list_ne_set(
3489                 __isl_take isl_pw_aff_list *list1,
3490                 __isl_take isl_pw_aff_list *list2);
3491         __isl_give isl_set *isl_pw_aff_list_le_set(
3492                 __isl_take isl_pw_aff_list *list1,
3493                 __isl_take isl_pw_aff_list *list2);
3494         __isl_give isl_set *isl_pw_aff_list_lt_set(
3495                 __isl_take isl_pw_aff_list *list1,
3496                 __isl_take isl_pw_aff_list *list2);
3497         __isl_give isl_set *isl_pw_aff_list_ge_set(
3498                 __isl_take isl_pw_aff_list *list1,
3499                 __isl_take isl_pw_aff_list *list2);
3500         __isl_give isl_set *isl_pw_aff_list_gt_set(
3501                 __isl_take isl_pw_aff_list *list1,
3502                 __isl_take isl_pw_aff_list *list2);
3504 The function C<isl_aff_neg_basic_set> returns a basic set
3505 containing those elements in the domain space
3506 of C<aff> where C<aff> is negative.
3507 The function C<isl_aff_ge_basic_set> returns a basic set
3508 containing those elements in the shared space
3509 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3510 The function C<isl_pw_aff_ge_set> returns a set
3511 containing those elements in the shared domain
3512 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3513 The functions operating on C<isl_pw_aff_list> apply the corresponding
3514 C<isl_pw_aff> function to each pair of elements in the two lists.
3516         #include <isl/aff.h>
3517         __isl_give isl_set *isl_pw_aff_nonneg_set(
3518                 __isl_take isl_pw_aff *pwaff);
3519         __isl_give isl_set *isl_pw_aff_zero_set(
3520                 __isl_take isl_pw_aff *pwaff);
3521         __isl_give isl_set *isl_pw_aff_non_zero_set(
3522                 __isl_take isl_pw_aff *pwaff);
3524 The function C<isl_pw_aff_nonneg_set> returns a set
3525 containing those elements in the domain
3526 of C<pwaff> where C<pwaff> is non-negative.
3528         #include <isl/aff.h>
3529         __isl_give isl_pw_aff *isl_pw_aff_cond(
3530                 __isl_take isl_pw_aff *cond,
3531                 __isl_take isl_pw_aff *pwaff_true,
3532                 __isl_take isl_pw_aff *pwaff_false);
3534 The function C<isl_pw_aff_cond> performs a conditional operator
3535 and returns an expression that is equal to C<pwaff_true>
3536 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3537 where C<cond> is zero.
3539         #include <isl/aff.h>
3540         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3541                 __isl_take isl_pw_aff *pwaff1,
3542                 __isl_take isl_pw_aff *pwaff2);
3543         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3544                 __isl_take isl_pw_aff *pwaff1,
3545                 __isl_take isl_pw_aff *pwaff2);
3546         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3547                 __isl_take isl_pw_aff *pwaff1,
3548                 __isl_take isl_pw_aff *pwaff2);
3550 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3551 expression with a domain that is the union of those of C<pwaff1> and
3552 C<pwaff2> and such that on each cell, the quasi-affine expression is
3553 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3554 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3555 associated expression is the defined one.
3557 An expression can be read from input using
3559         #include <isl/aff.h>
3560         __isl_give isl_aff *isl_aff_read_from_str(
3561                 isl_ctx *ctx, const char *str);
3562         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3563                 isl_ctx *ctx, const char *str);
3565 An expression can be printed using
3567         #include <isl/aff.h>
3568         __isl_give isl_printer *isl_printer_print_aff(
3569                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3571         __isl_give isl_printer *isl_printer_print_pw_aff(
3572                 __isl_take isl_printer *p,
3573                 __isl_keep isl_pw_aff *pwaff);
3575 =head2 Piecewise Multiple Quasi Affine Expressions
3577 An C<isl_multi_aff> object represents a sequence of
3578 zero or more affine expressions, all defined on the same domain space.
3580 An C<isl_multi_aff> can be constructed from a C<isl_aff_list> using the
3581 following function.
3583         #include <isl/aff.h>
3584         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3585                 __isl_take isl_space *space,
3586                 __isl_take isl_aff_list *list);
3588 An empty piecewise multiple quasi affine expression (one with no cells),
3589 the zero piecewise multiple quasi affine expression (with value zero
3590 for each output dimension),
3591 a piecewise multiple quasi affine expression with a single cell (with
3592 either a universe or a specified domain) or
3593 a zero-dimensional piecewise multiple quasi affine expression
3594 on a given domain
3595 can be created using the following functions.
3597         #include <isl/aff.h>
3598         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3599                 __isl_take isl_space *space);
3600         __isl_give isl_multi_aff *isl_multi_aff_zero(
3601                 __isl_take isl_space *space);
3602         __isl_give isl_multi_aff *isl_multi_aff_identity(
3603                 __isl_take isl_space *space);
3604         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3605                 __isl_take isl_space *space);
3606         __isl_give isl_pw_multi_aff *
3607         isl_pw_multi_aff_from_multi_aff(
3608                 __isl_take isl_multi_aff *ma);
3609         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3610                 __isl_take isl_set *set,
3611                 __isl_take isl_multi_aff *maff);
3612         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3613                 __isl_take isl_set *set);
3615         __isl_give isl_union_pw_multi_aff *
3616         isl_union_pw_multi_aff_empty(
3617                 __isl_take isl_space *space);
3618         __isl_give isl_union_pw_multi_aff *
3619         isl_union_pw_multi_aff_add_pw_multi_aff(
3620                 __isl_take isl_union_pw_multi_aff *upma,
3621                 __isl_take isl_pw_multi_aff *pma);
3622         __isl_give isl_union_pw_multi_aff *
3623         isl_union_pw_multi_aff_from_domain(
3624                 __isl_take isl_union_set *uset);
3626 A piecewise multiple quasi affine expression can also be initialized
3627 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3628 and the C<isl_map> is single-valued.
3630         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3631                 __isl_take isl_set *set);
3632         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3633                 __isl_take isl_map *map);
3635 Multiple quasi affine expressions can be copied and freed using
3637         #include <isl/aff.h>
3638         __isl_give isl_multi_aff *isl_multi_aff_copy(
3639                 __isl_keep isl_multi_aff *maff);
3640         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3642         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3643                 __isl_keep isl_pw_multi_aff *pma);
3644         void *isl_pw_multi_aff_free(
3645                 __isl_take isl_pw_multi_aff *pma);
3647         __isl_give isl_union_pw_multi_aff *
3648         isl_union_pw_multi_aff_copy(
3649                 __isl_keep isl_union_pw_multi_aff *upma);
3650         void *isl_union_pw_multi_aff_free(
3651                 __isl_take isl_union_pw_multi_aff *upma);
3653 The expression can be inspected using
3655         #include <isl/aff.h>
3656         isl_ctx *isl_multi_aff_get_ctx(
3657                 __isl_keep isl_multi_aff *maff);
3658         isl_ctx *isl_pw_multi_aff_get_ctx(
3659                 __isl_keep isl_pw_multi_aff *pma);
3660         isl_ctx *isl_union_pw_multi_aff_get_ctx(
3661                 __isl_keep isl_union_pw_multi_aff *upma);
3662         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3663                 enum isl_dim_type type);
3664         unsigned isl_pw_multi_aff_dim(
3665                 __isl_keep isl_pw_multi_aff *pma,
3666                 enum isl_dim_type type);
3667         __isl_give isl_aff *isl_multi_aff_get_aff(
3668                 __isl_keep isl_multi_aff *multi, int pos);
3669         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3670                 __isl_keep isl_pw_multi_aff *pma, int pos);
3671         const char *isl_pw_multi_aff_get_dim_name(
3672                 __isl_keep isl_pw_multi_aff *pma,
3673                 enum isl_dim_type type, unsigned pos);
3674         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3675                 __isl_keep isl_pw_multi_aff *pma,
3676                 enum isl_dim_type type, unsigned pos);
3677         const char *isl_multi_aff_get_tuple_name(
3678                 __isl_keep isl_multi_aff *multi,
3679                 enum isl_dim_type type);
3680         int isl_pw_multi_aff_has_tuple_name(
3681                 __isl_keep isl_pw_multi_aff *pma,
3682                 enum isl_dim_type type);
3683         const char *isl_pw_multi_aff_get_tuple_name(
3684                 __isl_keep isl_pw_multi_aff *pma,
3685                 enum isl_dim_type type);
3686         int isl_pw_multi_aff_has_tuple_id(
3687                 __isl_keep isl_pw_multi_aff *pma,
3688                 enum isl_dim_type type);
3689         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3690                 __isl_keep isl_pw_multi_aff *pma,
3691                 enum isl_dim_type type);
3693         int isl_pw_multi_aff_foreach_piece(
3694                 __isl_keep isl_pw_multi_aff *pma,
3695                 int (*fn)(__isl_take isl_set *set,
3696                             __isl_take isl_multi_aff *maff,
3697                             void *user), void *user);
3699         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
3700                 __isl_keep isl_union_pw_multi_aff *upma,
3701                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
3702                             void *user), void *user);
3704 It can be modified using
3706         #include <isl/aff.h>
3707         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
3708                 __isl_take isl_multi_aff *multi, int pos,
3709                 __isl_take isl_aff *aff);
3710         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
3711                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
3712                 __isl_take isl_pw_aff *pa);
3713         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3714                 __isl_take isl_multi_aff *maff,
3715                 enum isl_dim_type type, unsigned pos, const char *s);
3716         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
3717                 __isl_take isl_multi_aff *maff,
3718                 enum isl_dim_type type, __isl_take isl_id *id);
3719         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3720                 __isl_take isl_pw_multi_aff *pma,
3721                 enum isl_dim_type type, __isl_take isl_id *id);
3723         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
3724                 __isl_take isl_multi_aff *maff,
3725                 enum isl_dim_type type, unsigned first, unsigned n);
3726         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
3727                 __isl_take isl_pw_multi_aff *pma,
3728                 enum isl_dim_type type, unsigned first, unsigned n);
3730 To check whether two multiple affine expressions are
3731 obviously equal to each other, use
3733         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3734                 __isl_keep isl_multi_aff *maff2);
3735         int isl_pw_multi_aff_plain_is_equal(
3736                 __isl_keep isl_pw_multi_aff *pma1,
3737                 __isl_keep isl_pw_multi_aff *pma2);
3739 Operations include
3741         #include <isl/aff.h>
3742         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
3743                 __isl_take isl_pw_multi_aff *pma1,
3744                 __isl_take isl_pw_multi_aff *pma2);
3745         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
3746                 __isl_take isl_pw_multi_aff *pma1,
3747                 __isl_take isl_pw_multi_aff *pma2);
3748         __isl_give isl_multi_aff *isl_multi_aff_add(
3749                 __isl_take isl_multi_aff *maff1,
3750                 __isl_take isl_multi_aff *maff2);
3751         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3752                 __isl_take isl_pw_multi_aff *pma1,
3753                 __isl_take isl_pw_multi_aff *pma2);
3754         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
3755                 __isl_take isl_union_pw_multi_aff *upma1,
3756                 __isl_take isl_union_pw_multi_aff *upma2);
3757         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3758                 __isl_take isl_pw_multi_aff *pma1,
3759                 __isl_take isl_pw_multi_aff *pma2);
3760         __isl_give isl_multi_aff *isl_multi_aff_scale(
3761                 __isl_take isl_multi_aff *maff,
3762                 isl_int f);
3763         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
3764                 __isl_take isl_pw_multi_aff *pma,
3765                 __isl_take isl_set *set);
3766         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3767                 __isl_take isl_pw_multi_aff *pma,
3768                 __isl_take isl_set *set);
3769         __isl_give isl_multi_aff *isl_multi_aff_lift(
3770                 __isl_take isl_multi_aff *maff,
3771                 __isl_give isl_local_space **ls);
3772         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
3773                 __isl_take isl_pw_multi_aff *pma);
3774         __isl_give isl_multi_aff *isl_multi_aff_align_params(
3775                 __isl_take isl_multi_aff *multi,
3776                 __isl_take isl_space *model);
3777         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
3778                 __isl_take isl_pw_multi_aff *pma,
3779                 __isl_take isl_space *model);
3780         __isl_give isl_pw_multi_aff *
3781         isl_pw_multi_aff_project_domain_on_params(
3782                 __isl_take isl_pw_multi_aff *pma);
3783         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
3784                 __isl_take isl_multi_aff *maff,
3785                 __isl_take isl_set *context);
3786         __isl_give isl_multi_aff *isl_multi_aff_gist(
3787                 __isl_take isl_multi_aff *maff,
3788                 __isl_take isl_set *context);
3789         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
3790                 __isl_take isl_pw_multi_aff *pma,
3791                 __isl_take isl_set *set);
3792         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
3793                 __isl_take isl_pw_multi_aff *pma,
3794                 __isl_take isl_set *set);
3795         __isl_give isl_set *isl_pw_multi_aff_domain(
3796                 __isl_take isl_pw_multi_aff *pma);
3797         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
3798                 __isl_take isl_union_pw_multi_aff *upma);
3799         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
3800                 __isl_take isl_multi_aff *ma1,
3801                 __isl_take isl_multi_aff *ma2);
3802         __isl_give isl_multi_aff *isl_multi_aff_product(
3803                 __isl_take isl_multi_aff *ma1,
3804                 __isl_take isl_multi_aff *ma2);
3805         __isl_give isl_pw_multi_aff *
3806         isl_pw_multi_aff_flat_range_product(
3807                 __isl_take isl_pw_multi_aff *pma1,
3808                 __isl_take isl_pw_multi_aff *pma2);
3809         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
3810                 __isl_take isl_pw_multi_aff *pma1,
3811                 __isl_take isl_pw_multi_aff *pma2);
3812         __isl_give isl_union_pw_multi_aff *
3813         isl_union_pw_multi_aff_flat_range_product(
3814                 __isl_take isl_union_pw_multi_aff *upma1,
3815                 __isl_take isl_union_pw_multi_aff *upma2);
3817 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
3818 then it is assigned the local space that lies at the basis of
3819 the lifting applied.
3821         __isl_give isl_set *isl_multi_aff_lex_le_set(
3822                 __isl_take isl_multi_aff *ma1,
3823                 __isl_take isl_multi_aff *ma2);
3824         __isl_give isl_set *isl_multi_aff_lex_ge_set(
3825                 __isl_take isl_multi_aff *ma1,
3826                 __isl_take isl_multi_aff *ma2);
3828 The function C<isl_multi_aff_lex_le_set> returns a set
3829 containing those elements in the shared domain space
3830 where C<ma1> is lexicographically smaller than or
3831 equal to C<ma2>.
3833 An expression can be read from input using
3835         #include <isl/aff.h>
3836         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3837                 isl_ctx *ctx, const char *str);
3838         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3839                 isl_ctx *ctx, const char *str);
3841 An expression can be printed using
3843         #include <isl/aff.h>
3844         __isl_give isl_printer *isl_printer_print_multi_aff(
3845                 __isl_take isl_printer *p,
3846                 __isl_keep isl_multi_aff *maff);
3847         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3848                 __isl_take isl_printer *p,
3849                 __isl_keep isl_pw_multi_aff *pma);
3850         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
3851                 __isl_take isl_printer *p,
3852                 __isl_keep isl_union_pw_multi_aff *upma);
3854 =head2 Points
3856 Points are elements of a set.  They can be used to construct
3857 simple sets (boxes) or they can be used to represent the
3858 individual elements of a set.
3859 The zero point (the origin) can be created using
3861         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
3863 The coordinates of a point can be inspected, set and changed
3864 using
3866         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
3867                 enum isl_dim_type type, int pos, isl_int *v);
3868         __isl_give isl_point *isl_point_set_coordinate(
3869                 __isl_take isl_point *pnt,
3870                 enum isl_dim_type type, int pos, isl_int v);
3872         __isl_give isl_point *isl_point_add_ui(
3873                 __isl_take isl_point *pnt,
3874                 enum isl_dim_type type, int pos, unsigned val);
3875         __isl_give isl_point *isl_point_sub_ui(
3876                 __isl_take isl_point *pnt,
3877                 enum isl_dim_type type, int pos, unsigned val);
3879 Other properties can be obtained using
3881         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
3883 Points can be copied or freed using
3885         __isl_give isl_point *isl_point_copy(
3886                 __isl_keep isl_point *pnt);
3887         void isl_point_free(__isl_take isl_point *pnt);
3889 A singleton set can be created from a point using
3891         __isl_give isl_basic_set *isl_basic_set_from_point(
3892                 __isl_take isl_point *pnt);
3893         __isl_give isl_set *isl_set_from_point(
3894                 __isl_take isl_point *pnt);
3896 and a box can be created from two opposite extremal points using
3898         __isl_give isl_basic_set *isl_basic_set_box_from_points(
3899                 __isl_take isl_point *pnt1,
3900                 __isl_take isl_point *pnt2);
3901         __isl_give isl_set *isl_set_box_from_points(
3902                 __isl_take isl_point *pnt1,
3903                 __isl_take isl_point *pnt2);
3905 All elements of a B<bounded> (union) set can be enumerated using
3906 the following functions.
3908         int isl_set_foreach_point(__isl_keep isl_set *set,
3909                 int (*fn)(__isl_take isl_point *pnt, void *user),
3910                 void *user);
3911         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
3912                 int (*fn)(__isl_take isl_point *pnt, void *user),
3913                 void *user);
3915 The function C<fn> is called for each integer point in
3916 C<set> with as second argument the last argument of
3917 the C<isl_set_foreach_point> call.  The function C<fn>
3918 should return C<0> on success and C<-1> on failure.
3919 In the latter case, C<isl_set_foreach_point> will stop
3920 enumerating and return C<-1> as well.
3921 If the enumeration is performed successfully and to completion,
3922 then C<isl_set_foreach_point> returns C<0>.
3924 To obtain a single point of a (basic) set, use
3926         __isl_give isl_point *isl_basic_set_sample_point(
3927                 __isl_take isl_basic_set *bset);
3928         __isl_give isl_point *isl_set_sample_point(
3929                 __isl_take isl_set *set);
3931 If C<set> does not contain any (integer) points, then the
3932 resulting point will be ``void'', a property that can be
3933 tested using
3935         int isl_point_is_void(__isl_keep isl_point *pnt);
3937 =head2 Piecewise Quasipolynomials
3939 A piecewise quasipolynomial is a particular kind of function that maps
3940 a parametric point to a rational value.
3941 More specifically, a quasipolynomial is a polynomial expression in greatest
3942 integer parts of affine expressions of parameters and variables.
3943 A piecewise quasipolynomial is a subdivision of a given parametric
3944 domain into disjoint cells with a quasipolynomial associated to
3945 each cell.  The value of the piecewise quasipolynomial at a given
3946 point is the value of the quasipolynomial associated to the cell
3947 that contains the point.  Outside of the union of cells,
3948 the value is assumed to be zero.
3949 For example, the piecewise quasipolynomial
3951         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
3953 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
3954 A given piecewise quasipolynomial has a fixed domain dimension.
3955 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
3956 defined over different domains.
3957 Piecewise quasipolynomials are mainly used by the C<barvinok>
3958 library for representing the number of elements in a parametric set or map.
3959 For example, the piecewise quasipolynomial above represents
3960 the number of points in the map
3962         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
3964 =head3 Input and Output
3966 Piecewise quasipolynomials can be read from input using
3968         __isl_give isl_union_pw_qpolynomial *
3969         isl_union_pw_qpolynomial_read_from_str(
3970                 isl_ctx *ctx, const char *str);
3972 Quasipolynomials and piecewise quasipolynomials can be printed
3973 using the following functions.
3975         __isl_give isl_printer *isl_printer_print_qpolynomial(
3976                 __isl_take isl_printer *p,
3977                 __isl_keep isl_qpolynomial *qp);
3979         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3980                 __isl_take isl_printer *p,
3981                 __isl_keep isl_pw_qpolynomial *pwqp);
3983         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3984                 __isl_take isl_printer *p,
3985                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3987 The output format of the printer
3988 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3989 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
3990 is supported.
3991 In case of printing in C<ISL_FORMAT_C>, the user may want
3992 to set the names of all dimensions
3994         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
3995                 __isl_take isl_qpolynomial *qp,
3996                 enum isl_dim_type type, unsigned pos,
3997                 const char *s);
3998         __isl_give isl_pw_qpolynomial *
3999         isl_pw_qpolynomial_set_dim_name(
4000                 __isl_take isl_pw_qpolynomial *pwqp,
4001                 enum isl_dim_type type, unsigned pos,
4002                 const char *s);
4004 =head3 Creating New (Piecewise) Quasipolynomials
4006 Some simple quasipolynomials can be created using the following functions.
4007 More complicated quasipolynomials can be created by applying
4008 operations such as addition and multiplication
4009 on the resulting quasipolynomials
4011         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4012                 __isl_take isl_space *domain);
4013         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4014                 __isl_take isl_space *domain);
4015         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4016                 __isl_take isl_space *domain);
4017         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4018                 __isl_take isl_space *domain);
4019         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4020                 __isl_take isl_space *domain);
4021         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4022                 __isl_take isl_space *domain,
4023                 const isl_int n, const isl_int d);
4024         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4025                 __isl_take isl_space *domain,
4026                 enum isl_dim_type type, unsigned pos);
4027         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4028                 __isl_take isl_aff *aff);
4030 Note that the space in which a quasipolynomial lives is a map space
4031 with a one-dimensional range.  The C<domain> argument in some of
4032 the functions above corresponds to the domain of this map space.
4034 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4035 with a single cell can be created using the following functions.
4036 Multiple of these single cell piecewise quasipolynomials can
4037 be combined to create more complicated piecewise quasipolynomials.
4039         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4040                 __isl_take isl_space *space);
4041         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4042                 __isl_take isl_set *set,
4043                 __isl_take isl_qpolynomial *qp);
4044         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4045                 __isl_take isl_qpolynomial *qp);
4046         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4047                 __isl_take isl_pw_aff *pwaff);
4049         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4050                 __isl_take isl_space *space);
4051         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4052                 __isl_take isl_pw_qpolynomial *pwqp);
4053         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4054                 __isl_take isl_union_pw_qpolynomial *upwqp,
4055                 __isl_take isl_pw_qpolynomial *pwqp);
4057 Quasipolynomials can be copied and freed again using the following
4058 functions.
4060         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4061                 __isl_keep isl_qpolynomial *qp);
4062         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4064         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4065                 __isl_keep isl_pw_qpolynomial *pwqp);
4066         void *isl_pw_qpolynomial_free(
4067                 __isl_take isl_pw_qpolynomial *pwqp);
4069         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4070                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4071         void *isl_union_pw_qpolynomial_free(
4072                 __isl_take isl_union_pw_qpolynomial *upwqp);
4074 =head3 Inspecting (Piecewise) Quasipolynomials
4076 To iterate over all piecewise quasipolynomials in a union
4077 piecewise quasipolynomial, use the following function
4079         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4080                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4081                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4082                 void *user);
4084 To extract the piecewise quasipolynomial in a given space from a union, use
4086         __isl_give isl_pw_qpolynomial *
4087         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4088                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4089                 __isl_take isl_space *space);
4091 To iterate over the cells in a piecewise quasipolynomial,
4092 use either of the following two functions
4094         int isl_pw_qpolynomial_foreach_piece(
4095                 __isl_keep isl_pw_qpolynomial *pwqp,
4096                 int (*fn)(__isl_take isl_set *set,
4097                           __isl_take isl_qpolynomial *qp,
4098                           void *user), void *user);
4099         int isl_pw_qpolynomial_foreach_lifted_piece(
4100                 __isl_keep isl_pw_qpolynomial *pwqp,
4101                 int (*fn)(__isl_take isl_set *set,
4102                           __isl_take isl_qpolynomial *qp,
4103                           void *user), void *user);
4105 As usual, the function C<fn> should return C<0> on success
4106 and C<-1> on failure.  The difference between
4107 C<isl_pw_qpolynomial_foreach_piece> and
4108 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4109 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4110 compute unique representations for all existentially quantified
4111 variables and then turn these existentially quantified variables
4112 into extra set variables, adapting the associated quasipolynomial
4113 accordingly.  This means that the C<set> passed to C<fn>
4114 will not have any existentially quantified variables, but that
4115 the dimensions of the sets may be different for different
4116 invocations of C<fn>.
4118 To iterate over all terms in a quasipolynomial,
4121         int isl_qpolynomial_foreach_term(
4122                 __isl_keep isl_qpolynomial *qp,
4123                 int (*fn)(__isl_take isl_term *term,
4124                           void *user), void *user);
4126 The terms themselves can be inspected and freed using
4127 these functions
4129         unsigned isl_term_dim(__isl_keep isl_term *term,
4130                 enum isl_dim_type type);
4131         void isl_term_get_num(__isl_keep isl_term *term,
4132                 isl_int *n);
4133         void isl_term_get_den(__isl_keep isl_term *term,
4134                 isl_int *d);
4135         int isl_term_get_exp(__isl_keep isl_term *term,
4136                 enum isl_dim_type type, unsigned pos);
4137         __isl_give isl_aff *isl_term_get_div(
4138                 __isl_keep isl_term *term, unsigned pos);
4139         void isl_term_free(__isl_take isl_term *term);
4141 Each term is a product of parameters, set variables and
4142 integer divisions.  The function C<isl_term_get_exp>
4143 returns the exponent of a given dimensions in the given term.
4144 The C<isl_int>s in the arguments of C<isl_term_get_num>
4145 and C<isl_term_get_den> need to have been initialized
4146 using C<isl_int_init> before calling these functions.
4148 =head3 Properties of (Piecewise) Quasipolynomials
4150 To check whether a quasipolynomial is actually a constant,
4151 use the following function.
4153         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4154                 isl_int *n, isl_int *d);
4156 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4157 then the numerator and denominator of the constant
4158 are returned in C<*n> and C<*d>, respectively.
4160 To check whether two union piecewise quasipolynomials are
4161 obviously equal, use
4163         int isl_union_pw_qpolynomial_plain_is_equal(
4164                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4165                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4167 =head3 Operations on (Piecewise) Quasipolynomials
4169         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4170                 __isl_take isl_qpolynomial *qp, isl_int v);
4171         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4172                 __isl_take isl_qpolynomial *qp);
4173         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4174                 __isl_take isl_qpolynomial *qp1,
4175                 __isl_take isl_qpolynomial *qp2);
4176         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4177                 __isl_take isl_qpolynomial *qp1,
4178                 __isl_take isl_qpolynomial *qp2);
4179         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4180                 __isl_take isl_qpolynomial *qp1,
4181                 __isl_take isl_qpolynomial *qp2);
4182         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4183                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4185         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4186                 __isl_take isl_pw_qpolynomial *pwqp1,
4187                 __isl_take isl_pw_qpolynomial *pwqp2);
4188         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4189                 __isl_take isl_pw_qpolynomial *pwqp1,
4190                 __isl_take isl_pw_qpolynomial *pwqp2);
4191         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4192                 __isl_take isl_pw_qpolynomial *pwqp1,
4193                 __isl_take isl_pw_qpolynomial *pwqp2);
4194         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4195                 __isl_take isl_pw_qpolynomial *pwqp);
4196         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4197                 __isl_take isl_pw_qpolynomial *pwqp1,
4198                 __isl_take isl_pw_qpolynomial *pwqp2);
4199         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4200                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4202         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4203                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4204                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4205         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4206                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4207                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4208         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4209                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4210                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4212         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4213                 __isl_take isl_pw_qpolynomial *pwqp,
4214                 __isl_take isl_point *pnt);
4216         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4217                 __isl_take isl_union_pw_qpolynomial *upwqp,
4218                 __isl_take isl_point *pnt);
4220         __isl_give isl_set *isl_pw_qpolynomial_domain(
4221                 __isl_take isl_pw_qpolynomial *pwqp);
4222         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4223                 __isl_take isl_pw_qpolynomial *pwpq,
4224                 __isl_take isl_set *set);
4225         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4226                 __isl_take isl_pw_qpolynomial *pwpq,
4227                 __isl_take isl_set *set);
4229         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4230                 __isl_take isl_union_pw_qpolynomial *upwqp);
4231         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4232                 __isl_take isl_union_pw_qpolynomial *upwpq,
4233                 __isl_take isl_union_set *uset);
4234         __isl_give isl_union_pw_qpolynomial *
4235         isl_union_pw_qpolynomial_intersect_params(
4236                 __isl_take isl_union_pw_qpolynomial *upwpq,
4237                 __isl_take isl_set *set);
4239         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4240                 __isl_take isl_qpolynomial *qp,
4241                 __isl_take isl_space *model);
4243         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4244                 __isl_take isl_qpolynomial *qp);
4245         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4246                 __isl_take isl_pw_qpolynomial *pwqp);
4248         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4249                 __isl_take isl_union_pw_qpolynomial *upwqp);
4251         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4252                 __isl_take isl_qpolynomial *qp,
4253                 __isl_take isl_set *context);
4254         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4255                 __isl_take isl_qpolynomial *qp,
4256                 __isl_take isl_set *context);
4258         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4259                 __isl_take isl_pw_qpolynomial *pwqp,
4260                 __isl_take isl_set *context);
4261         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4262                 __isl_take isl_pw_qpolynomial *pwqp,
4263                 __isl_take isl_set *context);
4265         __isl_give isl_union_pw_qpolynomial *
4266         isl_union_pw_qpolynomial_gist_params(
4267                 __isl_take isl_union_pw_qpolynomial *upwqp,
4268                 __isl_take isl_set *context);
4269         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4270                 __isl_take isl_union_pw_qpolynomial *upwqp,
4271                 __isl_take isl_union_set *context);
4273 The gist operation applies the gist operation to each of
4274 the cells in the domain of the input piecewise quasipolynomial.
4275 The context is also exploited
4276 to simplify the quasipolynomials associated to each cell.
4278         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4279                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4280         __isl_give isl_union_pw_qpolynomial *
4281         isl_union_pw_qpolynomial_to_polynomial(
4282                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4284 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4285 the polynomial will be an overapproximation.  If C<sign> is negative,
4286 it will be an underapproximation.  If C<sign> is zero, the approximation
4287 will lie somewhere in between.
4289 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4291 A piecewise quasipolynomial reduction is a piecewise
4292 reduction (or fold) of quasipolynomials.
4293 In particular, the reduction can be maximum or a minimum.
4294 The objects are mainly used to represent the result of
4295 an upper or lower bound on a quasipolynomial over its domain,
4296 i.e., as the result of the following function.
4298         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4299                 __isl_take isl_pw_qpolynomial *pwqp,
4300                 enum isl_fold type, int *tight);
4302         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4303                 __isl_take isl_union_pw_qpolynomial *upwqp,
4304                 enum isl_fold type, int *tight);
4306 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4307 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4308 is the returned bound is known be tight, i.e., for each value
4309 of the parameters there is at least
4310 one element in the domain that reaches the bound.
4311 If the domain of C<pwqp> is not wrapping, then the bound is computed
4312 over all elements in that domain and the result has a purely parametric
4313 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4314 computed over the range of the wrapped relation.  The domain of the
4315 wrapped relation becomes the domain of the result.
4317 A (piecewise) quasipolynomial reduction can be copied or freed using the
4318 following functions.
4320         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4321                 __isl_keep isl_qpolynomial_fold *fold);
4322         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4323                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4324         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4325                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4326         void isl_qpolynomial_fold_free(
4327                 __isl_take isl_qpolynomial_fold *fold);
4328         void *isl_pw_qpolynomial_fold_free(
4329                 __isl_take isl_pw_qpolynomial_fold *pwf);
4330         void *isl_union_pw_qpolynomial_fold_free(
4331                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4333 =head3 Printing Piecewise Quasipolynomial Reductions
4335 Piecewise quasipolynomial reductions can be printed
4336 using the following function.
4338         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4339                 __isl_take isl_printer *p,
4340                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4341         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4342                 __isl_take isl_printer *p,
4343                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4345 For C<isl_printer_print_pw_qpolynomial_fold>,
4346 output format of the printer
4347 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4348 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4349 output format of the printer
4350 needs to be set to C<ISL_FORMAT_ISL>.
4351 In case of printing in C<ISL_FORMAT_C>, the user may want
4352 to set the names of all dimensions
4354         __isl_give isl_pw_qpolynomial_fold *
4355         isl_pw_qpolynomial_fold_set_dim_name(
4356                 __isl_take isl_pw_qpolynomial_fold *pwf,
4357                 enum isl_dim_type type, unsigned pos,
4358                 const char *s);
4360 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4362 To iterate over all piecewise quasipolynomial reductions in a union
4363 piecewise quasipolynomial reduction, use the following function
4365         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4366                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4367                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4368                             void *user), void *user);
4370 To iterate over the cells in a piecewise quasipolynomial reduction,
4371 use either of the following two functions
4373         int isl_pw_qpolynomial_fold_foreach_piece(
4374                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4375                 int (*fn)(__isl_take isl_set *set,
4376                           __isl_take isl_qpolynomial_fold *fold,
4377                           void *user), void *user);
4378         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4379                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4380                 int (*fn)(__isl_take isl_set *set,
4381                           __isl_take isl_qpolynomial_fold *fold,
4382                           void *user), void *user);
4384 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4385 of the difference between these two functions.
4387 To iterate over all quasipolynomials in a reduction, use
4389         int isl_qpolynomial_fold_foreach_qpolynomial(
4390                 __isl_keep isl_qpolynomial_fold *fold,
4391                 int (*fn)(__isl_take isl_qpolynomial *qp,
4392                           void *user), void *user);
4394 =head3 Properties of Piecewise Quasipolynomial Reductions
4396 To check whether two union piecewise quasipolynomial reductions are
4397 obviously equal, use
4399         int isl_union_pw_qpolynomial_fold_plain_is_equal(
4400                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4401                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4403 =head3 Operations on Piecewise Quasipolynomial Reductions
4405         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4406                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4408         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4409                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4410                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4412         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4413                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4414                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4416         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4417                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4418                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4420         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4421                 __isl_take isl_pw_qpolynomial_fold *pwf,
4422                 __isl_take isl_point *pnt);
4424         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4425                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4426                 __isl_take isl_point *pnt);
4428         __isl_give isl_pw_qpolynomial_fold *
4429         isl_pw_qpolynomial_fold_intersect_params(
4430                 __isl_take isl_pw_qpolynomial_fold *pwf,
4431                 __isl_take isl_set *set);
4433         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4434                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4435         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4436                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4437                 __isl_take isl_union_set *uset);
4438         __isl_give isl_union_pw_qpolynomial_fold *
4439         isl_union_pw_qpolynomial_fold_intersect_params(
4440                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4441                 __isl_take isl_set *set);
4443         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4444                 __isl_take isl_pw_qpolynomial_fold *pwf);
4446         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4447                 __isl_take isl_pw_qpolynomial_fold *pwf);
4449         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4450                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4452         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4453                 __isl_take isl_qpolynomial_fold *fold,
4454                 __isl_take isl_set *context);
4455         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4456                 __isl_take isl_qpolynomial_fold *fold,
4457                 __isl_take isl_set *context);
4459         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4460                 __isl_take isl_pw_qpolynomial_fold *pwf,
4461                 __isl_take isl_set *context);
4462         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4463                 __isl_take isl_pw_qpolynomial_fold *pwf,
4464                 __isl_take isl_set *context);
4466         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4467                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4468                 __isl_take isl_union_set *context);
4469         __isl_give isl_union_pw_qpolynomial_fold *
4470         isl_union_pw_qpolynomial_fold_gist_params(
4471                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4472                 __isl_take isl_set *context);
4474 The gist operation applies the gist operation to each of
4475 the cells in the domain of the input piecewise quasipolynomial reduction.
4476 In future, the operation will also exploit the context
4477 to simplify the quasipolynomial reductions associated to each cell.
4479         __isl_give isl_pw_qpolynomial_fold *
4480         isl_set_apply_pw_qpolynomial_fold(
4481                 __isl_take isl_set *set,
4482                 __isl_take isl_pw_qpolynomial_fold *pwf,
4483                 int *tight);
4484         __isl_give isl_pw_qpolynomial_fold *
4485         isl_map_apply_pw_qpolynomial_fold(
4486                 __isl_take isl_map *map,
4487                 __isl_take isl_pw_qpolynomial_fold *pwf,
4488                 int *tight);
4489         __isl_give isl_union_pw_qpolynomial_fold *
4490         isl_union_set_apply_union_pw_qpolynomial_fold(
4491                 __isl_take isl_union_set *uset,
4492                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4493                 int *tight);
4494         __isl_give isl_union_pw_qpolynomial_fold *
4495         isl_union_map_apply_union_pw_qpolynomial_fold(
4496                 __isl_take isl_union_map *umap,
4497                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4498                 int *tight);
4500 The functions taking a map
4501 compose the given map with the given piecewise quasipolynomial reduction.
4502 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
4503 over all elements in the intersection of the range of the map
4504 and the domain of the piecewise quasipolynomial reduction
4505 as a function of an element in the domain of the map.
4506 The functions taking a set compute a bound over all elements in the
4507 intersection of the set and the domain of the
4508 piecewise quasipolynomial reduction.
4510 =head2 Dependence Analysis
4512 C<isl> contains specialized functionality for performing
4513 array dataflow analysis.  That is, given a I<sink> access relation
4514 and a collection of possible I<source> access relations,
4515 C<isl> can compute relations that describe
4516 for each iteration of the sink access, which iteration
4517 of which of the source access relations was the last
4518 to access the same data element before the given iteration
4519 of the sink access.
4520 The resulting dependence relations map source iterations
4521 to the corresponding sink iterations.
4522 To compute standard flow dependences, the sink should be
4523 a read, while the sources should be writes.
4524 If any of the source accesses are marked as being I<may>
4525 accesses, then there will be a dependence from the last
4526 I<must> access B<and> from any I<may> access that follows
4527 this last I<must> access.
4528 In particular, if I<all> sources are I<may> accesses,
4529 then memory based dependence analysis is performed.
4530 If, on the other hand, all sources are I<must> accesses,
4531 then value based dependence analysis is performed.
4533         #include <isl/flow.h>
4535         typedef int (*isl_access_level_before)(void *first, void *second);
4537         __isl_give isl_access_info *isl_access_info_alloc(
4538                 __isl_take isl_map *sink,
4539                 void *sink_user, isl_access_level_before fn,
4540                 int max_source);
4541         __isl_give isl_access_info *isl_access_info_add_source(
4542                 __isl_take isl_access_info *acc,
4543                 __isl_take isl_map *source, int must,
4544                 void *source_user);
4545         void *isl_access_info_free(__isl_take isl_access_info *acc);
4547         __isl_give isl_flow *isl_access_info_compute_flow(
4548                 __isl_take isl_access_info *acc);
4550         int isl_flow_foreach(__isl_keep isl_flow *deps,
4551                 int (*fn)(__isl_take isl_map *dep, int must,
4552                           void *dep_user, void *user),
4553                 void *user);
4554         __isl_give isl_map *isl_flow_get_no_source(
4555                 __isl_keep isl_flow *deps, int must);
4556         void isl_flow_free(__isl_take isl_flow *deps);
4558 The function C<isl_access_info_compute_flow> performs the actual
4559 dependence analysis.  The other functions are used to construct
4560 the input for this function or to read off the output.
4562 The input is collected in an C<isl_access_info>, which can
4563 be created through a call to C<isl_access_info_alloc>.
4564 The arguments to this functions are the sink access relation
4565 C<sink>, a token C<sink_user> used to identify the sink
4566 access to the user, a callback function for specifying the
4567 relative order of source and sink accesses, and the number
4568 of source access relations that will be added.
4569 The callback function has type C<int (*)(void *first, void *second)>.
4570 The function is called with two user supplied tokens identifying
4571 either a source or the sink and it should return the shared nesting
4572 level and the relative order of the two accesses.
4573 In particular, let I<n> be the number of loops shared by
4574 the two accesses.  If C<first> precedes C<second> textually,
4575 then the function should return I<2 * n + 1>; otherwise,
4576 it should return I<2 * n>.
4577 The sources can be added to the C<isl_access_info> by performing
4578 (at most) C<max_source> calls to C<isl_access_info_add_source>.
4579 C<must> indicates whether the source is a I<must> access
4580 or a I<may> access.  Note that a multi-valued access relation
4581 should only be marked I<must> if every iteration in the domain
4582 of the relation accesses I<all> elements in its image.
4583 The C<source_user> token is again used to identify
4584 the source access.  The range of the source access relation
4585 C<source> should have the same dimension as the range
4586 of the sink access relation.
4587 The C<isl_access_info_free> function should usually not be
4588 called explicitly, because it is called implicitly by
4589 C<isl_access_info_compute_flow>.
4591 The result of the dependence analysis is collected in an
4592 C<isl_flow>.  There may be elements of
4593 the sink access for which no preceding source access could be
4594 found or for which all preceding sources are I<may> accesses.
4595 The relations containing these elements can be obtained through
4596 calls to C<isl_flow_get_no_source>, the first with C<must> set
4597 and the second with C<must> unset.
4598 In the case of standard flow dependence analysis,
4599 with the sink a read and the sources I<must> writes,
4600 the first relation corresponds to the reads from uninitialized
4601 array elements and the second relation is empty.
4602 The actual flow dependences can be extracted using
4603 C<isl_flow_foreach>.  This function will call the user-specified
4604 callback function C<fn> for each B<non-empty> dependence between
4605 a source and the sink.  The callback function is called
4606 with four arguments, the actual flow dependence relation
4607 mapping source iterations to sink iterations, a boolean that
4608 indicates whether it is a I<must> or I<may> dependence, a token
4609 identifying the source and an additional C<void *> with value
4610 equal to the third argument of the C<isl_flow_foreach> call.
4611 A dependence is marked I<must> if it originates from a I<must>
4612 source and if it is not followed by any I<may> sources.
4614 After finishing with an C<isl_flow>, the user should call
4615 C<isl_flow_free> to free all associated memory.
4617 A higher-level interface to dependence analysis is provided
4618 by the following function.
4620         #include <isl/flow.h>
4622         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
4623                 __isl_take isl_union_map *must_source,
4624                 __isl_take isl_union_map *may_source,
4625                 __isl_take isl_union_map *schedule,
4626                 __isl_give isl_union_map **must_dep,
4627                 __isl_give isl_union_map **may_dep,
4628                 __isl_give isl_union_map **must_no_source,
4629                 __isl_give isl_union_map **may_no_source);
4631 The arrays are identified by the tuple names of the ranges
4632 of the accesses.  The iteration domains by the tuple names
4633 of the domains of the accesses and of the schedule.
4634 The relative order of the iteration domains is given by the
4635 schedule.  The relations returned through C<must_no_source>
4636 and C<may_no_source> are subsets of C<sink>.
4637 Any of C<must_dep>, C<may_dep>, C<must_no_source>
4638 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
4639 any of the other arguments is treated as an error.
4641 =head3 Interaction with Dependence Analysis
4643 During the dependence analysis, we frequently need to perform
4644 the following operation.  Given a relation between sink iterations
4645 and potential source iterations from a particular source domain,
4646 what is the last potential source iteration corresponding to each
4647 sink iteration.  It can sometimes be convenient to adjust
4648 the set of potential source iterations before or after each such operation.
4649 The prototypical example is fuzzy array dataflow analysis,
4650 where we need to analyze if, based on data-dependent constraints,
4651 the sink iteration can ever be executed without one or more of
4652 the corresponding potential source iterations being executed.
4653 If so, we can introduce extra parameters and select an unknown
4654 but fixed source iteration from the potential source iterations.
4655 To be able to perform such manipulations, C<isl> provides the following
4656 function.
4658         #include <isl/flow.h>
4660         typedef __isl_give isl_restriction *(*isl_access_restrict)(
4661                 __isl_keep isl_map *source_map,
4662                 __isl_keep isl_set *sink, void *source_user,
4663                 void *user);
4664         __isl_give isl_access_info *isl_access_info_set_restrict(
4665                 __isl_take isl_access_info *acc,
4666                 isl_access_restrict fn, void *user);
4668 The function C<isl_access_info_set_restrict> should be called
4669 before calling C<isl_access_info_compute_flow> and registers a callback function
4670 that will be called any time C<isl> is about to compute the last
4671 potential source.  The first argument is the (reverse) proto-dependence,
4672 mapping sink iterations to potential source iterations.
4673 The second argument represents the sink iterations for which
4674 we want to compute the last source iteration.
4675 The third argument is the token corresponding to the source
4676 and the final argument is the token passed to C<isl_access_info_set_restrict>.
4677 The callback is expected to return a restriction on either the input or
4678 the output of the operation computing the last potential source.
4679 If the input needs to be restricted then restrictions are needed
4680 for both the source and the sink iterations.  The sink iterations
4681 and the potential source iterations will be intersected with these sets.
4682 If the output needs to be restricted then only a restriction on the source
4683 iterations is required.
4684 If any error occurs, the callback should return C<NULL>.
4685 An C<isl_restriction> object can be created, freed and inspected
4686 using the following functions.
4688         #include <isl/flow.h>
4690         __isl_give isl_restriction *isl_restriction_input(
4691                 __isl_take isl_set *source_restr,
4692                 __isl_take isl_set *sink_restr);
4693         __isl_give isl_restriction *isl_restriction_output(
4694                 __isl_take isl_set *source_restr);
4695         __isl_give isl_restriction *isl_restriction_none(
4696                 __isl_take isl_map *source_map);
4697         __isl_give isl_restriction *isl_restriction_empty(
4698                 __isl_take isl_map *source_map);
4699         void *isl_restriction_free(
4700                 __isl_take isl_restriction *restr);
4701         isl_ctx *isl_restriction_get_ctx(
4702                 __isl_keep isl_restriction *restr);
4704 C<isl_restriction_none> and C<isl_restriction_empty> are special
4705 cases of C<isl_restriction_input>.  C<isl_restriction_none>
4706 is essentially equivalent to
4708         isl_restriction_input(isl_set_universe(
4709             isl_space_range(isl_map_get_space(source_map))),
4710                             isl_set_universe(
4711             isl_space_domain(isl_map_get_space(source_map))));
4713 whereas C<isl_restriction_empty> is essentially equivalent to
4715         isl_restriction_input(isl_set_empty(
4716             isl_space_range(isl_map_get_space(source_map))),
4717                             isl_set_universe(
4718             isl_space_domain(isl_map_get_space(source_map))));
4720 =head2 Scheduling
4722 B<The functionality described in this section is fairly new
4723 and may be subject to change.>
4725 The following function can be used to compute a schedule
4726 for a union of domains.
4727 By default, the algorithm used to construct the schedule is similar
4728 to that of C<Pluto>.
4729 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
4730 be selected.
4731 The generated schedule respects all C<validity> dependences.
4732 That is, all dependence distances over these dependences in the
4733 scheduled space are lexicographically positive.
4734 The default algorithm tries to minimize the dependence distances over
4735 C<proximity> dependences.
4736 Moreover, it tries to obtain sequences (bands) of schedule dimensions
4737 for groups of domains where the dependence distances have only
4738 non-negative values.
4739 When using Feautrier's algorithm, the C<proximity> dependence
4740 distances are only minimized during the extension to a
4741 full-dimensional schedule.
4743         #include <isl/schedule.h>
4744         __isl_give isl_schedule *isl_union_set_compute_schedule(
4745                 __isl_take isl_union_set *domain,
4746                 __isl_take isl_union_map *validity,
4747                 __isl_take isl_union_map *proximity);
4748         void *isl_schedule_free(__isl_take isl_schedule *sched);
4750 A mapping from the domains to the scheduled space can be obtained
4751 from an C<isl_schedule> using the following function.
4753         __isl_give isl_union_map *isl_schedule_get_map(
4754                 __isl_keep isl_schedule *sched);
4756 A representation of the schedule can be printed using
4757          
4758         __isl_give isl_printer *isl_printer_print_schedule(
4759                 __isl_take isl_printer *p,
4760                 __isl_keep isl_schedule *schedule);
4762 A representation of the schedule as a forest of bands can be obtained
4763 using the following function.
4765         __isl_give isl_band_list *isl_schedule_get_band_forest(
4766                 __isl_keep isl_schedule *schedule);
4768 The individual bands can be visited in depth-first post-order
4769 using the following function.
4771         #include <isl/schedule.h>
4772         int isl_schedule_foreach_band(
4773                 __isl_keep isl_schedule *sched,
4774                 int (*fn)(__isl_keep isl_band *band, void *user),
4775                 void *user);
4777 The list can be manipulated as explained in L<"Lists">.
4778 The bands inside the list can be copied and freed using the following
4779 functions.
4781         #include <isl/band.h>
4782         __isl_give isl_band *isl_band_copy(
4783                 __isl_keep isl_band *band);
4784         void *isl_band_free(__isl_take isl_band *band);
4786 Each band contains zero or more scheduling dimensions.
4787 These are referred to as the members of the band.
4788 The section of the schedule that corresponds to the band is
4789 referred to as the partial schedule of the band.
4790 For those nodes that participate in a band, the outer scheduling
4791 dimensions form the prefix schedule, while the inner scheduling
4792 dimensions form the suffix schedule.
4793 That is, if we take a cut of the band forest, then the union of
4794 the concatenations of the prefix, partial and suffix schedules of
4795 each band in the cut is equal to the entire schedule (modulo
4796 some possible padding at the end with zero scheduling dimensions).
4797 The properties of a band can be inspected using the following functions.
4799         #include <isl/band.h>
4800         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
4802         int isl_band_has_children(__isl_keep isl_band *band);
4803         __isl_give isl_band_list *isl_band_get_children(
4804                 __isl_keep isl_band *band);
4806         __isl_give isl_union_map *isl_band_get_prefix_schedule(
4807                 __isl_keep isl_band *band);
4808         __isl_give isl_union_map *isl_band_get_partial_schedule(
4809                 __isl_keep isl_band *band);
4810         __isl_give isl_union_map *isl_band_get_suffix_schedule(
4811                 __isl_keep isl_band *band);
4813         int isl_band_n_member(__isl_keep isl_band *band);
4814         int isl_band_member_is_zero_distance(
4815                 __isl_keep isl_band *band, int pos);
4817         int isl_band_list_foreach_band(
4818                 __isl_keep isl_band_list *list,
4819                 int (*fn)(__isl_keep isl_band *band, void *user),
4820                 void *user);
4822 Note that a scheduling dimension is considered to be ``zero
4823 distance'' if it does not carry any proximity dependences
4824 within its band.
4825 That is, if the dependence distances of the proximity
4826 dependences are all zero in that direction (for fixed
4827 iterations of outer bands).
4828 Like C<isl_schedule_foreach_band>,
4829 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
4830 in depth-first post-order.
4832 A band can be tiled using the following function.
4834         #include <isl/band.h>
4835         int isl_band_tile(__isl_keep isl_band *band,
4836                 __isl_take isl_vec *sizes);
4838         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
4839                 int val);
4840         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
4842 The C<isl_band_tile> function tiles the band using the given tile sizes
4843 inside its schedule.
4844 A new child band is created to represent the point loops and it is
4845 inserted between the modified band and its children.
4846 The C<tile_scale_tile_loops> option specifies whether the tile
4847 loops iterators should be scaled by the tile sizes.
4849 A representation of the band can be printed using
4851         #include <isl/band.h>
4852         __isl_give isl_printer *isl_printer_print_band(
4853                 __isl_take isl_printer *p,
4854                 __isl_keep isl_band *band);
4856 =head3 Options
4858         #include <isl/schedule.h>
4859         int isl_options_set_schedule_max_coefficient(
4860                 isl_ctx *ctx, int val);
4861         int isl_options_get_schedule_max_coefficient(
4862                 isl_ctx *ctx);
4863         int isl_options_set_schedule_max_constant_term(
4864                 isl_ctx *ctx, int val);
4865         int isl_options_get_schedule_max_constant_term(
4866                 isl_ctx *ctx);
4867         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
4868         int isl_options_get_schedule_fuse(isl_ctx *ctx);
4869         int isl_options_set_schedule_maximize_band_depth(
4870                 isl_ctx *ctx, int val);
4871         int isl_options_get_schedule_maximize_band_depth(
4872                 isl_ctx *ctx);
4873         int isl_options_set_schedule_outer_zero_distance(
4874                 isl_ctx *ctx, int val);
4875         int isl_options_get_schedule_outer_zero_distance(
4876                 isl_ctx *ctx);
4877         int isl_options_set_schedule_split_scaled(
4878                 isl_ctx *ctx, int val);
4879         int isl_options_get_schedule_split_scaled(
4880                 isl_ctx *ctx);
4881         int isl_options_set_schedule_algorithm(
4882                 isl_ctx *ctx, int val);
4883         int isl_options_get_schedule_algorithm(
4884                 isl_ctx *ctx);
4885         int isl_options_set_schedule_separate_components(
4886                 isl_ctx *ctx, int val);
4887         int isl_options_get_schedule_separate_components(
4888                 isl_ctx *ctx);
4890 =over
4892 =item * schedule_max_coefficient
4894 This option enforces that the coefficients for variable and parameter
4895 dimensions in the calculated schedule are not larger than the specified value.
4896 This option can significantly increase the speed of the scheduling calculation
4897 and may also prevent fusing of unrelated dimensions. A value of -1 means that
4898 this option does not introduce bounds on the variable or parameter
4899 coefficients.
4901 =item * schedule_max_constant_term
4903 This option enforces that the constant coefficients in the calculated schedule
4904 are not larger than the maximal constant term. This option can significantly
4905 increase the speed of the scheduling calculation and may also prevent fusing of
4906 unrelated dimensions. A value of -1 means that this option does not introduce
4907 bounds on the constant coefficients.
4909 =item * schedule_fuse
4911 This option controls the level of fusion.
4912 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
4913 resulting schedule will be distributed as much as possible.
4914 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
4915 try to fuse loops in the resulting schedule.
4917 =item * schedule_maximize_band_depth
4919 If this option is set, we do not split bands at the point
4920 where we detect splitting is necessary. Instead, we
4921 backtrack and split bands as early as possible. This
4922 reduces the number of splits and maximizes the width of
4923 the bands. Wider bands give more possibilities for tiling.
4924 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
4925 then bands will be split as early as possible, even if there is no need.
4926 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
4928 =item * schedule_outer_zero_distance
4930 If this option is set, then we try to construct schedules
4931 where the outermost scheduling dimension in each band
4932 results in a zero dependence distance over the proximity
4933 dependences.
4935 =item * schedule_split_scaled
4937 If this option is set, then we try to construct schedules in which the
4938 constant term is split off from the linear part if the linear parts of
4939 the scheduling rows for all nodes in the graphs have a common non-trivial
4940 divisor.
4941 The constant term is then placed in a separate band and the linear
4942 part is reduced.
4944 =item * schedule_algorithm
4946 Selects the scheduling algorithm to be used.
4947 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
4948 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
4950 =item * schedule_separate_components
4952 If at any point the dependence graph contains any (weakly connected) components,
4953 then these components are scheduled separately.
4954 If this option is not set, then some iterations of the domains
4955 in these components may be scheduled together.
4956 If this option is set, then the components are given consecutive
4957 schedules.
4959 =back
4961 =head2 Parametric Vertex Enumeration
4963 The parametric vertex enumeration described in this section
4964 is mainly intended to be used internally and by the C<barvinok>
4965 library.
4967         #include <isl/vertices.h>
4968         __isl_give isl_vertices *isl_basic_set_compute_vertices(
4969                 __isl_keep isl_basic_set *bset);
4971 The function C<isl_basic_set_compute_vertices> performs the
4972 actual computation of the parametric vertices and the chamber
4973 decomposition and store the result in an C<isl_vertices> object.
4974 This information can be queried by either iterating over all
4975 the vertices or iterating over all the chambers or cells
4976 and then iterating over all vertices that are active on the chamber.
4978         int isl_vertices_foreach_vertex(
4979                 __isl_keep isl_vertices *vertices,
4980                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4981                 void *user);
4983         int isl_vertices_foreach_cell(
4984                 __isl_keep isl_vertices *vertices,
4985                 int (*fn)(__isl_take isl_cell *cell, void *user),
4986                 void *user);
4987         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
4988                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4989                 void *user);
4991 Other operations that can be performed on an C<isl_vertices> object are
4992 the following.
4994         isl_ctx *isl_vertices_get_ctx(
4995                 __isl_keep isl_vertices *vertices);
4996         int isl_vertices_get_n_vertices(
4997                 __isl_keep isl_vertices *vertices);
4998         void isl_vertices_free(__isl_take isl_vertices *vertices);
5000 Vertices can be inspected and destroyed using the following functions.
5002         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5003         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5004         __isl_give isl_basic_set *isl_vertex_get_domain(
5005                 __isl_keep isl_vertex *vertex);
5006         __isl_give isl_basic_set *isl_vertex_get_expr(
5007                 __isl_keep isl_vertex *vertex);
5008         void isl_vertex_free(__isl_take isl_vertex *vertex);
5010 C<isl_vertex_get_expr> returns a singleton parametric set describing
5011 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5012 of the vertex.
5013 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5014 B<rational> basic sets, so they should mainly be used for inspection
5015 and should not be mixed with integer sets.
5017 Chambers can be inspected and destroyed using the following functions.
5019         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5020         __isl_give isl_basic_set *isl_cell_get_domain(
5021                 __isl_keep isl_cell *cell);
5022         void isl_cell_free(__isl_take isl_cell *cell);
5024 =head1 Applications
5026 Although C<isl> is mainly meant to be used as a library,
5027 it also contains some basic applications that use some
5028 of the functionality of C<isl>.
5029 The input may be specified in either the L<isl format>
5030 or the L<PolyLib format>.
5032 =head2 C<isl_polyhedron_sample>
5034 C<isl_polyhedron_sample> takes a polyhedron as input and prints
5035 an integer element of the polyhedron, if there is any.
5036 The first column in the output is the denominator and is always
5037 equal to 1.  If the polyhedron contains no integer points,
5038 then a vector of length zero is printed.
5040 =head2 C<isl_pip>
5042 C<isl_pip> takes the same input as the C<example> program
5043 from the C<piplib> distribution, i.e., a set of constraints
5044 on the parameters, a line containing only -1 and finally a set
5045 of constraints on a parametric polyhedron.
5046 The coefficients of the parameters appear in the last columns
5047 (but before the final constant column).
5048 The output is the lexicographic minimum of the parametric polyhedron.
5049 As C<isl> currently does not have its own output format, the output
5050 is just a dump of the internal state.
5052 =head2 C<isl_polyhedron_minimize>
5054 C<isl_polyhedron_minimize> computes the minimum of some linear
5055 or affine objective function over the integer points in a polyhedron.
5056 If an affine objective function
5057 is given, then the constant should appear in the last column.
5059 =head2 C<isl_polytope_scan>
5061 Given a polytope, C<isl_polytope_scan> prints
5062 all integer points in the polytope.