add isl_multi_*_mod_multi_val
[isl.git] / doc / user.pod
blob1797116553b645c09fa922b1871e217402a011c6
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> or C<imath>.
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 discussion group at
21 L<http://groups.google.com/group/isl-development>.
23 =head2 Backward Incompatible Changes
25 =head3 Changes since isl-0.02
27 =over
29 =item * The old printing functions have been deprecated
30 and replaced by C<isl_printer> functions, see L<Input and Output>.
32 =item * Most functions related to dependence analysis have acquired
33 an extra C<must> argument.  To obtain the old behavior, this argument
34 should be given the value 1.  See L<Dependence Analysis>.
36 =back
38 =head3 Changes since isl-0.03
40 =over
42 =item * The function C<isl_pw_qpolynomial_fold_add> has been
43 renamed to C<isl_pw_qpolynomial_fold_fold>.
44 Similarly, C<isl_union_pw_qpolynomial_fold_add> has been
45 renamed to C<isl_union_pw_qpolynomial_fold_fold>.
47 =back
49 =head3 Changes since isl-0.04
51 =over
53 =item * All header files have been renamed from C<isl_header.h>
54 to C<isl/header.h>.
56 =back
58 =head3 Changes since isl-0.05
60 =over
62 =item * The functions C<isl_printer_print_basic_set> and
63 C<isl_printer_print_basic_map> no longer print a newline.
65 =item * The functions C<isl_flow_get_no_source>
66 and C<isl_union_map_compute_flow> now return
67 the accesses for which no source could be found instead of
68 the iterations where those accesses occur.
70 =item * The functions C<isl_basic_map_identity> and
71 C<isl_map_identity> now take a B<map> space as input.  An old call
72 C<isl_map_identity(space)> can be rewritten to
73 C<isl_map_identity(isl_space_map_from_set(space))>.
75 =item * The function C<isl_map_power> no longer takes
76 a parameter position as input.  Instead, the exponent
77 is now expressed as the domain of the resulting relation.
79 =back
81 =head3 Changes since isl-0.06
83 =over
85 =item * The format of C<isl_printer_print_qpolynomial>'s
86 C<ISL_FORMAT_ISL> output has changed.
87 Use C<ISL_FORMAT_C> to obtain the old output.
89 =item * The C<*_fast_*> functions have been renamed to C<*_plain_*>.
90 Some of the old names have been kept for backward compatibility,
91 but they will be removed in the future.
93 =back
95 =head3 Changes since isl-0.07
97 =over
99 =item * The function C<isl_pw_aff_max> has been renamed to
100 C<isl_pw_aff_union_max>.
101 Similarly, the function C<isl_pw_aff_add> has been renamed to
102 C<isl_pw_aff_union_add>.
104 =item * The C<isl_dim> type has been renamed to C<isl_space>
105 along with the associated functions.
106 Some of the old names have been kept for backward compatibility,
107 but they will be removed in the future.
109 =item * Spaces of maps, sets and parameter domains are now
110 treated differently.  The distinction between map spaces and set spaces
111 has always been made on a conceptual level, but proper use of such spaces
112 was never checked.  Furthermore, up until isl-0.07 there was no way
113 of explicitly creating a parameter space.  These can now be created
114 directly using C<isl_space_params_alloc> or from other spaces using
115 C<isl_space_params>.
117 =item * The space in which C<isl_aff>, C<isl_pw_aff>, C<isl_qpolynomial>,
118 C<isl_pw_qpolynomial>, C<isl_qpolynomial_fold> and C<isl_pw_qpolynomial_fold>
119 objects live is now a map space
120 instead of a set space.  This means, for example, that the dimensions
121 of the domain of an C<isl_aff> are now considered to be of type
122 C<isl_dim_in> instead of C<isl_dim_set>.  Extra functions have been
123 added to obtain the domain space.  Some of the constructors still
124 take a domain space and have therefore been renamed.
126 =item * The functions C<isl_equality_alloc> and C<isl_inequality_alloc>
127 now take an C<isl_local_space> instead of an C<isl_space>.
128 An C<isl_local_space> can be created from an C<isl_space>
129 using C<isl_local_space_from_space>.
131 =item * The C<isl_div> type has been removed.  Functions that used
132 to return an C<isl_div> now return an C<isl_aff>.
133 Note that the space of an C<isl_aff> is that of relation.
134 When replacing a call to C<isl_div_get_coefficient> by a call to
135 C<isl_aff_get_coefficient> any C<isl_dim_set> argument needs
136 to be replaced by C<isl_dim_in>.
137 A call to C<isl_aff_from_div> can be replaced by a call
138 to C<isl_aff_floor>.
139 A call to C<isl_qpolynomial_div(div)> call be replaced by
140 the nested call
142         isl_qpolynomial_from_aff(isl_aff_floor(div))
144 The function C<isl_constraint_div> has also been renamed
145 to C<isl_constraint_get_div>.
147 =item * The C<nparam> argument has been removed from
148 C<isl_map_read_from_str> and similar functions.
149 When reading input in the original PolyLib format,
150 the result will have no parameters.
151 If parameters are expected, the caller may want to perform
152 dimension manipulation on the result.
154 =back
156 =head3 Changes since isl-0.09
158 =over
160 =item * The C<schedule_split_parallel> option has been replaced
161 by the C<schedule_split_scaled> option.
163 =item * The first argument of C<isl_pw_aff_cond> is now
164 an C<isl_pw_aff> instead of an C<isl_set>.
165 A call C<isl_pw_aff_cond(a, b, c)> can be replaced by
167         isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
169 =back
171 =head3 Changes since isl-0.10
173 =over
175 =item * The functions C<isl_set_dim_has_lower_bound> and
176 C<isl_set_dim_has_upper_bound> have been renamed to
177 C<isl_set_dim_has_any_lower_bound> and
178 C<isl_set_dim_has_any_upper_bound>.
179 The new C<isl_set_dim_has_lower_bound> and
180 C<isl_set_dim_has_upper_bound> have slightly different meanings.
182 =back
184 =head3 Changes since isl-0.12
186 =over
188 =item * C<isl_int> has been replaced by C<isl_val>.
189 Some of the old functions are still available in C<isl/deprecated/*.h>
190 but they will be removed in the future.
192 =item * The functions C<isl_pw_qpolynomial_eval>,
193 C<isl_union_pw_qpolynomial_eval>, C<isl_pw_qpolynomial_fold_eval>
194 and C<isl_union_pw_qpolynomial_fold_eval> have been changed to return
195 an C<isl_val> instead of an C<isl_qpolynomial>.
197 =item * The function C<isl_band_member_is_zero_distance>
198 has been removed.  Essentially the same functionality is available
199 through C<isl_band_member_is_coincident>, except that is requires
200 setting up coincidence constraints.
201 The option C<schedule_outer_zero_distance> has accordingly been
202 replaced by the option C<schedule_outer_coincidence>.
204 =item * The function C<isl_vertex_get_expr> has been changed
205 to return an C<isl_multi_aff> instead of a rational C<isl_basic_set>.
206 The function C<isl_vertex_get_domain> has been changed to return
207 a regular basic set, rather than a rational basic set.
209 =back
211 =head3 Changes since isl-0.14
213 =over
215 =item * Objects of type C<isl_union_pw_multi_aff> can no longer contain
216 two or more C<isl_pw_multi_aff> objects with the same domain space.
218 =item * The function C<isl_union_pw_multi_aff_add> now consistently
219 computes the sum on the shared definition domain.
220 The function C<isl_union_pw_multi_aff_union_add> has been added
221 to compute the sum on the union of definition domains.
222 The original behavior of C<isl_union_pw_multi_aff_add> was
223 confused and is no longer available.
225 =back
227 =head1 License
229 C<isl> is released under the MIT license.
231 =over
233 Permission is hereby granted, free of charge, to any person obtaining a copy of
234 this software and associated documentation files (the "Software"), to deal in
235 the Software without restriction, including without limitation the rights to
236 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
237 of the Software, and to permit persons to whom the Software is furnished to do
238 so, subject to the following conditions:
240 The above copyright notice and this permission notice shall be included in all
241 copies or substantial portions of the Software.
243 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
244 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
245 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
246 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
247 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
248 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
249 SOFTWARE.
251 =back
253 Note that by default C<isl> requires C<GMP>, which is released
254 under the GNU Lesser General Public License (LGPL).  This means
255 that code linked against C<isl> is also linked against LGPL code.
257 When configuring with C<--with-int=imath>, C<isl> will link against C<imath>, a
258 library for exact integer arithmetic released under the MIT license.
260 =head1 Installation
262 The source of C<isl> can be obtained either as a tarball
263 or from the git repository.  Both are available from
264 L<http://freshmeat.net/projects/isl/>.
265 The installation process depends on how you obtained
266 the source.
268 =head2 Installation from the git repository
270 =over
272 =item 1 Clone or update the repository
274 The first time the source is obtained, you need to clone
275 the repository.
277         git clone git://repo.or.cz/isl.git
279 To obtain updates, you need to pull in the latest changes
281         git pull
283 =item 2 Optionally get C<imath> submodule
285 To build C<isl> with C<imath>, you need to obtain the C<imath>
286 submodule by running in the git source tree of C<isl>
288        git submodule init
289        git submodule update
291 This will fetch the required version of C<imath> in a subdirectory of C<isl>.
293 =item 2 Generate C<configure>
295         ./autogen.sh
297 =back
299 After performing the above steps, continue
300 with the L<Common installation instructions>.
302 =head2 Common installation instructions
304 =over
306 =item 1 Obtain C<GMP>
308 By default, building C<isl> requires C<GMP>, including its headers files.
309 Your distribution may not provide these header files by default
310 and you may need to install a package called C<gmp-devel> or something
311 similar.  Alternatively, C<GMP> can be built from
312 source, available from L<http://gmplib.org/>.
313 C<GMP> is not needed if you build C<isl> with C<imath>.
315 =item 2 Configure
317 C<isl> uses the standard C<autoconf> C<configure> script.
318 To run it, just type
320         ./configure
322 optionally followed by some configure options.
323 A complete list of options can be obtained by running
325         ./configure --help
327 Below we discuss some of the more common options.
329 =over
331 =item C<--prefix>
333 Installation prefix for C<isl>
335 =item C<--with-int=[gmp|imath]>
337 Select the integer library to be used by C<isl>, the default is C<gmp>.
338 Note that C<isl> may run significantly slower if you use C<imath>.
340 =item C<--with-gmp-prefix>
342 Installation prefix for C<GMP> (architecture-independent files).
344 =item C<--with-gmp-exec-prefix>
346 Installation prefix for C<GMP> (architecture-dependent files).
348 =back
350 =item 3 Compile
352         make
354 =item 4 Install (optional)
356         make install
358 =back
360 =head1 Integer Set Library
362 =head2 Memory Management
364 Since a high-level operation on isl objects usually involves
365 several substeps and since the user is usually not interested in
366 the intermediate results, most functions that return a new object
367 will also release all the objects passed as arguments.
368 If the user still wants to use one or more of these arguments
369 after the function call, she should pass along a copy of the
370 object rather than the object itself.
371 The user is then responsible for making sure that the original
372 object gets used somewhere else or is explicitly freed.
374 The arguments and return values of all documented functions are
375 annotated to make clear which arguments are released and which
376 arguments are preserved.  In particular, the following annotations
377 are used
379 =over
381 =item C<__isl_give>
383 C<__isl_give> means that a new object is returned.
384 The user should make sure that the returned pointer is
385 used exactly once as a value for an C<__isl_take> argument.
386 In between, it can be used as a value for as many
387 C<__isl_keep> arguments as the user likes.
388 There is one exception, and that is the case where the
389 pointer returned is C<NULL>.  Is this case, the user
390 is free to use it as an C<__isl_take> argument or not.
391 When applied to a C<char *>, the returned pointer needs to be
392 freed using C<free>.
394 =item C<__isl_null>
396 C<__isl_null> means that a C<NULL> value is returned.
398 =item C<__isl_take>
400 C<__isl_take> means that the object the argument points to
401 is taken over by the function and may no longer be used
402 by the user as an argument to any other function.
403 The pointer value must be one returned by a function
404 returning an C<__isl_give> pointer.
405 If the user passes in a C<NULL> value, then this will
406 be treated as an error in the sense that the function will
407 not perform its usual operation.  However, it will still
408 make sure that all the other C<__isl_take> arguments
409 are released.
411 =item C<__isl_keep>
413 C<__isl_keep> means that the function will only use the object
414 temporarily.  After the function has finished, the user
415 can still use it as an argument to other functions.
416 A C<NULL> value will be treated in the same way as
417 a C<NULL> value for an C<__isl_take> argument.
418 This annotation may also be used on return values of
419 type C<const char *>, in which case the returned pointer should
420 not be freed by the user and is only valid until the object
421 from which it was derived is updated or freed.
423 =back
425 =head2 Initialization
427 All manipulations of integer sets and relations occur within
428 the context of an C<isl_ctx>.
429 A given C<isl_ctx> can only be used within a single thread.
430 All arguments of a function are required to have been allocated
431 within the same context.
432 There are currently no functions available for moving an object
433 from one C<isl_ctx> to another C<isl_ctx>.  This means that
434 there is currently no way of safely moving an object from one
435 thread to another, unless the whole C<isl_ctx> is moved.
437 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
438 freed using C<isl_ctx_free>.
439 All objects allocated within an C<isl_ctx> should be freed
440 before the C<isl_ctx> itself is freed.
442         isl_ctx *isl_ctx_alloc();
443         void isl_ctx_free(isl_ctx *ctx);
445 The user can impose a bound on the number of low-level I<operations>
446 that can be performed by an C<isl_ctx>.  This bound can be set and
447 retrieved using the following functions.  A bound of zero means that
448 no bound is imposed.  The number of operations performed can be
449 reset using C<isl_ctx_reset_operations>.  Note that the number
450 of low-level operations needed to perform a high-level computation
451 may differ significantly across different versions
452 of C<isl>, but it should be the same across different platforms
453 for the same version of C<isl>.
455 Warning: This feature is experimental.  C<isl> has good support to abort and
456 bail out during the computation, but this feature may exercise error code paths
457 that are normally not used that much. Consequently, it is not unlikely that
458 hidden bugs will be exposed.
460         void isl_ctx_set_max_operations(isl_ctx *ctx,
461                 unsigned long max_operations);
462         unsigned long isl_ctx_get_max_operations(isl_ctx *ctx);
463         void isl_ctx_reset_operations(isl_ctx *ctx);
465 In order to be able to create an object in the same context
466 as another object, most object types (described later in
467 this document) provide a function to obtain the context
468 in which the object was created.
470         #include <isl/val.h>
471         isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
472         isl_ctx *isl_multi_val_get_ctx(
473                 __isl_keep isl_multi_val *mv);
475         #include <isl/id.h>
476         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
478         #include <isl/local_space.h>
479         isl_ctx *isl_local_space_get_ctx(
480                 __isl_keep isl_local_space *ls);
482         #include <isl/set.h>
483         isl_ctx *isl_set_list_get_ctx(
484                 __isl_keep isl_set_list *list);
486         #include <isl/aff.h>
487         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
488         isl_ctx *isl_multi_aff_get_ctx(
489                 __isl_keep isl_multi_aff *maff);
490         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pa);
491         isl_ctx *isl_pw_multi_aff_get_ctx(
492                 __isl_keep isl_pw_multi_aff *pma);
493         isl_ctx *isl_multi_pw_aff_get_ctx(
494                 __isl_keep isl_multi_pw_aff *mpa);
495         isl_ctx *isl_union_pw_multi_aff_get_ctx(
496                 __isl_keep isl_union_pw_multi_aff *upma);
498         #include <isl/id_to_ast_expr.h>
499         isl_ctx *isl_id_to_ast_expr_get_ctx(
500                 __isl_keep id_to_ast_expr *id2expr);
502         #include <isl/point.h>
503         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
505         #include <isl/vec.h>
506         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
508         #include <isl/mat.h>
509         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
511         #include <isl/vertices.h>
512         isl_ctx *isl_vertices_get_ctx(
513                 __isl_keep isl_vertices *vertices);
514         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
515         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
517         #include <isl/flow.h>
518         isl_ctx *isl_restriction_get_ctx(
519                 __isl_keep isl_restriction *restr);
521         #include <isl/schedule.h>
522         isl_ctx *isl_schedule_constraints_get_ctx(
523                 __isl_keep isl_schedule_constraints *sc);
525         #include <isl/band.h>
526         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
528         #include <isl/ast_build.h>
529         isl_ctx *isl_ast_build_get_ctx(
530                 __isl_keep isl_ast_build *build);
532         #include <isl/ast.h>
533         isl_ctx *isl_ast_expr_get_ctx(
534                 __isl_keep isl_ast_expr *expr);
535         isl_ctx *isl_ast_node_get_ctx(
536                 __isl_keep isl_ast_node *node);
538 =head2 Values
540 An C<isl_val> represents an integer value, a rational value
541 or one of three special values, infinity, negative infinity and NaN.
542 Some predefined values can be created using the following functions.
544         #include <isl/val.h>
545         __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
546         __isl_give isl_val *isl_val_one(isl_ctx *ctx);
547         __isl_give isl_val *isl_val_negone(isl_ctx *ctx);
548         __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
549         __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
550         __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
552 Specific integer values can be created using the following functions.
554         #include <isl/val.h>
555         __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
556                 long i);
557         __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
558                 unsigned long u);
559         __isl_give isl_val *isl_val_int_from_chunks(isl_ctx *ctx,
560                 size_t n, size_t size, const void *chunks);
562 The function C<isl_val_int_from_chunks> constructs an C<isl_val>
563 from the C<n> I<digits>, each consisting of C<size> bytes, stored at C<chunks>.
564 The least significant digit is assumed to be stored first.
566 Value objects can be copied and freed using the following functions.
568         #include <isl/val.h>
569         __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
570         __isl_null isl_val *isl_val_free(__isl_take isl_val *v);
572 They can be inspected using the following functions.
574         #include <isl/val.h>
575         long isl_val_get_num_si(__isl_keep isl_val *v);
576         long isl_val_get_den_si(__isl_keep isl_val *v);
577         double isl_val_get_d(__isl_keep isl_val *v);
578         size_t isl_val_n_abs_num_chunks(__isl_keep isl_val *v,
579                 size_t size);
580         int isl_val_get_abs_num_chunks(__isl_keep isl_val *v,
581                 size_t size, void *chunks);
583 C<isl_val_n_abs_num_chunks> returns the number of I<digits>
584 of C<size> bytes needed to store the absolute value of the
585 numerator of C<v>.
586 C<isl_val_get_abs_num_chunks> stores these digits at C<chunks>,
587 which is assumed to have been preallocated by the caller.
588 The least significant digit is stored first.
589 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si>,
590 C<isl_val_get_d>, C<isl_val_n_abs_num_chunks>
591 and C<isl_val_get_abs_num_chunks> can only be applied to rational values.
593 An C<isl_val> can be modified using the following function.
595         #include <isl/val.h>
596         __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
597                 long i);
599 The following unary properties are defined on C<isl_val>s.
601         #include <isl/val.h>
602         int isl_val_sgn(__isl_keep isl_val *v);
603         int isl_val_is_zero(__isl_keep isl_val *v);
604         int isl_val_is_one(__isl_keep isl_val *v);
605         int isl_val_is_negone(__isl_keep isl_val *v);
606         int isl_val_is_nonneg(__isl_keep isl_val *v);
607         int isl_val_is_nonpos(__isl_keep isl_val *v);
608         int isl_val_is_pos(__isl_keep isl_val *v);
609         int isl_val_is_neg(__isl_keep isl_val *v);
610         int isl_val_is_int(__isl_keep isl_val *v);
611         int isl_val_is_rat(__isl_keep isl_val *v);
612         int isl_val_is_nan(__isl_keep isl_val *v);
613         int isl_val_is_infty(__isl_keep isl_val *v);
614         int isl_val_is_neginfty(__isl_keep isl_val *v);
616 Note that the sign of NaN is undefined.
618 The following binary properties are defined on pairs of C<isl_val>s.
620         #include <isl/val.h>
621         int isl_val_lt(__isl_keep isl_val *v1,
622                 __isl_keep isl_val *v2);
623         int isl_val_le(__isl_keep isl_val *v1,
624                 __isl_keep isl_val *v2);
625         int isl_val_gt(__isl_keep isl_val *v1,
626                 __isl_keep isl_val *v2);
627         int isl_val_ge(__isl_keep isl_val *v1,
628                 __isl_keep isl_val *v2);
629         int isl_val_eq(__isl_keep isl_val *v1,
630                 __isl_keep isl_val *v2);
631         int isl_val_ne(__isl_keep isl_val *v1,
632                 __isl_keep isl_val *v2);
633         int isl_val_abs_eq(__isl_keep isl_val *v1,
634                 __isl_keep isl_val *v2);
636 The function C<isl_val_abs_eq> checks whether its two arguments
637 are equal in absolute value.
639 For integer C<isl_val>s we additionally have the following binary property.
641         #include <isl/val.h>
642         int isl_val_is_divisible_by(__isl_keep isl_val *v1,
643                 __isl_keep isl_val *v2);
645 An C<isl_val> can also be compared to an integer using the following
646 function.  The result is undefined for NaN.
648         #include <isl/val.h>
649         int isl_val_cmp_si(__isl_keep isl_val *v, long i);
651 The following unary operations are available on C<isl_val>s.
653         #include <isl/val.h>
654         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
655         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
656         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
657         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
658         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
659         __isl_give isl_val *isl_val_inv(__isl_take isl_val *v);
660         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
662 The following binary operations are available on C<isl_val>s.
664         #include <isl/val.h>
665         __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
666                 __isl_take isl_val *v2);
667         __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
668                 __isl_take isl_val *v2);
669         __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
670                 __isl_take isl_val *v2);
671         __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
672                 unsigned long v2);
673         __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
674                 __isl_take isl_val *v2);
675         __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
676                 unsigned long v2);
677         __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
678                 __isl_take isl_val *v2);
679         __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
680                 unsigned long v2);
681         __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
682                 __isl_take isl_val *v2);
684 On integer values, we additionally have the following operations.
686         #include <isl/val.h>
687         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
688         __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
689                 __isl_take isl_val *v2);
690         __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
691                 __isl_take isl_val *v2);
692         __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
693                 __isl_take isl_val *v2, __isl_give isl_val **x,
694                 __isl_give isl_val **y);
696 The function C<isl_val_gcdext> returns the greatest common divisor g
697 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
698 that C<*x> * C<v1> + C<*y> * C<v2> = g.
700 =head3 GMP specific functions
702 These functions are only available if C<isl> has been compiled with C<GMP>
703 support.
705 Specific integer and rational values can be created from C<GMP> values using
706 the following functions.
708         #include <isl/val_gmp.h>
709         __isl_give isl_val *isl_val_int_from_gmp(isl_ctx *ctx,
710                 mpz_t z);
711         __isl_give isl_val *isl_val_from_gmp(isl_ctx *ctx,
712                 const mpz_t n, const mpz_t d);
714 The numerator and denominator of a rational value can be extracted as
715 C<GMP> values using the following functions.
717         #include <isl/val_gmp.h>
718         int isl_val_get_num_gmp(__isl_keep isl_val *v, mpz_t z);
719         int isl_val_get_den_gmp(__isl_keep isl_val *v, mpz_t z);
721 =head2 Sets and Relations
723 C<isl> uses six types of objects for representing sets and relations,
724 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
725 C<isl_union_set> and C<isl_union_map>.
726 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
727 can be described as a conjunction of affine constraints, while
728 C<isl_set> and C<isl_map> represent unions of
729 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
730 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
731 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
732 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
733 where spaces are considered different if they have a different number
734 of dimensions and/or different names (see L<"Spaces">).
735 The difference between sets and relations (maps) is that sets have
736 one set of variables, while relations have two sets of variables,
737 input variables and output variables.
739 =head2 Error Handling
741 C<isl> supports different ways to react in case a runtime error is triggered.
742 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
743 with two maps that have incompatible spaces. There are three possible ways
744 to react on error: to warn, to continue or to abort.
746 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
747 the last error in the corresponding C<isl_ctx> and the function in which the
748 error was triggered returns C<NULL>. An error does not corrupt internal state,
749 such that isl can continue to be used. C<isl> also provides functions to
750 read the last error and to reset the memory that stores the last error. The
751 last error is only stored for information purposes. Its presence does not
752 change the behavior of C<isl>. Hence, resetting an error is not required to
753 continue to use isl, but only to observe new errors.
755         #include <isl/ctx.h>
756         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
757         void isl_ctx_reset_error(isl_ctx *ctx);
759 Another option is to continue on error. This is similar to warn on error mode,
760 except that C<isl> does not print any warning. This allows a program to
761 implement its own error reporting.
763 The last option is to directly abort the execution of the program from within
764 the isl library. This makes it obviously impossible to recover from an error,
765 but it allows to directly spot the error location. By aborting on error,
766 debuggers break at the location the error occurred and can provide a stack
767 trace. Other tools that automatically provide stack traces on abort or that do
768 not want to continue execution after an error was triggered may also prefer to
769 abort on error.
771 The on error behavior of isl can be specified by calling
772 C<isl_options_set_on_error> or by setting the command line option
773 C<--isl-on-error>. Valid arguments for the function call are
774 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
775 choices for the command line option are C<warn>, C<continue> and C<abort>.
776 It is also possible to query the current error mode.
778         #include <isl/options.h>
779         int isl_options_set_on_error(isl_ctx *ctx, int val);
780         int isl_options_get_on_error(isl_ctx *ctx);
782 =head2 Identifiers
784 Identifiers are used to identify both individual dimensions
785 and tuples of dimensions.  They consist of an optional name and an optional
786 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
787 Identifiers with the same name but different pointer values
788 are considered to be distinct.
789 Similarly, identifiers with different names but the same pointer value
790 are also considered to be distinct.
791 Equal identifiers are represented using the same object.
792 Pairs of identifiers can therefore be tested for equality using the
793 C<==> operator.
794 Identifiers can be constructed, copied, freed, inspected and printed
795 using the following functions.
797         #include <isl/id.h>
798         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
799                 __isl_keep const char *name, void *user);
800         __isl_give isl_id *isl_id_set_free_user(
801                 __isl_take isl_id *id,
802                 __isl_give void (*free_user)(void *user));
803         __isl_give isl_id *isl_id_copy(isl_id *id);
804         __isl_null isl_id *isl_id_free(__isl_take isl_id *id);
806         void *isl_id_get_user(__isl_keep isl_id *id);
807         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
809         __isl_give isl_printer *isl_printer_print_id(
810                 __isl_take isl_printer *p, __isl_keep isl_id *id);
812 The callback set by C<isl_id_set_free_user> is called on the user
813 pointer when the last reference to the C<isl_id> is freed.
814 Note that C<isl_id_get_name> returns a pointer to some internal
815 data structure, so the result can only be used while the
816 corresponding C<isl_id> is alive.
818 =head2 Spaces
820 Whenever a new set, relation or similar object is created from scratch,
821 the space in which it lives needs to be specified using an C<isl_space>.
822 Each space involves zero or more parameters and zero, one or two
823 tuples of set or input/output dimensions.  The parameters and dimensions
824 are identified by an C<isl_dim_type> and a position.
825 The type C<isl_dim_param> refers to parameters,
826 the type C<isl_dim_set> refers to set dimensions (for spaces
827 with a single tuple of dimensions) and the types C<isl_dim_in>
828 and C<isl_dim_out> refer to input and output dimensions
829 (for spaces with two tuples of dimensions).
830 Local spaces (see L</"Local Spaces">) also contain dimensions
831 of type C<isl_dim_div>.
832 Note that parameters are only identified by their position within
833 a given object.  Across different objects, parameters are (usually)
834 identified by their names or identifiers.  Only unnamed parameters
835 are identified by their positions across objects.  The use of unnamed
836 parameters is discouraged.
838         #include <isl/space.h>
839         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
840                 unsigned nparam, unsigned n_in, unsigned n_out);
841         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
842                 unsigned nparam);
843         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
844                 unsigned nparam, unsigned dim);
845         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
846         __isl_null isl_space *isl_space_free(__isl_take isl_space *space);
848 The space used for creating a parameter domain
849 needs to be created using C<isl_space_params_alloc>.
850 For other sets, the space
851 needs to be created using C<isl_space_set_alloc>, while
852 for a relation, the space
853 needs to be created using C<isl_space_alloc>.
855 To check whether a given space is that of a set or a map
856 or whether it is a parameter space, use these functions:
858         #include <isl/space.h>
859         int isl_space_is_params(__isl_keep isl_space *space);
860         int isl_space_is_set(__isl_keep isl_space *space);
861         int isl_space_is_map(__isl_keep isl_space *space);
863 Spaces can be compared using the following functions:
865         #include <isl/space.h>
866         int isl_space_is_equal(__isl_keep isl_space *space1,
867                 __isl_keep isl_space *space2);
868         int isl_space_is_domain(__isl_keep isl_space *space1,
869                 __isl_keep isl_space *space2);
870         int isl_space_is_range(__isl_keep isl_space *space1,
871                 __isl_keep isl_space *space2);
872         int isl_space_tuple_is_equal(
873                 __isl_keep isl_space *space1,
874                 enum isl_dim_type type1,
875                 __isl_keep isl_space *space2,
876                 enum isl_dim_type type2);
878 C<isl_space_is_domain> checks whether the first argument is equal
879 to the domain of the second argument.  This requires in particular that
880 the first argument is a set space and that the second argument
881 is a map space.  C<isl_space_tuple_is_equal> checks whether the given
882 tuples (C<isl_dim_in>, C<isl_dim_out> or C<isl_dim_set>) of the given
883 spaces are the same.  That is, it checks if they have the same
884 identifier (if any), the same dimension and the same internal structure
885 (if any).
887 It is often useful to create objects that live in the
888 same space as some other object.  This can be accomplished
889 by creating the new objects
890 (see L</"Creating New Sets and Relations"> or
891 L</"Functions">) based on the space
892 of the original object.
894         #include <isl/set.h>
895         __isl_give isl_space *isl_basic_set_get_space(
896                 __isl_keep isl_basic_set *bset);
897         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
899         #include <isl/union_set.h>
900         __isl_give isl_space *isl_union_set_get_space(
901                 __isl_keep isl_union_set *uset);
903         #include <isl/map.h>
904         __isl_give isl_space *isl_basic_map_get_space(
905                 __isl_keep isl_basic_map *bmap);
906         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
908         #include <isl/union_map.h>
909         __isl_give isl_space *isl_union_map_get_space(
910                 __isl_keep isl_union_map *umap);
912         #include <isl/constraint.h>
913         __isl_give isl_space *isl_constraint_get_space(
914                 __isl_keep isl_constraint *constraint);
916         #include <isl/polynomial.h>
917         __isl_give isl_space *isl_qpolynomial_get_domain_space(
918                 __isl_keep isl_qpolynomial *qp);
919         __isl_give isl_space *isl_qpolynomial_get_space(
920                 __isl_keep isl_qpolynomial *qp);
921         __isl_give isl_space *isl_qpolynomial_fold_get_space(
922                 __isl_keep isl_qpolynomial_fold *fold);
923         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
924                 __isl_keep isl_pw_qpolynomial *pwqp);
925         __isl_give isl_space *isl_pw_qpolynomial_get_space(
926                 __isl_keep isl_pw_qpolynomial *pwqp);
927         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
928                 __isl_keep isl_pw_qpolynomial_fold *pwf);
929         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
930                 __isl_keep isl_pw_qpolynomial_fold *pwf);
931         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
932                 __isl_keep isl_union_pw_qpolynomial *upwqp);
933         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
934                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
936         #include <isl/val.h>
937         __isl_give isl_space *isl_multi_val_get_space(
938                 __isl_keep isl_multi_val *mv);
940         #include <isl/aff.h>
941         __isl_give isl_space *isl_aff_get_domain_space(
942                 __isl_keep isl_aff *aff);
943         __isl_give isl_space *isl_aff_get_space(
944                 __isl_keep isl_aff *aff);
945         __isl_give isl_space *isl_pw_aff_get_domain_space(
946                 __isl_keep isl_pw_aff *pwaff);
947         __isl_give isl_space *isl_pw_aff_get_space(
948                 __isl_keep isl_pw_aff *pwaff);
949         __isl_give isl_space *isl_multi_aff_get_domain_space(
950                 __isl_keep isl_multi_aff *maff);
951         __isl_give isl_space *isl_multi_aff_get_space(
952                 __isl_keep isl_multi_aff *maff);
953         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
954                 __isl_keep isl_pw_multi_aff *pma);
955         __isl_give isl_space *isl_pw_multi_aff_get_space(
956                 __isl_keep isl_pw_multi_aff *pma);
957         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
958                 __isl_keep isl_union_pw_multi_aff *upma);
959         __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
960                 __isl_keep isl_multi_pw_aff *mpa);
961         __isl_give isl_space *isl_multi_pw_aff_get_space(
962                 __isl_keep isl_multi_pw_aff *mpa);
964         #include <isl/point.h>
965         __isl_give isl_space *isl_point_get_space(
966                 __isl_keep isl_point *pnt);
968 The number of dimensions of a given type of space
969 may be read off from a space or an object that lives
970 in a space using the following functions.
971 In case of C<isl_space_dim>, type may be
972 C<isl_dim_param>, C<isl_dim_in> (only for relations),
973 C<isl_dim_out> (only for relations), C<isl_dim_set>
974 (only for sets) or C<isl_dim_all>.
976         #include <isl/space.h>
977         unsigned isl_space_dim(__isl_keep isl_space *space,
978                 enum isl_dim_type type);
980         #include <isl/local_space.h>
981         int isl_local_space_dim(__isl_keep isl_local_space *ls,
982                 enum isl_dim_type type);
984         #include <isl/set.h>
985         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
986                 enum isl_dim_type type);
987         unsigned isl_set_dim(__isl_keep isl_set *set,
988                 enum isl_dim_type type);
990         #include <isl/union_set.h>
991         unsigned isl_union_set_dim(__isl_keep isl_union_set *uset,
992                 enum isl_dim_type type);
994         #include <isl/map.h>
995         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
996                 enum isl_dim_type type);
997         unsigned isl_map_dim(__isl_keep isl_map *map,
998                 enum isl_dim_type type);
1000         #include <isl/union_map.h>
1001         unsigned isl_union_map_dim(__isl_keep isl_union_map *umap,
1002                 enum isl_dim_type type);
1004         #include <isl/val.h>
1005         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
1006                 enum isl_dim_type type);
1008         #include <isl/aff.h>
1009         int isl_aff_dim(__isl_keep isl_aff *aff,
1010                 enum isl_dim_type type);
1011         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
1012                 enum isl_dim_type type);
1013         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
1014                 enum isl_dim_type type);
1015         unsigned isl_pw_multi_aff_dim(
1016                 __isl_keep isl_pw_multi_aff *pma,
1017                 enum isl_dim_type type);
1018         unsigned isl_multi_pw_aff_dim(
1019                 __isl_keep isl_multi_pw_aff *mpa,
1020                 enum isl_dim_type type);
1021         unsigned isl_union_pw_multi_aff_dim(
1022                 __isl_keep isl_union_pw_multi_aff *upma,
1023                 enum isl_dim_type type);
1025         #include <isl/polynomial.h>
1026         unsigned isl_union_pw_qpolynomial_dim(
1027                 __isl_keep isl_union_pw_qpolynomial *upwqp,
1028                 enum isl_dim_type type);
1029         unsigned isl_union_pw_qpolynomial_fold_dim(
1030                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
1031                 enum isl_dim_type type);
1033 Note that an C<isl_union_set>, an C<isl_union_map>,
1034 an C<isl_union_pw_multi_aff>,
1035 an C<isl_union_pw_qpolynomial> and
1036 an C<isl_union_pw_qpolynomial_fold>
1037 only have parameters.
1039 The identifiers or names of the individual dimensions of spaces
1040 may be set or read off using the following functions on spaces
1041 or objects that live in spaces.
1042 These functions are mostly useful to obtain the identifiers, positions
1043 or names of the parameters.  Identifiers of individual dimensions are
1044 essentially only useful for printing.  They are ignored by all other
1045 operations and may not be preserved across those operations.
1047         #include <isl/space.h>
1048         __isl_give isl_space *isl_space_set_dim_id(
1049                 __isl_take isl_space *space,
1050                 enum isl_dim_type type, unsigned pos,
1051                 __isl_take isl_id *id);
1052         int isl_space_has_dim_id(__isl_keep isl_space *space,
1053                 enum isl_dim_type type, unsigned pos);
1054         __isl_give isl_id *isl_space_get_dim_id(
1055                 __isl_keep isl_space *space,
1056                 enum isl_dim_type type, unsigned pos);
1057         __isl_give isl_space *isl_space_set_dim_name(
1058                 __isl_take isl_space *space,
1059                  enum isl_dim_type type, unsigned pos,
1060                  __isl_keep const char *name);
1061         int isl_space_has_dim_name(__isl_keep isl_space *space,
1062                 enum isl_dim_type type, unsigned pos);
1063         __isl_keep const char *isl_space_get_dim_name(
1064                 __isl_keep isl_space *space,
1065                 enum isl_dim_type type, unsigned pos);
1067         #include <isl/local_space.h>
1068         __isl_give isl_local_space *isl_local_space_set_dim_id(
1069                 __isl_take isl_local_space *ls,
1070                 enum isl_dim_type type, unsigned pos,
1071                 __isl_take isl_id *id);
1072         int isl_local_space_has_dim_id(
1073                 __isl_keep isl_local_space *ls,
1074                 enum isl_dim_type type, unsigned pos);
1075         __isl_give isl_id *isl_local_space_get_dim_id(
1076                 __isl_keep isl_local_space *ls,
1077                 enum isl_dim_type type, unsigned pos);
1078         __isl_give isl_local_space *isl_local_space_set_dim_name(
1079                 __isl_take isl_local_space *ls,
1080                 enum isl_dim_type type, unsigned pos, const char *s);
1081         int isl_local_space_has_dim_name(
1082                 __isl_keep isl_local_space *ls,
1083                 enum isl_dim_type type, unsigned pos)
1084         const char *isl_local_space_get_dim_name(
1085                 __isl_keep isl_local_space *ls,
1086                 enum isl_dim_type type, unsigned pos);
1088         #include <isl/constraint.h>
1089         const char *isl_constraint_get_dim_name(
1090                 __isl_keep isl_constraint *constraint,
1091                 enum isl_dim_type type, unsigned pos);
1093         #include <isl/set.h>
1094         __isl_give isl_id *isl_basic_set_get_dim_id(
1095                 __isl_keep isl_basic_set *bset,
1096                 enum isl_dim_type type, unsigned pos);
1097         __isl_give isl_set *isl_set_set_dim_id(
1098                 __isl_take isl_set *set, enum isl_dim_type type,
1099                 unsigned pos, __isl_take isl_id *id);
1100         int isl_set_has_dim_id(__isl_keep isl_set *set,
1101                 enum isl_dim_type type, unsigned pos);
1102         __isl_give isl_id *isl_set_get_dim_id(
1103                 __isl_keep isl_set *set, enum isl_dim_type type,
1104                 unsigned pos);
1105         const char *isl_basic_set_get_dim_name(
1106                 __isl_keep isl_basic_set *bset,
1107                 enum isl_dim_type type, unsigned pos);
1108         int isl_set_has_dim_name(__isl_keep isl_set *set,
1109                 enum isl_dim_type type, unsigned pos);
1110         const char *isl_set_get_dim_name(
1111                 __isl_keep isl_set *set,
1112                 enum isl_dim_type type, unsigned pos);
1114         #include <isl/map.h>
1115         __isl_give isl_map *isl_map_set_dim_id(
1116                 __isl_take isl_map *map, enum isl_dim_type type,
1117                 unsigned pos, __isl_take isl_id *id);
1118         int isl_basic_map_has_dim_id(
1119                 __isl_keep isl_basic_map *bmap,
1120                 enum isl_dim_type type, unsigned pos);
1121         int isl_map_has_dim_id(__isl_keep isl_map *map,
1122                 enum isl_dim_type type, unsigned pos);
1123         __isl_give isl_id *isl_map_get_dim_id(
1124                 __isl_keep isl_map *map, enum isl_dim_type type,
1125                 unsigned pos);
1126         __isl_give isl_id *isl_union_map_get_dim_id(
1127                 __isl_keep isl_union_map *umap,
1128                 enum isl_dim_type type, unsigned pos);
1129         const char *isl_basic_map_get_dim_name(
1130                 __isl_keep isl_basic_map *bmap,
1131                 enum isl_dim_type type, unsigned pos);
1132         int isl_map_has_dim_name(__isl_keep isl_map *map,
1133                 enum isl_dim_type type, unsigned pos);
1134         const char *isl_map_get_dim_name(
1135                 __isl_keep isl_map *map,
1136                 enum isl_dim_type type, unsigned pos);
1138         #include <isl/val.h>
1139         __isl_give isl_multi_val *isl_multi_val_set_dim_id(
1140                 __isl_take isl_multi_val *mv,
1141                 enum isl_dim_type type, unsigned pos,
1142                 __isl_take isl_id *id);
1143         __isl_give isl_id *isl_multi_val_get_dim_id(
1144                 __isl_keep isl_multi_val *mv,
1145                 enum isl_dim_type type, unsigned pos);
1146         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
1147                 __isl_take isl_multi_val *mv,
1148                 enum isl_dim_type type, unsigned pos, const char *s);
1150         #include <isl/aff.h>
1151         __isl_give isl_aff *isl_aff_set_dim_id(
1152                 __isl_take isl_aff *aff, enum isl_dim_type type,
1153                 unsigned pos, __isl_take isl_id *id);
1154         __isl_give isl_multi_aff *isl_multi_aff_set_dim_id(
1155                 __isl_take isl_multi_aff *maff,
1156                 enum isl_dim_type type, unsigned pos,
1157                 __isl_take isl_id *id);
1158         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
1159                 __isl_take isl_pw_aff *pma,
1160                 enum isl_dim_type type, unsigned pos,
1161                 __isl_take isl_id *id);
1162         __isl_give isl_multi_pw_aff *
1163         isl_multi_pw_aff_set_dim_id(
1164                 __isl_take isl_multi_pw_aff *mpa,
1165                 enum isl_dim_type type, unsigned pos,
1166                 __isl_take isl_id *id);
1167         __isl_give isl_id *isl_multi_aff_get_dim_id(
1168                 __isl_keep isl_multi_aff *ma,
1169                 enum isl_dim_type type, unsigned pos);
1170         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
1171                 enum isl_dim_type type, unsigned pos);
1172         __isl_give isl_id *isl_pw_aff_get_dim_id(
1173                 __isl_keep isl_pw_aff *pa,
1174                 enum isl_dim_type type, unsigned pos);
1175         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
1176                 __isl_keep isl_pw_multi_aff *pma,
1177                 enum isl_dim_type type, unsigned pos);
1178         __isl_give isl_id *isl_multi_pw_aff_get_dim_id(
1179                 __isl_keep isl_multi_pw_aff *mpa,
1180                 enum isl_dim_type type, unsigned pos);
1181         __isl_give isl_aff *isl_aff_set_dim_name(
1182                 __isl_take isl_aff *aff, enum isl_dim_type type,
1183                 unsigned pos, const char *s);
1184         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
1185                 __isl_take isl_multi_aff *maff,
1186                 enum isl_dim_type type, unsigned pos, const char *s);
1187         __isl_give isl_multi_pw_aff *
1188         isl_multi_pw_aff_set_dim_name(
1189                 __isl_take isl_multi_pw_aff *mpa,
1190                 enum isl_dim_type type, unsigned pos, const char *s);
1191         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
1192                 enum isl_dim_type type, unsigned pos);
1193         const char *isl_pw_aff_get_dim_name(
1194                 __isl_keep isl_pw_aff *pa,
1195                 enum isl_dim_type type, unsigned pos);
1196         const char *isl_pw_multi_aff_get_dim_name(
1197                 __isl_keep isl_pw_multi_aff *pma,
1198                 enum isl_dim_type type, unsigned pos);
1200         #include <isl/polynomial.h>
1201         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
1202                 __isl_take isl_qpolynomial *qp,
1203                 enum isl_dim_type type, unsigned pos,
1204                 const char *s);
1205         __isl_give isl_pw_qpolynomial *
1206         isl_pw_qpolynomial_set_dim_name(
1207                 __isl_take isl_pw_qpolynomial *pwqp,
1208                 enum isl_dim_type type, unsigned pos,
1209                 const char *s);
1210         __isl_give isl_pw_qpolynomial_fold *
1211         isl_pw_qpolynomial_fold_set_dim_name(
1212                 __isl_take isl_pw_qpolynomial_fold *pwf,
1213                 enum isl_dim_type type, unsigned pos,
1214                 const char *s);
1216 Note that C<isl_space_get_name> returns a pointer to some internal
1217 data structure, so the result can only be used while the
1218 corresponding C<isl_space> is alive.
1219 Also note that every function that operates on two sets or relations
1220 requires that both arguments have the same parameters.  This also
1221 means that if one of the arguments has named parameters, then the
1222 other needs to have named parameters too and the names need to match.
1223 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
1224 arguments may have different parameters (as long as they are named),
1225 in which case the result will have as parameters the union of the parameters of
1226 the arguments.
1228 Given the identifier or name of a dimension (typically a parameter),
1229 its position can be obtained from the following functions.
1231         #include <isl/space.h>
1232         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
1233                 enum isl_dim_type type, __isl_keep isl_id *id);
1234         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
1235                 enum isl_dim_type type, const char *name);
1237         #include <isl/local_space.h>
1238         int isl_local_space_find_dim_by_name(
1239                 __isl_keep isl_local_space *ls,
1240                 enum isl_dim_type type, const char *name);
1242         #include <isl/val.h>
1243         int isl_multi_val_find_dim_by_id(
1244                 __isl_keep isl_multi_val *mv,
1245                 enum isl_dim_type type, __isl_keep isl_id *id);
1246         int isl_multi_val_find_dim_by_name(
1247                 __isl_keep isl_multi_val *mv,
1248                 enum isl_dim_type type, const char *name);
1250         #include <isl/set.h>
1251         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1252                 enum isl_dim_type type, __isl_keep isl_id *id);
1253         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1254                 enum isl_dim_type type, const char *name);
1256         #include <isl/map.h>
1257         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1258                 enum isl_dim_type type, __isl_keep isl_id *id);
1259         int isl_basic_map_find_dim_by_name(
1260                 __isl_keep isl_basic_map *bmap,
1261                 enum isl_dim_type type, const char *name);
1262         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1263                 enum isl_dim_type type, const char *name);
1264         int isl_union_map_find_dim_by_name(
1265                 __isl_keep isl_union_map *umap,
1266                 enum isl_dim_type type, const char *name);
1268         #include <isl/aff.h>
1269         int isl_multi_aff_find_dim_by_id(
1270                 __isl_keep isl_multi_aff *ma,
1271                 enum isl_dim_type type, __isl_keep isl_id *id);
1272         int isl_multi_pw_aff_find_dim_by_id(
1273                 __isl_keep isl_multi_pw_aff *mpa,
1274                 enum isl_dim_type type, __isl_keep isl_id *id);
1275         int isl_aff_find_dim_by_name(__isl_keep isl_aff *aff,
1276                 enum isl_dim_type type, const char *name);
1277         int isl_multi_aff_find_dim_by_name(
1278                 __isl_keep isl_multi_aff *ma,
1279                 enum isl_dim_type type, const char *name);
1280         int isl_pw_aff_find_dim_by_name(__isl_keep isl_pw_aff *pa,
1281                 enum isl_dim_type type, const char *name);
1282         int isl_multi_pw_aff_find_dim_by_name(
1283                 __isl_keep isl_multi_pw_aff *mpa,
1284                 enum isl_dim_type type, const char *name);
1285         int isl_pw_multi_aff_find_dim_by_name(
1286                 __isl_keep isl_pw_multi_aff *pma,
1287                 enum isl_dim_type type, const char *name);
1288         int isl_union_pw_multi_aff_find_dim_by_name(
1289                 __isl_keep isl_union_pw_multi_aff *upma,
1290                 enum isl_dim_type type, const char *name);
1292         #include <isl/polynomial.h>
1293         int isl_pw_qpolynomial_find_dim_by_name(
1294                 __isl_keep isl_pw_qpolynomial *pwqp,
1295                 enum isl_dim_type type, const char *name);
1296         int isl_pw_qpolynomial_fold_find_dim_by_name(
1297                 __isl_keep isl_pw_qpolynomial_fold *pwf,
1298                 enum isl_dim_type type, const char *name);
1299         int isl_union_pw_qpolynomial_find_dim_by_name(
1300                 __isl_keep isl_union_pw_qpolynomial *upwqp,
1301                 enum isl_dim_type type, const char *name);
1302         int isl_union_pw_qpolynomial_fold_find_dim_by_name(
1303                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
1304                 enum isl_dim_type type, const char *name);
1306 The identifiers or names of entire spaces may be set or read off
1307 using the following functions.
1309         #include <isl/space.h>
1310         __isl_give isl_space *isl_space_set_tuple_id(
1311                 __isl_take isl_space *space,
1312                 enum isl_dim_type type, __isl_take isl_id *id);
1313         __isl_give isl_space *isl_space_reset_tuple_id(
1314                 __isl_take isl_space *space, enum isl_dim_type type);
1315         int isl_space_has_tuple_id(__isl_keep isl_space *space,
1316                 enum isl_dim_type type);
1317         __isl_give isl_id *isl_space_get_tuple_id(
1318                 __isl_keep isl_space *space, enum isl_dim_type type);
1319         __isl_give isl_space *isl_space_set_tuple_name(
1320                 __isl_take isl_space *space,
1321                 enum isl_dim_type type, const char *s);
1322         int isl_space_has_tuple_name(__isl_keep isl_space *space,
1323                 enum isl_dim_type type);
1324         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
1325                 enum isl_dim_type type);
1327         #include <isl/local_space.h>
1328         __isl_give isl_local_space *isl_local_space_set_tuple_id(
1329                 __isl_take isl_local_space *ls,
1330                 enum isl_dim_type type, __isl_take isl_id *id);
1332         #include <isl/set.h>
1333         __isl_give isl_basic_set *isl_basic_set_set_tuple_id(
1334                 __isl_take isl_basic_set *bset,
1335                 __isl_take isl_id *id);
1336         __isl_give isl_set *isl_set_set_tuple_id(
1337                 __isl_take isl_set *set, __isl_take isl_id *id);
1338         __isl_give isl_set *isl_set_reset_tuple_id(
1339                 __isl_take isl_set *set);
1340         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1341         __isl_give isl_id *isl_set_get_tuple_id(
1342                 __isl_keep isl_set *set);
1343         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1344                 __isl_take isl_basic_set *set, const char *s);
1345         __isl_give isl_set *isl_set_set_tuple_name(
1346                 __isl_take isl_set *set, const char *s);
1347         const char *isl_basic_set_get_tuple_name(
1348                 __isl_keep isl_basic_set *bset);
1349         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1350         const char *isl_set_get_tuple_name(
1351                 __isl_keep isl_set *set);
1353         #include <isl/map.h>
1354         __isl_give isl_basic_map *isl_basic_map_set_tuple_id(
1355                 __isl_take isl_basic_map *bmap,
1356                 enum isl_dim_type type, __isl_take isl_id *id);
1357         __isl_give isl_map *isl_map_set_tuple_id(
1358                 __isl_take isl_map *map, enum isl_dim_type type,
1359                 __isl_take isl_id *id);
1360         __isl_give isl_map *isl_map_reset_tuple_id(
1361                 __isl_take isl_map *map, enum isl_dim_type type);
1362         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1363                 enum isl_dim_type type);
1364         __isl_give isl_id *isl_map_get_tuple_id(
1365                 __isl_keep isl_map *map, enum isl_dim_type type);
1366         __isl_give isl_map *isl_map_set_tuple_name(
1367                 __isl_take isl_map *map,
1368                 enum isl_dim_type type, const char *s);
1369         const char *isl_basic_map_get_tuple_name(
1370                 __isl_keep isl_basic_map *bmap,
1371                 enum isl_dim_type type);
1372         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1373                 __isl_take isl_basic_map *bmap,
1374                 enum isl_dim_type type, const char *s);
1375         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1376                 enum isl_dim_type type);
1377         const char *isl_map_get_tuple_name(
1378                 __isl_keep isl_map *map,
1379                 enum isl_dim_type type);
1381         #include <isl/val.h>
1382         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
1383                 __isl_take isl_multi_val *mv,
1384                 enum isl_dim_type type, __isl_take isl_id *id);
1385         __isl_give isl_multi_val *isl_multi_val_reset_tuple_id(
1386                 __isl_take isl_multi_val *mv,
1387                 enum isl_dim_type type);
1388         int isl_multi_val_has_tuple_id(__isl_keep isl_multi_val *mv,
1389                 enum isl_dim_type type);
1390         __isl_give isl_id *isl_multi_val_get_tuple_id(
1391                 __isl_keep isl_multi_val *mv,
1392                 enum isl_dim_type type);
1393         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
1394                 __isl_take isl_multi_val *mv,
1395                 enum isl_dim_type type, const char *s);
1396         const char *isl_multi_val_get_tuple_name(
1397                 __isl_keep isl_multi_val *mv,
1398                 enum isl_dim_type type);
1400         #include <isl/aff.h>
1401         __isl_give isl_aff *isl_aff_set_tuple_id(
1402                 __isl_take isl_aff *aff,
1403                 enum isl_dim_type type, __isl_take isl_id *id);
1404         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
1405                 __isl_take isl_multi_aff *maff,
1406                 enum isl_dim_type type, __isl_take isl_id *id);
1407         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
1408                 __isl_take isl_pw_aff *pwaff,
1409                 enum isl_dim_type type, __isl_take isl_id *id);
1410         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
1411                 __isl_take isl_pw_multi_aff *pma,
1412                 enum isl_dim_type type, __isl_take isl_id *id);
1413         __isl_give isl_multi_aff *isl_multi_aff_reset_tuple_id(
1414                 __isl_take isl_multi_aff *ma,
1415                 enum isl_dim_type type);
1416         __isl_give isl_pw_aff *isl_pw_aff_reset_tuple_id(
1417                 __isl_take isl_pw_aff *pa,
1418                 enum isl_dim_type type);
1419         __isl_give isl_multi_pw_aff *
1420         isl_multi_pw_aff_reset_tuple_id(
1421                 __isl_take isl_multi_pw_aff *mpa,
1422                 enum isl_dim_type type);
1423         __isl_give isl_pw_multi_aff *
1424         isl_pw_multi_aff_reset_tuple_id(
1425                 __isl_take isl_pw_multi_aff *pma,
1426                 enum isl_dim_type type);
1427         int isl_multi_aff_has_tuple_id(__isl_keep isl_multi_aff *ma,
1428                 enum isl_dim_type type);
1429         __isl_give isl_id *isl_multi_aff_get_tuple_id(
1430                 __isl_keep isl_multi_aff *ma,
1431                 enum isl_dim_type type);
1432         int isl_pw_aff_has_tuple_id(__isl_keep isl_pw_aff *pa,
1433                 enum isl_dim_type type);
1434         __isl_give isl_id *isl_pw_aff_get_tuple_id(
1435                 __isl_keep isl_pw_aff *pa,
1436                 enum isl_dim_type type);
1437         int isl_pw_multi_aff_has_tuple_id(
1438                 __isl_keep isl_pw_multi_aff *pma,
1439                 enum isl_dim_type type);
1440         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
1441                 __isl_keep isl_pw_multi_aff *pma,
1442                 enum isl_dim_type type);
1443         int isl_multi_pw_aff_has_tuple_id(
1444                 __isl_keep isl_multi_pw_aff *mpa,
1445                 enum isl_dim_type type);
1446         __isl_give isl_id *isl_multi_pw_aff_get_tuple_id(
1447                 __isl_keep isl_multi_pw_aff *mpa,
1448                 enum isl_dim_type type);
1449         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
1450                 __isl_take isl_multi_aff *maff,
1451                 enum isl_dim_type type, const char *s);
1452         __isl_give isl_multi_pw_aff *
1453         isl_multi_pw_aff_set_tuple_name(
1454                 __isl_take isl_multi_pw_aff *mpa,
1455                 enum isl_dim_type type, const char *s);
1456         const char *isl_multi_aff_get_tuple_name(
1457                 __isl_keep isl_multi_aff *multi,
1458                 enum isl_dim_type type);
1459         int isl_pw_multi_aff_has_tuple_name(
1460                 __isl_keep isl_pw_multi_aff *pma,
1461                 enum isl_dim_type type);
1462         const char *isl_pw_multi_aff_get_tuple_name(
1463                 __isl_keep isl_pw_multi_aff *pma,
1464                 enum isl_dim_type type);
1466 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
1467 or C<isl_dim_set>.  As with C<isl_space_get_name>,
1468 the C<isl_space_get_tuple_name> function returns a pointer to some internal
1469 data structure.
1470 Binary operations require the corresponding spaces of their arguments
1471 to have the same name.
1473 To keep the names of all parameters and tuples, but reset the user pointers
1474 of all the corresponding identifiers, use the following function.
1476         #include <isl/space.h>
1477         __isl_give isl_space *isl_space_reset_user(
1478                 __isl_take isl_space *space);
1480         #include <isl/set.h>
1481         __isl_give isl_set *isl_set_reset_user(
1482                 __isl_take isl_set *set);
1484         #include <isl/map.h>
1485         __isl_give isl_map *isl_map_reset_user(
1486                 __isl_take isl_map *map);
1488         #include <isl/union_set.h>
1489         __isl_give isl_union_set *isl_union_set_reset_user(
1490                 __isl_take isl_union_set *uset);
1492         #include <isl/union_map.h>
1493         __isl_give isl_union_map *isl_union_map_reset_user(
1494                 __isl_take isl_union_map *umap);
1496         #include <isl/val.h>
1497         __isl_give isl_multi_val *isl_multi_val_reset_user(
1498                 __isl_take isl_multi_val *mv);
1500         #include <isl/aff.h>
1501         __isl_give isl_multi_aff *isl_multi_aff_reset_user(
1502                 __isl_take isl_multi_aff *ma);
1503         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_reset_user(
1504                 __isl_take isl_multi_pw_aff *mpa);
1506 Spaces can be nested.  In particular, the domain of a set or
1507 the domain or range of a relation can be a nested relation.
1508 This process is also called I<wrapping>.
1509 The functions for detecting, constructing and deconstructing
1510 such nested spaces can be found in the wrapping properties
1511 of L</"Unary Properties">, the wrapping operations
1512 of L</"Unary Operations"> and the Cartesian product operations
1513 of L</"Basic Operations">.
1515 Spaces can be created from other spaces
1516 using the functions described in L</"Unary Operations">
1517 and L</"Binary Operations">.
1519 =head2 Local Spaces
1521 A local space is essentially a space with
1522 zero or more existentially quantified variables.
1523 The local space of various objects can be obtained
1524 using the following functions.
1526         #include <isl/constraint.h>
1527         __isl_give isl_local_space *isl_constraint_get_local_space(
1528                 __isl_keep isl_constraint *constraint);
1530         #include <isl/set.h>
1531         __isl_give isl_local_space *isl_basic_set_get_local_space(
1532                 __isl_keep isl_basic_set *bset);
1534         #include <isl/map.h>
1535         __isl_give isl_local_space *isl_basic_map_get_local_space(
1536                 __isl_keep isl_basic_map *bmap);
1538         #include <isl/aff.h>
1539         __isl_give isl_local_space *isl_aff_get_domain_local_space(
1540                 __isl_keep isl_aff *aff);
1541         __isl_give isl_local_space *isl_aff_get_local_space(
1542                 __isl_keep isl_aff *aff);
1544 A new local space can be created from a space using
1546         #include <isl/local_space.h>
1547         __isl_give isl_local_space *isl_local_space_from_space(
1548                 __isl_take isl_space *space);
1550 They can be inspected, modified, copied and freed using the following functions.
1552         #include <isl/local_space.h>
1553         int isl_local_space_is_params(
1554                 __isl_keep isl_local_space *ls);
1555         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
1556         __isl_give isl_space *isl_local_space_get_space(
1557                 __isl_keep isl_local_space *ls);
1558         __isl_give isl_aff *isl_local_space_get_div(
1559                 __isl_keep isl_local_space *ls, int pos);
1560         __isl_give isl_local_space *isl_local_space_copy(
1561                 __isl_keep isl_local_space *ls);
1562         __isl_null isl_local_space *isl_local_space_free(
1563                 __isl_take isl_local_space *ls);
1565 Note that C<isl_local_space_get_div> can only be used on local spaces
1566 of sets.
1568 Two local spaces can be compared using
1570         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
1571                 __isl_keep isl_local_space *ls2);
1573 Local spaces can be created from other local spaces
1574 using the functions described in L</"Unary Operations">
1575 and L</"Binary Operations">.
1577 =head2 Creating New Sets and Relations
1579 C<isl> has functions for creating some standard sets and relations.
1581 =over
1583 =item * Empty sets and relations
1585         __isl_give isl_basic_set *isl_basic_set_empty(
1586                 __isl_take isl_space *space);
1587         __isl_give isl_basic_map *isl_basic_map_empty(
1588                 __isl_take isl_space *space);
1589         __isl_give isl_set *isl_set_empty(
1590                 __isl_take isl_space *space);
1591         __isl_give isl_map *isl_map_empty(
1592                 __isl_take isl_space *space);
1593         __isl_give isl_union_set *isl_union_set_empty(
1594                 __isl_take isl_space *space);
1595         __isl_give isl_union_map *isl_union_map_empty(
1596                 __isl_take isl_space *space);
1598 For C<isl_union_set>s and C<isl_union_map>s, the space
1599 is only used to specify the parameters.
1601 =item * Universe sets and relations
1603         __isl_give isl_basic_set *isl_basic_set_universe(
1604                 __isl_take isl_space *space);
1605         __isl_give isl_basic_map *isl_basic_map_universe(
1606                 __isl_take isl_space *space);
1607         __isl_give isl_set *isl_set_universe(
1608                 __isl_take isl_space *space);
1609         __isl_give isl_map *isl_map_universe(
1610                 __isl_take isl_space *space);
1611         __isl_give isl_union_set *isl_union_set_universe(
1612                 __isl_take isl_union_set *uset);
1613         __isl_give isl_union_map *isl_union_map_universe(
1614                 __isl_take isl_union_map *umap);
1616 The sets and relations constructed by the functions above
1617 contain all integer values, while those constructed by the
1618 functions below only contain non-negative values.
1620         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1621                 __isl_take isl_space *space);
1622         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1623                 __isl_take isl_space *space);
1624         __isl_give isl_set *isl_set_nat_universe(
1625                 __isl_take isl_space *space);
1626         __isl_give isl_map *isl_map_nat_universe(
1627                 __isl_take isl_space *space);
1629 =item * Identity relations
1631         __isl_give isl_basic_map *isl_basic_map_identity(
1632                 __isl_take isl_space *space);
1633         __isl_give isl_map *isl_map_identity(
1634                 __isl_take isl_space *space);
1636 The number of input and output dimensions in C<space> needs
1637 to be the same.
1639 =item * Lexicographic order
1641         __isl_give isl_map *isl_map_lex_lt(
1642                 __isl_take isl_space *set_space);
1643         __isl_give isl_map *isl_map_lex_le(
1644                 __isl_take isl_space *set_space);
1645         __isl_give isl_map *isl_map_lex_gt(
1646                 __isl_take isl_space *set_space);
1647         __isl_give isl_map *isl_map_lex_ge(
1648                 __isl_take isl_space *set_space);
1649         __isl_give isl_map *isl_map_lex_lt_first(
1650                 __isl_take isl_space *space, unsigned n);
1651         __isl_give isl_map *isl_map_lex_le_first(
1652                 __isl_take isl_space *space, unsigned n);
1653         __isl_give isl_map *isl_map_lex_gt_first(
1654                 __isl_take isl_space *space, unsigned n);
1655         __isl_give isl_map *isl_map_lex_ge_first(
1656                 __isl_take isl_space *space, unsigned n);
1658 The first four functions take a space for a B<set>
1659 and return relations that express that the elements in the domain
1660 are lexicographically less
1661 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1662 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1663 than the elements in the range.
1664 The last four functions take a space for a map
1665 and return relations that express that the first C<n> dimensions
1666 in the domain are lexicographically less
1667 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1668 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1669 than the first C<n> dimensions in the range.
1671 =back
1673 A basic set or relation can be converted to a set or relation
1674 using the following functions.
1676         __isl_give isl_set *isl_set_from_basic_set(
1677                 __isl_take isl_basic_set *bset);
1678         __isl_give isl_map *isl_map_from_basic_map(
1679                 __isl_take isl_basic_map *bmap);
1681 Sets and relations can be converted to union sets and relations
1682 using the following functions.
1684         __isl_give isl_union_set *isl_union_set_from_basic_set(
1685                 __isl_take isl_basic_set *bset);
1686         __isl_give isl_union_map *isl_union_map_from_basic_map(
1687                 __isl_take isl_basic_map *bmap);
1688         __isl_give isl_union_set *isl_union_set_from_set(
1689                 __isl_take isl_set *set);
1690         __isl_give isl_union_map *isl_union_map_from_map(
1691                 __isl_take isl_map *map);
1693 The inverse conversions below can only be used if the input
1694 union set or relation is known to contain elements in exactly one
1695 space.
1697         __isl_give isl_set *isl_set_from_union_set(
1698                 __isl_take isl_union_set *uset);
1699         __isl_give isl_map *isl_map_from_union_map(
1700                 __isl_take isl_union_map *umap);
1702 Sets and relations can be copied and freed again using the following
1703 functions.
1705         __isl_give isl_basic_set *isl_basic_set_copy(
1706                 __isl_keep isl_basic_set *bset);
1707         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1708         __isl_give isl_union_set *isl_union_set_copy(
1709                 __isl_keep isl_union_set *uset);
1710         __isl_give isl_basic_map *isl_basic_map_copy(
1711                 __isl_keep isl_basic_map *bmap);
1712         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1713         __isl_give isl_union_map *isl_union_map_copy(
1714                 __isl_keep isl_union_map *umap);
1715         __isl_null isl_basic_set *isl_basic_set_free(
1716                 __isl_take isl_basic_set *bset);
1717         __isl_null isl_set *isl_set_free(__isl_take isl_set *set);
1718         __isl_null isl_union_set *isl_union_set_free(
1719                 __isl_take isl_union_set *uset);
1720         __isl_null isl_basic_map *isl_basic_map_free(
1721                 __isl_take isl_basic_map *bmap);
1722         __isl_null isl_map *isl_map_free(__isl_take isl_map *map);
1723         __isl_null isl_union_map *isl_union_map_free(
1724                 __isl_take isl_union_map *umap);
1726 Other sets and relations can be constructed by starting
1727 from a universe set or relation, adding equality and/or
1728 inequality constraints and then projecting out the
1729 existentially quantified variables, if any.
1730 Constraints can be constructed, manipulated and
1731 added to (or removed from) (basic) sets and relations
1732 using the following functions.
1734         #include <isl/constraint.h>
1735         __isl_give isl_constraint *isl_equality_alloc(
1736                 __isl_take isl_local_space *ls);
1737         __isl_give isl_constraint *isl_inequality_alloc(
1738                 __isl_take isl_local_space *ls);
1739         __isl_give isl_constraint *isl_constraint_set_constant_si(
1740                 __isl_take isl_constraint *constraint, int v);
1741         __isl_give isl_constraint *isl_constraint_set_constant_val(
1742                 __isl_take isl_constraint *constraint,
1743                 __isl_take isl_val *v);
1744         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1745                 __isl_take isl_constraint *constraint,
1746                 enum isl_dim_type type, int pos, int v);
1747         __isl_give isl_constraint *
1748         isl_constraint_set_coefficient_val(
1749                 __isl_take isl_constraint *constraint,
1750                 enum isl_dim_type type, int pos,
1751                 __isl_take isl_val *v);
1752         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1753                 __isl_take isl_basic_map *bmap,
1754                 __isl_take isl_constraint *constraint);
1755         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1756                 __isl_take isl_basic_set *bset,
1757                 __isl_take isl_constraint *constraint);
1758         __isl_give isl_map *isl_map_add_constraint(
1759                 __isl_take isl_map *map,
1760                 __isl_take isl_constraint *constraint);
1761         __isl_give isl_set *isl_set_add_constraint(
1762                 __isl_take isl_set *set,
1763                 __isl_take isl_constraint *constraint);
1764         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1765                 __isl_take isl_basic_set *bset,
1766                 __isl_take isl_constraint *constraint);
1768 For example, to create a set containing the even integers
1769 between 10 and 42, you would use the following code.
1771         isl_space *space;
1772         isl_local_space *ls;
1773         isl_constraint *c;
1774         isl_basic_set *bset;
1776         space = isl_space_set_alloc(ctx, 0, 2);
1777         bset = isl_basic_set_universe(isl_space_copy(space));
1778         ls = isl_local_space_from_space(space);
1780         c = isl_equality_alloc(isl_local_space_copy(ls));
1781         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1782         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1783         bset = isl_basic_set_add_constraint(bset, c);
1785         c = isl_inequality_alloc(isl_local_space_copy(ls));
1786         c = isl_constraint_set_constant_si(c, -10);
1787         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1788         bset = isl_basic_set_add_constraint(bset, c);
1790         c = isl_inequality_alloc(ls);
1791         c = isl_constraint_set_constant_si(c, 42);
1792         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1793         bset = isl_basic_set_add_constraint(bset, c);
1795         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1797 Or, alternatively,
1799         isl_basic_set *bset;
1800         bset = isl_basic_set_read_from_str(ctx,
1801                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1803 A basic set or relation can also be constructed from two matrices
1804 describing the equalities and the inequalities.
1806         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1807                 __isl_take isl_space *space,
1808                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1809                 enum isl_dim_type c1,
1810                 enum isl_dim_type c2, enum isl_dim_type c3,
1811                 enum isl_dim_type c4);
1812         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1813                 __isl_take isl_space *space,
1814                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1815                 enum isl_dim_type c1,
1816                 enum isl_dim_type c2, enum isl_dim_type c3,
1817                 enum isl_dim_type c4, enum isl_dim_type c5);
1819 The C<isl_dim_type> arguments indicate the order in which
1820 different kinds of variables appear in the input matrices
1821 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1822 C<isl_dim_set> and C<isl_dim_div> for sets and
1823 of C<isl_dim_cst>, C<isl_dim_param>,
1824 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1826 A (basic or union) set or relation can also be constructed from a
1827 (union) (piecewise) (multiple) affine expression
1828 or a list of affine expressions
1829 (See L</"Functions">).
1831         __isl_give isl_basic_map *isl_basic_map_from_aff(
1832                 __isl_take isl_aff *aff);
1833         __isl_give isl_map *isl_map_from_aff(
1834                 __isl_take isl_aff *aff);
1835         __isl_give isl_set *isl_set_from_pw_aff(
1836                 __isl_take isl_pw_aff *pwaff);
1837         __isl_give isl_map *isl_map_from_pw_aff(
1838                 __isl_take isl_pw_aff *pwaff);
1839         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1840                 __isl_take isl_space *domain_space,
1841                 __isl_take isl_aff_list *list);
1842         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1843                 __isl_take isl_multi_aff *maff)
1844         __isl_give isl_map *isl_map_from_multi_aff(
1845                 __isl_take isl_multi_aff *maff)
1846         __isl_give isl_set *isl_set_from_pw_multi_aff(
1847                 __isl_take isl_pw_multi_aff *pma);
1848         __isl_give isl_map *isl_map_from_pw_multi_aff(
1849                 __isl_take isl_pw_multi_aff *pma);
1850         __isl_give isl_set *isl_set_from_multi_pw_aff(
1851                 __isl_take isl_multi_pw_aff *mpa);
1852         __isl_give isl_map *isl_map_from_multi_pw_aff(
1853                 __isl_take isl_multi_pw_aff *mpa);
1854         __isl_give isl_union_map *
1855         isl_union_map_from_union_pw_multi_aff(
1856                 __isl_take isl_union_pw_multi_aff *upma);
1858 The C<domain_space> argument describes the domain of the resulting
1859 basic relation.  It is required because the C<list> may consist
1860 of zero affine expressions.
1862 =head2 Inspecting Sets and Relations
1864 Usually, the user should not have to care about the actual constraints
1865 of the sets and maps, but should instead apply the abstract operations
1866 explained in the following sections.
1867 Occasionally, however, it may be required to inspect the individual
1868 coefficients of the constraints.  This section explains how to do so.
1869 In these cases, it may also be useful to have C<isl> compute
1870 an explicit representation of the existentially quantified variables.
1872         __isl_give isl_set *isl_set_compute_divs(
1873                 __isl_take isl_set *set);
1874         __isl_give isl_map *isl_map_compute_divs(
1875                 __isl_take isl_map *map);
1876         __isl_give isl_union_set *isl_union_set_compute_divs(
1877                 __isl_take isl_union_set *uset);
1878         __isl_give isl_union_map *isl_union_map_compute_divs(
1879                 __isl_take isl_union_map *umap);
1881 This explicit representation defines the existentially quantified
1882 variables as integer divisions of the other variables, possibly
1883 including earlier existentially quantified variables.
1884 An explicitly represented existentially quantified variable therefore
1885 has a unique value when the values of the other variables are known.
1886 If, furthermore, the same existentials, i.e., existentials
1887 with the same explicit representations, should appear in the
1888 same order in each of the disjuncts of a set or map, then the user should call
1889 either of the following functions.
1891         __isl_give isl_set *isl_set_align_divs(
1892                 __isl_take isl_set *set);
1893         __isl_give isl_map *isl_map_align_divs(
1894                 __isl_take isl_map *map);
1896 Alternatively, the existentially quantified variables can be removed
1897 using the following functions, which compute an overapproximation.
1899         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1900                 __isl_take isl_basic_set *bset);
1901         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1902                 __isl_take isl_basic_map *bmap);
1903         __isl_give isl_set *isl_set_remove_divs(
1904                 __isl_take isl_set *set);
1905         __isl_give isl_map *isl_map_remove_divs(
1906                 __isl_take isl_map *map);
1908 It is also possible to only remove those divs that are defined
1909 in terms of a given range of dimensions or only those for which
1910 no explicit representation is known.
1912         __isl_give isl_basic_set *
1913         isl_basic_set_remove_divs_involving_dims(
1914                 __isl_take isl_basic_set *bset,
1915                 enum isl_dim_type type,
1916                 unsigned first, unsigned n);
1917         __isl_give isl_basic_map *
1918         isl_basic_map_remove_divs_involving_dims(
1919                 __isl_take isl_basic_map *bmap,
1920                 enum isl_dim_type type,
1921                 unsigned first, unsigned n);
1922         __isl_give isl_set *isl_set_remove_divs_involving_dims(
1923                 __isl_take isl_set *set, enum isl_dim_type type,
1924                 unsigned first, unsigned n);
1925         __isl_give isl_map *isl_map_remove_divs_involving_dims(
1926                 __isl_take isl_map *map, enum isl_dim_type type,
1927                 unsigned first, unsigned n);
1929         __isl_give isl_basic_set *
1930         isl_basic_set_remove_unknown_divs(
1931                 __isl_take isl_basic_set *bset);
1932         __isl_give isl_set *isl_set_remove_unknown_divs(
1933                 __isl_take isl_set *set);
1934         __isl_give isl_map *isl_map_remove_unknown_divs(
1935                 __isl_take isl_map *map);
1937 To iterate over all the sets or maps in a union set or map, use
1939         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1940                 int (*fn)(__isl_take isl_set *set, void *user),
1941                 void *user);
1942         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1943                 int (*fn)(__isl_take isl_map *map, void *user),
1944                 void *user);
1946 The number of sets or maps in a union set or map can be obtained
1947 from
1949         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1950         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1952 To extract the set or map in a given space from a union, use
1954         __isl_give isl_set *isl_union_set_extract_set(
1955                 __isl_keep isl_union_set *uset,
1956                 __isl_take isl_space *space);
1957         __isl_give isl_map *isl_union_map_extract_map(
1958                 __isl_keep isl_union_map *umap,
1959                 __isl_take isl_space *space);
1961 To iterate over all the basic sets or maps in a set or map, use
1963         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1964                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1965                 void *user);
1966         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1967                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1968                 void *user);
1970 The callback function C<fn> should return 0 if successful and
1971 -1 if an error occurs.  In the latter case, or if any other error
1972 occurs, the above functions will return -1.
1974 It should be noted that C<isl> does not guarantee that
1975 the basic sets or maps passed to C<fn> are disjoint.
1976 If this is required, then the user should call one of
1977 the following functions first.
1979         __isl_give isl_set *isl_set_make_disjoint(
1980                 __isl_take isl_set *set);
1981         __isl_give isl_map *isl_map_make_disjoint(
1982                 __isl_take isl_map *map);
1984 The number of basic sets in a set can be obtained
1985 or the number of basic maps in a map can be obtained
1986 from
1988         #include <isl/set.h>
1989         int isl_set_n_basic_set(__isl_keep isl_set *set);
1991         #include <isl/map.h>
1992         int isl_map_n_basic_map(__isl_keep isl_map *map);
1994 To iterate over the constraints of a basic set or map, use
1996         #include <isl/constraint.h>
1998         int isl_basic_set_n_constraint(
1999                 __isl_keep isl_basic_set *bset);
2000         int isl_basic_set_foreach_constraint(
2001                 __isl_keep isl_basic_set *bset,
2002                 int (*fn)(__isl_take isl_constraint *c, void *user),
2003                 void *user);
2004         int isl_basic_map_n_constraint(
2005                 __isl_keep isl_basic_map *bmap);
2006         int isl_basic_map_foreach_constraint(
2007                 __isl_keep isl_basic_map *bmap,
2008                 int (*fn)(__isl_take isl_constraint *c, void *user),
2009                 void *user);
2010         __isl_null isl_constraint *isl_constraint_free(
2011                 __isl_take isl_constraint *c);
2013 Again, the callback function C<fn> should return 0 if successful and
2014 -1 if an error occurs.  In the latter case, or if any other error
2015 occurs, the above functions will return -1.
2016 The constraint C<c> represents either an equality or an inequality.
2017 Use the following function to find out whether a constraint
2018 represents an equality.  If not, it represents an inequality.
2020         int isl_constraint_is_equality(
2021                 __isl_keep isl_constraint *constraint);
2023 It is also possible to obtain a list of constraints from a basic
2024 map or set
2026         #include <isl/constraint.h>
2027         __isl_give isl_constraint_list *
2028         isl_basic_map_get_constraint_list(
2029                 __isl_keep isl_basic_map *bmap);
2030         __isl_give isl_constraint_list *
2031         isl_basic_set_get_constraint_list(
2032                 __isl_keep isl_basic_set *bset);
2034 These functions require that all existentially quantified variables
2035 have an explicit representation.
2036 The returned list can be manipulated using the functions in L<"Lists">.
2038 The coefficients of the constraints can be inspected using
2039 the following functions.
2041         int isl_constraint_is_lower_bound(
2042                 __isl_keep isl_constraint *constraint,
2043                 enum isl_dim_type type, unsigned pos);
2044         int isl_constraint_is_upper_bound(
2045                 __isl_keep isl_constraint *constraint,
2046                 enum isl_dim_type type, unsigned pos);
2047         __isl_give isl_val *isl_constraint_get_constant_val(
2048                 __isl_keep isl_constraint *constraint);
2049         __isl_give isl_val *isl_constraint_get_coefficient_val(
2050                 __isl_keep isl_constraint *constraint,
2051                 enum isl_dim_type type, int pos);
2053 The explicit representations of the existentially quantified
2054 variables can be inspected using the following function.
2055 Note that the user is only allowed to use this function
2056 if the inspected set or map is the result of a call
2057 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
2058 The existentially quantified variable is equal to the floor
2059 of the returned affine expression.  The affine expression
2060 itself can be inspected using the functions in
2061 L</"Functions">.
2063         __isl_give isl_aff *isl_constraint_get_div(
2064                 __isl_keep isl_constraint *constraint, int pos);
2066 To obtain the constraints of a basic set or map in matrix
2067 form, use the following functions.
2069         __isl_give isl_mat *isl_basic_set_equalities_matrix(
2070                 __isl_keep isl_basic_set *bset,
2071                 enum isl_dim_type c1, enum isl_dim_type c2,
2072                 enum isl_dim_type c3, enum isl_dim_type c4);
2073         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
2074                 __isl_keep isl_basic_set *bset,
2075                 enum isl_dim_type c1, enum isl_dim_type c2,
2076                 enum isl_dim_type c3, enum isl_dim_type c4);
2077         __isl_give isl_mat *isl_basic_map_equalities_matrix(
2078                 __isl_keep isl_basic_map *bmap,
2079                 enum isl_dim_type c1,
2080                 enum isl_dim_type c2, enum isl_dim_type c3,
2081                 enum isl_dim_type c4, enum isl_dim_type c5);
2082         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
2083                 __isl_keep isl_basic_map *bmap,
2084                 enum isl_dim_type c1,
2085                 enum isl_dim_type c2, enum isl_dim_type c3,
2086                 enum isl_dim_type c4, enum isl_dim_type c5);
2088 The C<isl_dim_type> arguments dictate the order in which
2089 different kinds of variables appear in the resulting matrix.
2090 For set inputs, they should be a permutation of
2091 C<isl_dim_cst>, C<isl_dim_param>, C<isl_dim_set> and C<isl_dim_div>.
2092 For map inputs, they should be a permutation of
2093 C<isl_dim_cst>, C<isl_dim_param>,
2094 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
2096 =head2 Points
2098 Points are elements of a set.  They can be used to construct
2099 simple sets (boxes) or they can be used to represent the
2100 individual elements of a set.
2101 The zero point (the origin) can be created using
2103         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
2105 The coordinates of a point can be inspected, set and changed
2106 using
2108         __isl_give isl_val *isl_point_get_coordinate_val(
2109                 __isl_keep isl_point *pnt,
2110                 enum isl_dim_type type, int pos);
2111         __isl_give isl_point *isl_point_set_coordinate_val(
2112                 __isl_take isl_point *pnt,
2113                 enum isl_dim_type type, int pos,
2114                 __isl_take isl_val *v);
2116         __isl_give isl_point *isl_point_add_ui(
2117                 __isl_take isl_point *pnt,
2118                 enum isl_dim_type type, int pos, unsigned val);
2119         __isl_give isl_point *isl_point_sub_ui(
2120                 __isl_take isl_point *pnt,
2121                 enum isl_dim_type type, int pos, unsigned val);
2123 Points can be copied or freed using
2125         __isl_give isl_point *isl_point_copy(
2126                 __isl_keep isl_point *pnt);
2127         void isl_point_free(__isl_take isl_point *pnt);
2129 A singleton set can be created from a point using
2131         __isl_give isl_basic_set *isl_basic_set_from_point(
2132                 __isl_take isl_point *pnt);
2133         __isl_give isl_set *isl_set_from_point(
2134                 __isl_take isl_point *pnt);
2136 and a box can be created from two opposite extremal points using
2138         __isl_give isl_basic_set *isl_basic_set_box_from_points(
2139                 __isl_take isl_point *pnt1,
2140                 __isl_take isl_point *pnt2);
2141         __isl_give isl_set *isl_set_box_from_points(
2142                 __isl_take isl_point *pnt1,
2143                 __isl_take isl_point *pnt2);
2145 All elements of a B<bounded> (union) set can be enumerated using
2146 the following functions.
2148         int isl_set_foreach_point(__isl_keep isl_set *set,
2149                 int (*fn)(__isl_take isl_point *pnt, void *user),
2150                 void *user);
2151         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
2152                 int (*fn)(__isl_take isl_point *pnt, void *user),
2153                 void *user);
2155 The function C<fn> is called for each integer point in
2156 C<set> with as second argument the last argument of
2157 the C<isl_set_foreach_point> call.  The function C<fn>
2158 should return C<0> on success and C<-1> on failure.
2159 In the latter case, C<isl_set_foreach_point> will stop
2160 enumerating and return C<-1> as well.
2161 If the enumeration is performed successfully and to completion,
2162 then C<isl_set_foreach_point> returns C<0>.
2164 To obtain a single point of a (basic) set, use
2166         __isl_give isl_point *isl_basic_set_sample_point(
2167                 __isl_take isl_basic_set *bset);
2168         __isl_give isl_point *isl_set_sample_point(
2169                 __isl_take isl_set *set);
2171 If C<set> does not contain any (integer) points, then the
2172 resulting point will be ``void'', a property that can be
2173 tested using
2175         int isl_point_is_void(__isl_keep isl_point *pnt);
2177 =head2 Functions
2179 Besides sets and relation, C<isl> also supports various types of functions.
2180 Each of these types is derived from the value type (see L</"Values">)
2181 or from one of two primitive function types
2182 through the application of zero or more type constructors.
2183 We first describe the primitive type and then we describe
2184 the types derived from these primitive types.
2186 =head3 Primitive Functions
2188 C<isl> support two primitive function types, quasi-affine
2189 expressions and quasipolynomials.
2190 A quasi-affine expression is defined either over a parameter
2191 space or over a set and is composed of integer constants,
2192 parameters and set variables, addition, subtraction and
2193 integer division by an integer constant.
2194 For example, the quasi-affine expression
2196         [n] -> { [x] -> [2*floor((4 n + x)/9] }
2198 maps C<x> to C<2*floor((4 n + x)/9>.
2199 A quasipolynomial is a polynomial expression in quasi-affine
2200 expression.  That is, it additionally allows for multiplication.
2201 Note, though, that it is not allowed to construct an integer
2202 division of an expression involving multiplications.
2203 Here is an example of a quasipolynomial that is not
2204 quasi-affine expression
2206         [n] -> { [x] -> (n*floor((4 n + x)/9) }
2208 Note that the external representations of quasi-affine expressions
2209 and quasipolynomials are different.  Quasi-affine expressions
2210 use a notation with square brackets just like binary relations,
2211 while quasipolynomials do not.  This might change at some point.
2213 If a primitive function is defined over a parameter space,
2214 then the space of the function itself is that of a set.
2215 If it is defined over a set, then the space of the function
2216 is that of a relation.  In both cases, the set space (or
2217 the output space) is single-dimensional, anonymous and unstructured.
2218 To create functions with multiple dimensions or with other kinds
2219 of set or output spaces, use multiple expressions
2220 (see L</"Multiple Expressions">).
2222 =over
2224 =item * Quasi-affine Expressions
2226 Besides the expressions described above, a quasi-affine
2227 expression can also be set to NaN.  Such expressions
2228 typically represent a failure to represent a result
2229 as a quasi-affine expression.
2231 The zero quasi affine expression or the quasi affine expression
2232 that is equal to a given value or
2233 a specified dimension on a given domain can be created using
2235         #include <isl/aff.h>
2236         __isl_give isl_aff *isl_aff_zero_on_domain(
2237                 __isl_take isl_local_space *ls);
2238         __isl_give isl_aff *isl_aff_val_on_domain(
2239                 __isl_take isl_local_space *ls,
2240                 __isl_take isl_val *val);
2241         __isl_give isl_aff *isl_aff_var_on_domain(
2242                 __isl_take isl_local_space *ls,
2243                 enum isl_dim_type type, unsigned pos);
2244         __isl_give isl_aff *isl_aff_nan_on_domain(
2245                 __isl_take isl_local_space *ls);
2247 Quasi affine expressions can be copied and freed using
2249         #include <isl/aff.h>
2250         __isl_give isl_aff *isl_aff_copy(
2251                 __isl_keep isl_aff *aff);
2252         __isl_null isl_aff *isl_aff_free(
2253                 __isl_take isl_aff *aff);
2255 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2256 using the following function.  The constraint is required to have
2257 a non-zero coefficient for the specified dimension.
2259         #include <isl/constraint.h>
2260         __isl_give isl_aff *isl_constraint_get_bound(
2261                 __isl_keep isl_constraint *constraint,
2262                 enum isl_dim_type type, int pos);
2264 The entire affine expression of the constraint can also be extracted
2265 using the following function.
2267         #include <isl/constraint.h>
2268         __isl_give isl_aff *isl_constraint_get_aff(
2269                 __isl_keep isl_constraint *constraint);
2271 Conversely, an equality constraint equating
2272 the affine expression to zero or an inequality constraint enforcing
2273 the affine expression to be non-negative, can be constructed using
2275         __isl_give isl_constraint *isl_equality_from_aff(
2276                 __isl_take isl_aff *aff);
2277         __isl_give isl_constraint *isl_inequality_from_aff(
2278                 __isl_take isl_aff *aff);
2280 The coefficients and the integer divisions of an affine expression
2281 can be inspected using the following functions.
2283         #include <isl/aff.h>
2284         __isl_give isl_val *isl_aff_get_constant_val(
2285                 __isl_keep isl_aff *aff);
2286         __isl_give isl_val *isl_aff_get_coefficient_val(
2287                 __isl_keep isl_aff *aff,
2288                 enum isl_dim_type type, int pos);
2289         int isl_aff_coefficient_sgn(__isl_keep isl_aff *aff,
2290                 enum isl_dim_type type, int pos);
2291         __isl_give isl_val *isl_aff_get_denominator_val(
2292                 __isl_keep isl_aff *aff);
2293         __isl_give isl_aff *isl_aff_get_div(
2294                 __isl_keep isl_aff *aff, int pos);
2296 They can be modified using the following functions.
2298         #include <isl/aff.h>
2299         __isl_give isl_aff *isl_aff_set_constant_si(
2300                 __isl_take isl_aff *aff, int v);
2301         __isl_give isl_aff *isl_aff_set_constant_val(
2302                 __isl_take isl_aff *aff, __isl_take isl_val *v);
2303         __isl_give isl_aff *isl_aff_set_coefficient_si(
2304                 __isl_take isl_aff *aff,
2305                 enum isl_dim_type type, int pos, int v);
2306         __isl_give isl_aff *isl_aff_set_coefficient_val(
2307                 __isl_take isl_aff *aff,
2308                 enum isl_dim_type type, int pos,
2309                 __isl_take isl_val *v);
2311         __isl_give isl_aff *isl_aff_add_constant_si(
2312                 __isl_take isl_aff *aff, int v);
2313         __isl_give isl_aff *isl_aff_add_constant_val(
2314                 __isl_take isl_aff *aff, __isl_take isl_val *v);
2315         __isl_give isl_aff *isl_aff_add_constant_num_si(
2316                 __isl_take isl_aff *aff, int v);
2317         __isl_give isl_aff *isl_aff_add_coefficient_si(
2318                 __isl_take isl_aff *aff,
2319                 enum isl_dim_type type, int pos, int v);
2320         __isl_give isl_aff *isl_aff_add_coefficient_val(
2321                 __isl_take isl_aff *aff,
2322                 enum isl_dim_type type, int pos,
2323                 __isl_take isl_val *v);
2325 Note that C<isl_aff_set_constant_si> and C<isl_aff_set_coefficient_si>
2326 set the I<numerator> of the constant or coefficient, while
2327 C<isl_aff_set_constant_val> and C<isl_aff_set_coefficient_val> set
2328 the constant or coefficient as a whole.
2329 The C<add_constant> and C<add_coefficient> functions add an integer
2330 or rational value to
2331 the possibly rational constant or coefficient.
2332 The C<add_constant_num> functions add an integer value to
2333 the numerator.
2335 =item * Quasipolynomials
2337 Some simple quasipolynomials can be created using the following functions.
2339         #include <isl/polynomial.h>
2340         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
2341                 __isl_take isl_space *domain);
2342         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
2343                 __isl_take isl_space *domain);
2344         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
2345                 __isl_take isl_space *domain);
2346         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
2347                 __isl_take isl_space *domain);
2348         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
2349                 __isl_take isl_space *domain);
2350         __isl_give isl_qpolynomial *isl_qpolynomial_val_on_domain(
2351                 __isl_take isl_space *domain,
2352                 __isl_take isl_val *val);
2353         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
2354                 __isl_take isl_space *domain,
2355                 enum isl_dim_type type, unsigned pos);
2356         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
2357                 __isl_take isl_aff *aff);
2359 Recall that the space in which a quasipolynomial lives is a map space
2360 with a one-dimensional range.  The C<domain> argument in some of
2361 the functions above corresponds to the domain of this map space.
2363 Quasipolynomials can be copied and freed again using the following
2364 functions.
2366         #include <isl/polynomial.h>
2367         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
2368                 __isl_keep isl_qpolynomial *qp);
2369         __isl_null isl_qpolynomial *isl_qpolynomial_free(
2370                 __isl_take isl_qpolynomial *qp);
2372 The constant term of a quasipolynomial can be extracted using
2374         __isl_give isl_val *isl_qpolynomial_get_constant_val(
2375                 __isl_keep isl_qpolynomial *qp);
2377 To iterate over all terms in a quasipolynomial,
2380         int isl_qpolynomial_foreach_term(
2381                 __isl_keep isl_qpolynomial *qp,
2382                 int (*fn)(__isl_take isl_term *term,
2383                           void *user), void *user);
2385 The terms themselves can be inspected and freed using
2386 these functions
2388         unsigned isl_term_dim(__isl_keep isl_term *term,
2389                 enum isl_dim_type type);
2390         __isl_give isl_val *isl_term_get_coefficient_val(
2391                 __isl_keep isl_term *term);
2392         int isl_term_get_exp(__isl_keep isl_term *term,
2393                 enum isl_dim_type type, unsigned pos);
2394         __isl_give isl_aff *isl_term_get_div(
2395                 __isl_keep isl_term *term, unsigned pos);
2396         void isl_term_free(__isl_take isl_term *term);
2398 Each term is a product of parameters, set variables and
2399 integer divisions.  The function C<isl_term_get_exp>
2400 returns the exponent of a given dimensions in the given term.
2402 =back
2404 =head3 Reductions
2406 A reduction represents a maximum or a minimum of its
2407 base expressions.
2408 The only reduction type defined by C<isl> is
2409 C<isl_qpolynomial_fold>.
2411 There are currently no functions to directly create such
2412 objects, but they do appear in the piecewise quasipolynomial
2413 reductions returned by the C<isl_pw_qpolynomial_bound> function.
2415 L</"Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions">.
2417 Reductions can be copied and freed using
2418 the following functions.
2420         #include <isl/polynomial.h>
2421         __isl_give isl_qpolynomial_fold *
2422         isl_qpolynomial_fold_copy(
2423                 __isl_keep isl_qpolynomial_fold *fold);
2424         void isl_qpolynomial_fold_free(
2425                 __isl_take isl_qpolynomial_fold *fold);
2427 To iterate over all quasipolynomials in a reduction, use
2429         int isl_qpolynomial_fold_foreach_qpolynomial(
2430                 __isl_keep isl_qpolynomial_fold *fold,
2431                 int (*fn)(__isl_take isl_qpolynomial *qp,
2432                           void *user), void *user);
2434 =head3 Multiple Expressions
2436 A multiple expression represents a sequence of zero or
2437 more base expressions, all defined on the same domain space.
2438 The domain space of the multiple expression is the same
2439 as that of the base expressions, but the range space
2440 can be any space.  In case the base expressions have
2441 a set space, the corresponding multiple expression
2442 also has a set space.
2443 Objects of the value type do not have an associated space.
2444 The space of a multiple value is therefore always a set space.
2446 The multiple expression types defined by C<isl>
2447 are C<isl_multi_val>, C<isl_multi_aff> and C<isl_multi_pw_aff>.
2449 A multiple expression with the value zero for
2450 each output (or set) dimension can be created
2451 using the following functions.
2453         #include <isl/val.h>
2454         __isl_give isl_multi_val *isl_multi_val_zero(
2455                 __isl_take isl_space *space);
2457         #include <isl/aff.h>
2458         __isl_give isl_multi_aff *isl_multi_aff_zero(
2459                 __isl_take isl_space *space);
2460         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
2461                 __isl_take isl_space *space);
2463 An identity function can be created using the following
2464 functions.  The space needs to be that of a relation
2465 with the same number of input and output dimensions.
2467         #include <isl/aff.h>
2468         __isl_give isl_multi_aff *isl_multi_aff_identity(
2469                 __isl_take isl_space *space);
2470         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
2471                 __isl_take isl_space *space);
2473 A function that performs a projection on a universe
2474 relation or set can be created using the following functions.
2475 See also the corresponding
2476 projection operations in L</"Unary Operations">.
2478         #include <isl/aff.h>
2479         __isl_give isl_multi_aff *isl_multi_aff_domain_map(
2480                 __isl_take isl_space *space);
2481         __isl_give isl_multi_aff *isl_multi_aff_range_map(
2482                 __isl_take isl_space *space);
2483         __isl_give isl_multi_aff *isl_multi_aff_project_out_map(
2484                 __isl_take isl_space *space,
2485                 enum isl_dim_type type,
2486                 unsigned first, unsigned n);
2488 A multiple expression can be created from a single
2489 base expression using the following functions.
2490 The space of the created multiple expression is the same
2491 as that of the base expression.
2493         #include <isl/aff.h>
2494         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
2495                 __isl_take isl_aff *aff);
2496         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
2497                 __isl_take isl_pw_aff *pa);
2499 A multiple expression can be created from a list
2500 of base expression in a specified space.
2501 The domain of this space needs to be the same
2502 as the domains of the base expressions in the list.
2503 If the base expressions have a set space (or no associated space),
2504 then this space also needs to be a set space.
2506         #include <isl/val.h>
2507         __isl_give isl_multi_val *isl_multi_val_from_val_list(
2508                 __isl_take isl_space *space,
2509                 __isl_take isl_val_list *list);
2511         #include <isl/aff.h>
2512         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
2513                 __isl_take isl_space *space,
2514                 __isl_take isl_aff_list *list);
2516 As a convenience, a multiple piecewise expression can
2517 also be created from a multiple expression.
2518 Each piecewise expression in the result has a single
2519 universe cell.
2521         #include <isl/aff.h>
2522         __isl_give isl_multi_pw_aff *
2523         isl_multi_pw_aff_from_multi_aff(
2524                 __isl_take isl_multi_aff *ma);
2526 A multiple quasi-affine expression can be created from
2527 a multiple value with a given domain space using the following
2528 function.
2530         #include <isl/aff.h>
2531         __isl_give isl_multi_aff *
2532         isl_multi_aff_multi_val_on_space(
2533                 __isl_take isl_space *space,
2534                 __isl_take isl_multi_val *mv);
2536 Multiple expressions can be copied and freed using
2537 the following functions.
2539         #include <isl/val.h>
2540         __isl_give isl_multi_val *isl_multi_val_copy(
2541                 __isl_keep isl_multi_val *mv);
2542         __isl_null isl_multi_val *isl_multi_val_free(
2543                 __isl_take isl_multi_val *mv);
2545         #include <isl/aff.h>
2546         __isl_give isl_multi_aff *isl_multi_aff_copy(
2547                 __isl_keep isl_multi_aff *maff);
2548         __isl_null isl_multi_aff *isl_multi_aff_free(
2549                 __isl_take isl_multi_aff *maff);
2550         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
2551                 __isl_keep isl_multi_pw_aff *mpa);
2552         __isl_null isl_multi_pw_aff *isl_multi_pw_aff_free(
2553                 __isl_take isl_multi_pw_aff *mpa);
2555 The base expression at a given position of a multiple
2556 expression can be extracted using the following functions.
2558         #include <isl/val.h>
2559         __isl_give isl_val *isl_multi_val_get_val(
2560                 __isl_keep isl_multi_val *mv, int pos);
2562         #include <isl/aff.h>
2563         __isl_give isl_aff *isl_multi_aff_get_aff(
2564                 __isl_keep isl_multi_aff *multi, int pos);
2565         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
2566                 __isl_keep isl_multi_pw_aff *mpa, int pos);
2568 It can be replaced using the following functions.
2570         #include <isl/val.h>
2571         __isl_give isl_multi_val *isl_multi_val_set_val(
2572                 __isl_take isl_multi_val *mv, int pos,
2573                 __isl_take isl_val *val);
2575         #include <isl/aff.h>
2576         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
2577                 __isl_take isl_multi_aff *multi, int pos,
2578                 __isl_take isl_aff *aff);
2580 =head3 Piecewise Expressions
2582 A piecewise expression is an expression that is described
2583 using zero or more base expression defined over the same
2584 number of cells in the domain space of the base expressions.
2585 All base expressions are defined over the same
2586 domain space and the cells are disjoint.
2587 The space of a piecewise expression is the same as
2588 that of the base expressions.
2589 If the union of the cells is a strict subset of the domain
2590 space, then the value of the piecewise expression outside
2591 this union is different for types derived from quasi-affine
2592 expressions and those derived from quasipolynomials.
2593 Piecewise expressions derived from quasi-affine expressions
2594 are considered to be undefined outside the union of their cells.
2595 Piecewise expressions derived from quasipolynomials
2596 are considered to be zero outside the union of their cells.
2598 Piecewise quasipolynomials are mainly used by the C<barvinok>
2599 library for representing the number of elements in a parametric set or map.
2600 For example, the piecewise quasipolynomial
2602         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
2604 represents the number of points in the map
2606         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
2608 The piecewise expression types defined by C<isl>
2609 are C<isl_pw_aff>, C<isl_pw_multi_aff>,
2610 C<isl_pw_qpolynomial> and C<isl_pw_qpolynomial_fold>.
2612 A piecewise expression with no cells can be created using
2613 the following functions.
2615         #include <isl/aff.h>
2616         __isl_give isl_pw_aff *isl_pw_aff_empty(
2617                 __isl_take isl_space *space);
2618         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
2619                 __isl_take isl_space *space);
2621 A piecewise expression with a single universe cell can be
2622 created using the following functions.
2624         #include <isl/aff.h>
2625         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2626                 __isl_take isl_aff *aff);
2627         __isl_give isl_pw_multi_aff *
2628         isl_pw_multi_aff_from_multi_aff(
2629                 __isl_take isl_multi_aff *ma);
2631         #include <isl/polynomial.h>
2632         __isl_give isl_pw_qpolynomial *
2633         isl_pw_qpolynomial_from_qpolynomial(
2634                 __isl_take isl_qpolynomial *qp);
2636 A piecewise expression with a single specified cell can be
2637 created using the following functions.
2639         #include <isl/aff.h>
2640         __isl_give isl_pw_aff *isl_pw_aff_alloc(
2641                 __isl_take isl_set *set, __isl_take isl_aff *aff);
2642         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
2643                 __isl_take isl_set *set,
2644                 __isl_take isl_multi_aff *maff);
2646         #include <isl/polynomial.h>
2647         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
2648                 __isl_take isl_set *set,
2649                 __isl_take isl_qpolynomial *qp);
2651 The following convenience functions first create a base expression and
2652 then create a piecewise expression over a universe domain.
2654         #include <isl/aff.h>
2655         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
2656                 __isl_take isl_local_space *ls);
2657         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
2658                 __isl_take isl_local_space *ls,
2659                 enum isl_dim_type type, unsigned pos);
2660         __isl_give isl_pw_aff *isl_pw_aff_nan_on_domain(
2661                 __isl_take isl_local_space *ls);
2662         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_zero(
2663                 __isl_take isl_space *space);
2664         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
2665                 __isl_take isl_space *space);
2666         __isl_give isl_pw_multi_aff *
2667         isl_pw_multi_aff_project_out_map(
2668                 __isl_take isl_space *space,
2669                 enum isl_dim_type type,
2670                 unsigned first, unsigned n);
2672         #include <isl/polynomial.h>
2673         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
2674                 __isl_take isl_space *space);
2676 The following convenience functions first create a base expression and
2677 then create a piecewise expression over a given domain.
2679         #include <isl/aff.h>
2680         __isl_give isl_pw_aff *isl_pw_aff_val_on_domain(
2681                 __isl_take isl_set *domain,
2682                 __isl_take isl_val *v);
2683         __isl_give isl_pw_multi_aff *
2684         isl_pw_multi_aff_multi_val_on_domain(
2685                 __isl_take isl_set *domain,
2686                 __isl_take isl_multi_val *mv);
2688 As a convenience, a piecewise multiple expression can
2689 also be created from a piecewise expression.
2690 Each multiple expression in the result is derived
2691 from the corresponding base expression.
2693         #include <isl/aff.h>
2694         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_pw_aff(
2695                 __isl_take isl_pw_aff *pa);
2697 Similarly, a piecewise quasipolynomial can be
2698 created from a piecewise quasi-affine expression using
2699 the following function.
2701         #include <isl/polynomial.h>
2702         __isl_give isl_pw_qpolynomial *
2703         isl_pw_qpolynomial_from_pw_aff(
2704                 __isl_take isl_pw_aff *pwaff);
2706 Piecewise expressions can be copied and freed using the following functions.
2708         #include <isl/aff.h>
2709         __isl_give isl_pw_aff *isl_pw_aff_copy(
2710                 __isl_keep isl_pw_aff *pwaff);
2711         __isl_null isl_pw_aff *isl_pw_aff_free(
2712                 __isl_take isl_pw_aff *pwaff);
2713         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
2714                 __isl_keep isl_pw_multi_aff *pma);
2715         __isl_null isl_pw_multi_aff *isl_pw_multi_aff_free(
2716                 __isl_take isl_pw_multi_aff *pma);
2718         #include <isl/polynomial.h>
2719         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
2720                 __isl_keep isl_pw_qpolynomial *pwqp);
2721         __isl_null isl_pw_qpolynomial *isl_pw_qpolynomial_free(
2722                 __isl_take isl_pw_qpolynomial *pwqp);
2723         __isl_give isl_pw_qpolynomial_fold *
2724         isl_pw_qpolynomial_fold_copy(
2725                 __isl_keep isl_pw_qpolynomial_fold *pwf);
2726         __isl_null isl_pw_qpolynomial_fold *
2727         isl_pw_qpolynomial_fold_free(
2728                 __isl_take isl_pw_qpolynomial_fold *pwf);
2730 To iterate over the different cells of a piecewise expression,
2731 use the following functions.
2733         #include <isl/aff.h>
2734         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
2735         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
2736         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
2737                 int (*fn)(__isl_take isl_set *set,
2738                           __isl_take isl_aff *aff,
2739                           void *user), void *user);
2740         int isl_pw_multi_aff_foreach_piece(
2741                 __isl_keep isl_pw_multi_aff *pma,
2742                 int (*fn)(__isl_take isl_set *set,
2743                             __isl_take isl_multi_aff *maff,
2744                             void *user), void *user);
2746         #include <isl/polynomial.h>
2747         int isl_pw_qpolynomial_foreach_piece(
2748                 __isl_keep isl_pw_qpolynomial *pwqp,
2749                 int (*fn)(__isl_take isl_set *set,
2750                           __isl_take isl_qpolynomial *qp,
2751                           void *user), void *user);
2752         int isl_pw_qpolynomial_foreach_lifted_piece(
2753                 __isl_keep isl_pw_qpolynomial *pwqp,
2754                 int (*fn)(__isl_take isl_set *set,
2755                           __isl_take isl_qpolynomial *qp,
2756                           void *user), void *user);
2757         int isl_pw_qpolynomial_fold_foreach_piece(
2758                 __isl_keep isl_pw_qpolynomial_fold *pwf,
2759                 int (*fn)(__isl_take isl_set *set,
2760                           __isl_take isl_qpolynomial_fold *fold,
2761                           void *user), void *user);
2762         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
2763                 __isl_keep isl_pw_qpolynomial_fold *pwf,
2764                 int (*fn)(__isl_take isl_set *set,
2765                           __isl_take isl_qpolynomial_fold *fold,
2766                           void *user), void *user);
2768 As usual, the function C<fn> should return C<0> on success
2769 and C<-1> on failure.  The difference between
2770 C<isl_pw_qpolynomial_foreach_piece> and
2771 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
2772 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
2773 compute unique representations for all existentially quantified
2774 variables and then turn these existentially quantified variables
2775 into extra set variables, adapting the associated quasipolynomial
2776 accordingly.  This means that the C<set> passed to C<fn>
2777 will not have any existentially quantified variables, but that
2778 the dimensions of the sets may be different for different
2779 invocations of C<fn>.
2780 Similarly for C<isl_pw_qpolynomial_fold_foreach_piece>
2781 and C<isl_pw_qpolynomial_fold_foreach_lifted_piece>.
2783 A piecewise expression consisting of the expressions at a given
2784 position of a piecewise multiple expression can be extracted
2785 using the following function.
2787         #include <isl/aff.h>
2788         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
2789                 __isl_keep isl_pw_multi_aff *pma, int pos);
2791 These expressions can be replaced using the following function.
2793         #include <isl/aff.h>
2794         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
2795                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
2796                 __isl_take isl_pw_aff *pa);
2798 Note that there is a difference between C<isl_multi_pw_aff> and
2799 C<isl_pw_multi_aff> objects.  The first is a sequence of piecewise
2800 affine expressions, while the second is a piecewise sequence
2801 of affine expressions.  In particular, each of the piecewise
2802 affine expressions in an C<isl_multi_pw_aff> may have a different
2803 domain, while all multiple expressions associated to a cell
2804 in an C<isl_pw_multi_aff> have the same domain.
2805 It is possible to convert between the two, but when converting
2806 an C<isl_multi_pw_aff> to an C<isl_pw_multi_aff>, the domain
2807 of the result is the intersection of the domains of the input.
2808 The reverse conversion is exact.
2810         #include <isl/aff.h>
2811         __isl_give isl_pw_multi_aff *
2812         isl_pw_multi_aff_from_multi_pw_aff(
2813                 __isl_take isl_multi_pw_aff *mpa);
2814         __isl_give isl_multi_pw_aff *
2815         isl_multi_pw_aff_from_pw_multi_aff(
2816                 __isl_take isl_pw_multi_aff *pma);
2818 =head3 Union Expressions
2820 A union expression collects base expressions defined
2821 over different domains.  The space of a union expression
2822 is that of the shared parameter space.
2824 The union expression types defined by C<isl>
2825 are C<isl_union_pw_multi_aff>, C<isl_union_pw_qpolynomial> and
2826 C<isl_union_pw_qpolynomial_fold>.
2828 An empty union expression can be created using the following functions.
2830         #include <isl/aff.h>
2831         __isl_give isl_union_pw_multi_aff *
2832         isl_union_pw_multi_aff_empty(
2833                 __isl_take isl_space *space);
2835         #include <isl/polynomial.h>
2836         __isl_give isl_union_pw_qpolynomial *
2837         isl_union_pw_qpolynomial_zero(
2838                 __isl_take isl_space *space);
2840 A union expression containing a single base expression
2841 can be created using the following functions.
2843         #include <isl/aff.h>
2844         __isl_give isl_union_pw_multi_aff *
2845         isl_union_pw_multi_aff_from_pw_multi_aff(
2846                 __isl_take isl_pw_multi_aff *pma);
2848         #include <isl/polynomial.h>
2849         __isl_give isl_union_pw_qpolynomial *
2850         isl_union_pw_qpolynomial_from_pw_qpolynomial(
2851                 __isl_take isl_pw_qpolynomial *pwqp);
2853 The following function creates a base expression on each
2854 of the sets in the union set and collects the results.
2856         #include <isl/aff.h>
2857         __isl_give isl_union_pw_multi_aff *
2858         isl_union_pw_multi_aff_multi_val_on_domain(
2859                 __isl_take isl_union_set *domain,
2860                 __isl_take isl_multi_val *mv);
2862 A base expression can be added to a union expression using
2863 the following functions.
2865         #include <isl/aff.h>
2866         __isl_give isl_union_pw_multi_aff *
2867         isl_union_pw_multi_aff_add_pw_multi_aff(
2868                 __isl_take isl_union_pw_multi_aff *upma,
2869                 __isl_take isl_pw_multi_aff *pma);
2871         #include <isl/polynomial.h>
2872         __isl_give isl_union_pw_qpolynomial *
2873         isl_union_pw_qpolynomial_add_pw_qpolynomial(
2874                 __isl_take isl_union_pw_qpolynomial *upwqp,
2875                 __isl_take isl_pw_qpolynomial *pwqp);
2877 Union expressions can be copied and freed using
2878 the following functions.
2880         #include <isl/aff.h>
2881         __isl_give isl_union_pw_multi_aff *
2882         isl_union_pw_multi_aff_copy(
2883                 __isl_keep isl_union_pw_multi_aff *upma);
2884         __isl_null isl_union_pw_multi_aff *
2885         isl_union_pw_multi_aff_free(
2886                 __isl_take isl_union_pw_multi_aff *upma);
2888         #include <isl/polynomial.h>
2889         __isl_give isl_union_pw_qpolynomial *
2890         isl_union_pw_qpolynomial_copy(
2891                 __isl_keep isl_union_pw_qpolynomial *upwqp);
2892         __isl_null isl_union_pw_qpolynomial *
2893         isl_union_pw_qpolynomial_free(
2894                 __isl_take isl_union_pw_qpolynomial *upwqp);
2895         __isl_give isl_union_pw_qpolynomial_fold *
2896         isl_union_pw_qpolynomial_fold_copy(
2897                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
2898         __isl_null isl_union_pw_qpolynomial_fold *
2899         isl_union_pw_qpolynomial_fold_free(
2900                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
2902 To iterate over the base expressions in a union expression,
2903 use the following functions.
2905         #include <isl/aff.h>
2906         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
2907                 __isl_keep isl_union_pw_multi_aff *upma,
2908                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
2909                             void *user), void *user);
2911         #include <isl/polynomial.h>
2912         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
2913                 __isl_keep isl_union_pw_qpolynomial *upwqp,
2914                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp,
2915                             void *user), void *user);
2916         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
2917                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
2918                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
2919                             void *user), void *user);
2921 To extract the base expression in a given space from a union, use
2922 the following functions.
2924         #include <isl/aff.h>
2925         __isl_give isl_pw_multi_aff *
2926         isl_union_pw_multi_aff_extract_pw_multi_aff(
2927                 __isl_keep isl_union_pw_multi_aff *upma,
2928                 __isl_take isl_space *space);
2930         #include <isl/polynomial.h>
2931         __isl_give isl_pw_qpolynomial *
2932         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
2933                 __isl_keep isl_union_pw_qpolynomial *upwqp,
2934                 __isl_take isl_space *space);
2936 =head2 Input and Output
2938 For set and relation,
2939 C<isl> supports its own input/output format, which is similar
2940 to the C<Omega> format, but also supports the C<PolyLib> format
2941 in some cases.
2942 For other object types, typically only an C<isl> format is supported.
2944 =head3 C<isl> format
2946 The C<isl> format is similar to that of C<Omega>, but has a different
2947 syntax for describing the parameters and allows for the definition
2948 of an existentially quantified variable as the integer division
2949 of an affine expression.
2950 For example, the set of integers C<i> between C<0> and C<n>
2951 such that C<i % 10 <= 6> can be described as
2953         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
2954                                 i - 10 a <= 6) }
2956 A set or relation can have several disjuncts, separated
2957 by the keyword C<or>.  Each disjunct is either a conjunction
2958 of constraints or a projection (C<exists>) of a conjunction
2959 of constraints.  The constraints are separated by the keyword
2960 C<and>.
2962 =head3 C<PolyLib> format
2964 If the represented set is a union, then the first line
2965 contains a single number representing the number of disjuncts.
2966 Otherwise, a line containing the number C<1> is optional.
2968 Each disjunct is represented by a matrix of constraints.
2969 The first line contains two numbers representing
2970 the number of rows and columns,
2971 where the number of rows is equal to the number of constraints
2972 and the number of columns is equal to two plus the number of variables.
2973 The following lines contain the actual rows of the constraint matrix.
2974 In each row, the first column indicates whether the constraint
2975 is an equality (C<0>) or inequality (C<1>).  The final column
2976 corresponds to the constant term.
2978 If the set is parametric, then the coefficients of the parameters
2979 appear in the last columns before the constant column.
2980 The coefficients of any existentially quantified variables appear
2981 between those of the set variables and those of the parameters.
2983 =head3 Extended C<PolyLib> format
2985 The extended C<PolyLib> format is nearly identical to the
2986 C<PolyLib> format.  The only difference is that the line
2987 containing the number of rows and columns of a constraint matrix
2988 also contains four additional numbers:
2989 the number of output dimensions, the number of input dimensions,
2990 the number of local dimensions (i.e., the number of existentially
2991 quantified variables) and the number of parameters.
2992 For sets, the number of ``output'' dimensions is equal
2993 to the number of set dimensions, while the number of ``input''
2994 dimensions is zero.
2996 =head3 Input
2998 Objects can be read from input using the following functions.
3000         #include <isl/val.h>
3001         __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
3002                 const char *str);
3003         __isl_give isl_multi_val *isl_multi_val_read_from_str(
3004                 isl_ctx *ctx, const char *str);
3006         #include <isl/set.h>
3007         __isl_give isl_basic_set *isl_basic_set_read_from_file(
3008                 isl_ctx *ctx, FILE *input);
3009         __isl_give isl_basic_set *isl_basic_set_read_from_str(
3010                 isl_ctx *ctx, const char *str);
3011         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
3012                 FILE *input);
3013         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
3014                 const char *str);
3016         #include <isl/map.h>
3017         __isl_give isl_basic_map *isl_basic_map_read_from_file(
3018                 isl_ctx *ctx, FILE *input);
3019         __isl_give isl_basic_map *isl_basic_map_read_from_str(
3020                 isl_ctx *ctx, const char *str);
3021         __isl_give isl_map *isl_map_read_from_file(
3022                 isl_ctx *ctx, FILE *input);
3023         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
3024                 const char *str);
3026         #include <isl/union_set.h>
3027         __isl_give isl_union_set *isl_union_set_read_from_file(
3028                 isl_ctx *ctx, FILE *input);
3029         __isl_give isl_union_set *isl_union_set_read_from_str(
3030                 isl_ctx *ctx, const char *str);
3032         #include <isl/union_map.h>
3033         __isl_give isl_union_map *isl_union_map_read_from_file(
3034                 isl_ctx *ctx, FILE *input);
3035         __isl_give isl_union_map *isl_union_map_read_from_str(
3036                 isl_ctx *ctx, const char *str);
3038         #include <isl/aff.h>
3039         __isl_give isl_aff *isl_aff_read_from_str(
3040                 isl_ctx *ctx, const char *str);
3041         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3042                 isl_ctx *ctx, const char *str);
3043         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3044                 isl_ctx *ctx, const char *str);
3045         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3046                 isl_ctx *ctx, const char *str);
3047         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_read_from_str(
3048                 isl_ctx *ctx, const char *str);
3049         __isl_give isl_union_pw_multi_aff *
3050         isl_union_pw_multi_aff_read_from_str(
3051                 isl_ctx *ctx, const char *str);
3053         #include <isl/polynomial.h>
3054         __isl_give isl_union_pw_qpolynomial *
3055         isl_union_pw_qpolynomial_read_from_str(
3056                 isl_ctx *ctx, const char *str);
3058 For sets and relations,
3059 the input format is autodetected and may be either the C<PolyLib> format
3060 or the C<isl> format.
3062 =head3 Output
3064 Before anything can be printed, an C<isl_printer> needs to
3065 be created.
3067         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
3068                 FILE *file);
3069         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
3070         __isl_null isl_printer *isl_printer_free(
3071                 __isl_take isl_printer *printer);
3072         __isl_give char *isl_printer_get_str(
3073                 __isl_keep isl_printer *printer);
3075 The printer can be inspected using the following functions.
3077         FILE *isl_printer_get_file(
3078                 __isl_keep isl_printer *printer);
3079         int isl_printer_get_output_format(
3080                 __isl_keep isl_printer *p);
3082 The behavior of the printer can be modified in various ways
3084         __isl_give isl_printer *isl_printer_set_output_format(
3085                 __isl_take isl_printer *p, int output_format);
3086         __isl_give isl_printer *isl_printer_set_indent(
3087                 __isl_take isl_printer *p, int indent);
3088         __isl_give isl_printer *isl_printer_set_indent_prefix(
3089                 __isl_take isl_printer *p, const char *prefix);
3090         __isl_give isl_printer *isl_printer_indent(
3091                 __isl_take isl_printer *p, int indent);
3092         __isl_give isl_printer *isl_printer_set_prefix(
3093                 __isl_take isl_printer *p, const char *prefix);
3094         __isl_give isl_printer *isl_printer_set_suffix(
3095                 __isl_take isl_printer *p, const char *suffix);
3097 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
3098 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
3099 and defaults to C<ISL_FORMAT_ISL>.
3100 Each line in the output is prefixed by C<indent_prefix>,
3101 indented by C<indent> (set by C<isl_printer_set_indent>) spaces
3102 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
3103 In the C<PolyLib> format output,
3104 the coefficients of the existentially quantified variables
3105 appear between those of the set variables and those
3106 of the parameters.
3107 The function C<isl_printer_indent> increases the indentation
3108 by the specified amount (which may be negative).
3110 To actually print something, use
3112         #include <isl/printer.h>
3113         __isl_give isl_printer *isl_printer_print_double(
3114                 __isl_take isl_printer *p, double d);
3116         #include <isl/val.h>
3117         __isl_give isl_printer *isl_printer_print_val(
3118                 __isl_take isl_printer *p, __isl_keep isl_val *v);
3120         #include <isl/set.h>
3121         __isl_give isl_printer *isl_printer_print_basic_set(
3122                 __isl_take isl_printer *printer,
3123                 __isl_keep isl_basic_set *bset);
3124         __isl_give isl_printer *isl_printer_print_set(
3125                 __isl_take isl_printer *printer,
3126                 __isl_keep isl_set *set);
3128         #include <isl/map.h>
3129         __isl_give isl_printer *isl_printer_print_basic_map(
3130                 __isl_take isl_printer *printer,
3131                 __isl_keep isl_basic_map *bmap);
3132         __isl_give isl_printer *isl_printer_print_map(
3133                 __isl_take isl_printer *printer,
3134                 __isl_keep isl_map *map);
3136         #include <isl/union_set.h>
3137         __isl_give isl_printer *isl_printer_print_union_set(
3138                 __isl_take isl_printer *p,
3139                 __isl_keep isl_union_set *uset);
3141         #include <isl/union_map.h>
3142         __isl_give isl_printer *isl_printer_print_union_map(
3143                 __isl_take isl_printer *p,
3144                 __isl_keep isl_union_map *umap);
3146         #include <isl/val.h>
3147         __isl_give isl_printer *isl_printer_print_multi_val(
3148                 __isl_take isl_printer *p,
3149                 __isl_keep isl_multi_val *mv);
3151         #include <isl/aff.h>
3152         __isl_give isl_printer *isl_printer_print_aff(
3153                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3154         __isl_give isl_printer *isl_printer_print_multi_aff(
3155                 __isl_take isl_printer *p,
3156                 __isl_keep isl_multi_aff *maff);
3157         __isl_give isl_printer *isl_printer_print_pw_aff(
3158                 __isl_take isl_printer *p,
3159                 __isl_keep isl_pw_aff *pwaff);
3160         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3161                 __isl_take isl_printer *p,
3162                 __isl_keep isl_pw_multi_aff *pma);
3163         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
3164                 __isl_take isl_printer *p,
3165                 __isl_keep isl_multi_pw_aff *mpa);
3166         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
3167                 __isl_take isl_printer *p,
3168                 __isl_keep isl_union_pw_multi_aff *upma);
3170         #include <isl/polynomial.h>
3171         __isl_give isl_printer *isl_printer_print_qpolynomial(
3172                 __isl_take isl_printer *p,
3173                 __isl_keep isl_qpolynomial *qp);
3174         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3175                 __isl_take isl_printer *p,
3176                 __isl_keep isl_pw_qpolynomial *pwqp);
3177         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3178                 __isl_take isl_printer *p,
3179                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3181         __isl_give isl_printer *
3182         isl_printer_print_pw_qpolynomial_fold(
3183                 __isl_take isl_printer *p,
3184                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3185         __isl_give isl_printer *
3186         isl_printer_print_union_pw_qpolynomial_fold(
3187                 __isl_take isl_printer *p,
3188                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3190 For C<isl_printer_print_qpolynomial>,
3191 C<isl_printer_print_pw_qpolynomial> and
3192 C<isl_printer_print_pw_qpolynomial_fold>,
3193 the output format of the printer
3194 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3195 For C<isl_printer_print_union_pw_qpolynomial> and
3196 C<isl_printer_print_union_pw_qpolynomial_fold>, only C<ISL_FORMAT_ISL>
3197 is supported.
3198 In case of printing in C<ISL_FORMAT_C>, the user may want
3199 to set the names of all dimensions first.
3201 When called on a file printer, the following function flushes
3202 the file.  When called on a string printer, the buffer is cleared.
3204         __isl_give isl_printer *isl_printer_flush(
3205                 __isl_take isl_printer *p);
3207 Alternatively, a string representation can be obtained
3208 directly using the following functions, which always print
3209 in isl format.
3211         #include <isl/space.h>
3212         __isl_give char *isl_space_to_str(
3213                 __isl_keep isl_space *space);
3215         #include <isl/val.h>
3216         __isl_give char *isl_val_to_str(__isl_keep isl_val *v);
3217         __isl_give char *isl_multi_val_to_str(
3218                 __isl_keep isl_multi_val *mv);
3220         #include <isl/set.h>
3221         __isl_give char *isl_set_to_str(
3222                 __isl_keep isl_set *set);
3224         #include <isl/union_set.h>
3225         __isl_give char *isl_union_set_to_str(
3226                 __isl_keep isl_union_set *uset);
3228         #include <isl/map.h>
3229         __isl_give char *isl_map_to_str(
3230                 __isl_keep isl_map *map);
3232         #include <isl/union_map.h>
3233         __isl_give char *isl_union_map_to_str(
3234                 __isl_keep isl_union_map *umap);
3236         #include <isl/aff.h>
3237         __isl_give char *isl_multi_aff_to_str(
3238                 __isl_keep isl_multi_aff *aff);
3239         __isl_give char *isl_union_pw_multi_aff_to_str(
3240                 __isl_keep isl_union_pw_multi_aff *upma);
3242 =head2 Properties
3244 =head3 Unary Properties
3246 =over
3248 =item * Emptiness
3250 The following functions test whether the given set or relation
3251 contains any integer points.  The ``plain'' variants do not perform
3252 any computations, but simply check if the given set or relation
3253 is already known to be empty.
3255         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
3256         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
3257         int isl_set_plain_is_empty(__isl_keep isl_set *set);
3258         int isl_set_is_empty(__isl_keep isl_set *set);
3259         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
3260         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
3261         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
3262         int isl_map_plain_is_empty(__isl_keep isl_map *map);
3263         int isl_map_is_empty(__isl_keep isl_map *map);
3264         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
3266 =item * Universality
3268         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
3269         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
3270         int isl_set_plain_is_universe(__isl_keep isl_set *set);
3272 =item * Single-valuedness
3274         #include <isl/set.h>
3275         int isl_set_is_singleton(__isl_keep isl_set *set);
3277         #include <isl/map.h>
3278         int isl_basic_map_is_single_valued(
3279                 __isl_keep isl_basic_map *bmap);
3280         int isl_map_plain_is_single_valued(
3281                 __isl_keep isl_map *map);
3282         int isl_map_is_single_valued(__isl_keep isl_map *map);
3284         #include <isl/union_map.h>
3285         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
3287 =item * Injectivity
3289         int isl_map_plain_is_injective(__isl_keep isl_map *map);
3290         int isl_map_is_injective(__isl_keep isl_map *map);
3291         int isl_union_map_plain_is_injective(
3292                 __isl_keep isl_union_map *umap);
3293         int isl_union_map_is_injective(
3294                 __isl_keep isl_union_map *umap);
3296 =item * Bijectivity
3298         int isl_map_is_bijective(__isl_keep isl_map *map);
3299         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
3301 =item * Position
3303         __isl_give isl_val *
3304         isl_basic_map_plain_get_val_if_fixed(
3305                 __isl_keep isl_basic_map *bmap,
3306                 enum isl_dim_type type, unsigned pos);
3307         __isl_give isl_val *isl_set_plain_get_val_if_fixed(
3308                 __isl_keep isl_set *set,
3309                 enum isl_dim_type type, unsigned pos);
3310         __isl_give isl_val *isl_map_plain_get_val_if_fixed(
3311                 __isl_keep isl_map *map,
3312                 enum isl_dim_type type, unsigned pos);
3314 If the set or relation obviously lies on a hyperplane where the given dimension
3315 has a fixed value, then return that value.
3316 Otherwise return NaN.
3318 =item * Stride
3320         int isl_set_dim_residue_class_val(
3321                 __isl_keep isl_set *set,
3322                 int pos, __isl_give isl_val **modulo,
3323                 __isl_give isl_val **residue);
3325 Check if the values of the given set dimension are equal to a fixed
3326 value modulo some integer value.  If so, assign the modulo to C<*modulo>
3327 and the fixed value to C<*residue>.  If the given dimension attains only
3328 a single value, then assign C<0> to C<*modulo> and the fixed value to
3329 C<*residue>.
3330 If the dimension does not attain only a single value and if no modulo
3331 can be found then assign C<1> to C<*modulo> and C<1> to C<*residue>.
3333 =item * Dependence
3335 To check whether the description of a set, relation or function depends
3336 on one or more given dimensions,
3337 the following functions can be used.
3339         #include <isl/constraint.h>
3340         int isl_constraint_involves_dims(
3341                 __isl_keep isl_constraint *constraint,
3342                 enum isl_dim_type type, unsigned first, unsigned n);
3344         #include <isl/set.h>
3345         int isl_basic_set_involves_dims(
3346                 __isl_keep isl_basic_set *bset,
3347                 enum isl_dim_type type, unsigned first, unsigned n);
3348         int isl_set_involves_dims(__isl_keep isl_set *set,
3349                 enum isl_dim_type type, unsigned first, unsigned n);
3351         #include <isl/map.h>
3352         int isl_basic_map_involves_dims(
3353                 __isl_keep isl_basic_map *bmap,
3354                 enum isl_dim_type type, unsigned first, unsigned n);
3355         int isl_map_involves_dims(__isl_keep isl_map *map,
3356                 enum isl_dim_type type, unsigned first, unsigned n);
3358         #include <isl/union_map.h>
3359         int isl_union_map_involves_dims(
3360                 __isl_keep isl_union_map *umap,
3361                 enum isl_dim_type type, unsigned first, unsigned n);
3363         #include <isl/aff.h>
3364         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3365                 enum isl_dim_type type, unsigned first, unsigned n);
3366         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3367                 enum isl_dim_type type, unsigned first, unsigned n);
3368         int isl_multi_aff_involves_dims(
3369                 __isl_keep isl_multi_aff *ma,
3370                 enum isl_dim_type type, unsigned first, unsigned n);
3371         int isl_multi_pw_aff_involves_dims(
3372                 __isl_keep isl_multi_pw_aff *mpa,
3373                 enum isl_dim_type type, unsigned first, unsigned n);
3375 Similarly, the following functions can be used to check whether
3376 a given dimension is involved in any lower or upper bound.
3378         #include <isl/set.h>
3379         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
3380                 enum isl_dim_type type, unsigned pos);
3381         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
3382                 enum isl_dim_type type, unsigned pos);
3384 Note that these functions return true even if there is a bound on
3385 the dimension on only some of the basic sets of C<set>.
3386 To check if they have a bound for all of the basic sets in C<set>,
3387 use the following functions instead.
3389         #include <isl/set.h>
3390         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
3391                 enum isl_dim_type type, unsigned pos);
3392         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
3393                 enum isl_dim_type type, unsigned pos);
3395 =item * Space
3397 To check whether a set is a parameter domain, use this function:
3399         int isl_set_is_params(__isl_keep isl_set *set);
3400         int isl_union_set_is_params(
3401                 __isl_keep isl_union_set *uset);
3403 =item * Wrapping
3405 The following functions check whether the space of the given
3406 (basic) set or relation range is a wrapped relation.
3408         #include <isl/space.h>
3409         int isl_space_is_wrapping(
3410                 __isl_keep isl_space *space);
3411         int isl_space_domain_is_wrapping(
3412                 __isl_keep isl_space *space);
3413         int isl_space_range_is_wrapping(
3414                 __isl_keep isl_space *space);
3416         #include <isl/set.h>
3417         int isl_basic_set_is_wrapping(
3418                 __isl_keep isl_basic_set *bset);
3419         int isl_set_is_wrapping(__isl_keep isl_set *set);
3421         #include <isl/map.h>
3422         int isl_map_domain_is_wrapping(
3423                 __isl_keep isl_map *map);
3424         int isl_map_range_is_wrapping(
3425                 __isl_keep isl_map *map);
3427         #include <isl/val.h>
3428         int isl_multi_val_range_is_wrapping(
3429                 __isl_keep isl_multi_val *mv);
3431         #include <isl/aff.h>
3432         int isl_multi_aff_range_is_wrapping(
3433                 __isl_keep isl_multi_aff *ma);
3434         int isl_multi_pw_aff_range_is_wrapping(
3435                 __isl_keep isl_multi_pw_aff *mpa);
3437 The input to C<isl_space_is_wrapping> should
3438 be the space of a set, while that of
3439 C<isl_space_domain_is_wrapping> and
3440 C<isl_space_range_is_wrapping> should be the space of a relation.
3442 =item * Internal Product
3444         int isl_basic_map_can_zip(
3445                 __isl_keep isl_basic_map *bmap);
3446         int isl_map_can_zip(__isl_keep isl_map *map);
3448 Check whether the product of domain and range of the given relation
3449 can be computed,
3450 i.e., whether both domain and range are nested relations.
3452 =item * Currying
3454         int isl_basic_map_can_curry(
3455                 __isl_keep isl_basic_map *bmap);
3456         int isl_map_can_curry(__isl_keep isl_map *map);
3458 Check whether the domain of the (basic) relation is a wrapped relation.
3460         int isl_basic_map_can_uncurry(
3461                 __isl_keep isl_basic_map *bmap);
3462         int isl_map_can_uncurry(__isl_keep isl_map *map);
3464 Check whether the range of the (basic) relation is a wrapped relation.
3466 =item * Special Values
3468         #include <isl/aff.h>
3469         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3470         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3472 Check whether the given expression is a constant.
3474         #include <isl/aff.h>
3475         int isl_aff_is_nan(__isl_keep isl_aff *aff);
3476         int isl_pw_aff_involves_nan(__isl_keep isl_pw_aff *pa);
3478 Check whether the given expression is equal to or involves NaN.
3480         #include <isl/aff.h>
3481         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3483 Check whether the affine expression is obviously zero.
3485 =back
3487 =head3 Binary Properties
3489 =over
3491 =item * Equality
3493 The following functions check whether two objects
3494 represent the same set, relation or function.
3495 The C<plain> variants only return true if the objects
3496 are obviously the same.  That is, they may return false
3497 even if the objects are the same, but they will never
3498 return true if the objects are not the same.
3500         #include <isl/set.h>
3501         int isl_basic_set_plain_is_equal(
3502                 __isl_keep isl_basic_set *bset1,
3503                 __isl_keep isl_basic_set *bset2);
3504         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
3505                 __isl_keep isl_set *set2);
3506         int isl_set_is_equal(__isl_keep isl_set *set1,
3507                 __isl_keep isl_set *set2);
3509         #include <isl/map.h>
3510         int isl_basic_map_is_equal(
3511                 __isl_keep isl_basic_map *bmap1,
3512                 __isl_keep isl_basic_map *bmap2);
3513         int isl_map_is_equal(__isl_keep isl_map *map1,
3514                 __isl_keep isl_map *map2);
3515         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
3516                 __isl_keep isl_map *map2);
3518         #include <isl/union_set.h>
3519         int isl_union_set_is_equal(
3520                 __isl_keep isl_union_set *uset1,
3521                 __isl_keep isl_union_set *uset2);
3523         #include <isl/union_map.h>
3524         int isl_union_map_is_equal(
3525                 __isl_keep isl_union_map *umap1,
3526                 __isl_keep isl_union_map *umap2);
3528         #include <isl/aff.h>
3529         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3530                 __isl_keep isl_aff *aff2);
3531         int isl_multi_aff_plain_is_equal(
3532                 __isl_keep isl_multi_aff *maff1,
3533                 __isl_keep isl_multi_aff *maff2);
3534         int isl_pw_aff_plain_is_equal(
3535                 __isl_keep isl_pw_aff *pwaff1,
3536                 __isl_keep isl_pw_aff *pwaff2);
3537         int isl_pw_multi_aff_plain_is_equal(
3538                 __isl_keep isl_pw_multi_aff *pma1,
3539                 __isl_keep isl_pw_multi_aff *pma2);
3540         int isl_multi_pw_aff_plain_is_equal(
3541                 __isl_keep isl_multi_pw_aff *mpa1,
3542                 __isl_keep isl_multi_pw_aff *mpa2);
3543         int isl_multi_pw_aff_is_equal(
3544                 __isl_keep isl_multi_pw_aff *mpa1,
3545                 __isl_keep isl_multi_pw_aff *mpa2);
3546         int isl_union_pw_multi_aff_plain_is_equal(
3547                 __isl_keep isl_union_pw_multi_aff *upma1,
3548                 __isl_keep isl_union_pw_multi_aff *upma2);
3550         #include <isl/polynomial.h>
3551         int isl_union_pw_qpolynomial_plain_is_equal(
3552                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
3553                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
3554         int isl_union_pw_qpolynomial_fold_plain_is_equal(
3555                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
3556                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
3558 =item * Disjointness
3560         #include <isl/set.h>
3561         int isl_basic_set_is_disjoint(
3562                 __isl_keep isl_basic_set *bset1,
3563                 __isl_keep isl_basic_set *bset2);
3564         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
3565                 __isl_keep isl_set *set2);
3566         int isl_set_is_disjoint(__isl_keep isl_set *set1,
3567                 __isl_keep isl_set *set2);
3569         #include <isl/map.h>
3570         int isl_basic_map_is_disjoint(
3571                 __isl_keep isl_basic_map *bmap1,
3572                 __isl_keep isl_basic_map *bmap2);
3573         int isl_map_is_disjoint(__isl_keep isl_map *map1,
3574                 __isl_keep isl_map *map2);
3576         #include <isl/union_set.h>
3577         int isl_union_set_is_disjoint(
3578                 __isl_keep isl_union_set *uset1,
3579                 __isl_keep isl_union_set *uset2);
3581         #include <isl/union_map.h>
3582         int isl_union_map_is_disjoint(
3583                 __isl_keep isl_union_map *umap1,
3584                 __isl_keep isl_union_map *umap2);
3586 =item * Subset
3588         int isl_basic_set_is_subset(
3589                 __isl_keep isl_basic_set *bset1,
3590                 __isl_keep isl_basic_set *bset2);
3591         int isl_set_is_subset(__isl_keep isl_set *set1,
3592                 __isl_keep isl_set *set2);
3593         int isl_set_is_strict_subset(
3594                 __isl_keep isl_set *set1,
3595                 __isl_keep isl_set *set2);
3596         int isl_union_set_is_subset(
3597                 __isl_keep isl_union_set *uset1,
3598                 __isl_keep isl_union_set *uset2);
3599         int isl_union_set_is_strict_subset(
3600                 __isl_keep isl_union_set *uset1,
3601                 __isl_keep isl_union_set *uset2);
3602         int isl_basic_map_is_subset(
3603                 __isl_keep isl_basic_map *bmap1,
3604                 __isl_keep isl_basic_map *bmap2);
3605         int isl_basic_map_is_strict_subset(
3606                 __isl_keep isl_basic_map *bmap1,
3607                 __isl_keep isl_basic_map *bmap2);
3608         int isl_map_is_subset(
3609                 __isl_keep isl_map *map1,
3610                 __isl_keep isl_map *map2);
3611         int isl_map_is_strict_subset(
3612                 __isl_keep isl_map *map1,
3613                 __isl_keep isl_map *map2);
3614         int isl_union_map_is_subset(
3615                 __isl_keep isl_union_map *umap1,
3616                 __isl_keep isl_union_map *umap2);
3617         int isl_union_map_is_strict_subset(
3618                 __isl_keep isl_union_map *umap1,
3619                 __isl_keep isl_union_map *umap2);
3621 Check whether the first argument is a (strict) subset of the
3622 second argument.
3624 =item * Order
3626 Every comparison function returns a negative value if the first
3627 argument is considered smaller than the second, a positive value
3628 if the first argument is considered greater and zero if the two
3629 constraints are considered the same by the comparison criterion.
3631         #include <isl/constraint.h>
3632         int isl_constraint_plain_cmp(
3633                 __isl_keep isl_constraint *c1,
3634                 __isl_keep isl_constraint *c2);
3636 This function is useful for sorting C<isl_constraint>s.
3637 The order depends on the internal representation of the inputs.
3638 The order is fixed over different calls to the function (assuming
3639 the internal representation of the inputs has not changed), but may
3640 change over different versions of C<isl>.
3642         #include <isl/constraint.h>
3643         int isl_constraint_cmp_last_non_zero(
3644                 __isl_keep isl_constraint *c1,
3645                 __isl_keep isl_constraint *c2);
3647 This function can be used to sort constraints that live in the same
3648 local space.  Constraints that involve ``earlier'' dimensions or
3649 that have a smaller coefficient for the shared latest dimension
3650 are considered smaller than other constraints.
3651 This function only defines a B<partial> order.
3653         #include <isl/set.h>
3654         int isl_set_plain_cmp(__isl_keep isl_set *set1,
3655                 __isl_keep isl_set *set2);
3657 This function is useful for sorting C<isl_set>s.
3658 The order depends on the internal representation of the inputs.
3659 The order is fixed over different calls to the function (assuming
3660 the internal representation of the inputs has not changed), but may
3661 change over different versions of C<isl>.
3663         #include <isl/aff.h>
3664         int isl_pw_aff_plain_cmp(__isl_keep isl_pw_aff *pa1,
3665                 __isl_keep isl_pw_aff *pa2);
3667 The function C<isl_pw_aff_plain_cmp> can be used to sort
3668 C<isl_pw_aff>s.  The order is not strictly defined.
3669 The current order sorts expressions that only involve
3670 earlier dimensions before those that involve later dimensions.
3672 =back
3674 =head2 Unary Operations
3676 =over
3678 =item * Complement
3680         __isl_give isl_set *isl_set_complement(
3681                 __isl_take isl_set *set);
3682         __isl_give isl_map *isl_map_complement(
3683                 __isl_take isl_map *map);
3685 =item * Inverse map
3687         #include <isl/space.h>
3688         __isl_give isl_space *isl_space_reverse(
3689                 __isl_take isl_space *space);
3691         #include <isl/map.h>
3692         __isl_give isl_basic_map *isl_basic_map_reverse(
3693                 __isl_take isl_basic_map *bmap);
3694         __isl_give isl_map *isl_map_reverse(
3695                 __isl_take isl_map *map);
3697         #include <isl/union_map.h>
3698         __isl_give isl_union_map *isl_union_map_reverse(
3699                 __isl_take isl_union_map *umap);
3701 =item * Projection
3703         #include <isl/space.h>
3704         __isl_give isl_space *isl_space_domain(
3705                 __isl_take isl_space *space);
3706         __isl_give isl_space *isl_space_range(
3707                 __isl_take isl_space *space);
3708         __isl_give isl_space *isl_space_params(
3709                 __isl_take isl_space *space);
3711         #include <isl/local_space.h>
3712         __isl_give isl_local_space *isl_local_space_domain(
3713                 __isl_take isl_local_space *ls);
3714         __isl_give isl_local_space *isl_local_space_range(
3715                 __isl_take isl_local_space *ls);
3717         #include <isl/set.h>
3718         __isl_give isl_basic_set *isl_basic_set_project_out(
3719                 __isl_take isl_basic_set *bset,
3720                 enum isl_dim_type type, unsigned first, unsigned n);
3721         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
3722                 enum isl_dim_type type, unsigned first, unsigned n);
3723         __isl_give isl_basic_set *isl_basic_set_params(
3724                 __isl_take isl_basic_set *bset);
3725         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
3727         #include <isl/map.h>
3728         __isl_give isl_basic_map *isl_basic_map_project_out(
3729                 __isl_take isl_basic_map *bmap,
3730                 enum isl_dim_type type, unsigned first, unsigned n);
3731         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
3732                 enum isl_dim_type type, unsigned first, unsigned n);
3733         __isl_give isl_basic_set *isl_basic_map_domain(
3734                 __isl_take isl_basic_map *bmap);
3735         __isl_give isl_basic_set *isl_basic_map_range(
3736                 __isl_take isl_basic_map *bmap);
3737         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
3738         __isl_give isl_set *isl_map_domain(
3739                 __isl_take isl_map *bmap);
3740         __isl_give isl_set *isl_map_range(
3741                 __isl_take isl_map *map);
3743         #include <isl/union_set.h>
3744         __isl_give isl_union_set *isl_union_set_project_out(
3745                 __isl_take isl_union_set *uset,
3746                 enum isl_dim_type type,
3747                 unsigned first, unsigned n);
3748         __isl_give isl_set *isl_union_set_params(
3749                 __isl_take isl_union_set *uset);
3751 The function C<isl_union_set_project_out> can only project out
3752 parameters.
3754         #include <isl/union_map.h>
3755         __isl_give isl_union_map *isl_union_map_project_out(
3756                 __isl_take isl_union_map *umap,
3757                 enum isl_dim_type type, unsigned first, unsigned n);
3758         __isl_give isl_set *isl_union_map_params(
3759                 __isl_take isl_union_map *umap);
3760         __isl_give isl_union_set *isl_union_map_domain(
3761                 __isl_take isl_union_map *umap);
3762         __isl_give isl_union_set *isl_union_map_range(
3763                 __isl_take isl_union_map *umap);
3765 The function C<isl_union_map_project_out> can only project out
3766 parameters.
3768         #include <isl/aff.h>
3769         __isl_give isl_aff *isl_aff_project_domain_on_params(
3770                 __isl_take isl_aff *aff);
3771         __isl_give isl_pw_multi_aff *
3772         isl_pw_multi_aff_project_domain_on_params(
3773                 __isl_take isl_pw_multi_aff *pma);
3774         __isl_give isl_set *isl_pw_aff_domain(
3775                 __isl_take isl_pw_aff *pwaff);
3776         __isl_give isl_set *isl_pw_multi_aff_domain(
3777                 __isl_take isl_pw_multi_aff *pma);
3778         __isl_give isl_set *isl_multi_pw_aff_domain(
3779                 __isl_take isl_multi_pw_aff *mpa);
3780         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
3781                 __isl_take isl_union_pw_multi_aff *upma);
3782         __isl_give isl_set *isl_pw_aff_params(
3783                 __isl_take isl_pw_aff *pwa);
3785         #include <isl/polynomial.h>
3786         __isl_give isl_qpolynomial *
3787         isl_qpolynomial_project_domain_on_params(
3788                 __isl_take isl_qpolynomial *qp);
3789         __isl_give isl_pw_qpolynomial *
3790         isl_pw_qpolynomial_project_domain_on_params(
3791                 __isl_take isl_pw_qpolynomial *pwqp);
3792         __isl_give isl_pw_qpolynomial_fold *
3793         isl_pw_qpolynomial_fold_project_domain_on_params(
3794                 __isl_take isl_pw_qpolynomial_fold *pwf);
3795         __isl_give isl_set *isl_pw_qpolynomial_domain(
3796                 __isl_take isl_pw_qpolynomial *pwqp);
3797         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
3798                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3799         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
3800                 __isl_take isl_union_pw_qpolynomial *upwqp);
3802         #include <isl/space.h>
3803         __isl_give isl_space *isl_space_domain_map(
3804                 __isl_take isl_space *space);
3805         __isl_give isl_space *isl_space_range_map(
3806                 __isl_take isl_space *space);
3808         #include <isl/map.h>
3809         __isl_give isl_map *isl_set_wrapped_domain_map(
3810                 __isl_take isl_set *set);
3811         __isl_give isl_basic_map *isl_basic_map_domain_map(
3812                 __isl_take isl_basic_map *bmap);
3813         __isl_give isl_basic_map *isl_basic_map_range_map(
3814                 __isl_take isl_basic_map *bmap);
3815         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
3816         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
3818         #include <isl/union_map.h>
3819         __isl_give isl_union_map *isl_union_map_domain_map(
3820                 __isl_take isl_union_map *umap);
3821         __isl_give isl_union_map *isl_union_map_range_map(
3822                 __isl_take isl_union_map *umap);
3823         __isl_give isl_union_map *
3824         isl_union_set_wrapped_domain_map(
3825                 __isl_take isl_union_set *uset);
3827 The functions above construct a (basic, regular or union) relation
3828 that maps (a wrapped version of) the input relation to its domain or range.
3829 C<isl_set_wrapped_domain_map> maps the input set to the domain
3830 of its wrapped relation.
3832 =item * Elimination
3834         __isl_give isl_basic_set *isl_basic_set_eliminate(
3835                 __isl_take isl_basic_set *bset,
3836                 enum isl_dim_type type,
3837                 unsigned first, unsigned n);
3838         __isl_give isl_set *isl_set_eliminate(
3839                 __isl_take isl_set *set, enum isl_dim_type type,
3840                 unsigned first, unsigned n);
3841         __isl_give isl_basic_map *isl_basic_map_eliminate(
3842                 __isl_take isl_basic_map *bmap,
3843                 enum isl_dim_type type,
3844                 unsigned first, unsigned n);
3845         __isl_give isl_map *isl_map_eliminate(
3846                 __isl_take isl_map *map, enum isl_dim_type type,
3847                 unsigned first, unsigned n);
3849 Eliminate the coefficients for the given dimensions from the constraints,
3850 without removing the dimensions.
3852 =item * Constructing a set from a parameter domain
3854 A zero-dimensional space or (basic) set can be constructed
3855 on a given parameter domain using the following functions.
3857         #include <isl/space.h>
3858         __isl_give isl_space *isl_space_set_from_params(
3859                 __isl_take isl_space *space);
3861         #include <isl/set.h>
3862         __isl_give isl_basic_set *isl_basic_set_from_params(
3863                 __isl_take isl_basic_set *bset);
3864         __isl_give isl_set *isl_set_from_params(
3865                 __isl_take isl_set *set);
3867 =item * Constructing a relation from a set
3869 Create a relation with the given set as domain or range.
3870 The range or domain of the created relation is a zero-dimensional
3871 flat anonymous space.
3873         #include <isl/space.h>
3874         __isl_give isl_space *isl_space_from_domain(
3875                 __isl_take isl_space *space);
3876         __isl_give isl_space *isl_space_from_range(
3877                 __isl_take isl_space *space);
3878         __isl_give isl_space *isl_space_map_from_set(
3879                 __isl_take isl_space *space);
3880         __isl_give isl_space *isl_space_map_from_domain_and_range(
3881                 __isl_take isl_space *domain,
3882                 __isl_take isl_space *range);
3884         #include <isl/local_space.h>
3885         __isl_give isl_local_space *isl_local_space_from_domain(
3886                 __isl_take isl_local_space *ls);
3888         #include <isl/map.h>
3889         __isl_give isl_map *isl_map_from_domain(
3890                 __isl_take isl_set *set);
3891         __isl_give isl_map *isl_map_from_range(
3892                 __isl_take isl_set *set);
3894         #include <isl/val.h>
3895         __isl_give isl_multi_val *isl_multi_val_from_range(
3896                 __isl_take isl_multi_val *mv);
3898         #include <isl/aff.h>
3899         __isl_give isl_multi_aff *isl_multi_aff_from_range(
3900                 __isl_take isl_multi_aff *ma);
3901         __isl_give isl_pw_aff *isl_pw_aff_from_range(
3902                 __isl_take isl_pw_aff *pwa);
3903         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_range(
3904                 __isl_take isl_multi_pw_aff *mpa);
3905         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3906                 __isl_take isl_set *set);
3907         __isl_give isl_union_pw_multi_aff *
3908         isl_union_pw_multi_aff_from_domain(
3909                 __isl_take isl_union_set *uset);
3911 =item * Slicing
3913         #include <isl/set.h>
3914         __isl_give isl_basic_set *isl_basic_set_fix_si(
3915                 __isl_take isl_basic_set *bset,
3916                 enum isl_dim_type type, unsigned pos, int value);
3917         __isl_give isl_basic_set *isl_basic_set_fix_val(
3918                 __isl_take isl_basic_set *bset,
3919                 enum isl_dim_type type, unsigned pos,
3920                 __isl_take isl_val *v);
3921         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
3922                 enum isl_dim_type type, unsigned pos, int value);
3923         __isl_give isl_set *isl_set_fix_val(
3924                 __isl_take isl_set *set,
3925                 enum isl_dim_type type, unsigned pos,
3926                 __isl_take isl_val *v);
3928         #include <isl/map.h>
3929         __isl_give isl_basic_map *isl_basic_map_fix_si(
3930                 __isl_take isl_basic_map *bmap,
3931                 enum isl_dim_type type, unsigned pos, int value);
3932         __isl_give isl_basic_map *isl_basic_map_fix_val(
3933                 __isl_take isl_basic_map *bmap,
3934                 enum isl_dim_type type, unsigned pos,
3935                 __isl_take isl_val *v);
3936         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
3937                 enum isl_dim_type type, unsigned pos, int value);
3938         __isl_give isl_map *isl_map_fix_val(
3939                 __isl_take isl_map *map,
3940                 enum isl_dim_type type, unsigned pos,
3941                 __isl_take isl_val *v);
3943         #include <isl/aff.h>
3944         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_fix_si(
3945                 __isl_take isl_pw_multi_aff *pma,
3946                 enum isl_dim_type type, unsigned pos, int value);
3948         #include <isl/polynomial.h>
3949         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_fix_val(
3950                 __isl_take isl_pw_qpolynomial *pwqp,
3951                 enum isl_dim_type type, unsigned n,
3952                 __isl_take isl_val *v);
3954 Intersect the set, relation or function domain
3955 with the hyperplane where the given
3956 dimension has the fixed given value.
3958         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
3959                 __isl_take isl_basic_map *bmap,
3960                 enum isl_dim_type type, unsigned pos, int value);
3961         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
3962                 __isl_take isl_basic_map *bmap,
3963                 enum isl_dim_type type, unsigned pos, int value);
3964         __isl_give isl_set *isl_set_lower_bound_si(
3965                 __isl_take isl_set *set,
3966                 enum isl_dim_type type, unsigned pos, int value);
3967         __isl_give isl_set *isl_set_lower_bound_val(
3968                 __isl_take isl_set *set,
3969                 enum isl_dim_type type, unsigned pos,
3970                 __isl_take isl_val *value);
3971         __isl_give isl_map *isl_map_lower_bound_si(
3972                 __isl_take isl_map *map,
3973                 enum isl_dim_type type, unsigned pos, int value);
3974         __isl_give isl_set *isl_set_upper_bound_si(
3975                 __isl_take isl_set *set,
3976                 enum isl_dim_type type, unsigned pos, int value);
3977         __isl_give isl_set *isl_set_upper_bound_val(
3978                 __isl_take isl_set *set,
3979                 enum isl_dim_type type, unsigned pos,
3980                 __isl_take isl_val *value);
3981         __isl_give isl_map *isl_map_upper_bound_si(
3982                 __isl_take isl_map *map,
3983                 enum isl_dim_type type, unsigned pos, int value);
3985 Intersect the set or relation with the half-space where the given
3986 dimension has a value bounded by the fixed given integer value.
3988         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
3989                 enum isl_dim_type type1, int pos1,
3990                 enum isl_dim_type type2, int pos2);
3991         __isl_give isl_basic_map *isl_basic_map_equate(
3992                 __isl_take isl_basic_map *bmap,
3993                 enum isl_dim_type type1, int pos1,
3994                 enum isl_dim_type type2, int pos2);
3995         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
3996                 enum isl_dim_type type1, int pos1,
3997                 enum isl_dim_type type2, int pos2);
3999 Intersect the set or relation with the hyperplane where the given
4000 dimensions are equal to each other.
4002         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
4003                 enum isl_dim_type type1, int pos1,
4004                 enum isl_dim_type type2, int pos2);
4006 Intersect the relation with the hyperplane where the given
4007 dimensions have opposite values.
4009         __isl_give isl_map *isl_map_order_le(
4010                 __isl_take isl_map *map,
4011                 enum isl_dim_type type1, int pos1,
4012                 enum isl_dim_type type2, int pos2);
4013         __isl_give isl_basic_map *isl_basic_map_order_ge(
4014                 __isl_take isl_basic_map *bmap,
4015                 enum isl_dim_type type1, int pos1,
4016                 enum isl_dim_type type2, int pos2);
4017         __isl_give isl_map *isl_map_order_ge(
4018                 __isl_take isl_map *map,
4019                 enum isl_dim_type type1, int pos1,
4020                 enum isl_dim_type type2, int pos2);
4021         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
4022                 enum isl_dim_type type1, int pos1,
4023                 enum isl_dim_type type2, int pos2);
4024         __isl_give isl_basic_map *isl_basic_map_order_gt(
4025                 __isl_take isl_basic_map *bmap,
4026                 enum isl_dim_type type1, int pos1,
4027                 enum isl_dim_type type2, int pos2);
4028         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
4029                 enum isl_dim_type type1, int pos1,
4030                 enum isl_dim_type type2, int pos2);
4032 Intersect the relation with the half-space where the given
4033 dimensions satisfy the given ordering.
4035 =item * Locus
4037         #include <isl/aff.h>
4038         __isl_give isl_basic_set *isl_aff_zero_basic_set(
4039                 __isl_take isl_aff *aff);
4040         __isl_give isl_basic_set *isl_aff_neg_basic_set(
4041                 __isl_take isl_aff *aff);
4042         __isl_give isl_set *isl_pw_aff_nonneg_set(
4043                 __isl_take isl_pw_aff *pwaff);
4044         __isl_give isl_set *isl_pw_aff_zero_set(
4045                 __isl_take isl_pw_aff *pwaff);
4046         __isl_give isl_set *isl_pw_aff_non_zero_set(
4047                 __isl_take isl_pw_aff *pwaff);
4049 The function C<isl_aff_neg_basic_set> returns a basic set
4050 containing those elements in the domain space
4051 of C<aff> where C<aff> is negative.
4052 The function C<isl_pw_aff_nonneg_set> returns a set
4053 containing those elements in the domain
4054 of C<pwaff> where C<pwaff> is non-negative.
4056 =item * Identity
4058         __isl_give isl_map *isl_set_identity(
4059                 __isl_take isl_set *set);
4060         __isl_give isl_union_map *isl_union_set_identity(
4061                 __isl_take isl_union_set *uset);
4062         __isl_give isl_union_pw_multi_aff *
4063         isl_union_set_identity_union_pw_multi_aff(
4064                 __isl_take isl_union_set *uset);
4066 Construct an identity relation on the given (union) set.
4068 =item * Function Extraction
4070 A piecewise quasi affine expression that is equal to 1 on a set
4071 and 0 outside the set can be created using the following function.
4073         #include <isl/aff.h>
4074         __isl_give isl_pw_aff *isl_set_indicator_function(
4075                 __isl_take isl_set *set);
4077 A piecewise multiple quasi affine expression can be extracted
4078 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4079 and the C<isl_map> is single-valued.
4080 In case of a conversion from an C<isl_union_map>
4081 to an C<isl_union_pw_multi_aff>, these properties need to hold
4082 in each domain space.
4084         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4085                 __isl_take isl_set *set);
4086         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4087                 __isl_take isl_map *map);
4089         __isl_give isl_union_pw_multi_aff *
4090         isl_union_pw_multi_aff_from_union_set(
4091                 __isl_take isl_union_set *uset);
4092         __isl_give isl_union_pw_multi_aff *
4093         isl_union_pw_multi_aff_from_union_map(
4094                 __isl_take isl_union_map *umap);
4096 =item * Deltas
4098         __isl_give isl_basic_set *isl_basic_map_deltas(
4099                 __isl_take isl_basic_map *bmap);
4100         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
4101         __isl_give isl_union_set *isl_union_map_deltas(
4102                 __isl_take isl_union_map *umap);
4104 These functions return a (basic) set containing the differences
4105 between image elements and corresponding domain elements in the input.
4107         __isl_give isl_basic_map *isl_basic_map_deltas_map(
4108                 __isl_take isl_basic_map *bmap);
4109         __isl_give isl_map *isl_map_deltas_map(
4110                 __isl_take isl_map *map);
4111         __isl_give isl_union_map *isl_union_map_deltas_map(
4112                 __isl_take isl_union_map *umap);
4114 The functions above construct a (basic, regular or union) relation
4115 that maps (a wrapped version of) the input relation to its delta set.
4117 =item * Coalescing
4119 Simplify the representation of a set, relation or functions by trying
4120 to combine pairs of basic sets or relations into a single
4121 basic set or relation.
4123         #include <isl/set.h>
4124         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
4126         #include <isl/map.h>
4127         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
4129         #include <isl/union_set.h>
4130         __isl_give isl_union_set *isl_union_set_coalesce(
4131                 __isl_take isl_union_set *uset);
4133         #include <isl/union_map.h>
4134         __isl_give isl_union_map *isl_union_map_coalesce(
4135                 __isl_take isl_union_map *umap);
4137         #include <isl/aff.h>
4138         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
4139                 __isl_take isl_pw_aff *pwqp);
4140         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4141                 __isl_take isl_pw_multi_aff *pma);
4142         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_coalesce(
4143                 __isl_take isl_multi_pw_aff *mpa);
4144         __isl_give isl_union_pw_multi_aff *
4145         isl_union_pw_multi_aff_coalesce(
4146                 __isl_take isl_union_pw_multi_aff *upma);
4148         #include <isl/polynomial.h>
4149         __isl_give isl_pw_qpolynomial_fold *
4150         isl_pw_qpolynomial_fold_coalesce(
4151                 __isl_take isl_pw_qpolynomial_fold *pwf);
4152         __isl_give isl_union_pw_qpolynomial *
4153         isl_union_pw_qpolynomial_coalesce(
4154                 __isl_take isl_union_pw_qpolynomial *upwqp);
4155         __isl_give isl_union_pw_qpolynomial_fold *
4156         isl_union_pw_qpolynomial_fold_coalesce(
4157                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4159 One of the methods for combining pairs of basic sets or relations
4160 can result in coefficients that are much larger than those that appear
4161 in the constraints of the input.  By default, the coefficients are
4162 not allowed to grow larger, but this can be changed by unsetting
4163 the following option.
4165         int isl_options_set_coalesce_bounded_wrapping(
4166                 isl_ctx *ctx, int val);
4167         int isl_options_get_coalesce_bounded_wrapping(
4168                 isl_ctx *ctx);
4170 =item * Detecting equalities
4172         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
4173                 __isl_take isl_basic_set *bset);
4174         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
4175                 __isl_take isl_basic_map *bmap);
4176         __isl_give isl_set *isl_set_detect_equalities(
4177                 __isl_take isl_set *set);
4178         __isl_give isl_map *isl_map_detect_equalities(
4179                 __isl_take isl_map *map);
4180         __isl_give isl_union_set *isl_union_set_detect_equalities(
4181                 __isl_take isl_union_set *uset);
4182         __isl_give isl_union_map *isl_union_map_detect_equalities(
4183                 __isl_take isl_union_map *umap);
4185 Simplify the representation of a set or relation by detecting implicit
4186 equalities.
4188 =item * Removing redundant constraints
4190         #include <isl/set.h>
4191         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
4192                 __isl_take isl_basic_set *bset);
4193         __isl_give isl_set *isl_set_remove_redundancies(
4194                 __isl_take isl_set *set);
4196         #include <isl/union_set.h>
4197         __isl_give isl_union_set *
4198         isl_union_set_remove_redundancies(
4199                 __isl_take isl_union_set *uset);
4201         #include <isl/map.h>
4202         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
4203                 __isl_take isl_basic_map *bmap);
4204         __isl_give isl_map *isl_map_remove_redundancies(
4205                 __isl_take isl_map *map);
4207         #include <isl/union_map.h>
4208         __isl_give isl_union_map *
4209         isl_union_map_remove_redundancies(
4210                 __isl_take isl_union_map *umap);
4212 =item * Convex hull
4214         __isl_give isl_basic_set *isl_set_convex_hull(
4215                 __isl_take isl_set *set);
4216         __isl_give isl_basic_map *isl_map_convex_hull(
4217                 __isl_take isl_map *map);
4219 If the input set or relation has any existentially quantified
4220 variables, then the result of these operations is currently undefined.
4222 =item * Simple hull
4224         #include <isl/set.h>
4225         __isl_give isl_basic_set *
4226         isl_set_unshifted_simple_hull(
4227                 __isl_take isl_set *set);
4228         __isl_give isl_basic_set *isl_set_simple_hull(
4229                 __isl_take isl_set *set);
4230         __isl_give isl_basic_set *
4231         isl_set_unshifted_simple_hull_from_set_list(
4232                 __isl_take isl_set *set,
4233                 __isl_take isl_set_list *list);
4235         #include <isl/map.h>
4236         __isl_give isl_basic_map *
4237         isl_map_unshifted_simple_hull(
4238                 __isl_take isl_map *map);
4239         __isl_give isl_basic_map *isl_map_simple_hull(
4240                 __isl_take isl_map *map);
4241         __isl_give isl_basic_map *
4242         isl_map_unshifted_simple_hull_from_map_list(
4243                 __isl_take isl_map *map,
4244                 __isl_take isl_map_list *list);
4246         #include <isl/union_map.h>
4247         __isl_give isl_union_map *isl_union_map_simple_hull(
4248                 __isl_take isl_union_map *umap);
4250 These functions compute a single basic set or relation
4251 that contains the whole input set or relation.
4252 In particular, the output is described by translates
4253 of the constraints describing the basic sets or relations in the input.
4254 In case of C<isl_set_unshifted_simple_hull>, only the original
4255 constraints are used, without any translation.
4256 In case of C<isl_set_unshifted_simple_hull_from_set_list> and
4257 C<isl_map_unshifted_simple_hull_from_map_list>, the
4258 constraints are taken from the elements of the second argument.
4260 =begin latex
4262 (See \autoref{s:simple hull}.)
4264 =end latex
4266 =item * Affine hull
4268         __isl_give isl_basic_set *isl_basic_set_affine_hull(
4269                 __isl_take isl_basic_set *bset);
4270         __isl_give isl_basic_set *isl_set_affine_hull(
4271                 __isl_take isl_set *set);
4272         __isl_give isl_union_set *isl_union_set_affine_hull(
4273                 __isl_take isl_union_set *uset);
4274         __isl_give isl_basic_map *isl_basic_map_affine_hull(
4275                 __isl_take isl_basic_map *bmap);
4276         __isl_give isl_basic_map *isl_map_affine_hull(
4277                 __isl_take isl_map *map);
4278         __isl_give isl_union_map *isl_union_map_affine_hull(
4279                 __isl_take isl_union_map *umap);
4281 In case of union sets and relations, the affine hull is computed
4282 per space.
4284 =item * Polyhedral hull
4286         __isl_give isl_basic_set *isl_set_polyhedral_hull(
4287                 __isl_take isl_set *set);
4288         __isl_give isl_basic_map *isl_map_polyhedral_hull(
4289                 __isl_take isl_map *map);
4290         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
4291                 __isl_take isl_union_set *uset);
4292         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
4293                 __isl_take isl_union_map *umap);
4295 These functions compute a single basic set or relation
4296 not involving any existentially quantified variables
4297 that contains the whole input set or relation.
4298 In case of union sets and relations, the polyhedral hull is computed
4299 per space.
4301 =item * Other approximations
4303         #include <isl/set.h>
4304         __isl_give isl_basic_set *
4305         isl_basic_set_drop_constraints_involving_dims(
4306                 __isl_take isl_basic_set *bset,
4307                 enum isl_dim_type type,
4308                 unsigned first, unsigned n);
4309         __isl_give isl_basic_set *
4310         isl_basic_set_drop_constraints_not_involving_dims(
4311                 __isl_take isl_basic_set *bset,
4312                 enum isl_dim_type type,
4313                 unsigned first, unsigned n);
4314         __isl_give isl_set *
4315         isl_set_drop_constraints_involving_dims(
4316                 __isl_take isl_set *set,
4317                 enum isl_dim_type type,
4318                 unsigned first, unsigned n);
4320         #include <isl/map.h>
4321         __isl_give isl_basic_map *
4322         isl_basic_map_drop_constraints_involving_dims(
4323                 __isl_take isl_basic_map *bmap,
4324                 enum isl_dim_type type,
4325                 unsigned first, unsigned n);
4326         __isl_give isl_map *
4327         isl_map_drop_constraints_involving_dims(
4328                 __isl_take isl_map *map,
4329                 enum isl_dim_type type,
4330                 unsigned first, unsigned n);
4332 These functions drop any constraints (not) involving the specified dimensions.
4333 Note that the result depends on the representation of the input.
4335         #include <isl/polynomial.h>
4336         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4337                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4338         __isl_give isl_union_pw_qpolynomial *
4339         isl_union_pw_qpolynomial_to_polynomial(
4340                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4342 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4343 the polynomial will be an overapproximation.  If C<sign> is negative,
4344 it will be an underapproximation.  If C<sign> is zero, the approximation
4345 will lie somewhere in between.
4347 =item * Feasibility
4349         __isl_give isl_basic_set *isl_basic_set_sample(
4350                 __isl_take isl_basic_set *bset);
4351         __isl_give isl_basic_set *isl_set_sample(
4352                 __isl_take isl_set *set);
4353         __isl_give isl_basic_map *isl_basic_map_sample(
4354                 __isl_take isl_basic_map *bmap);
4355         __isl_give isl_basic_map *isl_map_sample(
4356                 __isl_take isl_map *map);
4358 If the input (basic) set or relation is non-empty, then return
4359 a singleton subset of the input.  Otherwise, return an empty set.
4361 =item * Optimization
4363         #include <isl/ilp.h>
4364         __isl_give isl_val *isl_basic_set_max_val(
4365                 __isl_keep isl_basic_set *bset,
4366                 __isl_keep isl_aff *obj);
4367         __isl_give isl_val *isl_set_min_val(
4368                 __isl_keep isl_set *set,
4369                 __isl_keep isl_aff *obj);
4370         __isl_give isl_val *isl_set_max_val(
4371                 __isl_keep isl_set *set,
4372                 __isl_keep isl_aff *obj);
4374 Compute the minimum or maximum of the integer affine expression C<obj>
4375 over the points in C<set>, returning the result in C<opt>.
4376 The result is C<NULL> in case of an error, the optimal value in case
4377 there is one, negative infinity or infinity if the problem is unbounded and
4378 NaN if the problem is empty.
4380 =item * Parametric optimization
4382         __isl_give isl_pw_aff *isl_set_dim_min(
4383                 __isl_take isl_set *set, int pos);
4384         __isl_give isl_pw_aff *isl_set_dim_max(
4385                 __isl_take isl_set *set, int pos);
4386         __isl_give isl_pw_aff *isl_map_dim_max(
4387                 __isl_take isl_map *map, int pos);
4389 Compute the minimum or maximum of the given set or output dimension
4390 as a function of the parameters (and input dimensions), but independently
4391 of the other set or output dimensions.
4392 For lexicographic optimization, see L<"Lexicographic Optimization">.
4394 =item * Dual
4396 The following functions compute either the set of (rational) coefficient
4397 values of valid constraints for the given set or the set of (rational)
4398 values satisfying the constraints with coefficients from the given set.
4399 Internally, these two sets of functions perform essentially the
4400 same operations, except that the set of coefficients is assumed to
4401 be a cone, while the set of values may be any polyhedron.
4402 The current implementation is based on the Farkas lemma and
4403 Fourier-Motzkin elimination, but this may change or be made optional
4404 in future.  In particular, future implementations may use different
4405 dualization algorithms or skip the elimination step.
4407         __isl_give isl_basic_set *isl_basic_set_coefficients(
4408                 __isl_take isl_basic_set *bset);
4409         __isl_give isl_basic_set *isl_set_coefficients(
4410                 __isl_take isl_set *set);
4411         __isl_give isl_union_set *isl_union_set_coefficients(
4412                 __isl_take isl_union_set *bset);
4413         __isl_give isl_basic_set *isl_basic_set_solutions(
4414                 __isl_take isl_basic_set *bset);
4415         __isl_give isl_basic_set *isl_set_solutions(
4416                 __isl_take isl_set *set);
4417         __isl_give isl_union_set *isl_union_set_solutions(
4418                 __isl_take isl_union_set *bset);
4420 =item * Power
4422         __isl_give isl_map *isl_map_fixed_power_val(
4423                 __isl_take isl_map *map,
4424                 __isl_take isl_val *exp);
4425         __isl_give isl_union_map *
4426         isl_union_map_fixed_power_val(
4427                 __isl_take isl_union_map *umap,
4428                 __isl_take isl_val *exp);
4430 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
4431 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
4432 of C<map> is computed.
4434         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
4435                 int *exact);
4436         __isl_give isl_union_map *isl_union_map_power(
4437                 __isl_take isl_union_map *umap, int *exact);
4439 Compute a parametric representation for all positive powers I<k> of C<map>.
4440 The result maps I<k> to a nested relation corresponding to the
4441 I<k>th power of C<map>.
4442 The result may be an overapproximation.  If the result is known to be exact,
4443 then C<*exact> is set to C<1>.
4445 =item * Transitive closure
4447         __isl_give isl_map *isl_map_transitive_closure(
4448                 __isl_take isl_map *map, int *exact);
4449         __isl_give isl_union_map *isl_union_map_transitive_closure(
4450                 __isl_take isl_union_map *umap, int *exact);
4452 Compute the transitive closure of C<map>.
4453 The result may be an overapproximation.  If the result is known to be exact,
4454 then C<*exact> is set to C<1>.
4456 =item * Reaching path lengths
4458         __isl_give isl_map *isl_map_reaching_path_lengths(
4459                 __isl_take isl_map *map, int *exact);
4461 Compute a relation that maps each element in the range of C<map>
4462 to the lengths of all paths composed of edges in C<map> that
4463 end up in the given element.
4464 The result may be an overapproximation.  If the result is known to be exact,
4465 then C<*exact> is set to C<1>.
4466 To compute the I<maximal> path length, the resulting relation
4467 should be postprocessed by C<isl_map_lexmax>.
4468 In particular, if the input relation is a dependence relation
4469 (mapping sources to sinks), then the maximal path length corresponds
4470 to the free schedule.
4471 Note, however, that C<isl_map_lexmax> expects the maximum to be
4472 finite, so if the path lengths are unbounded (possibly due to
4473 the overapproximation), then you will get an error message.
4475 =item * Wrapping
4477         #include <isl/space.h>
4478         __isl_give isl_space *isl_space_wrap(
4479                 __isl_take isl_space *space);
4480         __isl_give isl_space *isl_space_unwrap(
4481                 __isl_take isl_space *space);
4483         #include <isl/local_space.h>
4484         __isl_give isl_local_space *isl_local_space_wrap(
4485                 __isl_take isl_local_space *ls);
4487         #include <isl/set.h>
4488         __isl_give isl_basic_map *isl_basic_set_unwrap(
4489                 __isl_take isl_basic_set *bset);
4490         __isl_give isl_map *isl_set_unwrap(
4491                 __isl_take isl_set *set);
4493         #include <isl/map.h>
4494         __isl_give isl_basic_set *isl_basic_map_wrap(
4495                 __isl_take isl_basic_map *bmap);
4496         __isl_give isl_set *isl_map_wrap(
4497                 __isl_take isl_map *map);
4499         #include <isl/union_set.h>
4500         __isl_give isl_union_map *isl_union_set_unwrap(
4501                 __isl_take isl_union_set *uset);
4503         #include <isl/union_map.h>
4504         __isl_give isl_union_set *isl_union_map_wrap(
4505                 __isl_take isl_union_map *umap);
4507 The input to C<isl_space_unwrap> should
4508 be the space of a set, while that of
4509 C<isl_space_wrap> should be the space of a relation.
4510 Conversely, the output of C<isl_space_unwrap> is the space
4511 of a relation, while that of C<isl_space_wrap> is the space of a set.
4513 =item * Flattening
4515 Remove any internal structure of domain (and range) of the given
4516 set or relation.  If there is any such internal structure in the input,
4517 then the name of the space is also removed.
4519         #include <isl/local_space.h>
4520         __isl_give isl_local_space *
4521         isl_local_space_flatten_domain(
4522                 __isl_take isl_local_space *ls);
4523         __isl_give isl_local_space *
4524         isl_local_space_flatten_range(
4525                 __isl_take isl_local_space *ls);
4527         #include <isl/set.h>
4528         __isl_give isl_basic_set *isl_basic_set_flatten(
4529                 __isl_take isl_basic_set *bset);
4530         __isl_give isl_set *isl_set_flatten(
4531                 __isl_take isl_set *set);
4533         #include <isl/map.h>
4534         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
4535                 __isl_take isl_basic_map *bmap);
4536         __isl_give isl_basic_map *isl_basic_map_flatten_range(
4537                 __isl_take isl_basic_map *bmap);
4538         __isl_give isl_map *isl_map_flatten_range(
4539                 __isl_take isl_map *map);
4540         __isl_give isl_map *isl_map_flatten_domain(
4541                 __isl_take isl_map *map);
4542         __isl_give isl_basic_map *isl_basic_map_flatten(
4543                 __isl_take isl_basic_map *bmap);
4544         __isl_give isl_map *isl_map_flatten(
4545                 __isl_take isl_map *map);
4547         #include <isl/val.h>
4548         __isl_give isl_multi_val *isl_multi_val_flatten_range(
4549                 __isl_take isl_multi_val *mv);
4551         #include <isl/aff.h>
4552         __isl_give isl_multi_aff *isl_multi_aff_flatten_domain(
4553                 __isl_take isl_multi_aff *ma);
4554         __isl_give isl_multi_aff *isl_multi_aff_flatten_range(
4555                 __isl_take isl_multi_aff *ma);
4556         __isl_give isl_multi_pw_aff *
4557         isl_multi_pw_aff_flatten_range(
4558                 __isl_take isl_multi_pw_aff *mpa);
4560         #include <isl/map.h>
4561         __isl_give isl_map *isl_set_flatten_map(
4562                 __isl_take isl_set *set);
4564 The function above constructs a relation
4565 that maps the input set to a flattened version of the set.
4567 =item * Lifting
4569 Lift the input set to a space with extra dimensions corresponding
4570 to the existentially quantified variables in the input.
4571 In particular, the result lives in a wrapped map where the domain
4572 is the original space and the range corresponds to the original
4573 existentially quantified variables.
4575         #include <isl/set.h>
4576         __isl_give isl_basic_set *isl_basic_set_lift(
4577                 __isl_take isl_basic_set *bset);
4578         __isl_give isl_set *isl_set_lift(
4579                 __isl_take isl_set *set);
4580         __isl_give isl_union_set *isl_union_set_lift(
4581                 __isl_take isl_union_set *uset);
4583 Given a local space that contains the existentially quantified
4584 variables of a set, a basic relation that, when applied to
4585 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
4586 can be constructed using the following function.
4588         #include <isl/local_space.h>
4589         __isl_give isl_basic_map *isl_local_space_lifting(
4590                 __isl_take isl_local_space *ls);
4592         #include <isl/aff.h>
4593         __isl_give isl_multi_aff *isl_multi_aff_lift(
4594                 __isl_take isl_multi_aff *maff,
4595                 __isl_give isl_local_space **ls);
4597 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4598 then it is assigned the local space that lies at the basis of
4599 the lifting applied.
4601 =item * Internal Product
4603         #include <isl/space.h>
4604         __isl_give isl_space *isl_space_zip(
4605                 __isl_take isl_space *space);
4607         #include <isl/map.h>
4608         __isl_give isl_basic_map *isl_basic_map_zip(
4609                 __isl_take isl_basic_map *bmap);
4610         __isl_give isl_map *isl_map_zip(
4611                 __isl_take isl_map *map);
4613         #include <isl/union_map.h>
4614         __isl_give isl_union_map *isl_union_map_zip(
4615                 __isl_take isl_union_map *umap);
4617 Given a relation with nested relations for domain and range,
4618 interchange the range of the domain with the domain of the range.
4620 =item * Currying
4622         #include <isl/space.h>
4623         __isl_give isl_space *isl_space_curry(
4624                 __isl_take isl_space *space);
4625         __isl_give isl_space *isl_space_uncurry(
4626                 __isl_take isl_space *space);
4628         #include <isl/map.h>
4629         __isl_give isl_basic_map *isl_basic_map_curry(
4630                 __isl_take isl_basic_map *bmap);
4631         __isl_give isl_basic_map *isl_basic_map_uncurry(
4632                 __isl_take isl_basic_map *bmap);
4633         __isl_give isl_map *isl_map_curry(
4634                 __isl_take isl_map *map);
4635         __isl_give isl_map *isl_map_uncurry(
4636                 __isl_take isl_map *map);
4638         #include <isl/union_map.h>
4639         __isl_give isl_union_map *isl_union_map_curry(
4640                 __isl_take isl_union_map *umap);
4641         __isl_give isl_union_map *isl_union_map_uncurry(
4642                 __isl_take isl_union_map *umap);
4644 Given a relation with a nested relation for domain,
4645 the C<curry> functions
4646 move the range of the nested relation out of the domain
4647 and use it as the domain of a nested relation in the range,
4648 with the original range as range of this nested relation.
4649 The C<uncurry> functions perform the inverse operation.
4651 =item * Aligning parameters
4653 Change the order of the parameters of the given set, relation
4654 or function
4655 such that the first parameters match those of C<model>.
4656 This may involve the introduction of extra parameters.
4657 All parameters need to be named.
4659         #include <isl/space.h>
4660         __isl_give isl_space *isl_space_align_params(
4661                 __isl_take isl_space *space1,
4662                 __isl_take isl_space *space2)
4664         #include <isl/set.h>
4665         __isl_give isl_basic_set *isl_basic_set_align_params(
4666                 __isl_take isl_basic_set *bset,
4667                 __isl_take isl_space *model);
4668         __isl_give isl_set *isl_set_align_params(
4669                 __isl_take isl_set *set,
4670                 __isl_take isl_space *model);
4672         #include <isl/map.h>
4673         __isl_give isl_basic_map *isl_basic_map_align_params(
4674                 __isl_take isl_basic_map *bmap,
4675                 __isl_take isl_space *model);
4676         __isl_give isl_map *isl_map_align_params(
4677                 __isl_take isl_map *map,
4678                 __isl_take isl_space *model);
4680         #include <isl/val.h>
4681         __isl_give isl_multi_val *isl_multi_val_align_params(
4682                 __isl_take isl_multi_val *mv,
4683                 __isl_take isl_space *model);
4685         #include <isl/aff.h>
4686         __isl_give isl_aff *isl_aff_align_params(
4687                 __isl_take isl_aff *aff,
4688                 __isl_take isl_space *model);
4689         __isl_give isl_multi_aff *isl_multi_aff_align_params(
4690                 __isl_take isl_multi_aff *multi,
4691                 __isl_take isl_space *model);
4692         __isl_give isl_pw_aff *isl_pw_aff_align_params(
4693                 __isl_take isl_pw_aff *pwaff,
4694                 __isl_take isl_space *model);
4695         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4696                 __isl_take isl_pw_multi_aff *pma,
4697                 __isl_take isl_space *model);
4698         __isl_give isl_union_pw_multi_aff *
4699         isl_union_pw_multi_aff_align_params(
4700                 __isl_take isl_union_pw_multi_aff *upma,
4701                 __isl_take isl_space *model);
4703         #include <isl/polynomial.h>
4704         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4705                 __isl_take isl_qpolynomial *qp,
4706                 __isl_take isl_space *model);
4708 =item * Unary Arithmethic Operations
4710         #include <isl/aff.h>
4711         __isl_give isl_aff *isl_aff_neg(
4712                 __isl_take isl_aff *aff);
4713         __isl_give isl_pw_aff *isl_pw_aff_neg(
4714                 __isl_take isl_pw_aff *pwaff);
4715         __isl_give isl_aff *isl_aff_ceil(
4716                 __isl_take isl_aff *aff);
4717         __isl_give isl_pw_aff *isl_pw_aff_ceil(
4718                 __isl_take isl_pw_aff *pwaff);
4719         __isl_give isl_aff *isl_aff_floor(
4720                 __isl_take isl_aff *aff);
4721         __isl_give isl_multi_aff *isl_multi_aff_floor(
4722                 __isl_take isl_multi_aff *ma);
4723         __isl_give isl_pw_aff *isl_pw_aff_floor(
4724                 __isl_take isl_pw_aff *pwaff);
4726         #include <isl/aff.h>
4727         __isl_give isl_pw_aff *isl_pw_aff_list_min(
4728                 __isl_take isl_pw_aff_list *list);
4729         __isl_give isl_pw_aff *isl_pw_aff_list_max(
4730                 __isl_take isl_pw_aff_list *list);
4732         #include <isl/polynomial.h>
4733         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4734                 __isl_take isl_qpolynomial *qp);
4735         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4736                 __isl_take isl_pw_qpolynomial *pwqp);
4737         __isl_give isl_union_pw_qpolynomial *
4738         isl_union_pw_qpolynomial_neg(
4739                 __isl_take isl_union_pw_qpolynomial *upwqp);
4740         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4741                 __isl_take isl_qpolynomial *qp,
4742                 unsigned exponent);
4743         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4744                 __isl_take isl_pw_qpolynomial *pwqp,
4745                 unsigned exponent);
4747 =item * Evaluation
4749 The following functions evaluate a function in a point.
4751         #include <isl/polynomial.h>
4752         __isl_give isl_val *isl_pw_qpolynomial_eval(
4753                 __isl_take isl_pw_qpolynomial *pwqp,
4754                 __isl_take isl_point *pnt);
4755         __isl_give isl_val *isl_pw_qpolynomial_fold_eval(
4756                 __isl_take isl_pw_qpolynomial_fold *pwf,
4757                 __isl_take isl_point *pnt);
4758         __isl_give isl_val *isl_union_pw_qpolynomial_eval(
4759                 __isl_take isl_union_pw_qpolynomial *upwqp,
4760                 __isl_take isl_point *pnt);
4761         __isl_give isl_val *isl_union_pw_qpolynomial_fold_eval(
4762                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4763                 __isl_take isl_point *pnt);
4765 =item * Dimension manipulation
4767 It is usually not advisable to directly change the (input or output)
4768 space of a set or a relation as this removes the name and the internal
4769 structure of the space.  However, the functions below can be useful
4770 to add new parameters, assuming
4771 C<isl_set_align_params> and C<isl_map_align_params>
4772 are not sufficient.
4774         #include <isl/space.h>
4775         __isl_give isl_space *isl_space_add_dims(
4776                 __isl_take isl_space *space,
4777                 enum isl_dim_type type, unsigned n);
4778         __isl_give isl_space *isl_space_insert_dims(
4779                 __isl_take isl_space *space,
4780                 enum isl_dim_type type, unsigned pos, unsigned n);
4781         __isl_give isl_space *isl_space_drop_dims(
4782                 __isl_take isl_space *space,
4783                 enum isl_dim_type type, unsigned first, unsigned n);
4784         __isl_give isl_space *isl_space_move_dims(
4785                 __isl_take isl_space *space,
4786                 enum isl_dim_type dst_type, unsigned dst_pos,
4787                 enum isl_dim_type src_type, unsigned src_pos,
4788                 unsigned n);
4790         #include <isl/local_space.h>
4791         __isl_give isl_local_space *isl_local_space_add_dims(
4792                 __isl_take isl_local_space *ls,
4793                 enum isl_dim_type type, unsigned n);
4794         __isl_give isl_local_space *isl_local_space_insert_dims(
4795                 __isl_take isl_local_space *ls,
4796                 enum isl_dim_type type, unsigned first, unsigned n);
4797         __isl_give isl_local_space *isl_local_space_drop_dims(
4798                 __isl_take isl_local_space *ls,
4799                 enum isl_dim_type type, unsigned first, unsigned n);
4801         #include <isl/set.h>
4802         __isl_give isl_basic_set *isl_basic_set_add_dims(
4803                 __isl_take isl_basic_set *bset,
4804                 enum isl_dim_type type, unsigned n);
4805         __isl_give isl_set *isl_set_add_dims(
4806                 __isl_take isl_set *set,
4807                 enum isl_dim_type type, unsigned n);
4808         __isl_give isl_basic_set *isl_basic_set_insert_dims(
4809                 __isl_take isl_basic_set *bset,
4810                 enum isl_dim_type type, unsigned pos,
4811                 unsigned n);
4812         __isl_give isl_set *isl_set_insert_dims(
4813                 __isl_take isl_set *set,
4814                 enum isl_dim_type type, unsigned pos, unsigned n);
4815         __isl_give isl_basic_set *isl_basic_set_move_dims(
4816                 __isl_take isl_basic_set *bset,
4817                 enum isl_dim_type dst_type, unsigned dst_pos,
4818                 enum isl_dim_type src_type, unsigned src_pos,
4819                 unsigned n);
4820         __isl_give isl_set *isl_set_move_dims(
4821                 __isl_take isl_set *set,
4822                 enum isl_dim_type dst_type, unsigned dst_pos,
4823                 enum isl_dim_type src_type, unsigned src_pos,
4824                 unsigned n);
4826         #include <isl/map.h>
4827         __isl_give isl_map *isl_map_add_dims(
4828                 __isl_take isl_map *map,
4829                 enum isl_dim_type type, unsigned n);
4830         __isl_give isl_basic_map *isl_basic_map_insert_dims(
4831                 __isl_take isl_basic_map *bmap,
4832                 enum isl_dim_type type, unsigned pos,
4833                 unsigned n);
4834         __isl_give isl_map *isl_map_insert_dims(
4835                 __isl_take isl_map *map,
4836                 enum isl_dim_type type, unsigned pos, unsigned n);
4837         __isl_give isl_basic_map *isl_basic_map_move_dims(
4838                 __isl_take isl_basic_map *bmap,
4839                 enum isl_dim_type dst_type, unsigned dst_pos,
4840                 enum isl_dim_type src_type, unsigned src_pos,
4841                 unsigned n);
4842         __isl_give isl_map *isl_map_move_dims(
4843                 __isl_take isl_map *map,
4844                 enum isl_dim_type dst_type, unsigned dst_pos,
4845                 enum isl_dim_type src_type, unsigned src_pos,
4846                 unsigned n);
4848         #include <isl/val.h>
4849         __isl_give isl_multi_val *isl_multi_val_insert_dims(
4850                 __isl_take isl_multi_val *mv,
4851                 enum isl_dim_type type, unsigned first, unsigned n);
4852         __isl_give isl_multi_val *isl_multi_val_add_dims(
4853                 __isl_take isl_multi_val *mv,
4854                 enum isl_dim_type type, unsigned n);
4855         __isl_give isl_multi_val *isl_multi_val_drop_dims(
4856                 __isl_take isl_multi_val *mv,
4857                 enum isl_dim_type type, unsigned first, unsigned n);
4859         #include <isl/aff.h>
4860         __isl_give isl_aff *isl_aff_insert_dims(
4861                 __isl_take isl_aff *aff,
4862                 enum isl_dim_type type, unsigned first, unsigned n);
4863         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4864                 __isl_take isl_multi_aff *ma,
4865                 enum isl_dim_type type, unsigned first, unsigned n);
4866         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
4867                 __isl_take isl_pw_aff *pwaff,
4868                 enum isl_dim_type type, unsigned first, unsigned n);
4869         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4870                 __isl_take isl_multi_pw_aff *mpa,
4871                 enum isl_dim_type type, unsigned first, unsigned n);
4872         __isl_give isl_aff *isl_aff_add_dims(
4873                 __isl_take isl_aff *aff,
4874                 enum isl_dim_type type, unsigned n);
4875         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4876                 __isl_take isl_multi_aff *ma,
4877                 enum isl_dim_type type, unsigned n);
4878         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
4879                 __isl_take isl_pw_aff *pwaff,
4880                 enum isl_dim_type type, unsigned n);
4881         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4882                 __isl_take isl_multi_pw_aff *mpa,
4883                 enum isl_dim_type type, unsigned n);
4884         __isl_give isl_aff *isl_aff_drop_dims(
4885                 __isl_take isl_aff *aff,
4886                 enum isl_dim_type type, unsigned first, unsigned n);
4887         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4888                 __isl_take isl_multi_aff *maff,
4889                 enum isl_dim_type type, unsigned first, unsigned n);
4890         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
4891                 __isl_take isl_pw_aff *pwaff,
4892                 enum isl_dim_type type, unsigned first, unsigned n);
4893         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4894                 __isl_take isl_pw_multi_aff *pma,
4895                 enum isl_dim_type type, unsigned first, unsigned n);
4896         __isl_give isl_aff *isl_aff_move_dims(
4897                 __isl_take isl_aff *aff,
4898                 enum isl_dim_type dst_type, unsigned dst_pos,
4899                 enum isl_dim_type src_type, unsigned src_pos,
4900                 unsigned n);
4901         __isl_give isl_multi_aff *isl_multi_aff_move_dims(
4902                 __isl_take isl_multi_aff *ma,
4903                 enum isl_dim_type dst_type, unsigned dst_pos,
4904                 enum isl_dim_type src_type, unsigned src_pos,
4905                 unsigned n);
4906         __isl_give isl_pw_aff *isl_pw_aff_move_dims(
4907                 __isl_take isl_pw_aff *pa,
4908                 enum isl_dim_type dst_type, unsigned dst_pos,
4909                 enum isl_dim_type src_type, unsigned src_pos,
4910                 unsigned n);
4911         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_move_dims(
4912                 __isl_take isl_multi_pw_aff *pma,
4913                 enum isl_dim_type dst_type, unsigned dst_pos,
4914                 enum isl_dim_type src_type, unsigned src_pos,
4915                 unsigned n);
4917 =back
4919 =head2 Binary Operations
4921 The two arguments of a binary operation not only need to live
4922 in the same C<isl_ctx>, they currently also need to have
4923 the same (number of) parameters.
4925 =head3 Basic Operations
4927 =over
4929 =item * Intersection
4931         #include <isl/local_space.h>
4932         __isl_give isl_local_space *isl_local_space_intersect(
4933                 __isl_take isl_local_space *ls1,
4934                 __isl_take isl_local_space *ls2);
4936         #include <isl/set.h>
4937         __isl_give isl_basic_set *isl_basic_set_intersect_params(
4938                 __isl_take isl_basic_set *bset1,
4939                 __isl_take isl_basic_set *bset2);
4940         __isl_give isl_basic_set *isl_basic_set_intersect(
4941                 __isl_take isl_basic_set *bset1,
4942                 __isl_take isl_basic_set *bset2);
4943         __isl_give isl_basic_set *isl_basic_set_list_intersect(
4944                 __isl_take struct isl_basic_set_list *list);
4945         __isl_give isl_set *isl_set_intersect_params(
4946                 __isl_take isl_set *set,
4947                 __isl_take isl_set *params);
4948         __isl_give isl_set *isl_set_intersect(
4949                 __isl_take isl_set *set1,
4950                 __isl_take isl_set *set2);
4952         #include <isl/map.h>
4953         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
4954                 __isl_take isl_basic_map *bmap,
4955                 __isl_take isl_basic_set *bset);
4956         __isl_give isl_basic_map *isl_basic_map_intersect_range(
4957                 __isl_take isl_basic_map *bmap,
4958                 __isl_take isl_basic_set *bset);
4959         __isl_give isl_basic_map *isl_basic_map_intersect(
4960                 __isl_take isl_basic_map *bmap1,
4961                 __isl_take isl_basic_map *bmap2);
4962         __isl_give isl_basic_map *isl_basic_map_list_intersect(
4963                 __isl_take isl_basic_map_list *list);
4964         __isl_give isl_map *isl_map_intersect_params(
4965                 __isl_take isl_map *map,
4966                 __isl_take isl_set *params);
4967         __isl_give isl_map *isl_map_intersect_domain(
4968                 __isl_take isl_map *map,
4969                 __isl_take isl_set *set);
4970         __isl_give isl_map *isl_map_intersect_range(
4971                 __isl_take isl_map *map,
4972                 __isl_take isl_set *set);
4973         __isl_give isl_map *isl_map_intersect(
4974                 __isl_take isl_map *map1,
4975                 __isl_take isl_map *map2);
4977         #include <isl/union_set.h>
4978         __isl_give isl_union_set *isl_union_set_intersect_params(
4979                 __isl_take isl_union_set *uset,
4980                 __isl_take isl_set *set);
4981         __isl_give isl_union_set *isl_union_set_intersect(
4982                 __isl_take isl_union_set *uset1,
4983                 __isl_take isl_union_set *uset2);
4985         #include <isl/union_map.h>
4986         __isl_give isl_union_map *isl_union_map_intersect_params(
4987                 __isl_take isl_union_map *umap,
4988                 __isl_take isl_set *set);
4989         __isl_give isl_union_map *isl_union_map_intersect_domain(
4990                 __isl_take isl_union_map *umap,
4991                 __isl_take isl_union_set *uset);
4992         __isl_give isl_union_map *isl_union_map_intersect_range(
4993                 __isl_take isl_union_map *umap,
4994                 __isl_take isl_union_set *uset);
4995         __isl_give isl_union_map *isl_union_map_intersect(
4996                 __isl_take isl_union_map *umap1,
4997                 __isl_take isl_union_map *umap2);
4999         #include <isl/aff.h>
5000         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
5001                 __isl_take isl_pw_aff *pa,
5002                 __isl_take isl_set *set);
5003         __isl_give isl_multi_pw_aff *
5004         isl_multi_pw_aff_intersect_domain(
5005                 __isl_take isl_multi_pw_aff *mpa,
5006                 __isl_take isl_set *domain);
5007         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
5008                 __isl_take isl_pw_multi_aff *pma,
5009                 __isl_take isl_set *set);
5010         __isl_give isl_union_pw_multi_aff *
5011         isl_union_pw_multi_aff_intersect_domain(
5012                 __isl_take isl_union_pw_multi_aff *upma,
5013                 __isl_take isl_union_set *uset);
5014         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
5015                 __isl_take isl_pw_aff *pa,
5016                 __isl_take isl_set *set);
5017         __isl_give isl_multi_pw_aff *
5018         isl_multi_pw_aff_intersect_params(
5019                 __isl_take isl_multi_pw_aff *mpa,
5020                 __isl_take isl_set *set);
5021         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
5022                 __isl_take isl_pw_multi_aff *pma,
5023                 __isl_take isl_set *set);
5024         __isl_give isl_union_pw_multi_aff *
5025         isl_union_pw_multi_aff_intersect_params(
5026                 __isl_take isl_union_pw_multi_aff *upma,
5027                 __isl_take isl_set *set);
5029         #include <isl/polynomial.h>
5030         __isl_give isl_pw_qpolynomial *
5031         isl_pw_qpolynomial_intersect_domain(
5032                 __isl_take isl_pw_qpolynomial *pwpq,
5033                 __isl_take isl_set *set);
5034         __isl_give isl_union_pw_qpolynomial *
5035         isl_union_pw_qpolynomial_intersect_domain(
5036                 __isl_take isl_union_pw_qpolynomial *upwpq,
5037                 __isl_take isl_union_set *uset);
5038         __isl_give isl_union_pw_qpolynomial_fold *
5039         isl_union_pw_qpolynomial_fold_intersect_domain(
5040                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5041                 __isl_take isl_union_set *uset);
5042         __isl_give isl_pw_qpolynomial *
5043         isl_pw_qpolynomial_intersect_params(
5044                 __isl_take isl_pw_qpolynomial *pwpq,
5045                 __isl_take isl_set *set);
5046         __isl_give isl_pw_qpolynomial_fold *
5047         isl_pw_qpolynomial_fold_intersect_params(
5048                 __isl_take isl_pw_qpolynomial_fold *pwf,
5049                 __isl_take isl_set *set);
5050         __isl_give isl_union_pw_qpolynomial *
5051         isl_union_pw_qpolynomial_intersect_params(
5052                 __isl_take isl_union_pw_qpolynomial *upwpq,
5053                 __isl_take isl_set *set);
5054         __isl_give isl_union_pw_qpolynomial_fold *
5055         isl_union_pw_qpolynomial_fold_intersect_params(
5056                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5057                 __isl_take isl_set *set);
5059 The second argument to the C<_params> functions needs to be
5060 a parametric (basic) set.  For the other functions, a parametric set
5061 for either argument is only allowed if the other argument is
5062 a parametric set as well.
5063 The list passed to C<isl_basic_set_list_intersect> needs to have
5064 at least one element and all elements need to live in the same space.
5066 =item * Union
5068         #include <isl/set.h>
5069         __isl_give isl_set *isl_basic_set_union(
5070                 __isl_take isl_basic_set *bset1,
5071                 __isl_take isl_basic_set *bset2);
5072         __isl_give isl_set *isl_set_union(
5073                 __isl_take isl_set *set1,
5074                 __isl_take isl_set *set2);
5076         #include <isl/map.h>
5077         __isl_give isl_map *isl_basic_map_union(
5078                 __isl_take isl_basic_map *bmap1,
5079                 __isl_take isl_basic_map *bmap2);
5080         __isl_give isl_map *isl_map_union(
5081                 __isl_take isl_map *map1,
5082                 __isl_take isl_map *map2);
5084         #include <isl/union_set.h>
5085         __isl_give isl_union_set *isl_union_set_union(
5086                 __isl_take isl_union_set *uset1,
5087                 __isl_take isl_union_set *uset2);
5088         __isl_give isl_union_set *isl_union_set_list_union(
5089                 __isl_take isl_union_set_list *list);
5091         #include <isl/union_map.h>
5092         __isl_give isl_union_map *isl_union_map_union(
5093                 __isl_take isl_union_map *umap1,
5094                 __isl_take isl_union_map *umap2);
5096 =item * Set difference
5098         #include <isl/set.h>
5099         __isl_give isl_set *isl_set_subtract(
5100                 __isl_take isl_set *set1,
5101                 __isl_take isl_set *set2);
5103         #include <isl/map.h>
5104         __isl_give isl_map *isl_map_subtract(
5105                 __isl_take isl_map *map1,
5106                 __isl_take isl_map *map2);
5107         __isl_give isl_map *isl_map_subtract_domain(
5108                 __isl_take isl_map *map,
5109                 __isl_take isl_set *dom);
5110         __isl_give isl_map *isl_map_subtract_range(
5111                 __isl_take isl_map *map,
5112                 __isl_take isl_set *dom);
5114         #include <isl/union_set.h>
5115         __isl_give isl_union_set *isl_union_set_subtract(
5116                 __isl_take isl_union_set *uset1,
5117                 __isl_take isl_union_set *uset2);
5119         #include <isl/union_map.h>
5120         __isl_give isl_union_map *isl_union_map_subtract(
5121                 __isl_take isl_union_map *umap1,
5122                 __isl_take isl_union_map *umap2);
5123         __isl_give isl_union_map *isl_union_map_subtract_domain(
5124                 __isl_take isl_union_map *umap,
5125                 __isl_take isl_union_set *dom);
5126         __isl_give isl_union_map *isl_union_map_subtract_range(
5127                 __isl_take isl_union_map *umap,
5128                 __isl_take isl_union_set *dom);
5130         #include <isl/aff.h>
5131         __isl_give isl_pw_aff *isl_pw_aff_subtract_domain(
5132                 __isl_take isl_pw_aff *pa,
5133                 __isl_take isl_set *set);
5134         __isl_give isl_pw_multi_aff *
5135         isl_pw_multi_aff_subtract_domain(
5136                 __isl_take isl_pw_multi_aff *pma,
5137                 __isl_take isl_set *set);
5138         __isl_give isl_union_pw_multi_aff *
5139         isl_union_pw_multi_aff_subtract_domain(
5140                 __isl_take isl_union_pw_multi_aff *upma,
5141                 __isl_take isl_union_set *uset);
5143         #include <isl/polynomial.h>
5144         __isl_give isl_pw_qpolynomial *
5145         isl_pw_qpolynomial_subtract_domain(
5146                 __isl_take isl_pw_qpolynomial *pwpq,
5147                 __isl_take isl_set *set);
5148         __isl_give isl_pw_qpolynomial_fold *
5149         isl_pw_qpolynomial_fold_subtract_domain(
5150                 __isl_take isl_pw_qpolynomial_fold *pwf,
5151                 __isl_take isl_set *set);
5152         __isl_give isl_union_pw_qpolynomial *
5153         isl_union_pw_qpolynomial_subtract_domain(
5154                 __isl_take isl_union_pw_qpolynomial *upwpq,
5155                 __isl_take isl_union_set *uset);
5156         __isl_give isl_union_pw_qpolynomial_fold *
5157         isl_union_pw_qpolynomial_fold_subtract_domain(
5158                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5159                 __isl_take isl_union_set *uset);
5161 =item * Application
5163         #include <isl/space.h>
5164         __isl_give isl_space *isl_space_join(
5165                 __isl_take isl_space *left,
5166                 __isl_take isl_space *right);
5168         #include <isl/map.h>
5169         __isl_give isl_basic_set *isl_basic_set_apply(
5170                 __isl_take isl_basic_set *bset,
5171                 __isl_take isl_basic_map *bmap);
5172         __isl_give isl_set *isl_set_apply(
5173                 __isl_take isl_set *set,
5174                 __isl_take isl_map *map);
5175         __isl_give isl_union_set *isl_union_set_apply(
5176                 __isl_take isl_union_set *uset,
5177                 __isl_take isl_union_map *umap);
5178         __isl_give isl_basic_map *isl_basic_map_apply_domain(
5179                 __isl_take isl_basic_map *bmap1,
5180                 __isl_take isl_basic_map *bmap2);
5181         __isl_give isl_basic_map *isl_basic_map_apply_range(
5182                 __isl_take isl_basic_map *bmap1,
5183                 __isl_take isl_basic_map *bmap2);
5184         __isl_give isl_map *isl_map_apply_domain(
5185                 __isl_take isl_map *map1,
5186                 __isl_take isl_map *map2);
5187         __isl_give isl_map *isl_map_apply_range(
5188                 __isl_take isl_map *map1,
5189                 __isl_take isl_map *map2);
5191         #include <isl/union_map.h>
5192         __isl_give isl_union_map *isl_union_map_apply_domain(
5193                 __isl_take isl_union_map *umap1,
5194                 __isl_take isl_union_map *umap2);
5195         __isl_give isl_union_map *isl_union_map_apply_range(
5196                 __isl_take isl_union_map *umap1,
5197                 __isl_take isl_union_map *umap2);
5199         #include <isl/polynomial.h>
5200         __isl_give isl_pw_qpolynomial_fold *
5201         isl_set_apply_pw_qpolynomial_fold(
5202                 __isl_take isl_set *set,
5203                 __isl_take isl_pw_qpolynomial_fold *pwf,
5204                 int *tight);
5205         __isl_give isl_pw_qpolynomial_fold *
5206         isl_map_apply_pw_qpolynomial_fold(
5207                 __isl_take isl_map *map,
5208                 __isl_take isl_pw_qpolynomial_fold *pwf,
5209                 int *tight);
5210         __isl_give isl_union_pw_qpolynomial_fold *
5211         isl_union_set_apply_union_pw_qpolynomial_fold(
5212                 __isl_take isl_union_set *uset,
5213                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5214                 int *tight);
5215         __isl_give isl_union_pw_qpolynomial_fold *
5216         isl_union_map_apply_union_pw_qpolynomial_fold(
5217                 __isl_take isl_union_map *umap,
5218                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5219                 int *tight);
5221 The functions taking a map
5222 compose the given map with the given piecewise quasipolynomial reduction.
5223 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5224 over all elements in the intersection of the range of the map
5225 and the domain of the piecewise quasipolynomial reduction
5226 as a function of an element in the domain of the map.
5227 The functions taking a set compute a bound over all elements in the
5228 intersection of the set and the domain of the
5229 piecewise quasipolynomial reduction.
5231 =item * Preimage
5233         #include <isl/set.h>
5234         __isl_give isl_basic_set *
5235         isl_basic_set_preimage_multi_aff(
5236                 __isl_take isl_basic_set *bset,
5237                 __isl_take isl_multi_aff *ma);
5238         __isl_give isl_set *isl_set_preimage_multi_aff(
5239                 __isl_take isl_set *set,
5240                 __isl_take isl_multi_aff *ma);
5241         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
5242                 __isl_take isl_set *set,
5243                 __isl_take isl_pw_multi_aff *pma);
5244         __isl_give isl_set *isl_set_preimage_multi_pw_aff(
5245                 __isl_take isl_set *set,
5246                 __isl_take isl_multi_pw_aff *mpa);
5248         #include <isl/union_set.h>
5249         __isl_give isl_union_set *
5250         isl_union_set_preimage_multi_aff(
5251                 __isl_take isl_union_set *uset,
5252                 __isl_take isl_multi_aff *ma);
5253         __isl_give isl_union_set *
5254         isl_union_set_preimage_pw_multi_aff(
5255                 __isl_take isl_union_set *uset,
5256                 __isl_take isl_pw_multi_aff *pma);
5257         __isl_give isl_union_set *
5258         isl_union_set_preimage_union_pw_multi_aff(
5259                 __isl_take isl_union_set *uset,
5260                 __isl_take isl_union_pw_multi_aff *upma);
5262         #include <isl/map.h>
5263         __isl_give isl_basic_map *
5264         isl_basic_map_preimage_domain_multi_aff(
5265                 __isl_take isl_basic_map *bmap,
5266                 __isl_take isl_multi_aff *ma);
5267         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
5268                 __isl_take isl_map *map,
5269                 __isl_take isl_multi_aff *ma);
5270         __isl_give isl_map *isl_map_preimage_range_multi_aff(
5271                 __isl_take isl_map *map,
5272                 __isl_take isl_multi_aff *ma);
5273         __isl_give isl_map *
5274         isl_map_preimage_domain_pw_multi_aff(
5275                 __isl_take isl_map *map,
5276                 __isl_take isl_pw_multi_aff *pma);
5277         __isl_give isl_map *
5278         isl_map_preimage_range_pw_multi_aff(
5279                 __isl_take isl_map *map,
5280                 __isl_take isl_pw_multi_aff *pma);
5281         __isl_give isl_map *
5282         isl_map_preimage_domain_multi_pw_aff(
5283                 __isl_take isl_map *map,
5284                 __isl_take isl_multi_pw_aff *mpa);
5285         __isl_give isl_basic_map *
5286         isl_basic_map_preimage_range_multi_aff(
5287                 __isl_take isl_basic_map *bmap,
5288                 __isl_take isl_multi_aff *ma);
5290         #include <isl/union_map.h>
5291         __isl_give isl_union_map *
5292         isl_union_map_preimage_domain_multi_aff(
5293                 __isl_take isl_union_map *umap,
5294                 __isl_take isl_multi_aff *ma);
5295         __isl_give isl_union_map *
5296         isl_union_map_preimage_range_multi_aff(
5297                 __isl_take isl_union_map *umap,
5298                 __isl_take isl_multi_aff *ma);
5299         __isl_give isl_union_map *
5300         isl_union_map_preimage_domain_pw_multi_aff(
5301                 __isl_take isl_union_map *umap,
5302                 __isl_take isl_pw_multi_aff *pma);
5303         __isl_give isl_union_map *
5304         isl_union_map_preimage_range_pw_multi_aff(
5305                 __isl_take isl_union_map *umap,
5306                 __isl_take isl_pw_multi_aff *pma);
5307         __isl_give isl_union_map *
5308         isl_union_map_preimage_domain_union_pw_multi_aff(
5309                 __isl_take isl_union_map *umap,
5310                 __isl_take isl_union_pw_multi_aff *upma);
5311         __isl_give isl_union_map *
5312         isl_union_map_preimage_range_union_pw_multi_aff(
5313                 __isl_take isl_union_map *umap,
5314                 __isl_take isl_union_pw_multi_aff *upma);
5316 These functions compute the preimage of the given set or map domain/range under
5317 the given function.  In other words, the expression is plugged
5318 into the set description or into the domain/range of the map.
5320 =item * Pullback
5322         #include <isl/aff.h>
5323         __isl_give isl_aff *isl_aff_pullback_aff(
5324                 __isl_take isl_aff *aff1,
5325                 __isl_take isl_aff *aff2);
5326         __isl_give isl_aff *isl_aff_pullback_multi_aff(
5327                 __isl_take isl_aff *aff,
5328                 __isl_take isl_multi_aff *ma);
5329         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
5330                 __isl_take isl_pw_aff *pa,
5331                 __isl_take isl_multi_aff *ma);
5332         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
5333                 __isl_take isl_pw_aff *pa,
5334                 __isl_take isl_pw_multi_aff *pma);
5335         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_pw_aff(
5336                 __isl_take isl_pw_aff *pa,
5337                 __isl_take isl_multi_pw_aff *mpa);
5338         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
5339                 __isl_take isl_multi_aff *ma1,
5340                 __isl_take isl_multi_aff *ma2);
5341         __isl_give isl_pw_multi_aff *
5342         isl_pw_multi_aff_pullback_multi_aff(
5343                 __isl_take isl_pw_multi_aff *pma,
5344                 __isl_take isl_multi_aff *ma);
5345         __isl_give isl_multi_pw_aff *
5346         isl_multi_pw_aff_pullback_multi_aff(
5347                 __isl_take isl_multi_pw_aff *mpa,
5348                 __isl_take isl_multi_aff *ma);
5349         __isl_give isl_pw_multi_aff *
5350         isl_pw_multi_aff_pullback_pw_multi_aff(
5351                 __isl_take isl_pw_multi_aff *pma1,
5352                 __isl_take isl_pw_multi_aff *pma2);
5353         __isl_give isl_multi_pw_aff *
5354         isl_multi_pw_aff_pullback_pw_multi_aff(
5355                 __isl_take isl_multi_pw_aff *mpa,
5356                 __isl_take isl_pw_multi_aff *pma);
5357         __isl_give isl_multi_pw_aff *
5358         isl_multi_pw_aff_pullback_multi_pw_aff(
5359                 __isl_take isl_multi_pw_aff *mpa1,
5360                 __isl_take isl_multi_pw_aff *mpa2);
5362 These functions precompose the first expression by the second function.
5363 In other words, the second function is plugged
5364 into the first expression.
5366 =item * Locus
5368         #include <isl/aff.h>
5369         __isl_give isl_basic_set *isl_aff_le_basic_set(
5370                 __isl_take isl_aff *aff1,
5371                 __isl_take isl_aff *aff2);
5372         __isl_give isl_basic_set *isl_aff_ge_basic_set(
5373                 __isl_take isl_aff *aff1,
5374                 __isl_take isl_aff *aff2);
5375         __isl_give isl_set *isl_pw_aff_eq_set(
5376                 __isl_take isl_pw_aff *pwaff1,
5377                 __isl_take isl_pw_aff *pwaff2);
5378         __isl_give isl_set *isl_pw_aff_ne_set(
5379                 __isl_take isl_pw_aff *pwaff1,
5380                 __isl_take isl_pw_aff *pwaff2);
5381         __isl_give isl_set *isl_pw_aff_le_set(
5382                 __isl_take isl_pw_aff *pwaff1,
5383                 __isl_take isl_pw_aff *pwaff2);
5384         __isl_give isl_set *isl_pw_aff_lt_set(
5385                 __isl_take isl_pw_aff *pwaff1,
5386                 __isl_take isl_pw_aff *pwaff2);
5387         __isl_give isl_set *isl_pw_aff_ge_set(
5388                 __isl_take isl_pw_aff *pwaff1,
5389                 __isl_take isl_pw_aff *pwaff2);
5390         __isl_give isl_set *isl_pw_aff_gt_set(
5391                 __isl_take isl_pw_aff *pwaff1,
5392                 __isl_take isl_pw_aff *pwaff2);
5394         __isl_give isl_set *isl_multi_aff_lex_le_set(
5395                 __isl_take isl_multi_aff *ma1,
5396                 __isl_take isl_multi_aff *ma2);
5397         __isl_give isl_set *isl_multi_aff_lex_ge_set(
5398                 __isl_take isl_multi_aff *ma1,
5399                 __isl_take isl_multi_aff *ma2);
5401         __isl_give isl_set *isl_pw_aff_list_eq_set(
5402                 __isl_take isl_pw_aff_list *list1,
5403                 __isl_take isl_pw_aff_list *list2);
5404         __isl_give isl_set *isl_pw_aff_list_ne_set(
5405                 __isl_take isl_pw_aff_list *list1,
5406                 __isl_take isl_pw_aff_list *list2);
5407         __isl_give isl_set *isl_pw_aff_list_le_set(
5408                 __isl_take isl_pw_aff_list *list1,
5409                 __isl_take isl_pw_aff_list *list2);
5410         __isl_give isl_set *isl_pw_aff_list_lt_set(
5411                 __isl_take isl_pw_aff_list *list1,
5412                 __isl_take isl_pw_aff_list *list2);
5413         __isl_give isl_set *isl_pw_aff_list_ge_set(
5414                 __isl_take isl_pw_aff_list *list1,
5415                 __isl_take isl_pw_aff_list *list2);
5416         __isl_give isl_set *isl_pw_aff_list_gt_set(
5417                 __isl_take isl_pw_aff_list *list1,
5418                 __isl_take isl_pw_aff_list *list2);
5420 The function C<isl_aff_ge_basic_set> returns a basic set
5421 containing those elements in the shared space
5422 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
5423 The function C<isl_pw_aff_ge_set> returns a set
5424 containing those elements in the shared domain
5425 of C<pwaff1> and C<pwaff2> where C<pwaff1> is
5426 greater than or equal to C<pwaff2>.
5427 The function C<isl_multi_aff_lex_le_set> returns a set
5428 containing those elements in the shared domain space
5429 where C<ma1> is lexicographically smaller than or
5430 equal to C<ma2>.
5431 The functions operating on C<isl_pw_aff_list> apply the corresponding
5432 C<isl_pw_aff> function to each pair of elements in the two lists.
5434 =item * Cartesian Product
5436         #include <isl/space.h>
5437         __isl_give isl_space *isl_space_product(
5438                 __isl_take isl_space *space1,
5439                 __isl_take isl_space *space2);
5440         __isl_give isl_space *isl_space_domain_product(
5441                 __isl_take isl_space *space1,
5442                 __isl_take isl_space *space2);
5443         __isl_give isl_space *isl_space_range_product(
5444                 __isl_take isl_space *space1,
5445                 __isl_take isl_space *space2);
5447 The functions
5448 C<isl_space_product>, C<isl_space_domain_product>
5449 and C<isl_space_range_product> take pairs or relation spaces and
5450 produce a single relations space, where either the domain, the range
5451 or both domain and range are wrapped spaces of relations between
5452 the domains and/or ranges of the input spaces.
5453 If the product is only constructed over the domain or the range
5454 then the ranges or the domains of the inputs should be the same.
5455 The function C<isl_space_product> also accepts a pair of set spaces,
5456 in which case it returns a wrapped space of a relation between the
5457 two input spaces.
5459         #include <isl/set.h>
5460         __isl_give isl_set *isl_set_product(
5461                 __isl_take isl_set *set1,
5462                 __isl_take isl_set *set2);
5464         #include <isl/map.h>
5465         __isl_give isl_basic_map *isl_basic_map_domain_product(
5466                 __isl_take isl_basic_map *bmap1,
5467                 __isl_take isl_basic_map *bmap2);
5468         __isl_give isl_basic_map *isl_basic_map_range_product(
5469                 __isl_take isl_basic_map *bmap1,
5470                 __isl_take isl_basic_map *bmap2);
5471         __isl_give isl_basic_map *isl_basic_map_product(
5472                 __isl_take isl_basic_map *bmap1,
5473                 __isl_take isl_basic_map *bmap2);
5474         __isl_give isl_map *isl_map_domain_product(
5475                 __isl_take isl_map *map1,
5476                 __isl_take isl_map *map2);
5477         __isl_give isl_map *isl_map_range_product(
5478                 __isl_take isl_map *map1,
5479                 __isl_take isl_map *map2);
5480         __isl_give isl_map *isl_map_product(
5481                 __isl_take isl_map *map1,
5482                 __isl_take isl_map *map2);
5484         #include <isl/union_set.h>
5485         __isl_give isl_union_set *isl_union_set_product(
5486                 __isl_take isl_union_set *uset1,
5487                 __isl_take isl_union_set *uset2);
5489         #include <isl/union_map.h>
5490         __isl_give isl_union_map *isl_union_map_domain_product(
5491                 __isl_take isl_union_map *umap1,
5492                 __isl_take isl_union_map *umap2);
5493         __isl_give isl_union_map *isl_union_map_range_product(
5494                 __isl_take isl_union_map *umap1,
5495                 __isl_take isl_union_map *umap2);
5496         __isl_give isl_union_map *isl_union_map_product(
5497                 __isl_take isl_union_map *umap1,
5498                 __isl_take isl_union_map *umap2);
5500         #include <isl/val.h>
5501         __isl_give isl_multi_val *isl_multi_val_range_product(
5502                 __isl_take isl_multi_val *mv1,
5503                 __isl_take isl_multi_val *mv2);
5504         __isl_give isl_multi_val *isl_multi_val_product(
5505                 __isl_take isl_multi_val *mv1,
5506                 __isl_take isl_multi_val *mv2);
5508         #include <isl/aff.h>
5509         __isl_give isl_multi_aff *isl_multi_aff_range_product(
5510                 __isl_take isl_multi_aff *ma1,
5511                 __isl_take isl_multi_aff *ma2);
5512         __isl_give isl_multi_aff *isl_multi_aff_product(
5513                 __isl_take isl_multi_aff *ma1,
5514                 __isl_take isl_multi_aff *ma2);
5515         __isl_give isl_multi_pw_aff *
5516         isl_multi_pw_aff_range_product(
5517                 __isl_take isl_multi_pw_aff *mpa1,
5518                 __isl_take isl_multi_pw_aff *mpa2);
5519         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_product(
5520                 __isl_take isl_multi_pw_aff *mpa1,
5521                 __isl_take isl_multi_pw_aff *mpa2);
5522         __isl_give isl_pw_multi_aff *
5523         isl_pw_multi_aff_range_product(
5524                 __isl_take isl_pw_multi_aff *pma1,
5525                 __isl_take isl_pw_multi_aff *pma2);
5526         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
5527                 __isl_take isl_pw_multi_aff *pma1,
5528                 __isl_take isl_pw_multi_aff *pma2);
5530 The above functions compute the cross product of the given
5531 sets, relations or functions.  The domains and ranges of the results
5532 are wrapped maps between domains and ranges of the inputs.
5533 To obtain a ``flat'' product, use the following functions
5534 instead.
5536         #include <isl/set.h>
5537         __isl_give isl_basic_set *isl_basic_set_flat_product(
5538                 __isl_take isl_basic_set *bset1,
5539                 __isl_take isl_basic_set *bset2);
5540         __isl_give isl_set *isl_set_flat_product(
5541                 __isl_take isl_set *set1,
5542                 __isl_take isl_set *set2);
5544         #include <isl/map.h>
5545         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
5546                 __isl_take isl_basic_map *bmap1,
5547                 __isl_take isl_basic_map *bmap2);
5548         __isl_give isl_map *isl_map_flat_domain_product(
5549                 __isl_take isl_map *map1,
5550                 __isl_take isl_map *map2);
5551         __isl_give isl_map *isl_map_flat_range_product(
5552                 __isl_take isl_map *map1,
5553                 __isl_take isl_map *map2);
5554         __isl_give isl_basic_map *isl_basic_map_flat_product(
5555                 __isl_take isl_basic_map *bmap1,
5556                 __isl_take isl_basic_map *bmap2);
5557         __isl_give isl_map *isl_map_flat_product(
5558                 __isl_take isl_map *map1,
5559                 __isl_take isl_map *map2);
5561         #include <isl/union_map.h>
5562         __isl_give isl_union_map *
5563         isl_union_map_flat_domain_product(
5564                 __isl_take isl_union_map *umap1,
5565                 __isl_take isl_union_map *umap2);
5566         __isl_give isl_union_map *
5567         isl_union_map_flat_range_product(
5568                 __isl_take isl_union_map *umap1,
5569                 __isl_take isl_union_map *umap2);
5571         #include <isl/val.h>
5572         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
5573                 __isl_take isl_multi_val *mv1,
5574                 __isl_take isl_multi_aff *mv2);
5576         #include <isl/aff.h>
5577         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
5578                 __isl_take isl_multi_aff *ma1,
5579                 __isl_take isl_multi_aff *ma2);
5580         __isl_give isl_pw_multi_aff *
5581         isl_pw_multi_aff_flat_range_product(
5582                 __isl_take isl_pw_multi_aff *pma1,
5583                 __isl_take isl_pw_multi_aff *pma2);
5584         __isl_give isl_multi_pw_aff *
5585         isl_multi_pw_aff_flat_range_product(
5586                 __isl_take isl_multi_pw_aff *mpa1,
5587                 __isl_take isl_multi_pw_aff *mpa2);
5588         __isl_give isl_union_pw_multi_aff *
5589         isl_union_pw_multi_aff_flat_range_product(
5590                 __isl_take isl_union_pw_multi_aff *upma1,
5591                 __isl_take isl_union_pw_multi_aff *upma2);
5593         #include <isl/space.h>
5594         __isl_give isl_space *isl_space_factor_domain(
5595                 __isl_take isl_space *space);
5596         __isl_give isl_space *isl_space_factor_range(
5597                 __isl_take isl_space *space);
5598         __isl_give isl_space *isl_space_domain_factor_domain(
5599                 __isl_take isl_space *space);
5600         __isl_give isl_space *isl_space_domain_factor_range(
5601                 __isl_take isl_space *space);
5602         __isl_give isl_space *isl_space_range_factor_domain(
5603                 __isl_take isl_space *space);
5604         __isl_give isl_space *isl_space_range_factor_range(
5605                 __isl_take isl_space *space);
5607 The functions C<isl_space_range_factor_domain> and
5608 C<isl_space_range_factor_range> extract the two arguments from
5609 the result of a call to C<isl_space_range_product>.
5611 The arguments of a call to C<isl_map_range_product> can be extracted
5612 from the result using the following functions.
5614         #include <isl/map.h>
5615         __isl_give isl_map *isl_map_factor_domain(
5616                 __isl_take isl_map *map);
5617         __isl_give isl_map *isl_map_factor_range(
5618                 __isl_take isl_map *map);
5619         __isl_give isl_map *isl_map_domain_factor_domain(
5620                 __isl_take isl_map *map);
5621         __isl_give isl_map *isl_map_domain_factor_range(
5622                 __isl_take isl_map *map);
5623         __isl_give isl_map *isl_map_range_factor_domain(
5624                 __isl_take isl_map *map);
5625         __isl_give isl_map *isl_map_range_factor_range(
5626                 __isl_take isl_map *map);
5628         #include <isl/union_map.h>
5629         __isl_give isl_union_map *isl_union_map_factor_domain(
5630                 __isl_take isl_union_map *umap);
5631         __isl_give isl_union_map *isl_union_map_factor_range(
5632                 __isl_take isl_union_map *umap);
5633         __isl_give isl_union_map *
5634         isl_union_map_domain_factor_domain(
5635                 __isl_take isl_union_map *umap);
5636         __isl_give isl_union_map *
5637         isl_union_map_domain_factor_range(
5638                 __isl_take isl_union_map *umap);
5639         __isl_give isl_union_map *
5640         isl_union_map_range_factor_range(
5641                 __isl_take isl_union_map *umap);
5643         #include <isl/val.h>
5644         __isl_give isl_multi_val *
5645         isl_multi_val_range_factor_domain(
5646                 __isl_take isl_multi_val *mv);
5647         __isl_give isl_multi_val *
5648         isl_multi_val_range_factor_range(
5649                 __isl_take isl_multi_val *mv);
5651         #include <isl/aff.h>
5652         __isl_give isl_multi_aff *
5653         isl_multi_aff_range_factor_domain(
5654                 __isl_take isl_multi_aff *ma);
5655         __isl_give isl_multi_aff *
5656         isl_multi_aff_range_factor_range(
5657                 __isl_take isl_multi_aff *ma);
5658         __isl_give isl_multi_pw_aff *
5659         isl_multi_pw_aff_range_factor_domain(
5660                 __isl_take isl_multi_pw_aff *mpa);
5661         __isl_give isl_multi_pw_aff *
5662         isl_multi_pw_aff_range_factor_range(
5663                 __isl_take isl_multi_pw_aff *mpa);
5665 The splice functions are a generalization of the flat product functions,
5666 where the second argument may be inserted at any position inside
5667 the first argument rather than being placed at the end.
5669         #include <isl/val.h>
5670         __isl_give isl_multi_val *isl_multi_val_range_splice(
5671                 __isl_take isl_multi_val *mv1, unsigned pos,
5672                 __isl_take isl_multi_val *mv2);
5674         #include <isl/aff.h>
5675         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
5676                 __isl_take isl_multi_aff *ma1, unsigned pos,
5677                 __isl_take isl_multi_aff *ma2);
5678         __isl_give isl_multi_aff *isl_multi_aff_splice(
5679                 __isl_take isl_multi_aff *ma1,
5680                 unsigned in_pos, unsigned out_pos,
5681                 __isl_take isl_multi_aff *ma2);
5682         __isl_give isl_multi_pw_aff *
5683         isl_multi_pw_aff_range_splice(
5684                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
5685                 __isl_take isl_multi_pw_aff *mpa2);
5686         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
5687                 __isl_take isl_multi_pw_aff *mpa1,
5688                 unsigned in_pos, unsigned out_pos,
5689                 __isl_take isl_multi_pw_aff *mpa2);
5691 =item * Simplification
5693 When applied to a set or relation,
5694 the gist operation returns a set or relation that has the
5695 same intersection with the context as the input set or relation.
5696 Any implicit equality in the intersection is made explicit in the result,
5697 while all inequalities that are redundant with respect to the intersection
5698 are removed.
5699 In case of union sets and relations, the gist operation is performed
5700 per space.
5702 When applied to a function,
5703 the gist operation applies the set gist operation to each of
5704 the cells in the domain of the input piecewise expression.
5705 The context is also exploited
5706 to simplify the expression associated to each cell.
5708         #include <isl/set.h>
5709         __isl_give isl_basic_set *isl_basic_set_gist(
5710                 __isl_take isl_basic_set *bset,
5711                 __isl_take isl_basic_set *context);
5712         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
5713                 __isl_take isl_set *context);
5714         __isl_give isl_set *isl_set_gist_params(
5715                 __isl_take isl_set *set,
5716                 __isl_take isl_set *context);
5718         #include <isl/map.h>
5719         __isl_give isl_basic_map *isl_basic_map_gist(
5720                 __isl_take isl_basic_map *bmap,
5721                 __isl_take isl_basic_map *context);
5722         __isl_give isl_basic_map *isl_basic_map_gist_domain(
5723                 __isl_take isl_basic_map *bmap,
5724                 __isl_take isl_basic_set *context);
5725         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
5726                 __isl_take isl_map *context);
5727         __isl_give isl_map *isl_map_gist_params(
5728                 __isl_take isl_map *map,
5729                 __isl_take isl_set *context);
5730         __isl_give isl_map *isl_map_gist_domain(
5731                 __isl_take isl_map *map,
5732                 __isl_take isl_set *context);
5733         __isl_give isl_map *isl_map_gist_range(
5734                 __isl_take isl_map *map,
5735                 __isl_take isl_set *context);
5737         #include <isl/union_set.h>
5738         __isl_give isl_union_set *isl_union_set_gist(
5739                 __isl_take isl_union_set *uset,
5740                 __isl_take isl_union_set *context);
5741         __isl_give isl_union_set *isl_union_set_gist_params(
5742                 __isl_take isl_union_set *uset,
5743                 __isl_take isl_set *set);
5745         #include <isl/union_map.h>
5746         __isl_give isl_union_map *isl_union_map_gist(
5747                 __isl_take isl_union_map *umap,
5748                 __isl_take isl_union_map *context);
5749         __isl_give isl_union_map *isl_union_map_gist_params(
5750                 __isl_take isl_union_map *umap,
5751                 __isl_take isl_set *set);
5752         __isl_give isl_union_map *isl_union_map_gist_domain(
5753                 __isl_take isl_union_map *umap,
5754                 __isl_take isl_union_set *uset);
5755         __isl_give isl_union_map *isl_union_map_gist_range(
5756                 __isl_take isl_union_map *umap,
5757                 __isl_take isl_union_set *uset);
5759         #include <isl/aff.h>
5760         __isl_give isl_aff *isl_aff_gist_params(
5761                 __isl_take isl_aff *aff,
5762                 __isl_take isl_set *context);
5763         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
5764                 __isl_take isl_set *context);
5765         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
5766                 __isl_take isl_multi_aff *maff,
5767                 __isl_take isl_set *context);
5768         __isl_give isl_multi_aff *isl_multi_aff_gist(
5769                 __isl_take isl_multi_aff *maff,
5770                 __isl_take isl_set *context);
5771         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
5772                 __isl_take isl_pw_aff *pwaff,
5773                 __isl_take isl_set *context);
5774         __isl_give isl_pw_aff *isl_pw_aff_gist(
5775                 __isl_take isl_pw_aff *pwaff,
5776                 __isl_take isl_set *context);
5777         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
5778                 __isl_take isl_pw_multi_aff *pma,
5779                 __isl_take isl_set *set);
5780         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
5781                 __isl_take isl_pw_multi_aff *pma,
5782                 __isl_take isl_set *set);
5783         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist_params(
5784                 __isl_take isl_multi_pw_aff *mpa,
5785                 __isl_take isl_set *set);
5786         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist(
5787                 __isl_take isl_multi_pw_aff *mpa,
5788                 __isl_take isl_set *set);
5789         __isl_give isl_union_pw_multi_aff *
5790         isl_union_pw_multi_aff_gist_params(
5791                 __isl_take isl_union_pw_multi_aff *upma,
5792                 __isl_take isl_set *context);
5793         __isl_give isl_union_pw_multi_aff *
5794         isl_union_pw_multi_aff_gist(
5795                 __isl_take isl_union_pw_multi_aff *upma,
5796                 __isl_take isl_union_set *context);
5798         #include <isl/polynomial.h>
5799         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
5800                 __isl_take isl_qpolynomial *qp,
5801                 __isl_take isl_set *context);
5802         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
5803                 __isl_take isl_qpolynomial *qp,
5804                 __isl_take isl_set *context);
5805         __isl_give isl_qpolynomial_fold *
5806         isl_qpolynomial_fold_gist_params(
5807                 __isl_take isl_qpolynomial_fold *fold,
5808                 __isl_take isl_set *context);
5809         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
5810                 __isl_take isl_qpolynomial_fold *fold,
5811                 __isl_take isl_set *context);
5812         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
5813                 __isl_take isl_pw_qpolynomial *pwqp,
5814                 __isl_take isl_set *context);
5815         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
5816                 __isl_take isl_pw_qpolynomial *pwqp,
5817                 __isl_take isl_set *context);
5818         __isl_give isl_pw_qpolynomial_fold *
5819         isl_pw_qpolynomial_fold_gist(
5820                 __isl_take isl_pw_qpolynomial_fold *pwf,
5821                 __isl_take isl_set *context);
5822         __isl_give isl_pw_qpolynomial_fold *
5823         isl_pw_qpolynomial_fold_gist_params(
5824                 __isl_take isl_pw_qpolynomial_fold *pwf,
5825                 __isl_take isl_set *context);
5826         __isl_give isl_union_pw_qpolynomial *
5827         isl_union_pw_qpolynomial_gist_params(
5828                 __isl_take isl_union_pw_qpolynomial *upwqp,
5829                 __isl_take isl_set *context);
5830         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
5831                 __isl_take isl_union_pw_qpolynomial *upwqp,
5832                 __isl_take isl_union_set *context);
5833         __isl_give isl_union_pw_qpolynomial_fold *
5834         isl_union_pw_qpolynomial_fold_gist(
5835                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5836                 __isl_take isl_union_set *context);
5837         __isl_give isl_union_pw_qpolynomial_fold *
5838         isl_union_pw_qpolynomial_fold_gist_params(
5839                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5840                 __isl_take isl_set *context);
5842 =item * Binary Arithmethic Operations
5844         #include <isl/val.h>
5845         __isl_give isl_multi_val *isl_multi_val_sub(
5846                 __isl_take isl_multi_val *mv1,
5847                 __isl_take isl_multi_val *mv2);
5849         #include <isl/aff.h>
5850         __isl_give isl_aff *isl_aff_add(
5851                 __isl_take isl_aff *aff1,
5852                 __isl_take isl_aff *aff2);
5853         __isl_give isl_multi_aff *isl_multi_aff_add(
5854                 __isl_take isl_multi_aff *maff1,
5855                 __isl_take isl_multi_aff *maff2);
5856         __isl_give isl_pw_aff *isl_pw_aff_add(
5857                 __isl_take isl_pw_aff *pwaff1,
5858                 __isl_take isl_pw_aff *pwaff2);
5859         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
5860                 __isl_take isl_pw_multi_aff *pma1,
5861                 __isl_take isl_pw_multi_aff *pma2);
5862         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
5863                 __isl_take isl_union_pw_multi_aff *upma1,
5864                 __isl_take isl_union_pw_multi_aff *upma2);
5865         __isl_give isl_pw_aff *isl_pw_aff_min(
5866                 __isl_take isl_pw_aff *pwaff1,
5867                 __isl_take isl_pw_aff *pwaff2);
5868         __isl_give isl_pw_aff *isl_pw_aff_max(
5869                 __isl_take isl_pw_aff *pwaff1,
5870                 __isl_take isl_pw_aff *pwaff2);
5871         __isl_give isl_aff *isl_aff_sub(
5872                 __isl_take isl_aff *aff1,
5873                 __isl_take isl_aff *aff2);
5874         __isl_give isl_multi_aff *isl_multi_aff_sub(
5875                 __isl_take isl_multi_aff *ma1,
5876                 __isl_take isl_multi_aff *ma2);
5877         __isl_give isl_pw_aff *isl_pw_aff_sub(
5878                 __isl_take isl_pw_aff *pwaff1,
5879                 __isl_take isl_pw_aff *pwaff2);
5880         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_sub(
5881                 __isl_take isl_multi_pw_aff *mpa1,
5882                 __isl_take isl_multi_pw_aff *mpa2);
5883         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
5884                 __isl_take isl_pw_multi_aff *pma1,
5885                 __isl_take isl_pw_multi_aff *pma2);
5886         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
5887                 __isl_take isl_union_pw_multi_aff *upma1,
5888                 __isl_take isl_union_pw_multi_aff *upma2);
5890 C<isl_aff_sub> subtracts the second argument from the first.
5892         #include <isl/polynomial.h>
5893         __isl_give isl_qpolynomial *isl_qpolynomial_add(
5894                 __isl_take isl_qpolynomial *qp1,
5895                 __isl_take isl_qpolynomial *qp2);
5896         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
5897                 __isl_take isl_pw_qpolynomial *pwqp1,
5898                 __isl_take isl_pw_qpolynomial *pwqp2);
5899         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
5900                 __isl_take isl_pw_qpolynomial *pwqp1,
5901                 __isl_take isl_pw_qpolynomial *pwqp2);
5902         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
5903                 __isl_take isl_pw_qpolynomial_fold *pwf1,
5904                 __isl_take isl_pw_qpolynomial_fold *pwf2);
5905         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
5906                 __isl_take isl_union_pw_qpolynomial *upwqp1,
5907                 __isl_take isl_union_pw_qpolynomial *upwqp2);
5908         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
5909                 __isl_take isl_qpolynomial *qp1,
5910                 __isl_take isl_qpolynomial *qp2);
5911         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
5912                 __isl_take isl_pw_qpolynomial *pwqp1,
5913                 __isl_take isl_pw_qpolynomial *pwqp2);
5914         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
5915                 __isl_take isl_union_pw_qpolynomial *upwqp1,
5916                 __isl_take isl_union_pw_qpolynomial *upwqp2);
5917         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
5918                 __isl_take isl_pw_qpolynomial_fold *pwf1,
5919                 __isl_take isl_pw_qpolynomial_fold *pwf2);
5920         __isl_give isl_union_pw_qpolynomial_fold *
5921         isl_union_pw_qpolynomial_fold_fold(
5922                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
5923                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
5925         #include <isl/aff.h>
5926         __isl_give isl_pw_aff *isl_pw_aff_union_add(
5927                 __isl_take isl_pw_aff *pwaff1,
5928                 __isl_take isl_pw_aff *pwaff2);
5929         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
5930                 __isl_take isl_pw_multi_aff *pma1,
5931                 __isl_take isl_pw_multi_aff *pma2);
5932         __isl_give isl_union_pw_multi_aff *
5933         isl_union_pw_multi_aff_union_add(
5934                 __isl_take isl_union_pw_multi_aff *upma1,
5935                 __isl_take isl_union_pw_multi_aff *upma2);
5936         __isl_give isl_pw_aff *isl_pw_aff_union_min(
5937                 __isl_take isl_pw_aff *pwaff1,
5938                 __isl_take isl_pw_aff *pwaff2);
5939         __isl_give isl_pw_aff *isl_pw_aff_union_max(
5940                 __isl_take isl_pw_aff *pwaff1,
5941                 __isl_take isl_pw_aff *pwaff2);
5943 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
5944 expression with a domain that is the union of those of C<pwaff1> and
5945 C<pwaff2> and such that on each cell, the quasi-affine expression is
5946 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
5947 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
5948 associated expression is the defined one.
5949 This in contrast to the C<isl_pw_aff_max> function, which is
5950 only defined on the shared definition domain of the arguments.
5952         #include <isl/val.h>
5953         __isl_give isl_multi_val *isl_multi_val_add_val(
5954                 __isl_take isl_multi_val *mv,
5955                 __isl_take isl_val *v);
5956         __isl_give isl_multi_val *isl_multi_val_mod_val(
5957                 __isl_take isl_multi_val *mv,
5958                 __isl_take isl_val *v);
5959         __isl_give isl_multi_val *isl_multi_val_scale_val(
5960                 __isl_take isl_multi_val *mv,
5961                 __isl_take isl_val *v);
5962         __isl_give isl_multi_val *isl_multi_val_scale_down_val(
5963                 __isl_take isl_multi_val *mv,
5964                 __isl_take isl_val *v);
5966         #include <isl/aff.h>
5967         __isl_give isl_aff *isl_aff_mod_val(__isl_take isl_aff *aff,
5968                 __isl_take isl_val *mod);
5969         __isl_give isl_pw_aff *isl_pw_aff_mod_val(
5970                 __isl_take isl_pw_aff *pa,
5971                 __isl_take isl_val *mod);
5972         __isl_give isl_aff *isl_aff_scale_val(__isl_take isl_aff *aff,
5973                 __isl_take isl_val *v);
5974         __isl_give isl_multi_aff *isl_multi_aff_scale_val(
5975                 __isl_take isl_multi_aff *ma,
5976                 __isl_take isl_val *v);
5977         __isl_give isl_pw_aff *isl_pw_aff_scale_val(
5978                 __isl_take isl_pw_aff *pa, __isl_take isl_val *v);
5979         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_val(
5980                 __isl_take isl_multi_pw_aff *mpa,
5981                 __isl_take isl_val *v);
5982         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_val(
5983                 __isl_take isl_pw_multi_aff *pma,
5984                 __isl_take isl_val *v);
5985         __isl_give isl_union_pw_multi_aff *
5986         isl_union_pw_multi_aff_scale_val(
5987                 __isl_take isl_union_pw_multi_aff *upma,
5988                 __isl_take isl_val *val);
5989         __isl_give isl_aff *isl_aff_scale_down_ui(
5990                 __isl_take isl_aff *aff, unsigned f);
5991         __isl_give isl_aff *isl_aff_scale_down_val(
5992                 __isl_take isl_aff *aff, __isl_take isl_val *v);
5993         __isl_give isl_multi_aff *isl_multi_aff_scale_down_val(
5994                 __isl_take isl_multi_aff *ma,
5995                 __isl_take isl_val *v);
5996         __isl_give isl_pw_aff *isl_pw_aff_scale_down_val(
5997                 __isl_take isl_pw_aff *pa,
5998                 __isl_take isl_val *f);
5999         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_down_val(
6000                 __isl_take isl_multi_pw_aff *mpa,
6001                 __isl_take isl_val *v);
6002         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_down_val(
6003                 __isl_take isl_pw_multi_aff *pma,
6004                 __isl_take isl_val *v);
6005         __isl_give isl_union_pw_multi_aff *
6006         isl_union_pw_multi_aff_scale_down_val(
6007                 __isl_take isl_union_pw_multi_aff *upma,
6008                 __isl_take isl_val *val);
6010         #include <isl/polynomial.h>
6011         __isl_give isl_qpolynomial *isl_qpolynomial_scale_val(
6012                 __isl_take isl_qpolynomial *qp,
6013                 __isl_take isl_val *v);
6014         __isl_give isl_qpolynomial_fold *
6015         isl_qpolynomial_fold_scale_val(
6016                 __isl_take isl_qpolynomial_fold *fold,
6017                 __isl_take isl_val *v);
6018         __isl_give isl_pw_qpolynomial *
6019         isl_pw_qpolynomial_scale_val(
6020                 __isl_take isl_pw_qpolynomial *pwqp,
6021                 __isl_take isl_val *v);
6022         __isl_give isl_pw_qpolynomial_fold *
6023         isl_pw_qpolynomial_fold_scale_val(
6024                 __isl_take isl_pw_qpolynomial_fold *pwf,
6025                 __isl_take isl_val *v);
6026         __isl_give isl_union_pw_qpolynomial *
6027         isl_union_pw_qpolynomial_scale_val(
6028                 __isl_take isl_union_pw_qpolynomial *upwqp,
6029                 __isl_take isl_val *v);
6030         __isl_give isl_union_pw_qpolynomial_fold *
6031         isl_union_pw_qpolynomial_fold_scale_val(
6032                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6033                 __isl_take isl_val *v);
6034         __isl_give isl_qpolynomial *
6035         isl_qpolynomial_scale_down_val(
6036                 __isl_take isl_qpolynomial *qp,
6037                 __isl_take isl_val *v);
6038         __isl_give isl_qpolynomial_fold *
6039         isl_qpolynomial_fold_scale_down_val(
6040                 __isl_take isl_qpolynomial_fold *fold,
6041                 __isl_take isl_val *v);
6042         __isl_give isl_pw_qpolynomial *
6043         isl_pw_qpolynomial_scale_down_val(
6044                 __isl_take isl_pw_qpolynomial *pwqp,
6045                 __isl_take isl_val *v);
6046         __isl_give isl_pw_qpolynomial_fold *
6047         isl_pw_qpolynomial_fold_scale_down_val(
6048                 __isl_take isl_pw_qpolynomial_fold *pwf,
6049                 __isl_take isl_val *v);
6050         __isl_give isl_union_pw_qpolynomial *
6051         isl_union_pw_qpolynomial_scale_down_val(
6052                 __isl_take isl_union_pw_qpolynomial *upwqp,
6053                 __isl_take isl_val *v);
6054         __isl_give isl_union_pw_qpolynomial_fold *
6055         isl_union_pw_qpolynomial_fold_scale_down_val(
6056                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6057                 __isl_take isl_val *v);
6059         #include <isl/val.h>
6060         __isl_give isl_multi_val *isl_multi_val_mod_multi_val(
6061                 __isl_take isl_multi_val *mv1,
6062                 __isl_take isl_multi_val *mv2);
6063         __isl_give isl_multi_val *isl_multi_val_scale_multi_val(
6064                 __isl_take isl_multi_val *mv1,
6065                 __isl_take isl_multi_val *mv2);
6066         __isl_give isl_multi_val *
6067         isl_multi_val_scale_down_multi_val(
6068                 __isl_take isl_multi_val *mv1,
6069                 __isl_take isl_multi_val *mv2);
6071         #include <isl/aff.h>
6072         __isl_give isl_multi_aff *isl_multi_aff_mod_multi_val(
6073                 __isl_take isl_multi_aff *ma,
6074                 __isl_take isl_multi_val *mv);
6075         __isl_give isl_multi_pw_aff *
6076         isl_multi_pw_aff_mod_multi_val(
6077                 __isl_take isl_multi_pw_aff *mpa,
6078                 __isl_take isl_multi_val *mv);
6079         __isl_give isl_multi_aff *isl_multi_aff_scale_multi_val(
6080                 __isl_take isl_multi_aff *ma,
6081                 __isl_take isl_multi_val *mv);
6082         __isl_give isl_pw_multi_aff *
6083         isl_pw_multi_aff_scale_multi_val(
6084                 __isl_take isl_pw_multi_aff *pma,
6085                 __isl_take isl_multi_val *mv);
6086         __isl_give isl_multi_pw_aff *
6087         isl_multi_pw_aff_scale_multi_val(
6088                 __isl_take isl_multi_pw_aff *mpa,
6089                 __isl_take isl_multi_val *mv);
6090         __isl_give isl_union_pw_multi_aff *
6091         isl_union_pw_multi_aff_scale_multi_val(
6092                 __isl_take isl_union_pw_multi_aff *upma,
6093                 __isl_take isl_multi_val *mv);
6094         __isl_give isl_multi_aff *
6095         isl_multi_aff_scale_down_multi_val(
6096                 __isl_take isl_multi_aff *ma,
6097                 __isl_take isl_multi_val *mv);
6098         __isl_give isl_multi_pw_aff *
6099         isl_multi_pw_aff_scale_down_multi_val(
6100                 __isl_take isl_multi_pw_aff *mpa,
6101                 __isl_take isl_multi_val *mv);
6103 C<isl_multi_aff_scale_multi_val> scales the elements of C<ma>
6104 by the corresponding elements of C<mv>.
6106         #include <isl/aff.h>
6107         __isl_give isl_aff *isl_aff_mul(
6108                 __isl_take isl_aff *aff1,
6109                 __isl_take isl_aff *aff2);
6110         __isl_give isl_aff *isl_aff_div(
6111                 __isl_take isl_aff *aff1,
6112                 __isl_take isl_aff *aff2);
6113         __isl_give isl_pw_aff *isl_pw_aff_mul(
6114                 __isl_take isl_pw_aff *pwaff1,
6115                 __isl_take isl_pw_aff *pwaff2);
6116         __isl_give isl_pw_aff *isl_pw_aff_div(
6117                 __isl_take isl_pw_aff *pa1,
6118                 __isl_take isl_pw_aff *pa2);
6119         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
6120                 __isl_take isl_pw_aff *pa1,
6121                 __isl_take isl_pw_aff *pa2);
6122         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
6123                 __isl_take isl_pw_aff *pa1,
6124                 __isl_take isl_pw_aff *pa2);
6126 When multiplying two affine expressions, at least one of the two needs
6127 to be a constant.  Similarly, when dividing an affine expression by another,
6128 the second expression needs to be a constant.
6129 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
6130 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
6131 remainder.
6133         #include <isl/polynomial.h>
6134         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
6135                 __isl_take isl_qpolynomial *qp1,
6136                 __isl_take isl_qpolynomial *qp2);
6137         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
6138                 __isl_take isl_pw_qpolynomial *pwqp1,
6139                 __isl_take isl_pw_qpolynomial *pwqp2);
6140         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
6141                 __isl_take isl_union_pw_qpolynomial *upwqp1,
6142                 __isl_take isl_union_pw_qpolynomial *upwqp2);
6144 =back
6146 =head3 Lexicographic Optimization
6148 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
6149 the following functions
6150 compute a set that contains the lexicographic minimum or maximum
6151 of the elements in C<set> (or C<bset>) for those values of the parameters
6152 that satisfy C<dom>.
6153 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
6154 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
6155 has no elements.
6156 In other words, the union of the parameter values
6157 for which the result is non-empty and of C<*empty>
6158 is equal to C<dom>.
6160         #include <isl/set.h>
6161         __isl_give isl_set *isl_basic_set_partial_lexmin(
6162                 __isl_take isl_basic_set *bset,
6163                 __isl_take isl_basic_set *dom,
6164                 __isl_give isl_set **empty);
6165         __isl_give isl_set *isl_basic_set_partial_lexmax(
6166                 __isl_take isl_basic_set *bset,
6167                 __isl_take isl_basic_set *dom,
6168                 __isl_give isl_set **empty);
6169         __isl_give isl_set *isl_set_partial_lexmin(
6170                 __isl_take isl_set *set, __isl_take isl_set *dom,
6171                 __isl_give isl_set **empty);
6172         __isl_give isl_set *isl_set_partial_lexmax(
6173                 __isl_take isl_set *set, __isl_take isl_set *dom,
6174                 __isl_give isl_set **empty);
6176 Given a (basic) set C<set> (or C<bset>), the following functions simply
6177 return a set containing the lexicographic minimum or maximum
6178 of the elements in C<set> (or C<bset>).
6179 In case of union sets, the optimum is computed per space.
6181         #include <isl/set.h>
6182         __isl_give isl_set *isl_basic_set_lexmin(
6183                 __isl_take isl_basic_set *bset);
6184         __isl_give isl_set *isl_basic_set_lexmax(
6185                 __isl_take isl_basic_set *bset);
6186         __isl_give isl_set *isl_set_lexmin(
6187                 __isl_take isl_set *set);
6188         __isl_give isl_set *isl_set_lexmax(
6189                 __isl_take isl_set *set);
6190         __isl_give isl_union_set *isl_union_set_lexmin(
6191                 __isl_take isl_union_set *uset);
6192         __isl_give isl_union_set *isl_union_set_lexmax(
6193                 __isl_take isl_union_set *uset);
6195 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
6196 the following functions
6197 compute a relation that maps each element of C<dom>
6198 to the single lexicographic minimum or maximum
6199 of the elements that are associated to that same
6200 element in C<map> (or C<bmap>).
6201 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
6202 that contains the elements in C<dom> that do not map
6203 to any elements in C<map> (or C<bmap>).
6204 In other words, the union of the domain of the result and of C<*empty>
6205 is equal to C<dom>.
6207         #include <isl/map.h>
6208         __isl_give isl_map *isl_basic_map_partial_lexmax(
6209                 __isl_take isl_basic_map *bmap,
6210                 __isl_take isl_basic_set *dom,
6211                 __isl_give isl_set **empty);
6212         __isl_give isl_map *isl_basic_map_partial_lexmin(
6213                 __isl_take isl_basic_map *bmap,
6214                 __isl_take isl_basic_set *dom,
6215                 __isl_give isl_set **empty);
6216         __isl_give isl_map *isl_map_partial_lexmax(
6217                 __isl_take isl_map *map, __isl_take isl_set *dom,
6218                 __isl_give isl_set **empty);
6219         __isl_give isl_map *isl_map_partial_lexmin(
6220                 __isl_take isl_map *map, __isl_take isl_set *dom,
6221                 __isl_give isl_set **empty);
6223 Given a (basic) map C<map> (or C<bmap>), the following functions simply
6224 return a map mapping each element in the domain of
6225 C<map> (or C<bmap>) to the lexicographic minimum or maximum
6226 of all elements associated to that element.
6227 In case of union relations, the optimum is computed per space.
6229         #include <isl/map.h>
6230         __isl_give isl_map *isl_basic_map_lexmin(
6231                 __isl_take isl_basic_map *bmap);
6232         __isl_give isl_map *isl_basic_map_lexmax(
6233                 __isl_take isl_basic_map *bmap);
6234         __isl_give isl_map *isl_map_lexmin(
6235                 __isl_take isl_map *map);
6236         __isl_give isl_map *isl_map_lexmax(
6237                 __isl_take isl_map *map);
6238         __isl_give isl_union_map *isl_union_map_lexmin(
6239                 __isl_take isl_union_map *umap);
6240         __isl_give isl_union_map *isl_union_map_lexmax(
6241                 __isl_take isl_union_map *umap);
6243 The following functions return their result in the form of
6244 a piecewise multi-affine expression,
6245 but are otherwise equivalent to the corresponding functions
6246 returning a basic set or relation.
6248         #include <isl/set.h>
6249         __isl_give isl_pw_multi_aff *
6250         isl_basic_set_partial_lexmin_pw_multi_aff(
6251                 __isl_take isl_basic_set *bset,
6252                 __isl_take isl_basic_set *dom,
6253                 __isl_give isl_set **empty);
6254         __isl_give isl_pw_multi_aff *
6255         isl_basic_set_partial_lexmax_pw_multi_aff(
6256                 __isl_take isl_basic_set *bset,
6257                 __isl_take isl_basic_set *dom,
6258                 __isl_give isl_set **empty);
6259         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
6260                 __isl_take isl_set *set);
6261         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
6262                 __isl_take isl_set *set);
6264         #include <isl/map.h>
6265         __isl_give isl_pw_multi_aff *
6266         isl_basic_map_lexmin_pw_multi_aff(
6267                 __isl_take isl_basic_map *bmap);
6268         __isl_give isl_pw_multi_aff *
6269         isl_basic_map_partial_lexmin_pw_multi_aff(
6270                 __isl_take isl_basic_map *bmap,
6271                 __isl_take isl_basic_set *dom,
6272                 __isl_give isl_set **empty);
6273         __isl_give isl_pw_multi_aff *
6274         isl_basic_map_partial_lexmax_pw_multi_aff(
6275                 __isl_take isl_basic_map *bmap,
6276                 __isl_take isl_basic_set *dom,
6277                 __isl_give isl_set **empty);
6278         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
6279                 __isl_take isl_map *map);
6280         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
6281                 __isl_take isl_map *map);
6283 The following functions return the lexicographic minimum or maximum
6284 on the shared domain of the inputs and the single defined function
6285 on those parts of the domain where only a single function is defined.
6287         #include <isl/aff.h>
6288         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
6289                 __isl_take isl_pw_multi_aff *pma1,
6290                 __isl_take isl_pw_multi_aff *pma2);
6291         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
6292                 __isl_take isl_pw_multi_aff *pma1,
6293                 __isl_take isl_pw_multi_aff *pma2);
6295 =head2 Ternary Operations
6297         #include <isl/aff.h>
6298         __isl_give isl_pw_aff *isl_pw_aff_cond(
6299                 __isl_take isl_pw_aff *cond,
6300                 __isl_take isl_pw_aff *pwaff_true,
6301                 __isl_take isl_pw_aff *pwaff_false);
6303 The function C<isl_pw_aff_cond> performs a conditional operator
6304 and returns an expression that is equal to C<pwaff_true>
6305 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
6306 where C<cond> is zero.
6308 =head2 Lists
6310 Lists are defined over several element types, including
6311 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>,
6312 C<isl_union_pw_multi_aff>, C<isl_constraint>,
6313 C<isl_basic_set>, C<isl_set>, C<isl_basic_map>, C<isl_map>, C<isl_union_set>,
6314 C<isl_union_map>, C<isl_ast_expr> and C<isl_ast_node>.
6315 Here we take lists of C<isl_set>s as an example.
6316 Lists can be created, copied, modified and freed using the following functions.
6318         #include <isl/set.h>
6319         __isl_give isl_set_list *isl_set_list_from_set(
6320                 __isl_take isl_set *el);
6321         __isl_give isl_set_list *isl_set_list_alloc(
6322                 isl_ctx *ctx, int n);
6323         __isl_give isl_set_list *isl_set_list_copy(
6324                 __isl_keep isl_set_list *list);
6325         __isl_give isl_set_list *isl_set_list_insert(
6326                 __isl_take isl_set_list *list, unsigned pos,
6327                 __isl_take isl_set *el);
6328         __isl_give isl_set_list *isl_set_list_add(
6329                 __isl_take isl_set_list *list,
6330                 __isl_take isl_set *el);
6331         __isl_give isl_set_list *isl_set_list_drop(
6332                 __isl_take isl_set_list *list,
6333                 unsigned first, unsigned n);
6334         __isl_give isl_set_list *isl_set_list_set_set(
6335                 __isl_take isl_set_list *list, int index,
6336                 __isl_take isl_set *set);
6337         __isl_give isl_set_list *isl_set_list_concat(
6338                 __isl_take isl_set_list *list1,
6339                 __isl_take isl_set_list *list2);
6340         __isl_give isl_set_list *isl_set_list_sort(
6341                 __isl_take isl_set_list *list,
6342                 int (*cmp)(__isl_keep isl_set *a,
6343                         __isl_keep isl_set *b, void *user),
6344                 void *user);
6345         __isl_null isl_set_list *isl_set_list_free(
6346                 __isl_take isl_set_list *list);
6348 C<isl_set_list_alloc> creates an empty list with an initial capacity
6349 for C<n> elements.  C<isl_set_list_insert> and C<isl_set_list_add>
6350 add elements to a list, increasing its capacity as needed.
6351 C<isl_set_list_from_set> creates a list with a single element.
6353 Lists can be inspected using the following functions.
6355         #include <isl/set.h>
6356         int isl_set_list_n_set(__isl_keep isl_set_list *list);
6357         __isl_give isl_set *isl_set_list_get_set(
6358                 __isl_keep isl_set_list *list, int index);
6359         int isl_set_list_foreach(__isl_keep isl_set_list *list,
6360                 int (*fn)(__isl_take isl_set *el, void *user),
6361                 void *user);
6362         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
6363                 int (*follows)(__isl_keep isl_set *a,
6364                         __isl_keep isl_set *b, void *user),
6365                 void *follows_user
6366                 int (*fn)(__isl_take isl_set *el, void *user),
6367                 void *fn_user);
6369 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
6370 strongly connected components of the graph with as vertices the elements
6371 of C<list> and a directed edge from vertex C<b> to vertex C<a>
6372 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
6373 should return C<-1> on error.
6375 Lists can be printed using
6377         #include <isl/set.h>
6378         __isl_give isl_printer *isl_printer_print_set_list(
6379                 __isl_take isl_printer *p,
6380                 __isl_keep isl_set_list *list);
6382 =head2 Associative arrays
6384 Associative arrays map isl objects of a specific type to isl objects
6385 of some (other) specific type.  They are defined for several pairs
6386 of types, including (C<isl_map>, C<isl_basic_set>),
6387 (C<isl_id>, C<isl_ast_expr>) and.
6388 (C<isl_id>, C<isl_pw_aff>).
6389 Here, we take associative arrays that map C<isl_id>s to C<isl_ast_expr>s
6390 as an example.
6392 Associative arrays can be created, copied and freed using
6393 the following functions.
6395         #include <isl/id_to_ast_expr.h>
6396         __isl_give id_to_ast_expr *isl_id_to_ast_expr_alloc(
6397                 isl_ctx *ctx, int min_size);
6398         __isl_give id_to_ast_expr *isl_id_to_ast_expr_copy(
6399                 __isl_keep id_to_ast_expr *id2expr);
6400         __isl_null id_to_ast_expr *isl_id_to_ast_expr_free(
6401                 __isl_take id_to_ast_expr *id2expr);
6403 The C<min_size> argument to C<isl_id_to_ast_expr_alloc> can be used
6404 to specify the expected size of the associative array.
6405 The associative array will be grown automatically as needed.
6407 Associative arrays can be inspected using the following functions.
6409         #include <isl/id_to_ast_expr.h>
6410         int isl_id_to_ast_expr_has(
6411                 __isl_keep id_to_ast_expr *id2expr,
6412                 __isl_keep isl_id *key);
6413         __isl_give isl_ast_expr *isl_id_to_ast_expr_get(
6414                 __isl_keep id_to_ast_expr *id2expr,
6415                 __isl_take isl_id *key);
6416         int isl_id_to_ast_expr_foreach(
6417                 __isl_keep id_to_ast_expr *id2expr,
6418                 int (*fn)(__isl_take isl_id *key,
6419                         __isl_take isl_ast_expr *val, void *user),
6420                 void *user);
6422 They can be modified using the following function.
6424         #include <isl/id_to_ast_expr.h>
6425         __isl_give id_to_ast_expr *isl_id_to_ast_expr_set(
6426                 __isl_take id_to_ast_expr *id2expr,
6427                 __isl_take isl_id *key,
6428                 __isl_take isl_ast_expr *val);
6429         __isl_give id_to_ast_expr *isl_id_to_ast_expr_drop(
6430                 __isl_take id_to_ast_expr *id2expr,
6431                 __isl_take isl_id *key);
6433 Associative arrays can be printed using the following function.
6435         #include <isl/id_to_ast_expr.h>
6436         __isl_give isl_printer *isl_printer_print_id_to_ast_expr(
6437                 __isl_take isl_printer *p,
6438                 __isl_keep id_to_ast_expr *id2expr);
6440 =head2 Vectors
6442 Vectors can be created, copied and freed using the following functions.
6444         #include <isl/vec.h>
6445         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
6446                 unsigned size);
6447         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
6448         __isl_null isl_vec *isl_vec_free(__isl_take isl_vec *vec);
6450 Note that the elements of a newly created vector may have arbitrary values.
6451 The elements can be changed and inspected using the following functions.
6453         int isl_vec_size(__isl_keep isl_vec *vec);
6454         __isl_give isl_val *isl_vec_get_element_val(
6455                 __isl_keep isl_vec *vec, int pos);
6456         __isl_give isl_vec *isl_vec_set_element_si(
6457                 __isl_take isl_vec *vec, int pos, int v);
6458         __isl_give isl_vec *isl_vec_set_element_val(
6459                 __isl_take isl_vec *vec, int pos,
6460                 __isl_take isl_val *v);
6461         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
6462                 int v);
6463         __isl_give isl_vec *isl_vec_set_val(
6464                 __isl_take isl_vec *vec, __isl_take isl_val *v);
6465         int isl_vec_cmp_element(__isl_keep isl_vec *vec1,
6466                 __isl_keep isl_vec *vec2, int pos);
6468 C<isl_vec_get_element> will return a negative value if anything went wrong.
6469 In that case, the value of C<*v> is undefined.
6471 The following function can be used to concatenate two vectors.
6473         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
6474                 __isl_take isl_vec *vec2);
6476 =head2 Matrices
6478 Matrices can be created, copied and freed using the following functions.
6480         #include <isl/mat.h>
6481         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
6482                 unsigned n_row, unsigned n_col);
6483         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
6484         __isl_null isl_mat *isl_mat_free(__isl_take isl_mat *mat);
6486 Note that the elements of a newly created matrix may have arbitrary values.
6487 The elements can be changed and inspected using the following functions.
6489         int isl_mat_rows(__isl_keep isl_mat *mat);
6490         int isl_mat_cols(__isl_keep isl_mat *mat);
6491         __isl_give isl_val *isl_mat_get_element_val(
6492                 __isl_keep isl_mat *mat, int row, int col);
6493         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
6494                 int row, int col, int v);
6495         __isl_give isl_mat *isl_mat_set_element_val(
6496                 __isl_take isl_mat *mat, int row, int col,
6497                 __isl_take isl_val *v);
6499 C<isl_mat_get_element> will return a negative value if anything went wrong.
6500 In that case, the value of C<*v> is undefined.
6502 The following function can be used to compute the (right) inverse
6503 of a matrix, i.e., a matrix such that the product of the original
6504 and the inverse (in that order) is a multiple of the identity matrix.
6505 The input matrix is assumed to be of full row-rank.
6507         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
6509 The following function can be used to compute the (right) kernel
6510 (or null space) of a matrix, i.e., a matrix such that the product of
6511 the original and the kernel (in that order) is the zero matrix.
6513         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
6515 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
6517 The following functions determine
6518 an upper or lower bound on a quasipolynomial over its domain.
6520         __isl_give isl_pw_qpolynomial_fold *
6521         isl_pw_qpolynomial_bound(
6522                 __isl_take isl_pw_qpolynomial *pwqp,
6523                 enum isl_fold type, int *tight);
6525         __isl_give isl_union_pw_qpolynomial_fold *
6526         isl_union_pw_qpolynomial_bound(
6527                 __isl_take isl_union_pw_qpolynomial *upwqp,
6528                 enum isl_fold type, int *tight);
6530 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
6531 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
6532 is the returned bound is known be tight, i.e., for each value
6533 of the parameters there is at least
6534 one element in the domain that reaches the bound.
6535 If the domain of C<pwqp> is not wrapping, then the bound is computed
6536 over all elements in that domain and the result has a purely parametric
6537 domain.  If the domain of C<pwqp> is wrapping, then the bound is
6538 computed over the range of the wrapped relation.  The domain of the
6539 wrapped relation becomes the domain of the result.
6541 =head2 Parametric Vertex Enumeration
6543 The parametric vertex enumeration described in this section
6544 is mainly intended to be used internally and by the C<barvinok>
6545 library.
6547         #include <isl/vertices.h>
6548         __isl_give isl_vertices *isl_basic_set_compute_vertices(
6549                 __isl_keep isl_basic_set *bset);
6551 The function C<isl_basic_set_compute_vertices> performs the
6552 actual computation of the parametric vertices and the chamber
6553 decomposition and store the result in an C<isl_vertices> object.
6554 This information can be queried by either iterating over all
6555 the vertices or iterating over all the chambers or cells
6556 and then iterating over all vertices that are active on the chamber.
6558         int isl_vertices_foreach_vertex(
6559                 __isl_keep isl_vertices *vertices,
6560                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
6561                 void *user);
6563         int isl_vertices_foreach_cell(
6564                 __isl_keep isl_vertices *vertices,
6565                 int (*fn)(__isl_take isl_cell *cell, void *user),
6566                 void *user);
6567         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
6568                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
6569                 void *user);
6571 Other operations that can be performed on an C<isl_vertices> object are
6572 the following.
6574         int isl_vertices_get_n_vertices(
6575                 __isl_keep isl_vertices *vertices);
6576         void isl_vertices_free(__isl_take isl_vertices *vertices);
6578 Vertices can be inspected and destroyed using the following functions.
6580         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
6581         __isl_give isl_basic_set *isl_vertex_get_domain(
6582                 __isl_keep isl_vertex *vertex);
6583         __isl_give isl_multi_aff *isl_vertex_get_expr(
6584                 __isl_keep isl_vertex *vertex);
6585         void isl_vertex_free(__isl_take isl_vertex *vertex);
6587 C<isl_vertex_get_expr> returns a multiple quasi-affine expression
6588 describing the vertex in terms of the parameters,
6589 while C<isl_vertex_get_domain> returns the activity domain
6590 of the vertex.
6592 Chambers can be inspected and destroyed using the following functions.
6594         __isl_give isl_basic_set *isl_cell_get_domain(
6595                 __isl_keep isl_cell *cell);
6596         void isl_cell_free(__isl_take isl_cell *cell);
6598 =head1 Polyhedral Compilation Library
6600 This section collects functionality in C<isl> that has been specifically
6601 designed for use during polyhedral compilation.
6603 =head2 Dependence Analysis
6605 C<isl> contains specialized functionality for performing
6606 array dataflow analysis.  That is, given a I<sink> access relation
6607 and a collection of possible I<source> access relations,
6608 C<isl> can compute relations that describe
6609 for each iteration of the sink access, which iteration
6610 of which of the source access relations was the last
6611 to access the same data element before the given iteration
6612 of the sink access.
6613 The resulting dependence relations map source iterations
6614 to the corresponding sink iterations.
6615 To compute standard flow dependences, the sink should be
6616 a read, while the sources should be writes.
6617 If any of the source accesses are marked as being I<may>
6618 accesses, then there will be a dependence from the last
6619 I<must> access B<and> from any I<may> access that follows
6620 this last I<must> access.
6621 In particular, if I<all> sources are I<may> accesses,
6622 then memory based dependence analysis is performed.
6623 If, on the other hand, all sources are I<must> accesses,
6624 then value based dependence analysis is performed.
6626         #include <isl/flow.h>
6628         typedef int (*isl_access_level_before)(void *first, void *second);
6630         __isl_give isl_access_info *isl_access_info_alloc(
6631                 __isl_take isl_map *sink,
6632                 void *sink_user, isl_access_level_before fn,
6633                 int max_source);
6634         __isl_give isl_access_info *isl_access_info_add_source(
6635                 __isl_take isl_access_info *acc,
6636                 __isl_take isl_map *source, int must,
6637                 void *source_user);
6638         __isl_null isl_access_info *isl_access_info_free(
6639                 __isl_take isl_access_info *acc);
6641         __isl_give isl_flow *isl_access_info_compute_flow(
6642                 __isl_take isl_access_info *acc);
6644         int isl_flow_foreach(__isl_keep isl_flow *deps,
6645                 int (*fn)(__isl_take isl_map *dep, int must,
6646                           void *dep_user, void *user),
6647                 void *user);
6648         __isl_give isl_map *isl_flow_get_no_source(
6649                 __isl_keep isl_flow *deps, int must);
6650         void isl_flow_free(__isl_take isl_flow *deps);
6652 The function C<isl_access_info_compute_flow> performs the actual
6653 dependence analysis.  The other functions are used to construct
6654 the input for this function or to read off the output.
6656 The input is collected in an C<isl_access_info>, which can
6657 be created through a call to C<isl_access_info_alloc>.
6658 The arguments to this functions are the sink access relation
6659 C<sink>, a token C<sink_user> used to identify the sink
6660 access to the user, a callback function for specifying the
6661 relative order of source and sink accesses, and the number
6662 of source access relations that will be added.
6663 The callback function has type C<int (*)(void *first, void *second)>.
6664 The function is called with two user supplied tokens identifying
6665 either a source or the sink and it should return the shared nesting
6666 level and the relative order of the two accesses.
6667 In particular, let I<n> be the number of loops shared by
6668 the two accesses.  If C<first> precedes C<second> textually,
6669 then the function should return I<2 * n + 1>; otherwise,
6670 it should return I<2 * n>.
6671 The sources can be added to the C<isl_access_info> by performing
6672 (at most) C<max_source> calls to C<isl_access_info_add_source>.
6673 C<must> indicates whether the source is a I<must> access
6674 or a I<may> access.  Note that a multi-valued access relation
6675 should only be marked I<must> if every iteration in the domain
6676 of the relation accesses I<all> elements in its image.
6677 The C<source_user> token is again used to identify
6678 the source access.  The range of the source access relation
6679 C<source> should have the same dimension as the range
6680 of the sink access relation.
6681 The C<isl_access_info_free> function should usually not be
6682 called explicitly, because it is called implicitly by
6683 C<isl_access_info_compute_flow>.
6685 The result of the dependence analysis is collected in an
6686 C<isl_flow>.  There may be elements of
6687 the sink access for which no preceding source access could be
6688 found or for which all preceding sources are I<may> accesses.
6689 The relations containing these elements can be obtained through
6690 calls to C<isl_flow_get_no_source>, the first with C<must> set
6691 and the second with C<must> unset.
6692 In the case of standard flow dependence analysis,
6693 with the sink a read and the sources I<must> writes,
6694 the first relation corresponds to the reads from uninitialized
6695 array elements and the second relation is empty.
6696 The actual flow dependences can be extracted using
6697 C<isl_flow_foreach>.  This function will call the user-specified
6698 callback function C<fn> for each B<non-empty> dependence between
6699 a source and the sink.  The callback function is called
6700 with four arguments, the actual flow dependence relation
6701 mapping source iterations to sink iterations, a boolean that
6702 indicates whether it is a I<must> or I<may> dependence, a token
6703 identifying the source and an additional C<void *> with value
6704 equal to the third argument of the C<isl_flow_foreach> call.
6705 A dependence is marked I<must> if it originates from a I<must>
6706 source and if it is not followed by any I<may> sources.
6708 After finishing with an C<isl_flow>, the user should call
6709 C<isl_flow_free> to free all associated memory.
6711 A higher-level interface to dependence analysis is provided
6712 by the following function.
6714         #include <isl/flow.h>
6716         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
6717                 __isl_take isl_union_map *must_source,
6718                 __isl_take isl_union_map *may_source,
6719                 __isl_take isl_union_map *schedule,
6720                 __isl_give isl_union_map **must_dep,
6721                 __isl_give isl_union_map **may_dep,
6722                 __isl_give isl_union_map **must_no_source,
6723                 __isl_give isl_union_map **may_no_source);
6725 The arrays are identified by the tuple names of the ranges
6726 of the accesses.  The iteration domains by the tuple names
6727 of the domains of the accesses and of the schedule.
6728 The relative order of the iteration domains is given by the
6729 schedule.  The relations returned through C<must_no_source>
6730 and C<may_no_source> are subsets of C<sink>.
6731 Any of C<must_dep>, C<may_dep>, C<must_no_source>
6732 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
6733 any of the other arguments is treated as an error.
6735 =head3 Interaction with Dependence Analysis
6737 During the dependence analysis, we frequently need to perform
6738 the following operation.  Given a relation between sink iterations
6739 and potential source iterations from a particular source domain,
6740 what is the last potential source iteration corresponding to each
6741 sink iteration.  It can sometimes be convenient to adjust
6742 the set of potential source iterations before or after each such operation.
6743 The prototypical example is fuzzy array dataflow analysis,
6744 where we need to analyze if, based on data-dependent constraints,
6745 the sink iteration can ever be executed without one or more of
6746 the corresponding potential source iterations being executed.
6747 If so, we can introduce extra parameters and select an unknown
6748 but fixed source iteration from the potential source iterations.
6749 To be able to perform such manipulations, C<isl> provides the following
6750 function.
6752         #include <isl/flow.h>
6754         typedef __isl_give isl_restriction *(*isl_access_restrict)(
6755                 __isl_keep isl_map *source_map,
6756                 __isl_keep isl_set *sink, void *source_user,
6757                 void *user);
6758         __isl_give isl_access_info *isl_access_info_set_restrict(
6759                 __isl_take isl_access_info *acc,
6760                 isl_access_restrict fn, void *user);
6762 The function C<isl_access_info_set_restrict> should be called
6763 before calling C<isl_access_info_compute_flow> and registers a callback function
6764 that will be called any time C<isl> is about to compute the last
6765 potential source.  The first argument is the (reverse) proto-dependence,
6766 mapping sink iterations to potential source iterations.
6767 The second argument represents the sink iterations for which
6768 we want to compute the last source iteration.
6769 The third argument is the token corresponding to the source
6770 and the final argument is the token passed to C<isl_access_info_set_restrict>.
6771 The callback is expected to return a restriction on either the input or
6772 the output of the operation computing the last potential source.
6773 If the input needs to be restricted then restrictions are needed
6774 for both the source and the sink iterations.  The sink iterations
6775 and the potential source iterations will be intersected with these sets.
6776 If the output needs to be restricted then only a restriction on the source
6777 iterations is required.
6778 If any error occurs, the callback should return C<NULL>.
6779 An C<isl_restriction> object can be created, freed and inspected
6780 using the following functions.
6782         #include <isl/flow.h>
6784         __isl_give isl_restriction *isl_restriction_input(
6785                 __isl_take isl_set *source_restr,
6786                 __isl_take isl_set *sink_restr);
6787         __isl_give isl_restriction *isl_restriction_output(
6788                 __isl_take isl_set *source_restr);
6789         __isl_give isl_restriction *isl_restriction_none(
6790                 __isl_take isl_map *source_map);
6791         __isl_give isl_restriction *isl_restriction_empty(
6792                 __isl_take isl_map *source_map);
6793         __isl_null isl_restriction *isl_restriction_free(
6794                 __isl_take isl_restriction *restr);
6796 C<isl_restriction_none> and C<isl_restriction_empty> are special
6797 cases of C<isl_restriction_input>.  C<isl_restriction_none>
6798 is essentially equivalent to
6800         isl_restriction_input(isl_set_universe(
6801             isl_space_range(isl_map_get_space(source_map))),
6802                             isl_set_universe(
6803             isl_space_domain(isl_map_get_space(source_map))));
6805 whereas C<isl_restriction_empty> is essentially equivalent to
6807         isl_restriction_input(isl_set_empty(
6808             isl_space_range(isl_map_get_space(source_map))),
6809                             isl_set_universe(
6810             isl_space_domain(isl_map_get_space(source_map))));
6812 =head2 Scheduling
6814 B<The functionality described in this section is fairly new
6815 and may be subject to change.>
6817         #include <isl/schedule.h>
6818         __isl_give isl_schedule *
6819         isl_schedule_constraints_compute_schedule(
6820                 __isl_take isl_schedule_constraints *sc);
6821         __isl_null isl_schedule *isl_schedule_free(
6822                 __isl_take isl_schedule *sched);
6824 The function C<isl_schedule_constraints_compute_schedule> can be
6825 used to compute a schedule that satisfies the given schedule constraints.
6826 These schedule constraints include the iteration domain for which
6827 a schedule should be computed and dependences between pairs of
6828 iterations.  In particular, these dependences include
6829 I<validity> dependences and I<proximity> dependences.
6830 By default, the algorithm used to construct the schedule is similar
6831 to that of C<Pluto>.
6832 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
6833 be selected.
6834 The generated schedule respects all validity dependences.
6835 That is, all dependence distances over these dependences in the
6836 scheduled space are lexicographically positive.
6837 The default algorithm tries to ensure that the dependence distances
6838 over coincidence constraints are zero and to minimize the
6839 dependence distances over proximity dependences.
6840 Moreover, it tries to obtain sequences (bands) of schedule dimensions
6841 for groups of domains where the dependence distances over validity
6842 dependences have only non-negative values.
6843 When using Feautrier's algorithm, the coincidence and proximity constraints
6844 are only taken into account during the extension to a
6845 full-dimensional schedule.
6847 An C<isl_schedule_constraints> object can be constructed
6848 and manipulated using the following functions.
6850         #include <isl/schedule.h>
6851         __isl_give isl_schedule_constraints *
6852         isl_schedule_constraints_copy(
6853                 __isl_keep isl_schedule_constraints *sc);
6854         __isl_give isl_schedule_constraints *
6855         isl_schedule_constraints_on_domain(
6856                 __isl_take isl_union_set *domain);
6857         __isl_give isl_schedule_constraints *
6858         isl_schedule_constraints_set_validity(
6859                 __isl_take isl_schedule_constraints *sc,
6860                 __isl_take isl_union_map *validity);
6861         __isl_give isl_schedule_constraints *
6862         isl_schedule_constraints_set_coincidence(
6863                 __isl_take isl_schedule_constraints *sc,
6864                 __isl_take isl_union_map *coincidence);
6865         __isl_give isl_schedule_constraints *
6866         isl_schedule_constraints_set_proximity(
6867                 __isl_take isl_schedule_constraints *sc,
6868                 __isl_take isl_union_map *proximity);
6869         __isl_give isl_schedule_constraints *
6870         isl_schedule_constraints_set_conditional_validity(
6871                 __isl_take isl_schedule_constraints *sc,
6872                 __isl_take isl_union_map *condition,
6873                 __isl_take isl_union_map *validity);
6874         __isl_null isl_schedule_constraints *
6875         isl_schedule_constraints_free(
6876                 __isl_take isl_schedule_constraints *sc);
6878 The initial C<isl_schedule_constraints> object created by
6879 C<isl_schedule_constraints_on_domain> does not impose any constraints.
6880 That is, it has an empty set of dependences.
6881 The function C<isl_schedule_constraints_set_validity> replaces the
6882 validity dependences, mapping domain elements I<i> to domain
6883 elements that should be scheduled after I<i>.
6884 The function C<isl_schedule_constraints_set_coincidence> replaces the
6885 coincidence dependences, mapping domain elements I<i> to domain
6886 elements that should be scheduled together with I<I>, if possible.
6887 The function C<isl_schedule_constraints_set_proximity> replaces the
6888 proximity dependences, mapping domain elements I<i> to domain
6889 elements that should be scheduled either before I<I>
6890 or as early as possible after I<i>.
6892 The function C<isl_schedule_constraints_set_conditional_validity>
6893 replaces the conditional validity constraints.
6894 A conditional validity constraint is only imposed when any of the corresponding
6895 conditions is satisfied, i.e., when any of them is non-zero.
6896 That is, the scheduler ensures that within each band if the dependence
6897 distances over the condition constraints are not all zero
6898 then all corresponding conditional validity constraints are respected.
6899 A conditional validity constraint corresponds to a condition
6900 if the two are adjacent, i.e., if the domain of one relation intersect
6901 the range of the other relation.
6902 The typical use case of conditional validity constraints is
6903 to allow order constraints between live ranges to be violated
6904 as long as the live ranges themselves are local to the band.
6905 To allow more fine-grained control over which conditions correspond
6906 to which conditional validity constraints, the domains and ranges
6907 of these relations may include I<tags>.  That is, the domains and
6908 ranges of those relation may themselves be wrapped relations
6909 where the iteration domain appears in the domain of those wrapped relations
6910 and the range of the wrapped relations can be arbitrarily chosen
6911 by the user.  Conditions and conditional validity constraints are only
6912 considered adjacent to each other if the entire wrapped relation matches.
6913 In particular, a relation with a tag will never be considered adjacent
6914 to a relation without a tag.
6916 The following function computes a schedule directly from
6917 an iteration domain and validity and proximity dependences
6918 and is implemented in terms of the functions described above.
6919 The use of C<isl_union_set_compute_schedule> is discouraged.
6921         #include <isl/schedule.h>
6922         __isl_give isl_schedule *isl_union_set_compute_schedule(
6923                 __isl_take isl_union_set *domain,
6924                 __isl_take isl_union_map *validity,
6925                 __isl_take isl_union_map *proximity);
6927 A mapping from the domains to the scheduled space can be obtained
6928 from an C<isl_schedule> using the following function.
6930         __isl_give isl_union_map *isl_schedule_get_map(
6931                 __isl_keep isl_schedule *sched);
6933 A representation of the schedule can be printed using
6934          
6935         __isl_give isl_printer *isl_printer_print_schedule(
6936                 __isl_take isl_printer *p,
6937                 __isl_keep isl_schedule *schedule);
6939 A representation of the schedule as a forest of bands can be obtained
6940 using the following function.
6942         __isl_give isl_band_list *isl_schedule_get_band_forest(
6943                 __isl_keep isl_schedule *schedule);
6945 The individual bands can be visited in depth-first post-order
6946 using the following function.
6948         #include <isl/schedule.h>
6949         int isl_schedule_foreach_band(
6950                 __isl_keep isl_schedule *sched,
6951                 int (*fn)(__isl_keep isl_band *band, void *user),
6952                 void *user);
6954 The list can be manipulated as explained in L<"Lists">.
6955 The bands inside the list can be copied and freed using the following
6956 functions.
6958         #include <isl/band.h>
6959         __isl_give isl_band *isl_band_copy(
6960                 __isl_keep isl_band *band);
6961         __isl_null isl_band *isl_band_free(
6962                 __isl_take isl_band *band);
6964 Each band contains zero or more scheduling dimensions.
6965 These are referred to as the members of the band.
6966 The section of the schedule that corresponds to the band is
6967 referred to as the partial schedule of the band.
6968 For those nodes that participate in a band, the outer scheduling
6969 dimensions form the prefix schedule, while the inner scheduling
6970 dimensions form the suffix schedule.
6971 That is, if we take a cut of the band forest, then the union of
6972 the concatenations of the prefix, partial and suffix schedules of
6973 each band in the cut is equal to the entire schedule (modulo
6974 some possible padding at the end with zero scheduling dimensions).
6975 The properties of a band can be inspected using the following functions.
6977         #include <isl/band.h>
6978         int isl_band_has_children(__isl_keep isl_band *band);
6979         __isl_give isl_band_list *isl_band_get_children(
6980                 __isl_keep isl_band *band);
6982         __isl_give isl_union_map *isl_band_get_prefix_schedule(
6983                 __isl_keep isl_band *band);
6984         __isl_give isl_union_map *isl_band_get_partial_schedule(
6985                 __isl_keep isl_band *band);
6986         __isl_give isl_union_map *isl_band_get_suffix_schedule(
6987                 __isl_keep isl_band *band);
6989         int isl_band_n_member(__isl_keep isl_band *band);
6990         int isl_band_member_is_coincident(
6991                 __isl_keep isl_band *band, int pos);
6993         int isl_band_list_foreach_band(
6994                 __isl_keep isl_band_list *list,
6995                 int (*fn)(__isl_keep isl_band *band, void *user),
6996                 void *user);
6998 Note that a scheduling dimension is considered to be ``coincident''
6999 if it satisfies the coincidence constraints within its band.
7000 That is, if the dependence distances of the coincidence
7001 constraints are all zero in that direction (for fixed
7002 iterations of outer bands).
7003 Like C<isl_schedule_foreach_band>,
7004 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
7005 in depth-first post-order.
7007 A band can be tiled using the following function.
7009         #include <isl/band.h>
7010         int isl_band_tile(__isl_keep isl_band *band,
7011                 __isl_take isl_vec *sizes);
7013         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
7014                 int val);
7015         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
7016         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
7017                 int val);
7018         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
7020 The C<isl_band_tile> function tiles the band using the given tile sizes
7021 inside its schedule.
7022 A new child band is created to represent the point loops and it is
7023 inserted between the modified band and its children.
7024 The C<tile_scale_tile_loops> option specifies whether the tile
7025 loops iterators should be scaled by the tile sizes.
7026 If the C<tile_shift_point_loops> option is set, then the point loops
7027 are shifted to start at zero.
7029 A band can be split into two nested bands using the following function.
7031         int isl_band_split(__isl_keep isl_band *band, int pos);
7033 The resulting outer band contains the first C<pos> dimensions of C<band>
7034 while the inner band contains the remaining dimensions.
7036 A representation of the band can be printed using
7038         #include <isl/band.h>
7039         __isl_give isl_printer *isl_printer_print_band(
7040                 __isl_take isl_printer *p,
7041                 __isl_keep isl_band *band);
7043 =head3 Options
7045         #include <isl/schedule.h>
7046         int isl_options_set_schedule_max_coefficient(
7047                 isl_ctx *ctx, int val);
7048         int isl_options_get_schedule_max_coefficient(
7049                 isl_ctx *ctx);
7050         int isl_options_set_schedule_max_constant_term(
7051                 isl_ctx *ctx, int val);
7052         int isl_options_get_schedule_max_constant_term(
7053                 isl_ctx *ctx);
7054         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
7055         int isl_options_get_schedule_fuse(isl_ctx *ctx);
7056         int isl_options_set_schedule_maximize_band_depth(
7057                 isl_ctx *ctx, int val);
7058         int isl_options_get_schedule_maximize_band_depth(
7059                 isl_ctx *ctx);
7060         int isl_options_set_schedule_outer_coincidence(
7061                 isl_ctx *ctx, int val);
7062         int isl_options_get_schedule_outer_coincidence(
7063                 isl_ctx *ctx);
7064         int isl_options_set_schedule_split_scaled(
7065                 isl_ctx *ctx, int val);
7066         int isl_options_get_schedule_split_scaled(
7067                 isl_ctx *ctx);
7068         int isl_options_set_schedule_algorithm(
7069                 isl_ctx *ctx, int val);
7070         int isl_options_get_schedule_algorithm(
7071                 isl_ctx *ctx);
7072         int isl_options_set_schedule_separate_components(
7073                 isl_ctx *ctx, int val);
7074         int isl_options_get_schedule_separate_components(
7075                 isl_ctx *ctx);
7077 =over
7079 =item * schedule_max_coefficient
7081 This option enforces that the coefficients for variable and parameter
7082 dimensions in the calculated schedule are not larger than the specified value.
7083 This option can significantly increase the speed of the scheduling calculation
7084 and may also prevent fusing of unrelated dimensions. A value of -1 means that
7085 this option does not introduce bounds on the variable or parameter
7086 coefficients.
7088 =item * schedule_max_constant_term
7090 This option enforces that the constant coefficients in the calculated schedule
7091 are not larger than the maximal constant term. This option can significantly
7092 increase the speed of the scheduling calculation and may also prevent fusing of
7093 unrelated dimensions. A value of -1 means that this option does not introduce
7094 bounds on the constant coefficients.
7096 =item * schedule_fuse
7098 This option controls the level of fusion.
7099 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
7100 resulting schedule will be distributed as much as possible.
7101 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
7102 try to fuse loops in the resulting schedule.
7104 =item * schedule_maximize_band_depth
7106 If this option is set, we do not split bands at the point
7107 where we detect splitting is necessary. Instead, we
7108 backtrack and split bands as early as possible. This
7109 reduces the number of splits and maximizes the width of
7110 the bands. Wider bands give more possibilities for tiling.
7111 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
7112 then bands will be split as early as possible, even if there is no need.
7113 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
7115 =item * schedule_outer_coincidence
7117 If this option is set, then we try to construct schedules
7118 where the outermost scheduling dimension in each band
7119 satisfies the coincidence constraints.
7121 =item * schedule_split_scaled
7123 If this option is set, then we try to construct schedules in which the
7124 constant term is split off from the linear part if the linear parts of
7125 the scheduling rows for all nodes in the graphs have a common non-trivial
7126 divisor.
7127 The constant term is then placed in a separate band and the linear
7128 part is reduced.
7130 =item * schedule_algorithm
7132 Selects the scheduling algorithm to be used.
7133 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
7134 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
7136 =item * schedule_separate_components
7138 If at any point the dependence graph contains any (weakly connected) components,
7139 then these components are scheduled separately.
7140 If this option is not set, then some iterations of the domains
7141 in these components may be scheduled together.
7142 If this option is set, then the components are given consecutive
7143 schedules.
7145 =back
7147 =head2 AST Generation
7149 This section describes the C<isl> functionality for generating
7150 ASTs that visit all the elements
7151 in a domain in an order specified by a schedule.
7152 In particular, given a C<isl_union_map>, an AST is generated
7153 that visits all the elements in the domain of the C<isl_union_map>
7154 according to the lexicographic order of the corresponding image
7155 element(s).  If the range of the C<isl_union_map> consists of
7156 elements in more than one space, then each of these spaces is handled
7157 separately in an arbitrary order.
7158 It should be noted that the image elements only specify the I<order>
7159 in which the corresponding domain elements should be visited.
7160 No direct relation between the image elements and the loop iterators
7161 in the generated AST should be assumed.
7163 Each AST is generated within a build.  The initial build
7164 simply specifies the constraints on the parameters (if any)
7165 and can be created, inspected, copied and freed using the following functions.
7167         #include <isl/ast_build.h>
7168         __isl_give isl_ast_build *isl_ast_build_from_context(
7169                 __isl_take isl_set *set);
7170         __isl_give isl_ast_build *isl_ast_build_copy(
7171                 __isl_keep isl_ast_build *build);
7172         __isl_null isl_ast_build *isl_ast_build_free(
7173                 __isl_take isl_ast_build *build);
7175 The C<set> argument is usually a parameter set with zero or more parameters.
7176 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
7177 and L</"Fine-grained Control over AST Generation">.
7178 Finally, the AST itself can be constructed using the following
7179 function.
7181         #include <isl/ast_build.h>
7182         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
7183                 __isl_keep isl_ast_build *build,
7184                 __isl_take isl_union_map *schedule);
7186 =head3 Inspecting the AST
7188 The basic properties of an AST node can be obtained as follows.
7190         #include <isl/ast.h>
7191         enum isl_ast_node_type isl_ast_node_get_type(
7192                 __isl_keep isl_ast_node *node);
7194 The type of an AST node is one of
7195 C<isl_ast_node_for>,
7196 C<isl_ast_node_if>,
7197 C<isl_ast_node_block> or
7198 C<isl_ast_node_user>.
7199 An C<isl_ast_node_for> represents a for node.
7200 An C<isl_ast_node_if> represents an if node.
7201 An C<isl_ast_node_block> represents a compound node.
7202 An C<isl_ast_node_user> represents an expression statement.
7203 An expression statement typically corresponds to a domain element, i.e.,
7204 one of the elements that is visited by the AST.
7206 Each type of node has its own additional properties.
7208         #include <isl/ast.h>
7209         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
7210                 __isl_keep isl_ast_node *node);
7211         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
7212                 __isl_keep isl_ast_node *node);
7213         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
7214                 __isl_keep isl_ast_node *node);
7215         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
7216                 __isl_keep isl_ast_node *node);
7217         __isl_give isl_ast_node *isl_ast_node_for_get_body(
7218                 __isl_keep isl_ast_node *node);
7219         int isl_ast_node_for_is_degenerate(
7220                 __isl_keep isl_ast_node *node);
7222 An C<isl_ast_for> is considered degenerate if it is known to execute
7223 exactly once.
7225         #include <isl/ast.h>
7226         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
7227                 __isl_keep isl_ast_node *node);
7228         __isl_give isl_ast_node *isl_ast_node_if_get_then(
7229                 __isl_keep isl_ast_node *node);
7230         int isl_ast_node_if_has_else(
7231                 __isl_keep isl_ast_node *node);
7232         __isl_give isl_ast_node *isl_ast_node_if_get_else(
7233                 __isl_keep isl_ast_node *node);
7235         __isl_give isl_ast_node_list *
7236         isl_ast_node_block_get_children(
7237                 __isl_keep isl_ast_node *node);
7239         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
7240                 __isl_keep isl_ast_node *node);
7242 Each of the returned C<isl_ast_expr>s can in turn be inspected using
7243 the following functions.
7245         #include <isl/ast.h>
7246         enum isl_ast_expr_type isl_ast_expr_get_type(
7247                 __isl_keep isl_ast_expr *expr);
7249 The type of an AST expression is one of
7250 C<isl_ast_expr_op>,
7251 C<isl_ast_expr_id> or
7252 C<isl_ast_expr_int>.
7253 An C<isl_ast_expr_op> represents the result of an operation.
7254 An C<isl_ast_expr_id> represents an identifier.
7255 An C<isl_ast_expr_int> represents an integer value.
7257 Each type of expression has its own additional properties.
7259         #include <isl/ast.h>
7260         enum isl_ast_op_type isl_ast_expr_get_op_type(
7261                 __isl_keep isl_ast_expr *expr);
7262         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
7263         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
7264                 __isl_keep isl_ast_expr *expr, int pos);
7265         int isl_ast_node_foreach_ast_op_type(
7266                 __isl_keep isl_ast_node *node,
7267                 int (*fn)(enum isl_ast_op_type type, void *user),
7268                 void *user);
7270 C<isl_ast_expr_get_op_type> returns the type of the operation
7271 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
7272 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
7273 argument.
7274 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
7275 C<isl_ast_op_type> that appears in C<node>.
7276 The operation type is one of the following.
7278 =over
7280 =item C<isl_ast_op_and>
7282 Logical I<and> of two arguments.
7283 Both arguments can be evaluated.
7285 =item C<isl_ast_op_and_then>
7287 Logical I<and> of two arguments.
7288 The second argument can only be evaluated if the first evaluates to true.
7290 =item C<isl_ast_op_or>
7292 Logical I<or> of two arguments.
7293 Both arguments can be evaluated.
7295 =item C<isl_ast_op_or_else>
7297 Logical I<or> of two arguments.
7298 The second argument can only be evaluated if the first evaluates to false.
7300 =item C<isl_ast_op_max>
7302 Maximum of two or more arguments.
7304 =item C<isl_ast_op_min>
7306 Minimum of two or more arguments.
7308 =item C<isl_ast_op_minus>
7310 Change sign.
7312 =item C<isl_ast_op_add>
7314 Sum of two arguments.
7316 =item C<isl_ast_op_sub>
7318 Difference of two arguments.
7320 =item C<isl_ast_op_mul>
7322 Product of two arguments.
7324 =item C<isl_ast_op_div>
7326 Exact division.  That is, the result is known to be an integer.
7328 =item C<isl_ast_op_fdiv_q>
7330 Result of integer division, rounded towards negative
7331 infinity.
7333 =item C<isl_ast_op_pdiv_q>
7335 Result of integer division, where dividend is known to be non-negative.
7337 =item C<isl_ast_op_pdiv_r>
7339 Remainder of integer division, where dividend is known to be non-negative.
7341 =item C<isl_ast_op_zdiv_r>
7343 Equal to zero iff the remainder on integer division is zero.
7345 =item C<isl_ast_op_cond>
7347 Conditional operator defined on three arguments.
7348 If the first argument evaluates to true, then the result
7349 is equal to the second argument.  Otherwise, the result
7350 is equal to the third argument.
7351 The second and third argument may only be evaluated if
7352 the first argument evaluates to true and false, respectively.
7353 Corresponds to C<a ? b : c> in C.
7355 =item C<isl_ast_op_select>
7357 Conditional operator defined on three arguments.
7358 If the first argument evaluates to true, then the result
7359 is equal to the second argument.  Otherwise, the result
7360 is equal to the third argument.
7361 The second and third argument may be evaluated independently
7362 of the value of the first argument.
7363 Corresponds to C<a * b + (1 - a) * c> in C.
7365 =item C<isl_ast_op_eq>
7367 Equality relation.
7369 =item C<isl_ast_op_le>
7371 Less than or equal relation.
7373 =item C<isl_ast_op_lt>
7375 Less than relation.
7377 =item C<isl_ast_op_ge>
7379 Greater than or equal relation.
7381 =item C<isl_ast_op_gt>
7383 Greater than relation.
7385 =item C<isl_ast_op_call>
7387 A function call.
7388 The number of arguments of the C<isl_ast_expr> is one more than
7389 the number of arguments in the function call, the first argument
7390 representing the function being called.
7392 =item C<isl_ast_op_access>
7394 An array access.
7395 The number of arguments of the C<isl_ast_expr> is one more than
7396 the number of index expressions in the array access, the first argument
7397 representing the array being accessed.
7399 =item C<isl_ast_op_member>
7401 A member access.
7402 This operation has two arguments, a structure and the name of
7403 the member of the structure being accessed.
7405 =back
7407         #include <isl/ast.h>
7408         __isl_give isl_id *isl_ast_expr_get_id(
7409                 __isl_keep isl_ast_expr *expr);
7411 Return the identifier represented by the AST expression.
7413         #include <isl/ast.h>
7414         __isl_give isl_val *isl_ast_expr_get_val(
7415                 __isl_keep isl_ast_expr *expr);
7417 Return the integer represented by the AST expression.
7419 =head3 Properties of ASTs
7421         #include <isl/ast.h>
7422         int isl_ast_expr_is_equal(__isl_keep isl_ast_expr *expr1,
7423                 __isl_keep isl_ast_expr *expr2);
7425 Check if two C<isl_ast_expr>s are equal to each other.
7427 =head3 Manipulating and printing the AST
7429 AST nodes can be copied and freed using the following functions.
7431         #include <isl/ast.h>
7432         __isl_give isl_ast_node *isl_ast_node_copy(
7433                 __isl_keep isl_ast_node *node);
7434         __isl_null isl_ast_node *isl_ast_node_free(
7435                 __isl_take isl_ast_node *node);
7437 AST expressions can be copied and freed using the following functions.
7439         #include <isl/ast.h>
7440         __isl_give isl_ast_expr *isl_ast_expr_copy(
7441                 __isl_keep isl_ast_expr *expr);
7442         __isl_null isl_ast_expr *isl_ast_expr_free(
7443                 __isl_take isl_ast_expr *expr);
7445 New AST expressions can be created either directly or within
7446 the context of an C<isl_ast_build>.
7448         #include <isl/ast.h>
7449         __isl_give isl_ast_expr *isl_ast_expr_from_val(
7450                 __isl_take isl_val *v);
7451         __isl_give isl_ast_expr *isl_ast_expr_from_id(
7452                 __isl_take isl_id *id);
7453         __isl_give isl_ast_expr *isl_ast_expr_neg(
7454                 __isl_take isl_ast_expr *expr);
7455         __isl_give isl_ast_expr *isl_ast_expr_address_of(
7456                 __isl_take isl_ast_expr *expr);
7457         __isl_give isl_ast_expr *isl_ast_expr_add(
7458                 __isl_take isl_ast_expr *expr1,
7459                 __isl_take isl_ast_expr *expr2);
7460         __isl_give isl_ast_expr *isl_ast_expr_sub(
7461                 __isl_take isl_ast_expr *expr1,
7462                 __isl_take isl_ast_expr *expr2);
7463         __isl_give isl_ast_expr *isl_ast_expr_mul(
7464                 __isl_take isl_ast_expr *expr1,
7465                 __isl_take isl_ast_expr *expr2);
7466         __isl_give isl_ast_expr *isl_ast_expr_div(
7467                 __isl_take isl_ast_expr *expr1,
7468                 __isl_take isl_ast_expr *expr2);
7469         __isl_give isl_ast_expr *isl_ast_expr_and(
7470                 __isl_take isl_ast_expr *expr1,
7471                 __isl_take isl_ast_expr *expr2)
7472         __isl_give isl_ast_expr *isl_ast_expr_or(
7473                 __isl_take isl_ast_expr *expr1,
7474                 __isl_take isl_ast_expr *expr2)
7475         __isl_give isl_ast_expr *isl_ast_expr_eq(
7476                 __isl_take isl_ast_expr *expr1,
7477                 __isl_take isl_ast_expr *expr2);
7478         __isl_give isl_ast_expr *isl_ast_expr_le(
7479                 __isl_take isl_ast_expr *expr1,
7480                 __isl_take isl_ast_expr *expr2);
7481         __isl_give isl_ast_expr *isl_ast_expr_lt(
7482                 __isl_take isl_ast_expr *expr1,
7483                 __isl_take isl_ast_expr *expr2);
7484         __isl_give isl_ast_expr *isl_ast_expr_ge(
7485                 __isl_take isl_ast_expr *expr1,
7486                 __isl_take isl_ast_expr *expr2);
7487         __isl_give isl_ast_expr *isl_ast_expr_gt(
7488                 __isl_take isl_ast_expr *expr1,
7489                 __isl_take isl_ast_expr *expr2);
7490         __isl_give isl_ast_expr *isl_ast_expr_access(
7491                 __isl_take isl_ast_expr *array,
7492                 __isl_take isl_ast_expr_list *indices);
7494 The function C<isl_ast_expr_address_of> can be applied to an
7495 C<isl_ast_expr> of type C<isl_ast_op_access> only. It is meant
7496 to represent the address of the C<isl_ast_expr_access>.
7498         #include <isl/ast_build.h>
7499         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
7500                 __isl_keep isl_ast_build *build,
7501                 __isl_take isl_pw_aff *pa);
7502         __isl_give isl_ast_expr *
7503         isl_ast_build_access_from_pw_multi_aff(
7504                 __isl_keep isl_ast_build *build,
7505                 __isl_take isl_pw_multi_aff *pma);
7506         __isl_give isl_ast_expr *
7507         isl_ast_build_access_from_multi_pw_aff(
7508                 __isl_keep isl_ast_build *build,
7509                 __isl_take isl_multi_pw_aff *mpa);
7510         __isl_give isl_ast_expr *
7511         isl_ast_build_call_from_pw_multi_aff(
7512                 __isl_keep isl_ast_build *build,
7513                 __isl_take isl_pw_multi_aff *pma);
7514         __isl_give isl_ast_expr *
7515         isl_ast_build_call_from_multi_pw_aff(
7516                 __isl_keep isl_ast_build *build,
7517                 __isl_take isl_multi_pw_aff *mpa);
7519 The domains of C<pa>, C<mpa> and C<pma> should correspond
7520 to the schedule space of C<build>.
7521 The tuple id of C<mpa> or C<pma> is used as the array being accessed or
7522 the function being called.
7523 If the accessed space is a nested relation, then it is taken
7524 to represent an access of the member specified by the range
7525 of this nested relation of the structure specified by the domain
7526 of the nested relation.
7528 The following functions can be used to modify an C<isl_ast_expr>.
7530         #include <isl/ast.h>
7531         __isl_give isl_ast_expr *isl_ast_expr_set_op_arg(
7532                 __isl_take isl_ast_expr *expr, int pos,
7533                 __isl_take isl_ast_expr *arg);
7535 Replace the argument of C<expr> at position C<pos> by C<arg>.
7537         #include <isl/ast.h>
7538         __isl_give isl_ast_expr *isl_ast_expr_substitute_ids(
7539                 __isl_take isl_ast_expr *expr,
7540                 __isl_take isl_id_to_ast_expr *id2expr);
7542 The function C<isl_ast_expr_substitute_ids> replaces the
7543 subexpressions of C<expr> of type C<isl_ast_expr_id>
7544 by the corresponding expression in C<id2expr>, if there is any.
7547 User specified data can be attached to an C<isl_ast_node> and obtained
7548 from the same C<isl_ast_node> using the following functions.
7550         #include <isl/ast.h>
7551         __isl_give isl_ast_node *isl_ast_node_set_annotation(
7552                 __isl_take isl_ast_node *node,
7553                 __isl_take isl_id *annotation);
7554         __isl_give isl_id *isl_ast_node_get_annotation(
7555                 __isl_keep isl_ast_node *node);
7557 Basic printing can be performed using the following functions.
7559         #include <isl/ast.h>
7560         __isl_give isl_printer *isl_printer_print_ast_expr(
7561                 __isl_take isl_printer *p,
7562                 __isl_keep isl_ast_expr *expr);
7563         __isl_give isl_printer *isl_printer_print_ast_node(
7564                 __isl_take isl_printer *p,
7565                 __isl_keep isl_ast_node *node);
7566         __isl_give char *isl_ast_expr_to_str(
7567                 __isl_keep isl_ast_expr *expr);
7569 More advanced printing can be performed using the following functions.
7571         #include <isl/ast.h>
7572         __isl_give isl_printer *isl_ast_op_type_print_macro(
7573                 enum isl_ast_op_type type,
7574                 __isl_take isl_printer *p);
7575         __isl_give isl_printer *isl_ast_node_print_macros(
7576                 __isl_keep isl_ast_node *node,
7577                 __isl_take isl_printer *p);
7578         __isl_give isl_printer *isl_ast_node_print(
7579                 __isl_keep isl_ast_node *node,
7580                 __isl_take isl_printer *p,
7581                 __isl_take isl_ast_print_options *options);
7582         __isl_give isl_printer *isl_ast_node_for_print(
7583                 __isl_keep isl_ast_node *node,
7584                 __isl_take isl_printer *p,
7585                 __isl_take isl_ast_print_options *options);
7586         __isl_give isl_printer *isl_ast_node_if_print(
7587                 __isl_keep isl_ast_node *node,
7588                 __isl_take isl_printer *p,
7589                 __isl_take isl_ast_print_options *options);
7591 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
7592 C<isl> may print out an AST that makes use of macros such
7593 as C<floord>, C<min> and C<max>.
7594 C<isl_ast_op_type_print_macro> prints out the macro
7595 corresponding to a specific C<isl_ast_op_type>.
7596 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
7597 for expressions where these macros would be used and prints
7598 out the required macro definitions.
7599 Essentially, C<isl_ast_node_print_macros> calls
7600 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
7601 as function argument.
7602 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
7603 C<isl_ast_node_if_print> print an C<isl_ast_node>
7604 in C<ISL_FORMAT_C>, but allow for some extra control
7605 through an C<isl_ast_print_options> object.
7606 This object can be created using the following functions.
7608         #include <isl/ast.h>
7609         __isl_give isl_ast_print_options *
7610         isl_ast_print_options_alloc(isl_ctx *ctx);
7611         __isl_give isl_ast_print_options *
7612         isl_ast_print_options_copy(
7613                 __isl_keep isl_ast_print_options *options);
7614         __isl_null isl_ast_print_options *
7615         isl_ast_print_options_free(
7616                 __isl_take isl_ast_print_options *options);
7618         __isl_give isl_ast_print_options *
7619         isl_ast_print_options_set_print_user(
7620                 __isl_take isl_ast_print_options *options,
7621                 __isl_give isl_printer *(*print_user)(
7622                         __isl_take isl_printer *p,
7623                         __isl_take isl_ast_print_options *options,
7624                         __isl_keep isl_ast_node *node, void *user),
7625                 void *user);
7626         __isl_give isl_ast_print_options *
7627         isl_ast_print_options_set_print_for(
7628                 __isl_take isl_ast_print_options *options,
7629                 __isl_give isl_printer *(*print_for)(
7630                         __isl_take isl_printer *p,
7631                         __isl_take isl_ast_print_options *options,
7632                         __isl_keep isl_ast_node *node, void *user),
7633                 void *user);
7635 The callback set by C<isl_ast_print_options_set_print_user>
7636 is called whenever a node of type C<isl_ast_node_user> needs to
7637 be printed.
7638 The callback set by C<isl_ast_print_options_set_print_for>
7639 is called whenever a node of type C<isl_ast_node_for> needs to
7640 be printed.
7641 Note that C<isl_ast_node_for_print> will I<not> call the
7642 callback set by C<isl_ast_print_options_set_print_for> on the node
7643 on which C<isl_ast_node_for_print> is called, but only on nested
7644 nodes of type C<isl_ast_node_for>.  It is therefore safe to
7645 call C<isl_ast_node_for_print> from within the callback set by
7646 C<isl_ast_print_options_set_print_for>.
7648 The following option determines the type to be used for iterators
7649 while printing the AST.
7651         int isl_options_set_ast_iterator_type(
7652                 isl_ctx *ctx, const char *val);
7653         const char *isl_options_get_ast_iterator_type(
7654                 isl_ctx *ctx);
7656 The AST printer only prints body nodes as blocks if these
7657 blocks cannot be safely omitted.
7658 For example, a C<for> node with one body node will not be
7659 surrounded with braces in C<ISL_FORMAT_C>.
7660 A block will always be printed by setting the following option.
7662         int isl_options_set_ast_always_print_block(isl_ctx *ctx,
7663                 int val);
7664         int isl_options_get_ast_always_print_block(isl_ctx *ctx);
7666 =head3 Options
7668         #include <isl/ast_build.h>
7669         int isl_options_set_ast_build_atomic_upper_bound(
7670                 isl_ctx *ctx, int val);
7671         int isl_options_get_ast_build_atomic_upper_bound(
7672                 isl_ctx *ctx);
7673         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
7674                 int val);
7675         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
7676         int isl_options_set_ast_build_exploit_nested_bounds(
7677                 isl_ctx *ctx, int val);
7678         int isl_options_get_ast_build_exploit_nested_bounds(
7679                 isl_ctx *ctx);
7680         int isl_options_set_ast_build_group_coscheduled(
7681                 isl_ctx *ctx, int val);
7682         int isl_options_get_ast_build_group_coscheduled(
7683                 isl_ctx *ctx);
7684         int isl_options_set_ast_build_scale_strides(
7685                 isl_ctx *ctx, int val);
7686         int isl_options_get_ast_build_scale_strides(
7687                 isl_ctx *ctx);
7688         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
7689                 int val);
7690         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
7691         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
7692                 int val);
7693         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
7695 =over
7697 =item * ast_build_atomic_upper_bound
7699 Generate loop upper bounds that consist of the current loop iterator,
7700 an operator and an expression not involving the iterator.
7701 If this option is not set, then the current loop iterator may appear
7702 several times in the upper bound.
7703 For example, when this option is turned off, AST generation
7704 for the schedule
7706         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
7708 produces
7710         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
7711           A(c0);
7713 When the option is turned on, the following AST is generated
7715         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
7716           A(c0);
7718 =item * ast_build_prefer_pdiv
7720 If this option is turned off, then the AST generation will
7721 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
7722 operators, but no C<isl_ast_op_pdiv_q> or
7723 C<isl_ast_op_pdiv_r> operators.
7724 If this options is turned on, then C<isl> will try to convert
7725 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
7726 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
7728 =item * ast_build_exploit_nested_bounds
7730 Simplify conditions based on bounds of nested for loops.
7731 In particular, remove conditions that are implied by the fact
7732 that one or more nested loops have at least one iteration,
7733 meaning that the upper bound is at least as large as the lower bound.
7734 For example, when this option is turned off, AST generation
7735 for the schedule
7737         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
7738                                         0 <= j <= M }
7740 produces
7742         if (M >= 0)
7743           for (int c0 = 0; c0 <= N; c0 += 1)
7744             for (int c1 = 0; c1 <= M; c1 += 1)
7745               A(c0, c1);
7747 When the option is turned on, the following AST is generated
7749         for (int c0 = 0; c0 <= N; c0 += 1)
7750           for (int c1 = 0; c1 <= M; c1 += 1)
7751             A(c0, c1);
7753 =item * ast_build_group_coscheduled
7755 If two domain elements are assigned the same schedule point, then
7756 they may be executed in any order and they may even appear in different
7757 loops.  If this options is set, then the AST generator will make
7758 sure that coscheduled domain elements do not appear in separate parts
7759 of the AST.  This is useful in case of nested AST generation
7760 if the outer AST generation is given only part of a schedule
7761 and the inner AST generation should handle the domains that are
7762 coscheduled by this initial part of the schedule together.
7763 For example if an AST is generated for a schedule
7765         { A[i] -> [0]; B[i] -> [0] }
7767 then the C<isl_ast_build_set_create_leaf> callback described
7768 below may get called twice, once for each domain.
7769 Setting this option ensures that the callback is only called once
7770 on both domains together.
7772 =item * ast_build_separation_bounds
7774 This option specifies which bounds to use during separation.
7775 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
7776 then all (possibly implicit) bounds on the current dimension will
7777 be used during separation.
7778 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
7779 then only those bounds that are explicitly available will
7780 be used during separation.
7782 =item * ast_build_scale_strides
7784 This option specifies whether the AST generator is allowed
7785 to scale down iterators of strided loops.
7787 =item * ast_build_allow_else
7789 This option specifies whether the AST generator is allowed
7790 to construct if statements with else branches.
7792 =item * ast_build_allow_or
7794 This option specifies whether the AST generator is allowed
7795 to construct if conditions with disjunctions.
7797 =back
7799 =head3 Fine-grained Control over AST Generation
7801 Besides specifying the constraints on the parameters,
7802 an C<isl_ast_build> object can be used to control
7803 various aspects of the AST generation process.
7804 The most prominent way of control is through ``options'',
7805 which can be set using the following function.
7807         #include <isl/ast_build.h>
7808         __isl_give isl_ast_build *
7809         isl_ast_build_set_options(
7810                 __isl_take isl_ast_build *control,
7811                 __isl_take isl_union_map *options);
7813 The options are encoded in an C<isl_union_map>.
7814 The domain of this union relation refers to the schedule domain,
7815 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
7816 In the case of nested AST generation (see L</"Nested AST Generation">),
7817 the domain of C<options> should refer to the extra piece of the schedule.
7818 That is, it should be equal to the range of the wrapped relation in the
7819 range of the schedule.
7820 The range of the options can consist of elements in one or more spaces,
7821 the names of which determine the effect of the option.
7822 The values of the range typically also refer to the schedule dimension
7823 to which the option applies.  In case of nested AST generation
7824 (see L</"Nested AST Generation">), these values refer to the position
7825 of the schedule dimension within the innermost AST generation.
7826 The constraints on the domain elements of
7827 the option should only refer to this dimension and earlier dimensions.
7828 We consider the following spaces.
7830 =over
7832 =item C<separation_class>
7834 This space is a wrapped relation between two one dimensional spaces.
7835 The input space represents the schedule dimension to which the option
7836 applies and the output space represents the separation class.
7837 While constructing a loop corresponding to the specified schedule
7838 dimension(s), the AST generator will try to generate separate loops
7839 for domain elements that are assigned different classes.
7840 If only some of the elements are assigned a class, then those elements
7841 that are not assigned any class will be treated as belonging to a class
7842 that is separate from the explicitly assigned classes.
7843 The typical use case for this option is to separate full tiles from
7844 partial tiles.
7845 The other options, described below, are applied after the separation
7846 into classes.
7848 As an example, consider the separation into full and partial tiles
7849 of a tiling of a triangular domain.
7850 Take, for example, the domain
7852         { A[i,j] : 0 <= i,j and i + j <= 100 }
7854 and a tiling into tiles of 10 by 10.  The input to the AST generator
7855 is then the schedule
7857         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
7858                                                 i + j <= 100 }
7860 Without any options, the following AST is generated
7862         for (int c0 = 0; c0 <= 10; c0 += 1)
7863           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
7864             for (int c2 = 10 * c0;
7865                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
7866                  c2 += 1)
7867               for (int c3 = 10 * c1;
7868                    c3 <= min(10 * c1 + 9, -c2 + 100);
7869                    c3 += 1)
7870                 A(c2, c3);
7872 Separation into full and partial tiles can be obtained by assigning
7873 a class, say C<0>, to the full tiles.  The full tiles are represented by those
7874 values of the first and second schedule dimensions for which there are
7875 values of the third and fourth dimensions to cover an entire tile.
7876 That is, we need to specify the following option
7878         { [a,b,c,d] -> separation_class[[0]->[0]] :
7879                 exists b': 0 <= 10a,10b' and
7880                            10a+9+10b'+9 <= 100;
7881           [a,b,c,d] -> separation_class[[1]->[0]] :
7882                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
7884 which simplifies to
7886         { [a, b, c, d] -> separation_class[[1] -> [0]] :
7887                 a >= 0 and b >= 0 and b <= 8 - a;
7888           [a, b, c, d] -> separation_class[[0] -> [0]] :
7889                 a >= 0 and a <= 8 }
7891 With this option, the generated AST is as follows
7893         {
7894           for (int c0 = 0; c0 <= 8; c0 += 1) {
7895             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
7896               for (int c2 = 10 * c0;
7897                    c2 <= 10 * c0 + 9; c2 += 1)
7898                 for (int c3 = 10 * c1;
7899                      c3 <= 10 * c1 + 9; c3 += 1)
7900                   A(c2, c3);
7901             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
7902               for (int c2 = 10 * c0;
7903                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
7904                    c2 += 1)
7905                 for (int c3 = 10 * c1;
7906                      c3 <= min(-c2 + 100, 10 * c1 + 9);
7907                      c3 += 1)
7908                   A(c2, c3);
7909           }
7910           for (int c0 = 9; c0 <= 10; c0 += 1)
7911             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
7912               for (int c2 = 10 * c0;
7913                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
7914                    c2 += 1)
7915                 for (int c3 = 10 * c1;
7916                      c3 <= min(10 * c1 + 9, -c2 + 100);
7917                      c3 += 1)
7918                   A(c2, c3);
7919         }
7921 =item C<separate>
7923 This is a single-dimensional space representing the schedule dimension(s)
7924 to which ``separation'' should be applied.  Separation tries to split
7925 a loop into several pieces if this can avoid the generation of guards
7926 inside the loop.
7927 See also the C<atomic> option.
7929 =item C<atomic>
7931 This is a single-dimensional space representing the schedule dimension(s)
7932 for which the domains should be considered ``atomic''.  That is, the
7933 AST generator will make sure that any given domain space will only appear
7934 in a single loop at the specified level.
7936 Consider the following schedule
7938         { a[i] -> [i] : 0 <= i < 10;
7939           b[i] -> [i+1] : 0 <= i < 10 }
7941 If the following option is specified
7943         { [i] -> separate[x] }
7945 then the following AST will be generated
7947         {
7948           a(0);
7949           for (int c0 = 1; c0 <= 9; c0 += 1) {
7950             a(c0);
7951             b(c0 - 1);
7952           }
7953           b(9);
7954         }
7956 If, on the other hand, the following option is specified
7958         { [i] -> atomic[x] }
7960 then the following AST will be generated
7962         for (int c0 = 0; c0 <= 10; c0 += 1) {
7963           if (c0 <= 9)
7964             a(c0);
7965           if (c0 >= 1)
7966             b(c0 - 1);
7967         }
7969 If neither C<atomic> nor C<separate> is specified, then the AST generator
7970 may produce either of these two results or some intermediate form.
7972 =item C<unroll>
7974 This is a single-dimensional space representing the schedule dimension(s)
7975 that should be I<completely> unrolled.
7976 To obtain a partial unrolling, the user should apply an additional
7977 strip-mining to the schedule and fully unroll the inner loop.
7979 =back
7981 Additional control is available through the following functions.
7983         #include <isl/ast_build.h>
7984         __isl_give isl_ast_build *
7985         isl_ast_build_set_iterators(
7986                 __isl_take isl_ast_build *control,
7987                 __isl_take isl_id_list *iterators);
7989 The function C<isl_ast_build_set_iterators> allows the user to
7990 specify a list of iterator C<isl_id>s to be used as iterators.
7991 If the input schedule is injective, then
7992 the number of elements in this list should be as large as the dimension
7993 of the schedule space, but no direct correspondence should be assumed
7994 between dimensions and elements.
7995 If the input schedule is not injective, then an additional number
7996 of C<isl_id>s equal to the largest dimension of the input domains
7997 may be required.
7998 If the number of provided C<isl_id>s is insufficient, then additional
7999 names are automatically generated.
8001         #include <isl/ast_build.h>
8002         __isl_give isl_ast_build *
8003         isl_ast_build_set_create_leaf(
8004                 __isl_take isl_ast_build *control,
8005                 __isl_give isl_ast_node *(*fn)(
8006                         __isl_take isl_ast_build *build,
8007                         void *user), void *user);
8010 C<isl_ast_build_set_create_leaf> function allows for the
8011 specification of a callback that should be called whenever the AST
8012 generator arrives at an element of the schedule domain.
8013 The callback should return an AST node that should be inserted
8014 at the corresponding position of the AST.  The default action (when
8015 the callback is not set) is to continue generating parts of the AST to scan
8016 all the domain elements associated to the schedule domain element
8017 and to insert user nodes, ``calling'' the domain element, for each of them.
8018 The C<build> argument contains the current state of the C<isl_ast_build>.
8019 To ease nested AST generation (see L</"Nested AST Generation">),
8020 all control information that is
8021 specific to the current AST generation such as the options and
8022 the callbacks has been removed from this C<isl_ast_build>.
8023 The callback would typically return the result of a nested
8024 AST generation or a
8025 user defined node created using the following function.
8027         #include <isl/ast.h>
8028         __isl_give isl_ast_node *isl_ast_node_alloc_user(
8029                 __isl_take isl_ast_expr *expr);
8031         #include <isl/ast_build.h>
8032         __isl_give isl_ast_build *
8033         isl_ast_build_set_at_each_domain(
8034                 __isl_take isl_ast_build *build,
8035                 __isl_give isl_ast_node *(*fn)(
8036                         __isl_take isl_ast_node *node,
8037                         __isl_keep isl_ast_build *build,
8038                         void *user), void *user);
8039         __isl_give isl_ast_build *
8040         isl_ast_build_set_before_each_for(
8041                 __isl_take isl_ast_build *build,
8042                 __isl_give isl_id *(*fn)(
8043                         __isl_keep isl_ast_build *build,
8044                         void *user), void *user);
8045         __isl_give isl_ast_build *
8046         isl_ast_build_set_after_each_for(
8047                 __isl_take isl_ast_build *build,
8048                 __isl_give isl_ast_node *(*fn)(
8049                         __isl_take isl_ast_node *node,
8050                         __isl_keep isl_ast_build *build,
8051                         void *user), void *user);
8053 The callback set by C<isl_ast_build_set_at_each_domain> will
8054 be called for each domain AST node.
8055 The callbacks set by C<isl_ast_build_set_before_each_for>
8056 and C<isl_ast_build_set_after_each_for> will be called
8057 for each for AST node.  The first will be called in depth-first
8058 pre-order, while the second will be called in depth-first post-order.
8059 Since C<isl_ast_build_set_before_each_for> is called before the for
8060 node is actually constructed, it is only passed an C<isl_ast_build>.
8061 The returned C<isl_id> will be added as an annotation (using
8062 C<isl_ast_node_set_annotation>) to the constructed for node.
8063 In particular, if the user has also specified an C<after_each_for>
8064 callback, then the annotation can be retrieved from the node passed to
8065 that callback using C<isl_ast_node_get_annotation>.
8066 All callbacks should C<NULL> on failure.
8067 The given C<isl_ast_build> can be used to create new
8068 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
8069 or C<isl_ast_build_call_from_pw_multi_aff>.
8071 =head3 Nested AST Generation
8073 C<isl> allows the user to create an AST within the context
8074 of another AST.  These nested ASTs are created using the
8075 same C<isl_ast_build_ast_from_schedule> function that is used to create the
8076 outer AST.  The C<build> argument should be an C<isl_ast_build>
8077 passed to a callback set by
8078 C<isl_ast_build_set_create_leaf>.
8079 The space of the range of the C<schedule> argument should refer
8080 to this build.  In particular, the space should be a wrapped
8081 relation and the domain of this wrapped relation should be the
8082 same as that of the range of the schedule returned by
8083 C<isl_ast_build_get_schedule> below.
8084 In practice, the new schedule is typically
8085 created by calling C<isl_union_map_range_product> on the old schedule
8086 and some extra piece of the schedule.
8087 The space of the schedule domain is also available from
8088 the C<isl_ast_build>.
8090         #include <isl/ast_build.h>
8091         __isl_give isl_union_map *isl_ast_build_get_schedule(
8092                 __isl_keep isl_ast_build *build);
8093         __isl_give isl_space *isl_ast_build_get_schedule_space(
8094                 __isl_keep isl_ast_build *build);
8095         __isl_give isl_ast_build *isl_ast_build_restrict(
8096                 __isl_take isl_ast_build *build,
8097                 __isl_take isl_set *set);
8099 The C<isl_ast_build_get_schedule> function returns a (partial)
8100 schedule for the domains elements for which part of the AST still needs to
8101 be generated in the current build.
8102 In particular, the domain elements are mapped to those iterations of the loops
8103 enclosing the current point of the AST generation inside which
8104 the domain elements are executed.
8105 No direct correspondence between
8106 the input schedule and this schedule should be assumed.
8107 The space obtained from C<isl_ast_build_get_schedule_space> can be used
8108 to create a set for C<isl_ast_build_restrict> to intersect
8109 with the current build.  In particular, the set passed to
8110 C<isl_ast_build_restrict> can have additional parameters.
8111 The ids of the set dimensions in the space returned by
8112 C<isl_ast_build_get_schedule_space> correspond to the
8113 iterators of the already generated loops.
8114 The user should not rely on the ids of the output dimensions
8115 of the relations in the union relation returned by
8116 C<isl_ast_build_get_schedule> having any particular value.
8118 =head1 Applications
8120 Although C<isl> is mainly meant to be used as a library,
8121 it also contains some basic applications that use some
8122 of the functionality of C<isl>.
8123 The input may be specified in either the L<isl format>
8124 or the L<PolyLib format>.
8126 =head2 C<isl_polyhedron_sample>
8128 C<isl_polyhedron_sample> takes a polyhedron as input and prints
8129 an integer element of the polyhedron, if there is any.
8130 The first column in the output is the denominator and is always
8131 equal to 1.  If the polyhedron contains no integer points,
8132 then a vector of length zero is printed.
8134 =head2 C<isl_pip>
8136 C<isl_pip> takes the same input as the C<example> program
8137 from the C<piplib> distribution, i.e., a set of constraints
8138 on the parameters, a line containing only -1 and finally a set
8139 of constraints on a parametric polyhedron.
8140 The coefficients of the parameters appear in the last columns
8141 (but before the final constant column).
8142 The output is the lexicographic minimum of the parametric polyhedron.
8143 As C<isl> currently does not have its own output format, the output
8144 is just a dump of the internal state.
8146 =head2 C<isl_polyhedron_minimize>
8148 C<isl_polyhedron_minimize> computes the minimum of some linear
8149 or affine objective function over the integer points in a polyhedron.
8150 If an affine objective function
8151 is given, then the constant should appear in the last column.
8153 =head2 C<isl_polytope_scan>
8155 Given a polytope, C<isl_polytope_scan> prints
8156 all integer points in the polytope.
8158 =head2 C<isl_codegen>
8160 Given a schedule, a context set and an options relation,
8161 C<isl_codegen> prints out an AST that scans the domain elements
8162 of the schedule in the order of their image(s) taking into account
8163 the constraints in the context set.