scheduler: try carrying only self-dependences in the Feautrier fallback
[isl.git] / doc / user.pod
blobd192bc48a662eb6c641e49c96fcb34792856a413
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 it 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 * The function C<isl_union_pw_multi_aff_add> now consistently
216 computes the sum on the shared definition domain.
217 The function C<isl_union_pw_multi_aff_union_add> has been added
218 to compute the sum on the union of definition domains.
219 The original behavior of C<isl_union_pw_multi_aff_add> was
220 confused and is no longer available.
222 =item * Band forests have been replaced by schedule trees.
224 =item * The function C<isl_union_map_compute_flow> has been
225 replaced by the function C<isl_union_access_info_compute_flow>.
226 Note that the may dependence relation returned by
227 C<isl_union_flow_get_may_dependence> is the union of
228 the two dependence relations returned by
229 C<isl_union_map_compute_flow>.  Similarly for the no source relations.
230 The function C<isl_union_map_compute_flow> is still available
231 for backward compatibility, but it will be removed in the future.
233 =item * The function C<isl_basic_set_drop_constraint> has been
234 deprecated.
236 =item * The function C<isl_ast_build_ast_from_schedule> has been
237 renamed to C<isl_ast_build_node_from_schedule_map>.
238 The original name is still available
239 for backward compatibility, but it will be removed in the future.
241 =item * The C<separation_class> AST generation option has been
242 deprecated.
244 =item * The functions C<isl_equality_alloc> and C<isl_inequality_alloc>
245 have been renamed to C<isl_constraint_alloc_equality> and
246 C<isl_constraint_alloc_inequality>.  The original names have been
247 kept for backward compatibility, but they will be removed in the future.
249 =item * The C<schedule_fuse> option has been replaced
250 by the C<schedule_serialize_sccs> option.  The effect
251 of setting the C<schedule_fuse> option to C<ISL_SCHEDULE_FUSE_MIN>
252 is now obtained by turning on the C<schedule_serialize_sccs> option.
254 =back
256 =head3 Changes since isl-0.17
258 =over
260 =item * The function C<isl_printer_print_ast_expr> no longer prints
261 in C format by default.  To print in C format, the output format
262 of the printer needs to have been explicitly set to C<ISL_FORMAT_C>.
263 As a result, the function C<isl_ast_expr_to_str> no longer prints
264 the expression in C format.  Use C<isl_ast_expr_to_C_str> instead.
266 =item * The functions C<isl_set_align_divs> and C<isl_map_align_divs>
267 have been deprecated.  The function C<isl_set_lift> has an effect
268 that is similar to C<isl_set_align_divs> and could in some cases
269 be used as an alternative.
271 =back
273 =head1 License
275 C<isl> is released under the MIT license.
277 =over
279 Permission is hereby granted, free of charge, to any person obtaining a copy of
280 this software and associated documentation files (the "Software"), to deal in
281 the Software without restriction, including without limitation the rights to
282 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
283 of the Software, and to permit persons to whom the Software is furnished to do
284 so, subject to the following conditions:
286 The above copyright notice and this permission notice shall be included in all
287 copies or substantial portions of the Software.
289 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
290 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
291 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
292 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
293 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
294 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
295 SOFTWARE.
297 =back
299 Note that by default C<isl> requires C<GMP>, which is released
300 under the GNU Lesser General Public License (LGPL).  This means
301 that code linked against C<isl> is also linked against LGPL code.
303 When configuring with C<--with-int=imath> or C<--with-int=imath-32>, C<isl>
304 will link against C<imath>, a library for exact integer arithmetic released
305 under the MIT license.
307 =head1 Installation
309 The source of C<isl> can be obtained either as a tarball
310 or from the git repository.  Both are available from
311 L<http://isl.gforge.inria.fr/>.
312 The installation process depends on how you obtained
313 the source.
315 =head2 Installation from the git repository
317 =over
319 =item 1 Clone or update the repository
321 The first time the source is obtained, you need to clone
322 the repository.
324         git clone git://repo.or.cz/isl.git
326 To obtain updates, you need to pull in the latest changes
328         git pull
330 =item 2 Optionally get C<imath> submodule
332 To build C<isl> with C<imath>, you need to obtain the C<imath>
333 submodule by running in the git source tree of C<isl>
335        git submodule init
336        git submodule update
338 This will fetch the required version of C<imath> in a subdirectory of C<isl>.
340 =item 2 Generate C<configure>
342         ./autogen.sh
344 =back
346 After performing the above steps, continue
347 with the L<Common installation instructions>.
349 =head2 Common installation instructions
351 =over
353 =item 1 Obtain C<GMP>
355 By default, building C<isl> requires C<GMP>, including its headers files.
356 Your distribution may not provide these header files by default
357 and you may need to install a package called C<gmp-devel> or something
358 similar.  Alternatively, C<GMP> can be built from
359 source, available from L<http://gmplib.org/>.
360 C<GMP> is not needed if you build C<isl> with C<imath>.
362 =item 2 Configure
364 C<isl> uses the standard C<autoconf> C<configure> script.
365 To run it, just type
367         ./configure
369 optionally followed by some configure options.
370 A complete list of options can be obtained by running
372         ./configure --help
374 Below we discuss some of the more common options.
376 =over
378 =item C<--prefix>
380 Installation prefix for C<isl>
382 =item C<--with-int=[gmp|imath|imath-32]>
384 Select the integer library to be used by C<isl>, the default is C<gmp>.
385 With C<imath-32>, C<isl> will use 32 bit integers, but fall back to C<imath>
386 for values out of the 32 bit range. In most applications, C<isl> will run
387 fastest with the C<imath-32> option, followed by C<gmp> and C<imath>, the
388 slowest.
390 =item C<--with-gmp-prefix>
392 Installation prefix for C<GMP> (architecture-independent files).
394 =item C<--with-gmp-exec-prefix>
396 Installation prefix for C<GMP> (architecture-dependent files).
398 =back
400 =item 3 Compile
402         make
404 =item 4 Install (optional)
406         make install
408 =back
410 =head1 Integer Set Library
412 =head2 Memory Management
414 Since a high-level operation on isl objects usually involves
415 several substeps and since the user is usually not interested in
416 the intermediate results, most functions that return a new object
417 will also release all the objects passed as arguments.
418 If the user still wants to use one or more of these arguments
419 after the function call, she should pass along a copy of the
420 object rather than the object itself.
421 The user is then responsible for making sure that the original
422 object gets used somewhere else or is explicitly freed.
424 The arguments and return values of all documented functions are
425 annotated to make clear which arguments are released and which
426 arguments are preserved.  In particular, the following annotations
427 are used
429 =over
431 =item C<__isl_give>
433 C<__isl_give> means that a new object is returned.
434 The user should make sure that the returned pointer is
435 used exactly once as a value for an C<__isl_take> argument.
436 In between, it can be used as a value for as many
437 C<__isl_keep> arguments as the user likes.
438 There is one exception, and that is the case where the
439 pointer returned is C<NULL>.  Is this case, the user
440 is free to use it as an C<__isl_take> argument or not.
441 When applied to a C<char *>, the returned pointer needs to be
442 freed using C<free>.
444 =item C<__isl_null>
446 C<__isl_null> means that a C<NULL> value is returned.
448 =item C<__isl_take>
450 C<__isl_take> means that the object the argument points to
451 is taken over by the function and may no longer be used
452 by the user as an argument to any other function.
453 The pointer value must be one returned by a function
454 returning an C<__isl_give> pointer.
455 If the user passes in a C<NULL> value, then this will
456 be treated as an error in the sense that the function will
457 not perform its usual operation.  However, it will still
458 make sure that all the other C<__isl_take> arguments
459 are released.
461 =item C<__isl_keep>
463 C<__isl_keep> means that the function will only use the object
464 temporarily.  After the function has finished, the user
465 can still use it as an argument to other functions.
466 A C<NULL> value will be treated in the same way as
467 a C<NULL> value for an C<__isl_take> argument.
468 This annotation may also be used on return values of
469 type C<const char *>, in which case the returned pointer should
470 not be freed by the user and is only valid until the object
471 from which it was derived is updated or freed.
473 =back
475 =head2 Initialization
477 All manipulations of integer sets and relations occur within
478 the context of an C<isl_ctx>.
479 A given C<isl_ctx> can only be used within a single thread.
480 All arguments of a function are required to have been allocated
481 within the same context.
482 There are currently no functions available for moving an object
483 from one C<isl_ctx> to another C<isl_ctx>.  This means that
484 there is currently no way of safely moving an object from one
485 thread to another, unless the whole C<isl_ctx> is moved.
487 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
488 freed using C<isl_ctx_free>.
489 All objects allocated within an C<isl_ctx> should be freed
490 before the C<isl_ctx> itself is freed.
492         isl_ctx *isl_ctx_alloc();
493         void isl_ctx_free(isl_ctx *ctx);
495 The user can impose a bound on the number of low-level I<operations>
496 that can be performed by an C<isl_ctx>.  This bound can be set and
497 retrieved using the following functions.  A bound of zero means that
498 no bound is imposed.  The number of operations performed can be
499 reset using C<isl_ctx_reset_operations>.  Note that the number
500 of low-level operations needed to perform a high-level computation
501 may differ significantly across different versions
502 of C<isl>, but it should be the same across different platforms
503 for the same version of C<isl>.
505 Warning: This feature is experimental.  C<isl> has good support to abort and
506 bail out during the computation, but this feature may exercise error code paths
507 that are normally not used that much. Consequently, it is not unlikely that
508 hidden bugs will be exposed.
510         void isl_ctx_set_max_operations(isl_ctx *ctx,
511                 unsigned long max_operations);
512         unsigned long isl_ctx_get_max_operations(isl_ctx *ctx);
513         void isl_ctx_reset_operations(isl_ctx *ctx);
515 In order to be able to create an object in the same context
516 as another object, most object types (described later in
517 this document) provide a function to obtain the context
518 in which the object was created.
520         #include <isl/val.h>
521         isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
522         isl_ctx *isl_multi_val_get_ctx(
523                 __isl_keep isl_multi_val *mv);
525         #include <isl/id.h>
526         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
528         #include <isl/local_space.h>
529         isl_ctx *isl_local_space_get_ctx(
530                 __isl_keep isl_local_space *ls);
532         #include <isl/set.h>
533         isl_ctx *isl_set_list_get_ctx(
534                 __isl_keep isl_set_list *list);
536         #include <isl/aff.h>
537         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
538         isl_ctx *isl_multi_aff_get_ctx(
539                 __isl_keep isl_multi_aff *maff);
540         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pa);
541         isl_ctx *isl_pw_multi_aff_get_ctx(
542                 __isl_keep isl_pw_multi_aff *pma);
543         isl_ctx *isl_multi_pw_aff_get_ctx(
544                 __isl_keep isl_multi_pw_aff *mpa);
545         isl_ctx *isl_union_pw_aff_get_ctx(
546                 __isl_keep isl_union_pw_aff *upa);
547         isl_ctx *isl_union_pw_multi_aff_get_ctx(
548                 __isl_keep isl_union_pw_multi_aff *upma);
549         isl_ctx *isl_multi_union_pw_aff_get_ctx(
550                 __isl_keep isl_multi_union_pw_aff *mupa);
552         #include <isl/id_to_ast_expr.h>
553         isl_ctx *isl_id_to_ast_expr_get_ctx(
554                 __isl_keep isl_id_to_ast_expr *id2expr);
556         #include <isl/point.h>
557         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
559         #include <isl/vec.h>
560         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
562         #include <isl/mat.h>
563         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
565         #include <isl/vertices.h>
566         isl_ctx *isl_vertices_get_ctx(
567                 __isl_keep isl_vertices *vertices);
568         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
569         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
571         #include <isl/flow.h>
572         isl_ctx *isl_restriction_get_ctx(
573                 __isl_keep isl_restriction *restr);
574         isl_ctx *isl_union_access_info_get_ctx(
575                 __isl_keep isl_union_access_info *access);
576         isl_ctx *isl_union_flow_get_ctx(
577                 __isl_keep isl_union_flow *flow);
579         #include <isl/schedule.h>
580         isl_ctx *isl_schedule_get_ctx(
581                 __isl_keep isl_schedule *sched);
582         isl_ctx *isl_schedule_constraints_get_ctx(
583                 __isl_keep isl_schedule_constraints *sc);
585         #include <isl/schedule_node.h>
586         isl_ctx *isl_schedule_node_get_ctx(
587                 __isl_keep isl_schedule_node *node);
589         #include <isl/band.h>
590         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
592         #include <isl/ast_build.h>
593         isl_ctx *isl_ast_build_get_ctx(
594                 __isl_keep isl_ast_build *build);
596         #include <isl/ast.h>
597         isl_ctx *isl_ast_expr_get_ctx(
598                 __isl_keep isl_ast_expr *expr);
599         isl_ctx *isl_ast_node_get_ctx(
600                 __isl_keep isl_ast_node *node);
602 =head2 Return Types
604 C<isl> uses two special return types for functions that either return
605 a boolean or that in principle do not return anything.
606 In particular, the C<isl_bool> type has three possible values:
607 C<isl_bool_true> (a positive integer value), indicating I<true> or I<yes>;
608 C<isl_bool_false> (the integer value zero), indicating I<false> or I<no>; and
609 C<isl_bool_error> (a negative integer value), indicating that something
610 went wrong.  The following function can be used to negate an C<isl_bool>,
611 where the negation of C<isl_bool_error> is C<isl_bool_error> again.
613         #include <isl/val.h>
614         isl_bool isl_bool_not(isl_bool b);
616 The C<isl_stat> type has two possible values:
617 C<isl_stat_ok> (the integer value zero), indicating a successful
618 operation; and
619 C<isl_stat_error> (a negative integer value), indicating that something
620 went wrong.
621 See L</"Error Handling"> for more information on
622 C<isl_bool_error> and C<isl_stat_error>.
624 =head2 Values
626 An C<isl_val> represents an integer value, a rational value
627 or one of three special values, infinity, negative infinity and NaN.
628 Some predefined values can be created using the following functions.
630         #include <isl/val.h>
631         __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
632         __isl_give isl_val *isl_val_one(isl_ctx *ctx);
633         __isl_give isl_val *isl_val_negone(isl_ctx *ctx);
634         __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
635         __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
636         __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
638 Specific integer values can be created using the following functions.
640         #include <isl/val.h>
641         __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
642                 long i);
643         __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
644                 unsigned long u);
645         __isl_give isl_val *isl_val_int_from_chunks(isl_ctx *ctx,
646                 size_t n, size_t size, const void *chunks);
648 The function C<isl_val_int_from_chunks> constructs an C<isl_val>
649 from the C<n> I<digits>, each consisting of C<size> bytes, stored at C<chunks>.
650 The least significant digit is assumed to be stored first.
652 Value objects can be copied and freed using the following functions.
654         #include <isl/val.h>
655         __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
656         __isl_null isl_val *isl_val_free(__isl_take isl_val *v);
658 They can be inspected using the following functions.
660         #include <isl/val.h>
661         long isl_val_get_num_si(__isl_keep isl_val *v);
662         long isl_val_get_den_si(__isl_keep isl_val *v);
663         __isl_give isl_val *isl_val_get_den_val(
664                 __isl_keep isl_val *v);
665         double isl_val_get_d(__isl_keep isl_val *v);
666         size_t isl_val_n_abs_num_chunks(__isl_keep isl_val *v,
667                 size_t size);
668         int isl_val_get_abs_num_chunks(__isl_keep isl_val *v,
669                 size_t size, void *chunks);
671 C<isl_val_n_abs_num_chunks> returns the number of I<digits>
672 of C<size> bytes needed to store the absolute value of the
673 numerator of C<v>.
674 C<isl_val_get_abs_num_chunks> stores these digits at C<chunks>,
675 which is assumed to have been preallocated by the caller.
676 The least significant digit is stored first.
677 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si>,
678 C<isl_val_get_d>, C<isl_val_n_abs_num_chunks>
679 and C<isl_val_get_abs_num_chunks> can only be applied to rational values.
681 An C<isl_val> can be modified using the following function.
683         #include <isl/val.h>
684         __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
685                 long i);
687 The following unary properties are defined on C<isl_val>s.
689         #include <isl/val.h>
690         int isl_val_sgn(__isl_keep isl_val *v);
691         isl_bool isl_val_is_zero(__isl_keep isl_val *v);
692         isl_bool isl_val_is_one(__isl_keep isl_val *v);
693         isl_bool isl_val_is_negone(__isl_keep isl_val *v);
694         isl_bool isl_val_is_nonneg(__isl_keep isl_val *v);
695         isl_bool isl_val_is_nonpos(__isl_keep isl_val *v);
696         isl_bool isl_val_is_pos(__isl_keep isl_val *v);
697         isl_bool isl_val_is_neg(__isl_keep isl_val *v);
698         isl_bool isl_val_is_int(__isl_keep isl_val *v);
699         isl_bool isl_val_is_rat(__isl_keep isl_val *v);
700         isl_bool isl_val_is_nan(__isl_keep isl_val *v);
701         isl_bool isl_val_is_infty(__isl_keep isl_val *v);
702         isl_bool isl_val_is_neginfty(__isl_keep isl_val *v);
704 Note that the sign of NaN is undefined.
706 The following binary properties are defined on pairs of C<isl_val>s.
708         #include <isl/val.h>
709         isl_bool isl_val_lt(__isl_keep isl_val *v1,
710                 __isl_keep isl_val *v2);
711         isl_bool isl_val_le(__isl_keep isl_val *v1,
712                 __isl_keep isl_val *v2);
713         isl_bool isl_val_gt(__isl_keep isl_val *v1,
714                 __isl_keep isl_val *v2);
715         isl_bool isl_val_ge(__isl_keep isl_val *v1,
716                 __isl_keep isl_val *v2);
717         isl_bool isl_val_eq(__isl_keep isl_val *v1,
718                 __isl_keep isl_val *v2);
719         isl_bool isl_val_ne(__isl_keep isl_val *v1,
720                 __isl_keep isl_val *v2);
721         isl_bool isl_val_abs_eq(__isl_keep isl_val *v1,
722                 __isl_keep isl_val *v2);
724 The function C<isl_val_abs_eq> checks whether its two arguments
725 are equal in absolute value.
727 For integer C<isl_val>s we additionally have the following binary property.
729         #include <isl/val.h>
730         isl_bool isl_val_is_divisible_by(__isl_keep isl_val *v1,
731                 __isl_keep isl_val *v2);
733 An C<isl_val> can also be compared to an integer using the following
734 function.  The result is undefined for NaN.
736         #include <isl/val.h>
737         int isl_val_cmp_si(__isl_keep isl_val *v, long i);
739 The following unary operations are available on C<isl_val>s.
741         #include <isl/val.h>
742         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
743         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
744         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
745         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
746         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
747         __isl_give isl_val *isl_val_inv(__isl_take isl_val *v);
748         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
750 The following binary operations are available on C<isl_val>s.
752         #include <isl/val.h>
753         __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
754                 __isl_take isl_val *v2);
755         __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
756                 __isl_take isl_val *v2);
757         __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
758                 __isl_take isl_val *v2);
759         __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
760                 unsigned long v2);
761         __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
762                 __isl_take isl_val *v2);
763         __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
764                 unsigned long v2);
765         __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
766                 __isl_take isl_val *v2);
767         __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
768                 unsigned long v2);
769         __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
770                 __isl_take isl_val *v2);
771         __isl_give isl_val *isl_val_div_ui(__isl_take isl_val *v1,
772                 unsigned long v2);
774 On integer values, we additionally have the following operations.
776         #include <isl/val.h>
777         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
778         __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
779                 __isl_take isl_val *v2);
780         __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
781                 __isl_take isl_val *v2);
782         __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
783                 __isl_take isl_val *v2, __isl_give isl_val **x,
784                 __isl_give isl_val **y);
786 The function C<isl_val_gcdext> returns the greatest common divisor g
787 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
788 that C<*x> * C<v1> + C<*y> * C<v2> = g.
790 =head3 GMP specific functions
792 These functions are only available if C<isl> has been compiled with C<GMP>
793 support.
795 Specific integer and rational values can be created from C<GMP> values using
796 the following functions.
798         #include <isl/val_gmp.h>
799         __isl_give isl_val *isl_val_int_from_gmp(isl_ctx *ctx,
800                 mpz_t z);
801         __isl_give isl_val *isl_val_from_gmp(isl_ctx *ctx,
802                 const mpz_t n, const mpz_t d);
804 The numerator and denominator of a rational value can be extracted as
805 C<GMP> values using the following functions.
807         #include <isl/val_gmp.h>
808         int isl_val_get_num_gmp(__isl_keep isl_val *v, mpz_t z);
809         int isl_val_get_den_gmp(__isl_keep isl_val *v, mpz_t z);
811 =head2 Sets and Relations
813 C<isl> uses six types of objects for representing sets and relations,
814 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
815 C<isl_union_set> and C<isl_union_map>.
816 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
817 can be described as a conjunction of affine constraints, while
818 C<isl_set> and C<isl_map> represent unions of
819 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
820 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
821 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
822 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
823 where spaces are considered different if they have a different number
824 of dimensions and/or different names (see L<"Spaces">).
825 The difference between sets and relations (maps) is that sets have
826 one set of variables, while relations have two sets of variables,
827 input variables and output variables.
829 =head2 Error Handling
831 C<isl> supports different ways to react in case a runtime error is triggered.
832 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
833 with two maps that have incompatible spaces. There are three possible ways
834 to react on error: to warn, to continue or to abort.
836 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
837 the last error in the corresponding C<isl_ctx> and the function in which the
838 error was triggered returns a value indicating that some error has
839 occurred.  In case of functions returning a pointer, this value is
840 C<NULL>.  In case of functions returning an C<isl_bool> or an
841 C<isl_stat>, this valus is C<isl_bool_error> or C<isl_stat_error>.
842 An error does not corrupt internal state,
843 such that isl can continue to be used. C<isl> also provides functions to
844 read the last error and to reset the memory that stores the last error. The
845 last error is only stored for information purposes. Its presence does not
846 change the behavior of C<isl>. Hence, resetting an error is not required to
847 continue to use isl, but only to observe new errors.
849         #include <isl/ctx.h>
850         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
851         void isl_ctx_reset_error(isl_ctx *ctx);
853 Another option is to continue on error. This is similar to warn on error mode,
854 except that C<isl> does not print any warning. This allows a program to
855 implement its own error reporting.
857 The last option is to directly abort the execution of the program from within
858 the isl library. This makes it obviously impossible to recover from an error,
859 but it allows to directly spot the error location. By aborting on error,
860 debuggers break at the location the error occurred and can provide a stack
861 trace. Other tools that automatically provide stack traces on abort or that do
862 not want to continue execution after an error was triggered may also prefer to
863 abort on error.
865 The on error behavior of isl can be specified by calling
866 C<isl_options_set_on_error> or by setting the command line option
867 C<--isl-on-error>. Valid arguments for the function call are
868 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
869 choices for the command line option are C<warn>, C<continue> and C<abort>.
870 It is also possible to query the current error mode.
872         #include <isl/options.h>
873         isl_stat isl_options_set_on_error(isl_ctx *ctx, int val);
874         int isl_options_get_on_error(isl_ctx *ctx);
876 =head2 Identifiers
878 Identifiers are used to identify both individual dimensions
879 and tuples of dimensions.  They consist of an optional name and an optional
880 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
881 Identifiers with the same name but different pointer values
882 are considered to be distinct.
883 Similarly, identifiers with different names but the same pointer value
884 are also considered to be distinct.
885 Equal identifiers are represented using the same object.
886 Pairs of identifiers can therefore be tested for equality using the
887 C<==> operator.
888 Identifiers can be constructed, copied, freed, inspected and printed
889 using the following functions.
891         #include <isl/id.h>
892         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
893                 __isl_keep const char *name, void *user);
894         __isl_give isl_id *isl_id_set_free_user(
895                 __isl_take isl_id *id,
896                 void (*free_user)(void *user));
897         __isl_give isl_id *isl_id_copy(isl_id *id);
898         __isl_null isl_id *isl_id_free(__isl_take isl_id *id);
900         void *isl_id_get_user(__isl_keep isl_id *id);
901         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
903         __isl_give isl_printer *isl_printer_print_id(
904                 __isl_take isl_printer *p, __isl_keep isl_id *id);
906 The callback set by C<isl_id_set_free_user> is called on the user
907 pointer when the last reference to the C<isl_id> is freed.
908 Note that C<isl_id_get_name> returns a pointer to some internal
909 data structure, so the result can only be used while the
910 corresponding C<isl_id> is alive.
912 =head2 Spaces
914 Whenever a new set, relation or similar object is created from scratch,
915 the space in which it lives needs to be specified using an C<isl_space>.
916 Each space involves zero or more parameters and zero, one or two
917 tuples of set or input/output dimensions.  The parameters and dimensions
918 are identified by an C<isl_dim_type> and a position.
919 The type C<isl_dim_param> refers to parameters,
920 the type C<isl_dim_set> refers to set dimensions (for spaces
921 with a single tuple of dimensions) and the types C<isl_dim_in>
922 and C<isl_dim_out> refer to input and output dimensions
923 (for spaces with two tuples of dimensions).
924 Local spaces (see L</"Local Spaces">) also contain dimensions
925 of type C<isl_dim_div>.
926 Note that parameters are only identified by their position within
927 a given object.  Across different objects, parameters are (usually)
928 identified by their names or identifiers.  Only unnamed parameters
929 are identified by their positions across objects.  The use of unnamed
930 parameters is discouraged.
932         #include <isl/space.h>
933         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
934                 unsigned nparam, unsigned n_in, unsigned n_out);
935         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
936                 unsigned nparam);
937         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
938                 unsigned nparam, unsigned dim);
939         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
940         __isl_null isl_space *isl_space_free(__isl_take isl_space *space);
942 The space used for creating a parameter domain
943 needs to be created using C<isl_space_params_alloc>.
944 For other sets, the space
945 needs to be created using C<isl_space_set_alloc>, while
946 for a relation, the space
947 needs to be created using C<isl_space_alloc>.
949 To check whether a given space is that of a set or a map
950 or whether it is a parameter space, use these functions:
952         #include <isl/space.h>
953         isl_bool isl_space_is_params(__isl_keep isl_space *space);
954         isl_bool isl_space_is_set(__isl_keep isl_space *space);
955         isl_bool isl_space_is_map(__isl_keep isl_space *space);
957 Spaces can be compared using the following functions:
959         #include <isl/space.h>
960         isl_bool isl_space_is_equal(__isl_keep isl_space *space1,
961                 __isl_keep isl_space *space2);
962         isl_bool isl_space_has_equal_params(
963                 __isl_keep isl_space *space1,
964                 __isl_keep isl_space *space2);
965         isl_bool isl_space_has_equal_tuples(
966                 __isl_keep isl_space *space1,
967                 __isl_keep isl_space *space2);
968         isl_bool isl_space_is_domain(__isl_keep isl_space *space1,
969                 __isl_keep isl_space *space2);
970         isl_bool isl_space_is_range(__isl_keep isl_space *space1,
971                 __isl_keep isl_space *space2);
972         isl_bool isl_space_tuple_is_equal(
973                 __isl_keep isl_space *space1,
974                 enum isl_dim_type type1,
975                 __isl_keep isl_space *space2,
976                 enum isl_dim_type type2);
978 C<isl_space_is_domain> checks whether the first argument is equal
979 to the domain of the second argument.  This requires in particular that
980 the first argument is a set space and that the second argument
981 is a map space.  C<isl_space_tuple_is_equal> checks whether the given
982 tuples (C<isl_dim_in>, C<isl_dim_out> or C<isl_dim_set>) of the given
983 spaces are the same.  That is, it checks if they have the same
984 identifier (if any), the same dimension and the same internal structure
985 (if any).
986 The function
987 C<isl_space_has_equal_params> checks whether two spaces
988 have the same parameters in the same order.
989 C<isl_space_has_equal_tuples> check whether two spaces have
990 the same tuples.  In contrast to C<isl_space_is_equal> below,
991 it does not check the
992 parameters.  This is useful because many C<isl> functions align the
993 parameters before they perform their operations, such that equivalence
994 is not necessary.
995 C<isl_space_is_equal> checks whether two spaces are identical,
996 meaning that they have the same parameters and the same tuples.
997 That is, it checks whether both C<isl_space_has_equal_params> and
998 C<isl_space_has_equal_tuples> hold.
1000 It is often useful to create objects that live in the
1001 same space as some other object.  This can be accomplished
1002 by creating the new objects
1003 (see L</"Creating New Sets and Relations"> or
1004 L</"Functions">) based on the space
1005 of the original object.
1007         #include <isl/set.h>
1008         __isl_give isl_space *isl_basic_set_get_space(
1009                 __isl_keep isl_basic_set *bset);
1010         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
1012         #include <isl/union_set.h>
1013         __isl_give isl_space *isl_union_set_get_space(
1014                 __isl_keep isl_union_set *uset);
1016         #include <isl/map.h>
1017         __isl_give isl_space *isl_basic_map_get_space(
1018                 __isl_keep isl_basic_map *bmap);
1019         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
1021         #include <isl/union_map.h>
1022         __isl_give isl_space *isl_union_map_get_space(
1023                 __isl_keep isl_union_map *umap);
1025         #include <isl/constraint.h>
1026         __isl_give isl_space *isl_constraint_get_space(
1027                 __isl_keep isl_constraint *constraint);
1029         #include <isl/polynomial.h>
1030         __isl_give isl_space *isl_qpolynomial_get_domain_space(
1031                 __isl_keep isl_qpolynomial *qp);
1032         __isl_give isl_space *isl_qpolynomial_get_space(
1033                 __isl_keep isl_qpolynomial *qp);
1034         __isl_give isl_space *
1035         isl_qpolynomial_fold_get_domain_space(
1036                 __isl_keep isl_qpolynomial_fold *fold);
1037         __isl_give isl_space *isl_qpolynomial_fold_get_space(
1038                 __isl_keep isl_qpolynomial_fold *fold);
1039         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
1040                 __isl_keep isl_pw_qpolynomial *pwqp);
1041         __isl_give isl_space *isl_pw_qpolynomial_get_space(
1042                 __isl_keep isl_pw_qpolynomial *pwqp);
1043         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
1044                 __isl_keep isl_pw_qpolynomial_fold *pwf);
1045         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
1046                 __isl_keep isl_pw_qpolynomial_fold *pwf);
1047         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
1048                 __isl_keep isl_union_pw_qpolynomial *upwqp);
1049         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
1050                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
1052         #include <isl/val.h>
1053         __isl_give isl_space *isl_multi_val_get_space(
1054                 __isl_keep isl_multi_val *mv);
1056         #include <isl/aff.h>
1057         __isl_give isl_space *isl_aff_get_domain_space(
1058                 __isl_keep isl_aff *aff);
1059         __isl_give isl_space *isl_aff_get_space(
1060                 __isl_keep isl_aff *aff);
1061         __isl_give isl_space *isl_pw_aff_get_domain_space(
1062                 __isl_keep isl_pw_aff *pwaff);
1063         __isl_give isl_space *isl_pw_aff_get_space(
1064                 __isl_keep isl_pw_aff *pwaff);
1065         __isl_give isl_space *isl_multi_aff_get_domain_space(
1066                 __isl_keep isl_multi_aff *maff);
1067         __isl_give isl_space *isl_multi_aff_get_space(
1068                 __isl_keep isl_multi_aff *maff);
1069         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
1070                 __isl_keep isl_pw_multi_aff *pma);
1071         __isl_give isl_space *isl_pw_multi_aff_get_space(
1072                 __isl_keep isl_pw_multi_aff *pma);
1073         __isl_give isl_space *isl_union_pw_aff_get_space(
1074                 __isl_keep isl_union_pw_aff *upa);
1075         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
1076                 __isl_keep isl_union_pw_multi_aff *upma);
1077         __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
1078                 __isl_keep isl_multi_pw_aff *mpa);
1079         __isl_give isl_space *isl_multi_pw_aff_get_space(
1080                 __isl_keep isl_multi_pw_aff *mpa);
1081         __isl_give isl_space *
1082         isl_multi_union_pw_aff_get_domain_space(
1083                 __isl_keep isl_multi_union_pw_aff *mupa);
1084         __isl_give isl_space *
1085         isl_multi_union_pw_aff_get_space(
1086                 __isl_keep isl_multi_union_pw_aff *mupa);
1088         #include <isl/point.h>
1089         __isl_give isl_space *isl_point_get_space(
1090                 __isl_keep isl_point *pnt);
1092 The number of dimensions of a given type of space
1093 may be read off from a space or an object that lives
1094 in a space using the following functions.
1095 In case of C<isl_space_dim>, type may be
1096 C<isl_dim_param>, C<isl_dim_in> (only for relations),
1097 C<isl_dim_out> (only for relations), C<isl_dim_set>
1098 (only for sets) or C<isl_dim_all>.
1100         #include <isl/space.h>
1101         unsigned isl_space_dim(__isl_keep isl_space *space,
1102                 enum isl_dim_type type);
1104         #include <isl/local_space.h>
1105         int isl_local_space_dim(__isl_keep isl_local_space *ls,
1106                 enum isl_dim_type type);
1108         #include <isl/set.h>
1109         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1110                 enum isl_dim_type type);
1111         unsigned isl_set_dim(__isl_keep isl_set *set,
1112                 enum isl_dim_type type);
1114         #include <isl/union_set.h>
1115         unsigned isl_union_set_dim(__isl_keep isl_union_set *uset,
1116                 enum isl_dim_type type);
1118         #include <isl/map.h>
1119         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1120                 enum isl_dim_type type);
1121         unsigned isl_map_dim(__isl_keep isl_map *map,
1122                 enum isl_dim_type type);
1124         #include <isl/union_map.h>
1125         unsigned isl_union_map_dim(__isl_keep isl_union_map *umap,
1126                 enum isl_dim_type type);
1128         #include <isl/val.h>
1129         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
1130                 enum isl_dim_type type);
1132         #include <isl/aff.h>
1133         int isl_aff_dim(__isl_keep isl_aff *aff,
1134                 enum isl_dim_type type);
1135         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
1136                 enum isl_dim_type type);
1137         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
1138                 enum isl_dim_type type);
1139         unsigned isl_pw_multi_aff_dim(
1140                 __isl_keep isl_pw_multi_aff *pma,
1141                 enum isl_dim_type type);
1142         unsigned isl_multi_pw_aff_dim(
1143                 __isl_keep isl_multi_pw_aff *mpa,
1144                 enum isl_dim_type type);
1145         unsigned isl_union_pw_aff_dim(
1146                 __isl_keep isl_union_pw_aff *upa,
1147                 enum isl_dim_type type);
1148         unsigned isl_union_pw_multi_aff_dim(
1149                 __isl_keep isl_union_pw_multi_aff *upma,
1150                 enum isl_dim_type type);
1151         unsigned isl_multi_union_pw_aff_dim(
1152                 __isl_keep isl_multi_union_pw_aff *mupa,
1153                 enum isl_dim_type type);
1155         #include <isl/polynomial.h>
1156         unsigned isl_union_pw_qpolynomial_dim(
1157                 __isl_keep isl_union_pw_qpolynomial *upwqp,
1158                 enum isl_dim_type type);
1159         unsigned isl_union_pw_qpolynomial_fold_dim(
1160                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
1161                 enum isl_dim_type type);
1163 Note that an C<isl_union_set>, an C<isl_union_map>,
1164 an C<isl_union_pw_multi_aff>,
1165 an C<isl_union_pw_qpolynomial> and
1166 an C<isl_union_pw_qpolynomial_fold>
1167 only have parameters.
1169 The identifiers or names of the individual dimensions of spaces
1170 may be set or read off using the following functions on spaces
1171 or objects that live in spaces.
1172 These functions are mostly useful to obtain the identifiers, positions
1173 or names of the parameters.  Identifiers of individual dimensions are
1174 essentially only useful for printing.  They are ignored by all other
1175 operations and may not be preserved across those operations.
1177         #include <isl/space.h>
1178         __isl_give isl_space *isl_space_set_dim_id(
1179                 __isl_take isl_space *space,
1180                 enum isl_dim_type type, unsigned pos,
1181                 __isl_take isl_id *id);
1182         isl_bool isl_space_has_dim_id(__isl_keep isl_space *space,
1183                 enum isl_dim_type type, unsigned pos);
1184         __isl_give isl_id *isl_space_get_dim_id(
1185                 __isl_keep isl_space *space,
1186                 enum isl_dim_type type, unsigned pos);
1187         __isl_give isl_space *isl_space_set_dim_name(
1188                 __isl_take isl_space *space,
1189                  enum isl_dim_type type, unsigned pos,
1190                  __isl_keep const char *name);
1191         isl_bool isl_space_has_dim_name(__isl_keep isl_space *space,
1192                 enum isl_dim_type type, unsigned pos);
1193         __isl_keep const char *isl_space_get_dim_name(
1194                 __isl_keep isl_space *space,
1195                 enum isl_dim_type type, unsigned pos);
1197         #include <isl/local_space.h>
1198         __isl_give isl_local_space *isl_local_space_set_dim_id(
1199                 __isl_take isl_local_space *ls,
1200                 enum isl_dim_type type, unsigned pos,
1201                 __isl_take isl_id *id);
1202         isl_bool isl_local_space_has_dim_id(
1203                 __isl_keep isl_local_space *ls,
1204                 enum isl_dim_type type, unsigned pos);
1205         __isl_give isl_id *isl_local_space_get_dim_id(
1206                 __isl_keep isl_local_space *ls,
1207                 enum isl_dim_type type, unsigned pos);
1208         __isl_give isl_local_space *isl_local_space_set_dim_name(
1209                 __isl_take isl_local_space *ls,
1210                 enum isl_dim_type type, unsigned pos, const char *s);
1211         isl_bool isl_local_space_has_dim_name(
1212                 __isl_keep isl_local_space *ls,
1213                 enum isl_dim_type type, unsigned pos)
1214         const char *isl_local_space_get_dim_name(
1215                 __isl_keep isl_local_space *ls,
1216                 enum isl_dim_type type, unsigned pos);
1218         #include <isl/constraint.h>
1219         const char *isl_constraint_get_dim_name(
1220                 __isl_keep isl_constraint *constraint,
1221                 enum isl_dim_type type, unsigned pos);
1223         #include <isl/set.h>
1224         __isl_give isl_id *isl_basic_set_get_dim_id(
1225                 __isl_keep isl_basic_set *bset,
1226                 enum isl_dim_type type, unsigned pos);
1227         __isl_give isl_set *isl_set_set_dim_id(
1228                 __isl_take isl_set *set, enum isl_dim_type type,
1229                 unsigned pos, __isl_take isl_id *id);
1230         isl_bool isl_set_has_dim_id(__isl_keep isl_set *set,
1231                 enum isl_dim_type type, unsigned pos);
1232         __isl_give isl_id *isl_set_get_dim_id(
1233                 __isl_keep isl_set *set, enum isl_dim_type type,
1234                 unsigned pos);
1235         const char *isl_basic_set_get_dim_name(
1236                 __isl_keep isl_basic_set *bset,
1237                 enum isl_dim_type type, unsigned pos);
1238         isl_bool isl_set_has_dim_name(__isl_keep isl_set *set,
1239                 enum isl_dim_type type, unsigned pos);
1240         const char *isl_set_get_dim_name(
1241                 __isl_keep isl_set *set,
1242                 enum isl_dim_type type, unsigned pos);
1244         #include <isl/map.h>
1245         __isl_give isl_map *isl_map_set_dim_id(
1246                 __isl_take isl_map *map, enum isl_dim_type type,
1247                 unsigned pos, __isl_take isl_id *id);
1248         isl_bool isl_basic_map_has_dim_id(
1249                 __isl_keep isl_basic_map *bmap,
1250                 enum isl_dim_type type, unsigned pos);
1251         isl_bool isl_map_has_dim_id(__isl_keep isl_map *map,
1252                 enum isl_dim_type type, unsigned pos);
1253         __isl_give isl_id *isl_map_get_dim_id(
1254                 __isl_keep isl_map *map, enum isl_dim_type type,
1255                 unsigned pos);
1256         __isl_give isl_id *isl_union_map_get_dim_id(
1257                 __isl_keep isl_union_map *umap,
1258                 enum isl_dim_type type, unsigned pos);
1259         const char *isl_basic_map_get_dim_name(
1260                 __isl_keep isl_basic_map *bmap,
1261                 enum isl_dim_type type, unsigned pos);
1262         isl_bool isl_map_has_dim_name(__isl_keep isl_map *map,
1263                 enum isl_dim_type type, unsigned pos);
1264         const char *isl_map_get_dim_name(
1265                 __isl_keep isl_map *map,
1266                 enum isl_dim_type type, unsigned pos);
1268         #include <isl/val.h>
1269         __isl_give isl_multi_val *isl_multi_val_set_dim_id(
1270                 __isl_take isl_multi_val *mv,
1271                 enum isl_dim_type type, unsigned pos,
1272                 __isl_take isl_id *id);
1273         __isl_give isl_id *isl_multi_val_get_dim_id(
1274                 __isl_keep isl_multi_val *mv,
1275                 enum isl_dim_type type, unsigned pos);
1276         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
1277                 __isl_take isl_multi_val *mv,
1278                 enum isl_dim_type type, unsigned pos, const char *s);
1280         #include <isl/aff.h>
1281         __isl_give isl_aff *isl_aff_set_dim_id(
1282                 __isl_take isl_aff *aff, enum isl_dim_type type,
1283                 unsigned pos, __isl_take isl_id *id);
1284         __isl_give isl_multi_aff *isl_multi_aff_set_dim_id(
1285                 __isl_take isl_multi_aff *maff,
1286                 enum isl_dim_type type, unsigned pos,
1287                 __isl_take isl_id *id);
1288         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
1289                 __isl_take isl_pw_aff *pma,
1290                 enum isl_dim_type type, unsigned pos,
1291                 __isl_take isl_id *id);
1292         __isl_give isl_multi_pw_aff *
1293         isl_multi_pw_aff_set_dim_id(
1294                 __isl_take isl_multi_pw_aff *mpa,
1295                 enum isl_dim_type type, unsigned pos,
1296                 __isl_take isl_id *id);
1297         __isl_give isl_multi_union_pw_aff *
1298         isl_multi_union_pw_aff_set_dim_id(
1299                 __isl_take isl_multi_union_pw_aff *mupa,
1300                 enum isl_dim_type type, unsigned pos,
1301                 __isl_take isl_id *id);
1302         __isl_give isl_id *isl_multi_aff_get_dim_id(
1303                 __isl_keep isl_multi_aff *ma,
1304                 enum isl_dim_type type, unsigned pos);
1305         isl_bool isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
1306                 enum isl_dim_type type, unsigned pos);
1307         __isl_give isl_id *isl_pw_aff_get_dim_id(
1308                 __isl_keep isl_pw_aff *pa,
1309                 enum isl_dim_type type, unsigned pos);
1310         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
1311                 __isl_keep isl_pw_multi_aff *pma,
1312                 enum isl_dim_type type, unsigned pos);
1313         __isl_give isl_id *isl_multi_pw_aff_get_dim_id(
1314                 __isl_keep isl_multi_pw_aff *mpa,
1315                 enum isl_dim_type type, unsigned pos);
1316         __isl_give isl_id *isl_multi_union_pw_aff_get_dim_id(
1317                 __isl_keep isl_multi_union_pw_aff *mupa,
1318                 enum isl_dim_type type, unsigned pos);
1319         __isl_give isl_aff *isl_aff_set_dim_name(
1320                 __isl_take isl_aff *aff, enum isl_dim_type type,
1321                 unsigned pos, const char *s);
1322         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
1323                 __isl_take isl_multi_aff *maff,
1324                 enum isl_dim_type type, unsigned pos, const char *s);
1325         __isl_give isl_multi_pw_aff *
1326         isl_multi_pw_aff_set_dim_name(
1327                 __isl_take isl_multi_pw_aff *mpa,
1328                 enum isl_dim_type type, unsigned pos, const char *s);
1329         __isl_give isl_union_pw_aff *
1330         isl_union_pw_aff_set_dim_name(
1331                 __isl_take isl_union_pw_aff *upa,
1332                 enum isl_dim_type type, unsigned pos,
1333                 const char *s);
1334         __isl_give isl_union_pw_multi_aff *
1335         isl_union_pw_multi_aff_set_dim_name(
1336                 __isl_take isl_union_pw_multi_aff *upma,
1337                 enum isl_dim_type type, unsigned pos,
1338                 const char *s);
1339         __isl_give isl_multi_union_pw_aff *
1340         isl_multi_union_pw_aff_set_dim_name(
1341                 __isl_take isl_multi_union_pw_aff *mupa,
1342                 enum isl_dim_type type, unsigned pos,
1343         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
1344                 enum isl_dim_type type, unsigned pos);
1345         const char *isl_pw_aff_get_dim_name(
1346                 __isl_keep isl_pw_aff *pa,
1347                 enum isl_dim_type type, unsigned pos);
1348         const char *isl_pw_multi_aff_get_dim_name(
1349                 __isl_keep isl_pw_multi_aff *pma,
1350                 enum isl_dim_type type, unsigned pos);
1352         #include <isl/polynomial.h>
1353         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
1354                 __isl_take isl_qpolynomial *qp,
1355                 enum isl_dim_type type, unsigned pos,
1356                 const char *s);
1357         __isl_give isl_pw_qpolynomial *
1358         isl_pw_qpolynomial_set_dim_name(
1359                 __isl_take isl_pw_qpolynomial *pwqp,
1360                 enum isl_dim_type type, unsigned pos,
1361                 const char *s);
1362         __isl_give isl_pw_qpolynomial_fold *
1363         isl_pw_qpolynomial_fold_set_dim_name(
1364                 __isl_take isl_pw_qpolynomial_fold *pwf,
1365                 enum isl_dim_type type, unsigned pos,
1366                 const char *s);
1367         __isl_give isl_union_pw_qpolynomial *
1368         isl_union_pw_qpolynomial_set_dim_name(
1369                 __isl_take isl_union_pw_qpolynomial *upwqp,
1370                 enum isl_dim_type type, unsigned pos,
1371                 const char *s);
1372         __isl_give isl_union_pw_qpolynomial_fold *
1373         isl_union_pw_qpolynomial_fold_set_dim_name(
1374                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
1375                 enum isl_dim_type type, unsigned pos,
1376                 const char *s);
1378 Note that C<isl_space_get_name> returns a pointer to some internal
1379 data structure, so the result can only be used while the
1380 corresponding C<isl_space> is alive.
1381 Also note that every function that operates on two sets or relations
1382 requires that both arguments have the same parameters.  This also
1383 means that if one of the arguments has named parameters, then the
1384 other needs to have named parameters too and the names need to match.
1385 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
1386 arguments may have different parameters (as long as they are named),
1387 in which case the result will have as parameters the union of the parameters of
1388 the arguments.
1390 Given the identifier or name of a dimension (typically a parameter),
1391 its position can be obtained from the following functions.
1393         #include <isl/space.h>
1394         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
1395                 enum isl_dim_type type, __isl_keep isl_id *id);
1396         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
1397                 enum isl_dim_type type, const char *name);
1399         #include <isl/local_space.h>
1400         int isl_local_space_find_dim_by_name(
1401                 __isl_keep isl_local_space *ls,
1402                 enum isl_dim_type type, const char *name);
1404         #include <isl/val.h>
1405         int isl_multi_val_find_dim_by_id(
1406                 __isl_keep isl_multi_val *mv,
1407                 enum isl_dim_type type, __isl_keep isl_id *id);
1408         int isl_multi_val_find_dim_by_name(
1409                 __isl_keep isl_multi_val *mv,
1410                 enum isl_dim_type type, const char *name);
1412         #include <isl/set.h>
1413         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1414                 enum isl_dim_type type, __isl_keep isl_id *id);
1415         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1416                 enum isl_dim_type type, const char *name);
1418         #include <isl/map.h>
1419         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1420                 enum isl_dim_type type, __isl_keep isl_id *id);
1421         int isl_basic_map_find_dim_by_name(
1422                 __isl_keep isl_basic_map *bmap,
1423                 enum isl_dim_type type, const char *name);
1424         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1425                 enum isl_dim_type type, const char *name);
1426         int isl_union_map_find_dim_by_name(
1427                 __isl_keep isl_union_map *umap,
1428                 enum isl_dim_type type, const char *name);
1430         #include <isl/aff.h>
1431         int isl_multi_aff_find_dim_by_id(
1432                 __isl_keep isl_multi_aff *ma,
1433                 enum isl_dim_type type, __isl_keep isl_id *id);
1434         int isl_multi_pw_aff_find_dim_by_id(
1435                 __isl_keep isl_multi_pw_aff *mpa,
1436                 enum isl_dim_type type, __isl_keep isl_id *id);
1437         int isl_multi_union_pw_aff_find_dim_by_id(
1438                 __isl_keep isl_union_multi_pw_aff *mupa,
1439                 enum isl_dim_type type, __isl_keep isl_id *id);
1440         int isl_aff_find_dim_by_name(__isl_keep isl_aff *aff,
1441                 enum isl_dim_type type, const char *name);
1442         int isl_multi_aff_find_dim_by_name(
1443                 __isl_keep isl_multi_aff *ma,
1444                 enum isl_dim_type type, const char *name);
1445         int isl_pw_aff_find_dim_by_name(__isl_keep isl_pw_aff *pa,
1446                 enum isl_dim_type type, const char *name);
1447         int isl_multi_pw_aff_find_dim_by_name(
1448                 __isl_keep isl_multi_pw_aff *mpa,
1449                 enum isl_dim_type type, const char *name);
1450         int isl_pw_multi_aff_find_dim_by_name(
1451                 __isl_keep isl_pw_multi_aff *pma,
1452                 enum isl_dim_type type, const char *name);
1453         int isl_union_pw_aff_find_dim_by_name(
1454                 __isl_keep isl_union_pw_aff *upa,
1455                 enum isl_dim_type type, const char *name);
1456         int isl_union_pw_multi_aff_find_dim_by_name(
1457                 __isl_keep isl_union_pw_multi_aff *upma,
1458                 enum isl_dim_type type, const char *name);
1459         int isl_multi_union_pw_aff_find_dim_by_name(
1460                 __isl_keep isl_multi_union_pw_aff *mupa,
1461                 enum isl_dim_type type, const char *name);
1463         #include <isl/polynomial.h>
1464         int isl_pw_qpolynomial_find_dim_by_name(
1465                 __isl_keep isl_pw_qpolynomial *pwqp,
1466                 enum isl_dim_type type, const char *name);
1467         int isl_pw_qpolynomial_fold_find_dim_by_name(
1468                 __isl_keep isl_pw_qpolynomial_fold *pwf,
1469                 enum isl_dim_type type, const char *name);
1470         int isl_union_pw_qpolynomial_find_dim_by_name(
1471                 __isl_keep isl_union_pw_qpolynomial *upwqp,
1472                 enum isl_dim_type type, const char *name);
1473         int isl_union_pw_qpolynomial_fold_find_dim_by_name(
1474                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
1475                 enum isl_dim_type type, const char *name);
1477 The identifiers or names of entire spaces may be set or read off
1478 using the following functions.
1480         #include <isl/space.h>
1481         __isl_give isl_space *isl_space_set_tuple_id(
1482                 __isl_take isl_space *space,
1483                 enum isl_dim_type type, __isl_take isl_id *id);
1484         __isl_give isl_space *isl_space_reset_tuple_id(
1485                 __isl_take isl_space *space, enum isl_dim_type type);
1486         isl_bool isl_space_has_tuple_id(
1487                 __isl_keep isl_space *space,
1488                 enum isl_dim_type type);
1489         __isl_give isl_id *isl_space_get_tuple_id(
1490                 __isl_keep isl_space *space, enum isl_dim_type type);
1491         __isl_give isl_space *isl_space_set_tuple_name(
1492                 __isl_take isl_space *space,
1493                 enum isl_dim_type type, const char *s);
1494         isl_bool isl_space_has_tuple_name(
1495                 __isl_keep isl_space *space,
1496                 enum isl_dim_type type);
1497         __isl_keep const char *isl_space_get_tuple_name(
1498                 __isl_keep isl_space *space,
1499                 enum isl_dim_type type);
1501         #include <isl/local_space.h>
1502         __isl_give isl_local_space *isl_local_space_set_tuple_id(
1503                 __isl_take isl_local_space *ls,
1504                 enum isl_dim_type type, __isl_take isl_id *id);
1506         #include <isl/set.h>
1507         __isl_give isl_basic_set *isl_basic_set_set_tuple_id(
1508                 __isl_take isl_basic_set *bset,
1509                 __isl_take isl_id *id);
1510         __isl_give isl_set *isl_set_set_tuple_id(
1511                 __isl_take isl_set *set, __isl_take isl_id *id);
1512         __isl_give isl_set *isl_set_reset_tuple_id(
1513                 __isl_take isl_set *set);
1514         isl_bool isl_set_has_tuple_id(__isl_keep isl_set *set);
1515         __isl_give isl_id *isl_set_get_tuple_id(
1516                 __isl_keep isl_set *set);
1517         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1518                 __isl_take isl_basic_set *set, const char *s);
1519         __isl_give isl_set *isl_set_set_tuple_name(
1520                 __isl_take isl_set *set, const char *s);
1521         const char *isl_basic_set_get_tuple_name(
1522                 __isl_keep isl_basic_set *bset);
1523         isl_bool isl_set_has_tuple_name(__isl_keep isl_set *set);
1524         const char *isl_set_get_tuple_name(
1525                 __isl_keep isl_set *set);
1527         #include <isl/map.h>
1528         __isl_give isl_basic_map *isl_basic_map_set_tuple_id(
1529                 __isl_take isl_basic_map *bmap,
1530                 enum isl_dim_type type, __isl_take isl_id *id);
1531         __isl_give isl_map *isl_map_set_tuple_id(
1532                 __isl_take isl_map *map, enum isl_dim_type type,
1533                 __isl_take isl_id *id);
1534         __isl_give isl_map *isl_map_reset_tuple_id(
1535                 __isl_take isl_map *map, enum isl_dim_type type);
1536         isl_bool isl_map_has_tuple_id(__isl_keep isl_map *map,
1537                 enum isl_dim_type type);
1538         __isl_give isl_id *isl_map_get_tuple_id(
1539                 __isl_keep isl_map *map, enum isl_dim_type type);
1540         __isl_give isl_map *isl_map_set_tuple_name(
1541                 __isl_take isl_map *map,
1542                 enum isl_dim_type type, const char *s);
1543         const char *isl_basic_map_get_tuple_name(
1544                 __isl_keep isl_basic_map *bmap,
1545                 enum isl_dim_type type);
1546         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1547                 __isl_take isl_basic_map *bmap,
1548                 enum isl_dim_type type, const char *s);
1549         isl_bool isl_map_has_tuple_name(__isl_keep isl_map *map,
1550                 enum isl_dim_type type);
1551         const char *isl_map_get_tuple_name(
1552                 __isl_keep isl_map *map,
1553                 enum isl_dim_type type);
1555         #include <isl/val.h>
1556         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
1557                 __isl_take isl_multi_val *mv,
1558                 enum isl_dim_type type, __isl_take isl_id *id);
1559         __isl_give isl_multi_val *isl_multi_val_reset_tuple_id(
1560                 __isl_take isl_multi_val *mv,
1561                 enum isl_dim_type type);
1562         isl_bool isl_multi_val_has_tuple_id(
1563                 __isl_keep isl_multi_val *mv,
1564                 enum isl_dim_type type);
1565         __isl_give isl_id *isl_multi_val_get_tuple_id(
1566                 __isl_keep isl_multi_val *mv,
1567                 enum isl_dim_type type);
1568         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
1569                 __isl_take isl_multi_val *mv,
1570                 enum isl_dim_type type, const char *s);
1571         const char *isl_multi_val_get_tuple_name(
1572                 __isl_keep isl_multi_val *mv,
1573                 enum isl_dim_type type);
1575         #include <isl/aff.h>
1576         __isl_give isl_aff *isl_aff_set_tuple_id(
1577                 __isl_take isl_aff *aff,
1578                 enum isl_dim_type type, __isl_take isl_id *id);
1579         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
1580                 __isl_take isl_multi_aff *maff,
1581                 enum isl_dim_type type, __isl_take isl_id *id);
1582         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
1583                 __isl_take isl_pw_aff *pwaff,
1584                 enum isl_dim_type type, __isl_take isl_id *id);
1585         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
1586                 __isl_take isl_pw_multi_aff *pma,
1587                 enum isl_dim_type type, __isl_take isl_id *id);
1588         __isl_give isl_multi_union_pw_aff *
1589         isl_multi_union_pw_aff_set_tuple_id(
1590                 __isl_take isl_multi_union_pw_aff *mupa,
1591                 enum isl_dim_type type, __isl_take isl_id *id);
1592         __isl_give isl_multi_aff *isl_multi_aff_reset_tuple_id(
1593                 __isl_take isl_multi_aff *ma,
1594                 enum isl_dim_type type);
1595         __isl_give isl_pw_aff *isl_pw_aff_reset_tuple_id(
1596                 __isl_take isl_pw_aff *pa,
1597                 enum isl_dim_type type);
1598         __isl_give isl_multi_pw_aff *
1599         isl_multi_pw_aff_reset_tuple_id(
1600                 __isl_take isl_multi_pw_aff *mpa,
1601                 enum isl_dim_type type);
1602         __isl_give isl_pw_multi_aff *
1603         isl_pw_multi_aff_reset_tuple_id(
1604                 __isl_take isl_pw_multi_aff *pma,
1605                 enum isl_dim_type type);
1606         __isl_give isl_multi_union_pw_aff *
1607         isl_multi_union_pw_aff_reset_tuple_id(
1608                 __isl_take isl_multi_union_pw_aff *mupa,
1609                 enum isl_dim_type type);
1610         isl_bool isl_multi_aff_has_tuple_id(
1611                 __isl_keep isl_multi_aff *ma,
1612                 enum isl_dim_type type);
1613         __isl_give isl_id *isl_multi_aff_get_tuple_id(
1614                 __isl_keep isl_multi_aff *ma,
1615                 enum isl_dim_type type);
1616         isl_bool isl_pw_aff_has_tuple_id(__isl_keep isl_pw_aff *pa,
1617                 enum isl_dim_type type);
1618         __isl_give isl_id *isl_pw_aff_get_tuple_id(
1619                 __isl_keep isl_pw_aff *pa,
1620                 enum isl_dim_type type);
1621         isl_bool isl_pw_multi_aff_has_tuple_id(
1622                 __isl_keep isl_pw_multi_aff *pma,
1623                 enum isl_dim_type type);
1624         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
1625                 __isl_keep isl_pw_multi_aff *pma,
1626                 enum isl_dim_type type);
1627         isl_bool isl_multi_pw_aff_has_tuple_id(
1628                 __isl_keep isl_multi_pw_aff *mpa,
1629                 enum isl_dim_type type);
1630         __isl_give isl_id *isl_multi_pw_aff_get_tuple_id(
1631                 __isl_keep isl_multi_pw_aff *mpa,
1632                 enum isl_dim_type type);
1633         isl_bool isl_multi_union_pw_aff_has_tuple_id(
1634                 __isl_keep isl_multi_union_pw_aff *mupa,
1635                 enum isl_dim_type type);
1636         __isl_give isl_id *isl_multi_union_pw_aff_get_tuple_id(
1637                 __isl_keep isl_multi_union_pw_aff *mupa,
1638                 enum isl_dim_type type);
1639         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
1640                 __isl_take isl_multi_aff *maff,
1641                 enum isl_dim_type type, const char *s);
1642         __isl_give isl_multi_pw_aff *
1643         isl_multi_pw_aff_set_tuple_name(
1644                 __isl_take isl_multi_pw_aff *mpa,
1645                 enum isl_dim_type type, const char *s);
1646         __isl_give isl_multi_union_pw_aff *
1647         isl_multi_union_pw_aff_set_tuple_name(
1648                 __isl_take isl_multi_union_pw_aff *mupa,
1649                 enum isl_dim_type type, const char *s);
1650         const char *isl_multi_aff_get_tuple_name(
1651                 __isl_keep isl_multi_aff *multi,
1652                 enum isl_dim_type type);
1653         isl_bool isl_pw_multi_aff_has_tuple_name(
1654                 __isl_keep isl_pw_multi_aff *pma,
1655                 enum isl_dim_type type);
1656         const char *isl_pw_multi_aff_get_tuple_name(
1657                 __isl_keep isl_pw_multi_aff *pma,
1658                 enum isl_dim_type type);
1659         const char *isl_multi_union_pw_aff_get_tuple_name(
1660                 __isl_keep isl_multi_union_pw_aff *mupa,
1661                 enum isl_dim_type type);
1663 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
1664 or C<isl_dim_set>.  As with C<isl_space_get_name>,
1665 the C<isl_space_get_tuple_name> function returns a pointer to some internal
1666 data structure.
1667 Binary operations require the corresponding spaces of their arguments
1668 to have the same name.
1670 To keep the names of all parameters and tuples, but reset the user pointers
1671 of all the corresponding identifiers, use the following function.
1673         #include <isl/space.h>
1674         __isl_give isl_space *isl_space_reset_user(
1675                 __isl_take isl_space *space);
1677         #include <isl/set.h>
1678         __isl_give isl_set *isl_set_reset_user(
1679                 __isl_take isl_set *set);
1681         #include <isl/map.h>
1682         __isl_give isl_map *isl_map_reset_user(
1683                 __isl_take isl_map *map);
1685         #include <isl/union_set.h>
1686         __isl_give isl_union_set *isl_union_set_reset_user(
1687                 __isl_take isl_union_set *uset);
1689         #include <isl/union_map.h>
1690         __isl_give isl_union_map *isl_union_map_reset_user(
1691                 __isl_take isl_union_map *umap);
1693         #include <isl/val.h>
1694         __isl_give isl_multi_val *isl_multi_val_reset_user(
1695                 __isl_take isl_multi_val *mv);
1697         #include <isl/aff.h>
1698         __isl_give isl_multi_aff *isl_multi_aff_reset_user(
1699                 __isl_take isl_multi_aff *ma);
1700         __isl_give isl_pw_aff *isl_pw_aff_reset_user(
1701                 __isl_take isl_pw_aff *pa);
1702         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_reset_user(
1703                 __isl_take isl_multi_pw_aff *mpa);
1704         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_reset_user(
1705                 __isl_take isl_pw_multi_aff *pma);
1706         __isl_give isl_union_pw_aff *isl_union_pw_aff_reset_user(
1707                 __isl_take isl_union_pw_aff *upa);
1708         __isl_give isl_multi_union_pw_aff *
1709         isl_multi_union_pw_aff_reset_user(
1710                 __isl_take isl_multi_union_pw_aff *mupa);
1711         __isl_give isl_union_pw_multi_aff *
1712         isl_union_pw_multi_aff_reset_user(
1713                 __isl_take isl_union_pw_multi_aff *upma);
1715         #include <isl/polynomial.h>
1716         __isl_give isl_pw_qpolynomial *
1717         isl_pw_qpolynomial_reset_user(
1718                 __isl_take isl_pw_qpolynomial *pwqp);
1719         __isl_give isl_union_pw_qpolynomial *
1720         isl_union_pw_qpolynomial_reset_user(
1721                 __isl_take isl_union_pw_qpolynomial *upwqp);
1722         __isl_give isl_pw_qpolynomial_fold *
1723         isl_pw_qpolynomial_fold_reset_user(
1724                 __isl_take isl_pw_qpolynomial_fold *pwf);
1725         __isl_give isl_union_pw_qpolynomial_fold *
1726         isl_union_pw_qpolynomial_fold_reset_user(
1727                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
1729 Spaces can be nested.  In particular, the domain of a set or
1730 the domain or range of a relation can be a nested relation.
1731 This process is also called I<wrapping>.
1732 The functions for detecting, constructing and deconstructing
1733 such nested spaces can be found in the wrapping properties
1734 of L</"Unary Properties">, the wrapping operations
1735 of L</"Unary Operations"> and the Cartesian product operations
1736 of L</"Basic Operations">.
1738 Spaces can be created from other spaces
1739 using the functions described in L</"Unary Operations">
1740 and L</"Binary Operations">.
1742 =head2 Local Spaces
1744 A local space is essentially a space with
1745 zero or more existentially quantified variables.
1746 The local space of various objects can be obtained
1747 using the following functions.
1749         #include <isl/constraint.h>
1750         __isl_give isl_local_space *isl_constraint_get_local_space(
1751                 __isl_keep isl_constraint *constraint);
1753         #include <isl/set.h>
1754         __isl_give isl_local_space *isl_basic_set_get_local_space(
1755                 __isl_keep isl_basic_set *bset);
1757         #include <isl/map.h>
1758         __isl_give isl_local_space *isl_basic_map_get_local_space(
1759                 __isl_keep isl_basic_map *bmap);
1761         #include <isl/aff.h>
1762         __isl_give isl_local_space *isl_aff_get_domain_local_space(
1763                 __isl_keep isl_aff *aff);
1764         __isl_give isl_local_space *isl_aff_get_local_space(
1765                 __isl_keep isl_aff *aff);
1767 A new local space can be created from a space using
1769         #include <isl/local_space.h>
1770         __isl_give isl_local_space *isl_local_space_from_space(
1771                 __isl_take isl_space *space);
1773 They can be inspected, modified, copied and freed using the following functions.
1775         #include <isl/local_space.h>
1776         isl_bool isl_local_space_is_params(
1777                 __isl_keep isl_local_space *ls);
1778         isl_bool isl_local_space_is_set(
1779                 __isl_keep isl_local_space *ls);
1780         __isl_give isl_space *isl_local_space_get_space(
1781                 __isl_keep isl_local_space *ls);
1782         __isl_give isl_aff *isl_local_space_get_div(
1783                 __isl_keep isl_local_space *ls, int pos);
1784         __isl_give isl_local_space *isl_local_space_copy(
1785                 __isl_keep isl_local_space *ls);
1786         __isl_null isl_local_space *isl_local_space_free(
1787                 __isl_take isl_local_space *ls);
1789 Note that C<isl_local_space_get_div> can only be used on local spaces
1790 of sets.
1792 Two local spaces can be compared using
1794         isl_bool isl_local_space_is_equal(
1795                 __isl_keep isl_local_space *ls1,
1796                 __isl_keep isl_local_space *ls2);
1798 Local spaces can be created from other local spaces
1799 using the functions described in L</"Unary Operations">
1800 and L</"Binary Operations">.
1802 =head2 Creating New Sets and Relations
1804 C<isl> has functions for creating some standard sets and relations.
1806 =over
1808 =item * Empty sets and relations
1810         __isl_give isl_basic_set *isl_basic_set_empty(
1811                 __isl_take isl_space *space);
1812         __isl_give isl_basic_map *isl_basic_map_empty(
1813                 __isl_take isl_space *space);
1814         __isl_give isl_set *isl_set_empty(
1815                 __isl_take isl_space *space);
1816         __isl_give isl_map *isl_map_empty(
1817                 __isl_take isl_space *space);
1818         __isl_give isl_union_set *isl_union_set_empty(
1819                 __isl_take isl_space *space);
1820         __isl_give isl_union_map *isl_union_map_empty(
1821                 __isl_take isl_space *space);
1823 For C<isl_union_set>s and C<isl_union_map>s, the space
1824 is only used to specify the parameters.
1826 =item * Universe sets and relations
1828         __isl_give isl_basic_set *isl_basic_set_universe(
1829                 __isl_take isl_space *space);
1830         __isl_give isl_basic_map *isl_basic_map_universe(
1831                 __isl_take isl_space *space);
1832         __isl_give isl_set *isl_set_universe(
1833                 __isl_take isl_space *space);
1834         __isl_give isl_map *isl_map_universe(
1835                 __isl_take isl_space *space);
1836         __isl_give isl_union_set *isl_union_set_universe(
1837                 __isl_take isl_union_set *uset);
1838         __isl_give isl_union_map *isl_union_map_universe(
1839                 __isl_take isl_union_map *umap);
1841 The sets and relations constructed by the functions above
1842 contain all integer values, while those constructed by the
1843 functions below only contain non-negative values.
1845         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1846                 __isl_take isl_space *space);
1847         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1848                 __isl_take isl_space *space);
1849         __isl_give isl_set *isl_set_nat_universe(
1850                 __isl_take isl_space *space);
1851         __isl_give isl_map *isl_map_nat_universe(
1852                 __isl_take isl_space *space);
1854 =item * Identity relations
1856         __isl_give isl_basic_map *isl_basic_map_identity(
1857                 __isl_take isl_space *space);
1858         __isl_give isl_map *isl_map_identity(
1859                 __isl_take isl_space *space);
1861 The number of input and output dimensions in C<space> needs
1862 to be the same.
1864 =item * Lexicographic order
1866         __isl_give isl_map *isl_map_lex_lt(
1867                 __isl_take isl_space *set_space);
1868         __isl_give isl_map *isl_map_lex_le(
1869                 __isl_take isl_space *set_space);
1870         __isl_give isl_map *isl_map_lex_gt(
1871                 __isl_take isl_space *set_space);
1872         __isl_give isl_map *isl_map_lex_ge(
1873                 __isl_take isl_space *set_space);
1874         __isl_give isl_map *isl_map_lex_lt_first(
1875                 __isl_take isl_space *space, unsigned n);
1876         __isl_give isl_map *isl_map_lex_le_first(
1877                 __isl_take isl_space *space, unsigned n);
1878         __isl_give isl_map *isl_map_lex_gt_first(
1879                 __isl_take isl_space *space, unsigned n);
1880         __isl_give isl_map *isl_map_lex_ge_first(
1881                 __isl_take isl_space *space, unsigned n);
1883 The first four functions take a space for a B<set>
1884 and return relations that express that the elements in the domain
1885 are lexicographically less
1886 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1887 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1888 than the elements in the range.
1889 The last four functions take a space for a map
1890 and return relations that express that the first C<n> dimensions
1891 in the domain are lexicographically less
1892 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1893 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1894 than the first C<n> dimensions in the range.
1896 =back
1898 A basic set or relation can be converted to a set or relation
1899 using the following functions.
1901         __isl_give isl_set *isl_set_from_basic_set(
1902                 __isl_take isl_basic_set *bset);
1903         __isl_give isl_map *isl_map_from_basic_map(
1904                 __isl_take isl_basic_map *bmap);
1906 Sets and relations can be converted to union sets and relations
1907 using the following functions.
1909         __isl_give isl_union_set *isl_union_set_from_basic_set(
1910                 __isl_take isl_basic_set *bset);
1911         __isl_give isl_union_map *isl_union_map_from_basic_map(
1912                 __isl_take isl_basic_map *bmap);
1913         __isl_give isl_union_set *isl_union_set_from_set(
1914                 __isl_take isl_set *set);
1915         __isl_give isl_union_map *isl_union_map_from_map(
1916                 __isl_take isl_map *map);
1918 The inverse conversions below can only be used if the input
1919 union set or relation is known to contain elements in exactly one
1920 space.
1922         __isl_give isl_set *isl_set_from_union_set(
1923                 __isl_take isl_union_set *uset);
1924         __isl_give isl_map *isl_map_from_union_map(
1925                 __isl_take isl_union_map *umap);
1927 Sets and relations can be copied and freed again using the following
1928 functions.
1930         __isl_give isl_basic_set *isl_basic_set_copy(
1931                 __isl_keep isl_basic_set *bset);
1932         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1933         __isl_give isl_union_set *isl_union_set_copy(
1934                 __isl_keep isl_union_set *uset);
1935         __isl_give isl_basic_map *isl_basic_map_copy(
1936                 __isl_keep isl_basic_map *bmap);
1937         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1938         __isl_give isl_union_map *isl_union_map_copy(
1939                 __isl_keep isl_union_map *umap);
1940         __isl_null isl_basic_set *isl_basic_set_free(
1941                 __isl_take isl_basic_set *bset);
1942         __isl_null isl_set *isl_set_free(__isl_take isl_set *set);
1943         __isl_null isl_union_set *isl_union_set_free(
1944                 __isl_take isl_union_set *uset);
1945         __isl_null isl_basic_map *isl_basic_map_free(
1946                 __isl_take isl_basic_map *bmap);
1947         __isl_null isl_map *isl_map_free(__isl_take isl_map *map);
1948         __isl_null isl_union_map *isl_union_map_free(
1949                 __isl_take isl_union_map *umap);
1951 Other sets and relations can be constructed by starting
1952 from a universe set or relation, adding equality and/or
1953 inequality constraints and then projecting out the
1954 existentially quantified variables, if any.
1955 Constraints can be constructed, manipulated and
1956 added to (or removed from) (basic) sets and relations
1957 using the following functions.
1959         #include <isl/constraint.h>
1960         __isl_give isl_constraint *isl_constraint_alloc_equality(
1961                 __isl_take isl_local_space *ls);
1962         __isl_give isl_constraint *isl_constraint_alloc_inequality(
1963                 __isl_take isl_local_space *ls);
1964         __isl_give isl_constraint *isl_constraint_set_constant_si(
1965                 __isl_take isl_constraint *constraint, int v);
1966         __isl_give isl_constraint *isl_constraint_set_constant_val(
1967                 __isl_take isl_constraint *constraint,
1968                 __isl_take isl_val *v);
1969         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1970                 __isl_take isl_constraint *constraint,
1971                 enum isl_dim_type type, int pos, int v);
1972         __isl_give isl_constraint *
1973         isl_constraint_set_coefficient_val(
1974                 __isl_take isl_constraint *constraint,
1975                 enum isl_dim_type type, int pos,
1976                 __isl_take isl_val *v);
1977         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1978                 __isl_take isl_basic_map *bmap,
1979                 __isl_take isl_constraint *constraint);
1980         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1981                 __isl_take isl_basic_set *bset,
1982                 __isl_take isl_constraint *constraint);
1983         __isl_give isl_map *isl_map_add_constraint(
1984                 __isl_take isl_map *map,
1985                 __isl_take isl_constraint *constraint);
1986         __isl_give isl_set *isl_set_add_constraint(
1987                 __isl_take isl_set *set,
1988                 __isl_take isl_constraint *constraint);
1990 For example, to create a set containing the even integers
1991 between 10 and 42, you would use the following code.
1993         isl_space *space;
1994         isl_local_space *ls;
1995         isl_constraint *c;
1996         isl_basic_set *bset;
1998         space = isl_space_set_alloc(ctx, 0, 2);
1999         bset = isl_basic_set_universe(isl_space_copy(space));
2000         ls = isl_local_space_from_space(space);
2002         c = isl_constraint_alloc_equality(isl_local_space_copy(ls));
2003         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
2004         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
2005         bset = isl_basic_set_add_constraint(bset, c);
2007         c = isl_constraint_alloc_inequality(isl_local_space_copy(ls));
2008         c = isl_constraint_set_constant_si(c, -10);
2009         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
2010         bset = isl_basic_set_add_constraint(bset, c);
2012         c = isl_constraint_alloc_inequality(ls);
2013         c = isl_constraint_set_constant_si(c, 42);
2014         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
2015         bset = isl_basic_set_add_constraint(bset, c);
2017         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
2019 Or, alternatively,
2021         isl_basic_set *bset;
2022         bset = isl_basic_set_read_from_str(ctx,
2023                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
2025 A basic set or relation can also be constructed from two matrices
2026 describing the equalities and the inequalities.
2028         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
2029                 __isl_take isl_space *space,
2030                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
2031                 enum isl_dim_type c1,
2032                 enum isl_dim_type c2, enum isl_dim_type c3,
2033                 enum isl_dim_type c4);
2034         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
2035                 __isl_take isl_space *space,
2036                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
2037                 enum isl_dim_type c1,
2038                 enum isl_dim_type c2, enum isl_dim_type c3,
2039                 enum isl_dim_type c4, enum isl_dim_type c5);
2041 The C<isl_dim_type> arguments indicate the order in which
2042 different kinds of variables appear in the input matrices
2043 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
2044 C<isl_dim_set> and C<isl_dim_div> for sets and
2045 of C<isl_dim_cst>, C<isl_dim_param>,
2046 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
2048 A (basic or union) set or relation can also be constructed from a
2049 (union) (piecewise) (multiple) affine expression
2050 or a list of affine expressions
2051 (See L</"Functions">), provided these affine expressions do not
2052 involve any NaN.
2054         __isl_give isl_basic_map *isl_basic_map_from_aff(
2055                 __isl_take isl_aff *aff);
2056         __isl_give isl_map *isl_map_from_aff(
2057                 __isl_take isl_aff *aff);
2058         __isl_give isl_set *isl_set_from_pw_aff(
2059                 __isl_take isl_pw_aff *pwaff);
2060         __isl_give isl_map *isl_map_from_pw_aff(
2061                 __isl_take isl_pw_aff *pwaff);
2062         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
2063                 __isl_take isl_space *domain_space,
2064                 __isl_take isl_aff_list *list);
2065         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
2066                 __isl_take isl_multi_aff *maff)
2067         __isl_give isl_map *isl_map_from_multi_aff(
2068                 __isl_take isl_multi_aff *maff)
2069         __isl_give isl_set *isl_set_from_pw_multi_aff(
2070                 __isl_take isl_pw_multi_aff *pma);
2071         __isl_give isl_map *isl_map_from_pw_multi_aff(
2072                 __isl_take isl_pw_multi_aff *pma);
2073         __isl_give isl_set *isl_set_from_multi_pw_aff(
2074                 __isl_take isl_multi_pw_aff *mpa);
2075         __isl_give isl_map *isl_map_from_multi_pw_aff(
2076                 __isl_take isl_multi_pw_aff *mpa);
2077         __isl_give isl_union_map *isl_union_map_from_union_pw_aff(
2078                 __isl_take isl_union_pw_aff *upa);
2079         __isl_give isl_union_map *
2080         isl_union_map_from_union_pw_multi_aff(
2081                 __isl_take isl_union_pw_multi_aff *upma);
2082         __isl_give isl_union_map *
2083         isl_union_map_from_multi_union_pw_aff(
2084                 __isl_take isl_multi_union_pw_aff *mupa);
2086 The C<domain_space> argument describes the domain of the resulting
2087 basic relation.  It is required because the C<list> may consist
2088 of zero affine expressions.
2089 The C<mupa> passed to C<isl_union_map_from_multi_union_pw_aff>
2090 is not allowed to be zero-dimensional.  The domain of the result
2091 is the shared domain of the union piecewise affine elements.
2093 =head2 Inspecting Sets and Relations
2095 Usually, the user should not have to care about the actual constraints
2096 of the sets and maps, but should instead apply the abstract operations
2097 explained in the following sections.
2098 Occasionally, however, it may be required to inspect the individual
2099 coefficients of the constraints.  This section explains how to do so.
2100 In these cases, it may also be useful to have C<isl> compute
2101 an explicit representation of the existentially quantified variables.
2103         __isl_give isl_set *isl_set_compute_divs(
2104                 __isl_take isl_set *set);
2105         __isl_give isl_map *isl_map_compute_divs(
2106                 __isl_take isl_map *map);
2107         __isl_give isl_union_set *isl_union_set_compute_divs(
2108                 __isl_take isl_union_set *uset);
2109         __isl_give isl_union_map *isl_union_map_compute_divs(
2110                 __isl_take isl_union_map *umap);
2112 This explicit representation defines the existentially quantified
2113 variables as integer divisions of the other variables, possibly
2114 including earlier existentially quantified variables.
2115 An explicitly represented existentially quantified variable therefore
2116 has a unique value when the values of the other variables are known.
2118 Alternatively, the existentially quantified variables can be removed
2119 using the following functions, which compute an overapproximation.
2121         #include <isl/set.h>
2122         __isl_give isl_basic_set *isl_basic_set_remove_divs(
2123                 __isl_take isl_basic_set *bset);
2124         __isl_give isl_set *isl_set_remove_divs(
2125                 __isl_take isl_set *set);
2127         #include <isl/map.h>
2128         __isl_give isl_basic_map *isl_basic_map_remove_divs(
2129                 __isl_take isl_basic_map *bmap);
2130         __isl_give isl_map *isl_map_remove_divs(
2131                 __isl_take isl_map *map);
2133         #include <isl/union_set.h>
2134         __isl_give isl_union_set *isl_union_set_remove_divs(
2135                 __isl_take isl_union_set *bset);
2137         #include <isl/union_map.h>
2138         __isl_give isl_union_map *isl_union_map_remove_divs(
2139                 __isl_take isl_union_map *bmap);
2141 It is also possible to only remove those divs that are defined
2142 in terms of a given range of dimensions or only those for which
2143 no explicit representation is known.
2145         __isl_give isl_basic_set *
2146         isl_basic_set_remove_divs_involving_dims(
2147                 __isl_take isl_basic_set *bset,
2148                 enum isl_dim_type type,
2149                 unsigned first, unsigned n);
2150         __isl_give isl_basic_map *
2151         isl_basic_map_remove_divs_involving_dims(
2152                 __isl_take isl_basic_map *bmap,
2153                 enum isl_dim_type type,
2154                 unsigned first, unsigned n);
2155         __isl_give isl_set *isl_set_remove_divs_involving_dims(
2156                 __isl_take isl_set *set, enum isl_dim_type type,
2157                 unsigned first, unsigned n);
2158         __isl_give isl_map *isl_map_remove_divs_involving_dims(
2159                 __isl_take isl_map *map, enum isl_dim_type type,
2160                 unsigned first, unsigned n);
2162         __isl_give isl_basic_set *
2163         isl_basic_set_remove_unknown_divs(
2164                 __isl_take isl_basic_set *bset);
2165         __isl_give isl_set *isl_set_remove_unknown_divs(
2166                 __isl_take isl_set *set);
2167         __isl_give isl_map *isl_map_remove_unknown_divs(
2168                 __isl_take isl_map *map);
2170 To iterate over all the sets or maps in a union set or map, use
2172         isl_stat isl_union_set_foreach_set(
2173                 __isl_keep isl_union_set *uset,
2174                 isl_stat (*fn)(__isl_take isl_set *set, void *user),
2175                 void *user);
2176         isl_stat isl_union_map_foreach_map(
2177                 __isl_keep isl_union_map *umap,
2178                 isl_stat (*fn)(__isl_take isl_map *map, void *user),
2179                 void *user);
2181 These functions call the callback function once for each
2182 (pair of) space(s) for which there are elements in the input.
2183 The argument to the callback contains all elements in the input
2184 with that (pair of) space(s).
2186 The number of sets or maps in a union set or map can be obtained
2187 from
2189         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
2190         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
2192 To extract the set or map in a given space from a union, use
2194         __isl_give isl_set *isl_union_set_extract_set(
2195                 __isl_keep isl_union_set *uset,
2196                 __isl_take isl_space *space);
2197         __isl_give isl_map *isl_union_map_extract_map(
2198                 __isl_keep isl_union_map *umap,
2199                 __isl_take isl_space *space);
2201 To iterate over all the basic sets or maps in a set or map, use
2203         isl_stat isl_set_foreach_basic_set(__isl_keep isl_set *set,
2204                 isl_stat (*fn)(__isl_take isl_basic_set *bset,
2205                         void *user),
2206                 void *user);
2207         isl_stat isl_map_foreach_basic_map(__isl_keep isl_map *map,
2208                 isl_stat (*fn)(__isl_take isl_basic_map *bmap,
2209                         void *user),
2210                 void *user);
2212 The callback function C<fn> should return 0 if successful and
2213 -1 if an error occurs.  In the latter case, or if any other error
2214 occurs, the above functions will return -1.
2216 It should be noted that C<isl> does not guarantee that
2217 the basic sets or maps passed to C<fn> are disjoint.
2218 If this is required, then the user should call one of
2219 the following functions first.
2221         __isl_give isl_set *isl_set_make_disjoint(
2222                 __isl_take isl_set *set);
2223         __isl_give isl_map *isl_map_make_disjoint(
2224                 __isl_take isl_map *map);
2226 The number of basic sets in a set can be obtained
2227 or the number of basic maps in a map can be obtained
2228 from
2230         #include <isl/set.h>
2231         int isl_set_n_basic_set(__isl_keep isl_set *set);
2233         #include <isl/map.h>
2234         int isl_map_n_basic_map(__isl_keep isl_map *map);
2236 It is also possible to obtain a list of basic sets from a set
2237 or union set
2239         #include <isl/set.h>
2240         __isl_give isl_basic_set_list *isl_set_get_basic_set_list(
2241                 __isl_keep isl_set *set);
2243         #include <isl/union_set.h>
2244         __isl_give isl_basic_set_list *
2245         isl_union_set_get_basic_set_list(
2246                 __isl_keep isl_union_set *uset);
2248 The returned list can be manipulated using the functions in L<"Lists">.
2250 To iterate over the constraints of a basic set or map, use
2252         #include <isl/constraint.h>
2254         int isl_basic_set_n_constraint(
2255                 __isl_keep isl_basic_set *bset);
2256         isl_stat isl_basic_set_foreach_constraint(
2257                 __isl_keep isl_basic_set *bset,
2258                 isl_stat (*fn)(__isl_take isl_constraint *c,
2259                         void *user),
2260                 void *user);
2261         int isl_basic_map_n_constraint(
2262                 __isl_keep isl_basic_map *bmap);
2263         isl_stat isl_basic_map_foreach_constraint(
2264                 __isl_keep isl_basic_map *bmap,
2265                 isl_stat (*fn)(__isl_take isl_constraint *c,
2266                         void *user),
2267                 void *user);
2268         __isl_null isl_constraint *isl_constraint_free(
2269                 __isl_take isl_constraint *c);
2271 Again, the callback function C<fn> should return 0 if successful and
2272 -1 if an error occurs.  In the latter case, or if any other error
2273 occurs, the above functions will return -1.
2274 The constraint C<c> represents either an equality or an inequality.
2275 Use the following function to find out whether a constraint
2276 represents an equality.  If not, it represents an inequality.
2278         isl_bool isl_constraint_is_equality(
2279                 __isl_keep isl_constraint *constraint);
2281 It is also possible to obtain a list of constraints from a basic
2282 map or set
2284         #include <isl/constraint.h>
2285         __isl_give isl_constraint_list *
2286         isl_basic_map_get_constraint_list(
2287                 __isl_keep isl_basic_map *bmap);
2288         __isl_give isl_constraint_list *
2289         isl_basic_set_get_constraint_list(
2290                 __isl_keep isl_basic_set *bset);
2292 These functions require that all existentially quantified variables
2293 have an explicit representation.
2294 The returned list can be manipulated using the functions in L<"Lists">.
2296 The coefficients of the constraints can be inspected using
2297 the following functions.
2299         isl_bool isl_constraint_is_lower_bound(
2300                 __isl_keep isl_constraint *constraint,
2301                 enum isl_dim_type type, unsigned pos);
2302         isl_bool isl_constraint_is_upper_bound(
2303                 __isl_keep isl_constraint *constraint,
2304                 enum isl_dim_type type, unsigned pos);
2305         __isl_give isl_val *isl_constraint_get_constant_val(
2306                 __isl_keep isl_constraint *constraint);
2307         __isl_give isl_val *isl_constraint_get_coefficient_val(
2308                 __isl_keep isl_constraint *constraint,
2309                 enum isl_dim_type type, int pos);
2311 The explicit representations of the existentially quantified
2312 variables can be inspected using the following function.
2313 Note that the user is only allowed to use this function
2314 if the inspected set or map is the result of a call
2315 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
2316 The existentially quantified variable is equal to the floor
2317 of the returned affine expression.  The affine expression
2318 itself can be inspected using the functions in
2319 L</"Functions">.
2321         __isl_give isl_aff *isl_constraint_get_div(
2322                 __isl_keep isl_constraint *constraint, int pos);
2324 To obtain the constraints of a basic set or map in matrix
2325 form, use the following functions.
2327         __isl_give isl_mat *isl_basic_set_equalities_matrix(
2328                 __isl_keep isl_basic_set *bset,
2329                 enum isl_dim_type c1, enum isl_dim_type c2,
2330                 enum isl_dim_type c3, enum isl_dim_type c4);
2331         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
2332                 __isl_keep isl_basic_set *bset,
2333                 enum isl_dim_type c1, enum isl_dim_type c2,
2334                 enum isl_dim_type c3, enum isl_dim_type c4);
2335         __isl_give isl_mat *isl_basic_map_equalities_matrix(
2336                 __isl_keep isl_basic_map *bmap,
2337                 enum isl_dim_type c1,
2338                 enum isl_dim_type c2, enum isl_dim_type c3,
2339                 enum isl_dim_type c4, enum isl_dim_type c5);
2340         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
2341                 __isl_keep isl_basic_map *bmap,
2342                 enum isl_dim_type c1,
2343                 enum isl_dim_type c2, enum isl_dim_type c3,
2344                 enum isl_dim_type c4, enum isl_dim_type c5);
2346 The C<isl_dim_type> arguments dictate the order in which
2347 different kinds of variables appear in the resulting matrix.
2348 For set inputs, they should be a permutation of
2349 C<isl_dim_cst>, C<isl_dim_param>, C<isl_dim_set> and C<isl_dim_div>.
2350 For map inputs, they should be a permutation of
2351 C<isl_dim_cst>, C<isl_dim_param>,
2352 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
2354 =head2 Points
2356 Points are elements of a set.  They can be used to construct
2357 simple sets (boxes) or they can be used to represent the
2358 individual elements of a set.
2359 The zero point (the origin) can be created using
2361         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
2363 The coordinates of a point can be inspected, set and changed
2364 using
2366         __isl_give isl_val *isl_point_get_coordinate_val(
2367                 __isl_keep isl_point *pnt,
2368                 enum isl_dim_type type, int pos);
2369         __isl_give isl_point *isl_point_set_coordinate_val(
2370                 __isl_take isl_point *pnt,
2371                 enum isl_dim_type type, int pos,
2372                 __isl_take isl_val *v);
2374         __isl_give isl_point *isl_point_add_ui(
2375                 __isl_take isl_point *pnt,
2376                 enum isl_dim_type type, int pos, unsigned val);
2377         __isl_give isl_point *isl_point_sub_ui(
2378                 __isl_take isl_point *pnt,
2379                 enum isl_dim_type type, int pos, unsigned val);
2381 Points can be copied or freed using
2383         __isl_give isl_point *isl_point_copy(
2384                 __isl_keep isl_point *pnt);
2385         __isl_null isl_point *isl_point_free(
2386                 __isl_take isl_point *pnt);
2388 A singleton set can be created from a point using
2390         __isl_give isl_basic_set *isl_basic_set_from_point(
2391                 __isl_take isl_point *pnt);
2392         __isl_give isl_set *isl_set_from_point(
2393                 __isl_take isl_point *pnt);
2394         __isl_give isl_union_set *isl_union_set_from_point(
2395                 __isl_take isl_point *pnt);
2397 and a box can be created from two opposite extremal points using
2399         __isl_give isl_basic_set *isl_basic_set_box_from_points(
2400                 __isl_take isl_point *pnt1,
2401                 __isl_take isl_point *pnt2);
2402         __isl_give isl_set *isl_set_box_from_points(
2403                 __isl_take isl_point *pnt1,
2404                 __isl_take isl_point *pnt2);
2406 All elements of a B<bounded> (union) set can be enumerated using
2407 the following functions.
2409         isl_stat isl_set_foreach_point(__isl_keep isl_set *set,
2410                 isl_stat (*fn)(__isl_take isl_point *pnt,
2411                         void *user),
2412                 void *user);
2413         isl_stat isl_union_set_foreach_point(
2414                 __isl_keep isl_union_set *uset,
2415                 isl_stat (*fn)(__isl_take isl_point *pnt,
2416                         void *user),
2417                 void *user);
2419 The function C<fn> is called for each integer point in
2420 C<set> with as second argument the last argument of
2421 the C<isl_set_foreach_point> call.  The function C<fn>
2422 should return C<0> on success and C<-1> on failure.
2423 In the latter case, C<isl_set_foreach_point> will stop
2424 enumerating and return C<-1> as well.
2425 If the enumeration is performed successfully and to completion,
2426 then C<isl_set_foreach_point> returns C<0>.
2428 To obtain a single point of a (basic or union) set, use
2430         __isl_give isl_point *isl_basic_set_sample_point(
2431                 __isl_take isl_basic_set *bset);
2432         __isl_give isl_point *isl_set_sample_point(
2433                 __isl_take isl_set *set);
2434         __isl_give isl_point *isl_union_set_sample_point(
2435                 __isl_take isl_union_set *uset);
2437 If C<set> does not contain any (integer) points, then the
2438 resulting point will be ``void'', a property that can be
2439 tested using
2441         isl_bool isl_point_is_void(__isl_keep isl_point *pnt);
2443 =head2 Functions
2445 Besides sets and relation, C<isl> also supports various types of functions.
2446 Each of these types is derived from the value type (see L</"Values">)
2447 or from one of two primitive function types
2448 through the application of zero or more type constructors.
2449 We first describe the primitive type and then we describe
2450 the types derived from these primitive types.
2452 =head3 Primitive Functions
2454 C<isl> support two primitive function types, quasi-affine
2455 expressions and quasipolynomials.
2456 A quasi-affine expression is defined either over a parameter
2457 space or over a set and is composed of integer constants,
2458 parameters and set variables, addition, subtraction and
2459 integer division by an integer constant.
2460 For example, the quasi-affine expression
2462         [n] -> { [x] -> [2*floor((4 n + x)/9] }
2464 maps C<x> to C<2*floor((4 n + x)/9>.
2465 A quasipolynomial is a polynomial expression in quasi-affine
2466 expression.  That is, it additionally allows for multiplication.
2467 Note, though, that it is not allowed to construct an integer
2468 division of an expression involving multiplications.
2469 Here is an example of a quasipolynomial that is not
2470 quasi-affine expression
2472         [n] -> { [x] -> (n*floor((4 n + x)/9) }
2474 Note that the external representations of quasi-affine expressions
2475 and quasipolynomials are different.  Quasi-affine expressions
2476 use a notation with square brackets just like binary relations,
2477 while quasipolynomials do not.  This might change at some point.
2479 If a primitive function is defined over a parameter space,
2480 then the space of the function itself is that of a set.
2481 If it is defined over a set, then the space of the function
2482 is that of a relation.  In both cases, the set space (or
2483 the output space) is single-dimensional, anonymous and unstructured.
2484 To create functions with multiple dimensions or with other kinds
2485 of set or output spaces, use multiple expressions
2486 (see L</"Multiple Expressions">).
2488 =over
2490 =item * Quasi-affine Expressions
2492 Besides the expressions described above, a quasi-affine
2493 expression can also be set to NaN.  Such expressions
2494 typically represent a failure to represent a result
2495 as a quasi-affine expression.
2497 The zero quasi affine expression or the quasi affine expression
2498 that is equal to a given value or
2499 a specified dimension on a given domain can be created using
2501         #include <isl/aff.h>
2502         __isl_give isl_aff *isl_aff_zero_on_domain(
2503                 __isl_take isl_local_space *ls);
2504         __isl_give isl_aff *isl_aff_val_on_domain(
2505                 __isl_take isl_local_space *ls,
2506                 __isl_take isl_val *val);
2507         __isl_give isl_aff *isl_aff_var_on_domain(
2508                 __isl_take isl_local_space *ls,
2509                 enum isl_dim_type type, unsigned pos);
2510         __isl_give isl_aff *isl_aff_nan_on_domain(
2511                 __isl_take isl_local_space *ls);
2513 Quasi affine expressions can be copied and freed using
2515         #include <isl/aff.h>
2516         __isl_give isl_aff *isl_aff_copy(
2517                 __isl_keep isl_aff *aff);
2518         __isl_null isl_aff *isl_aff_free(
2519                 __isl_take isl_aff *aff);
2521 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2522 using the following function.  The constraint is required to have
2523 a non-zero coefficient for the specified dimension.
2525         #include <isl/constraint.h>
2526         __isl_give isl_aff *isl_constraint_get_bound(
2527                 __isl_keep isl_constraint *constraint,
2528                 enum isl_dim_type type, int pos);
2530 The entire affine expression of the constraint can also be extracted
2531 using the following function.
2533         #include <isl/constraint.h>
2534         __isl_give isl_aff *isl_constraint_get_aff(
2535                 __isl_keep isl_constraint *constraint);
2537 Conversely, an equality constraint equating
2538 the affine expression to zero or an inequality constraint enforcing
2539 the affine expression to be non-negative, can be constructed using
2541         __isl_give isl_constraint *isl_equality_from_aff(
2542                 __isl_take isl_aff *aff);
2543         __isl_give isl_constraint *isl_inequality_from_aff(
2544                 __isl_take isl_aff *aff);
2546 The coefficients and the integer divisions of an affine expression
2547 can be inspected using the following functions.
2549         #include <isl/aff.h>
2550         __isl_give isl_val *isl_aff_get_constant_val(
2551                 __isl_keep isl_aff *aff);
2552         __isl_give isl_val *isl_aff_get_coefficient_val(
2553                 __isl_keep isl_aff *aff,
2554                 enum isl_dim_type type, int pos);
2555         int isl_aff_coefficient_sgn(__isl_keep isl_aff *aff,
2556                 enum isl_dim_type type, int pos);
2557         __isl_give isl_val *isl_aff_get_denominator_val(
2558                 __isl_keep isl_aff *aff);
2559         __isl_give isl_aff *isl_aff_get_div(
2560                 __isl_keep isl_aff *aff, int pos);
2562 They can be modified using the following functions.
2564         #include <isl/aff.h>
2565         __isl_give isl_aff *isl_aff_set_constant_si(
2566                 __isl_take isl_aff *aff, int v);
2567         __isl_give isl_aff *isl_aff_set_constant_val(
2568                 __isl_take isl_aff *aff, __isl_take isl_val *v);
2569         __isl_give isl_aff *isl_aff_set_coefficient_si(
2570                 __isl_take isl_aff *aff,
2571                 enum isl_dim_type type, int pos, int v);
2572         __isl_give isl_aff *isl_aff_set_coefficient_val(
2573                 __isl_take isl_aff *aff,
2574                 enum isl_dim_type type, int pos,
2575                 __isl_take isl_val *v);
2577         __isl_give isl_aff *isl_aff_add_constant_si(
2578                 __isl_take isl_aff *aff, int v);
2579         __isl_give isl_aff *isl_aff_add_constant_val(
2580                 __isl_take isl_aff *aff, __isl_take isl_val *v);
2581         __isl_give isl_aff *isl_aff_add_constant_num_si(
2582                 __isl_take isl_aff *aff, int v);
2583         __isl_give isl_aff *isl_aff_add_coefficient_si(
2584                 __isl_take isl_aff *aff,
2585                 enum isl_dim_type type, int pos, int v);
2586         __isl_give isl_aff *isl_aff_add_coefficient_val(
2587                 __isl_take isl_aff *aff,
2588                 enum isl_dim_type type, int pos,
2589                 __isl_take isl_val *v);
2591 Note that C<isl_aff_set_constant_si> and C<isl_aff_set_coefficient_si>
2592 set the I<numerator> of the constant or coefficient, while
2593 C<isl_aff_set_constant_val> and C<isl_aff_set_coefficient_val> set
2594 the constant or coefficient as a whole.
2595 The C<add_constant> and C<add_coefficient> functions add an integer
2596 or rational value to
2597 the possibly rational constant or coefficient.
2598 The C<add_constant_num> functions add an integer value to
2599 the numerator.
2601 =item * Quasipolynomials
2603 Some simple quasipolynomials can be created using the following functions.
2605         #include <isl/polynomial.h>
2606         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
2607                 __isl_take isl_space *domain);
2608         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
2609                 __isl_take isl_space *domain);
2610         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
2611                 __isl_take isl_space *domain);
2612         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
2613                 __isl_take isl_space *domain);
2614         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
2615                 __isl_take isl_space *domain);
2616         __isl_give isl_qpolynomial *isl_qpolynomial_val_on_domain(
2617                 __isl_take isl_space *domain,
2618                 __isl_take isl_val *val);
2619         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
2620                 __isl_take isl_space *domain,
2621                 enum isl_dim_type type, unsigned pos);
2622         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
2623                 __isl_take isl_aff *aff);
2625 Recall that the space in which a quasipolynomial lives is a map space
2626 with a one-dimensional range.  The C<domain> argument in some of
2627 the functions above corresponds to the domain of this map space.
2629 Quasipolynomials can be copied and freed again using the following
2630 functions.
2632         #include <isl/polynomial.h>
2633         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
2634                 __isl_keep isl_qpolynomial *qp);
2635         __isl_null isl_qpolynomial *isl_qpolynomial_free(
2636                 __isl_take isl_qpolynomial *qp);
2638 The constant term of a quasipolynomial can be extracted using
2640         __isl_give isl_val *isl_qpolynomial_get_constant_val(
2641                 __isl_keep isl_qpolynomial *qp);
2643 To iterate over all terms in a quasipolynomial,
2646         isl_stat isl_qpolynomial_foreach_term(
2647                 __isl_keep isl_qpolynomial *qp,
2648                 isl_stat (*fn)(__isl_take isl_term *term,
2649                           void *user), void *user);
2651 The terms themselves can be inspected and freed using
2652 these functions
2654         unsigned isl_term_dim(__isl_keep isl_term *term,
2655                 enum isl_dim_type type);
2656         __isl_give isl_val *isl_term_get_coefficient_val(
2657                 __isl_keep isl_term *term);
2658         int isl_term_get_exp(__isl_keep isl_term *term,
2659                 enum isl_dim_type type, unsigned pos);
2660         __isl_give isl_aff *isl_term_get_div(
2661                 __isl_keep isl_term *term, unsigned pos);
2662         void isl_term_free(__isl_take isl_term *term);
2664 Each term is a product of parameters, set variables and
2665 integer divisions.  The function C<isl_term_get_exp>
2666 returns the exponent of a given dimensions in the given term.
2668 =back
2670 =head3 Reductions
2672 A reduction represents a maximum or a minimum of its
2673 base expressions.
2674 The only reduction type defined by C<isl> is
2675 C<isl_qpolynomial_fold>.
2677 There are currently no functions to directly create such
2678 objects, but they do appear in the piecewise quasipolynomial
2679 reductions returned by the C<isl_pw_qpolynomial_bound> function.
2681 L</"Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions">.
2683 Reductions can be copied and freed using
2684 the following functions.
2686         #include <isl/polynomial.h>
2687         __isl_give isl_qpolynomial_fold *
2688         isl_qpolynomial_fold_copy(
2689                 __isl_keep isl_qpolynomial_fold *fold);
2690         void isl_qpolynomial_fold_free(
2691                 __isl_take isl_qpolynomial_fold *fold);
2693 To iterate over all quasipolynomials in a reduction, use
2695         isl_stat isl_qpolynomial_fold_foreach_qpolynomial(
2696                 __isl_keep isl_qpolynomial_fold *fold,
2697                 isl_stat (*fn)(__isl_take isl_qpolynomial *qp,
2698                           void *user), void *user);
2700 =head3 Multiple Expressions
2702 A multiple expression represents a sequence of zero or
2703 more base expressions, all defined on the same domain space.
2704 The domain space of the multiple expression is the same
2705 as that of the base expressions, but the range space
2706 can be any space.  In case the base expressions have
2707 a set space, the corresponding multiple expression
2708 also has a set space.
2709 Objects of the value type do not have an associated space.
2710 The space of a multiple value is therefore always a set space.
2711 Similarly, the space of a multiple union piecewise
2712 affine expression is always a set space.
2714 The multiple expression types defined by C<isl>
2715 are C<isl_multi_val>, C<isl_multi_aff>, C<isl_multi_pw_aff>,
2716 C<isl_multi_union_pw_aff>.
2718 A multiple expression with the value zero for
2719 each output (or set) dimension can be created
2720 using the following functions.
2722         #include <isl/val.h>
2723         __isl_give isl_multi_val *isl_multi_val_zero(
2724                 __isl_take isl_space *space);
2726         #include <isl/aff.h>
2727         __isl_give isl_multi_aff *isl_multi_aff_zero(
2728                 __isl_take isl_space *space);
2729         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
2730                 __isl_take isl_space *space);
2731         __isl_give isl_multi_union_pw_aff *
2732         isl_multi_union_pw_aff_zero(
2733                 __isl_take isl_space *space);
2735 Since there is no canonical way of representing a zero
2736 value of type C<isl_union_pw_aff>, the space passed
2737 to C<isl_multi_union_pw_aff_zero> needs to be zero-dimensional.
2739 An identity function can be created using the following
2740 functions.  The space needs to be that of a relation
2741 with the same number of input and output dimensions.
2743         #include <isl/aff.h>
2744         __isl_give isl_multi_aff *isl_multi_aff_identity(
2745                 __isl_take isl_space *space);
2746         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
2747                 __isl_take isl_space *space);
2749 A function that performs a projection on a universe
2750 relation or set can be created using the following functions.
2751 See also the corresponding
2752 projection operations in L</"Unary Operations">.
2754         #include <isl/aff.h>
2755         __isl_give isl_multi_aff *isl_multi_aff_domain_map(
2756                 __isl_take isl_space *space);
2757         __isl_give isl_multi_aff *isl_multi_aff_range_map(
2758                 __isl_take isl_space *space);
2759         __isl_give isl_multi_aff *isl_multi_aff_project_out_map(
2760                 __isl_take isl_space *space,
2761                 enum isl_dim_type type,
2762                 unsigned first, unsigned n);
2764 A multiple expression can be created from a single
2765 base expression using the following functions.
2766 The space of the created multiple expression is the same
2767 as that of the base expression, except for
2768 C<isl_multi_union_pw_aff_from_union_pw_aff> where the input
2769 lives in a parameter space and the output lives
2770 in a single-dimensional set space.
2772         #include <isl/aff.h>
2773         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
2774                 __isl_take isl_aff *aff);
2775         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
2776                 __isl_take isl_pw_aff *pa);
2777         __isl_give isl_multi_union_pw_aff *
2778         isl_multi_union_pw_aff_from_union_pw_aff(
2779                 __isl_take isl_union_pw_aff *upa);
2781 A multiple expression can be created from a list
2782 of base expression in a specified space.
2783 The domain of this space needs to be the same
2784 as the domains of the base expressions in the list.
2785 If the base expressions have a set space (or no associated space),
2786 then this space also needs to be a set space.
2788         #include <isl/val.h>
2789         __isl_give isl_multi_val *isl_multi_val_from_val_list(
2790                 __isl_take isl_space *space,
2791                 __isl_take isl_val_list *list);
2793         #include <isl/aff.h>
2794         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
2795                 __isl_take isl_space *space,
2796                 __isl_take isl_aff_list *list);
2797         __isl_give isl_multi_pw_aff *
2798         isl_multi_pw_aff_from_pw_aff_list(
2799                 __isl_take isl_space *space,
2800                 __isl_take isl_pw_aff_list *list);
2801         __isl_give isl_multi_union_pw_aff *
2802         isl_multi_union_pw_aff_from_union_pw_aff_list(
2803                 __isl_take isl_space *space,
2804                 __isl_take isl_union_pw_aff_list *list);
2806 As a convenience, a multiple piecewise expression can
2807 also be created from a multiple expression.
2808 Each piecewise expression in the result has a single
2809 universe cell.
2811         #include <isl/aff.h>
2812         __isl_give isl_multi_pw_aff *
2813         isl_multi_pw_aff_from_multi_aff(
2814                 __isl_take isl_multi_aff *ma);
2816 Similarly, a multiple union expression can be
2817 created from a multiple expression.
2819         #include <isl/aff.h>
2820         __isl_give isl_multi_union_pw_aff *
2821         isl_multi_union_pw_aff_from_multi_aff(
2822                 __isl_take isl_multi_aff *ma);
2823         __isl_give isl_multi_union_pw_aff *
2824         isl_multi_union_pw_aff_from_multi_pw_aff(
2825                 __isl_take isl_multi_pw_aff *mpa);
2827 A multiple quasi-affine expression can be created from
2828 a multiple value with a given domain space using the following
2829 function.
2831         #include <isl/aff.h>
2832         __isl_give isl_multi_aff *
2833         isl_multi_aff_multi_val_on_space(
2834                 __isl_take isl_space *space,
2835                 __isl_take isl_multi_val *mv);
2837 Similarly,
2838 a multiple union piecewise affine expression can be created from
2839 a multiple value with a given domain or
2840 a multiple affine expression with a given domain
2841 using the following functions.
2843         #include <isl/aff.h>
2844         __isl_give isl_multi_union_pw_aff *
2845         isl_multi_union_pw_aff_multi_val_on_domain(
2846                 __isl_take isl_union_set *domain,
2847                 __isl_take isl_multi_val *mv);
2848         __isl_give isl_multi_union_pw_aff *
2849         isl_multi_union_pw_aff_multi_aff_on_domain(
2850                 __isl_take isl_union_set *domain,
2851                 __isl_take isl_multi_aff *ma);
2853 Multiple expressions can be copied and freed using
2854 the following functions.
2856         #include <isl/val.h>
2857         __isl_give isl_multi_val *isl_multi_val_copy(
2858                 __isl_keep isl_multi_val *mv);
2859         __isl_null isl_multi_val *isl_multi_val_free(
2860                 __isl_take isl_multi_val *mv);
2862         #include <isl/aff.h>
2863         __isl_give isl_multi_aff *isl_multi_aff_copy(
2864                 __isl_keep isl_multi_aff *maff);
2865         __isl_null isl_multi_aff *isl_multi_aff_free(
2866                 __isl_take isl_multi_aff *maff);
2867         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
2868                 __isl_keep isl_multi_pw_aff *mpa);
2869         __isl_null isl_multi_pw_aff *isl_multi_pw_aff_free(
2870                 __isl_take isl_multi_pw_aff *mpa);
2871         __isl_give isl_multi_union_pw_aff *
2872         isl_multi_union_pw_aff_copy(
2873                 __isl_keep isl_multi_union_pw_aff *mupa);
2874         __isl_null isl_multi_union_pw_aff *
2875         isl_multi_union_pw_aff_free(
2876                 __isl_take isl_multi_union_pw_aff *mupa);
2878 The base expression at a given position of a multiple
2879 expression can be extracted using the following functions.
2881         #include <isl/val.h>
2882         __isl_give isl_val *isl_multi_val_get_val(
2883                 __isl_keep isl_multi_val *mv, int pos);
2885         #include <isl/aff.h>
2886         __isl_give isl_aff *isl_multi_aff_get_aff(
2887                 __isl_keep isl_multi_aff *multi, int pos);
2888         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
2889                 __isl_keep isl_multi_pw_aff *mpa, int pos);
2890         __isl_give isl_union_pw_aff *
2891         isl_multi_union_pw_aff_get_union_pw_aff(
2892                 __isl_keep isl_multi_union_pw_aff *mupa, int pos);
2894 It can be replaced using the following functions.
2896         #include <isl/val.h>
2897         __isl_give isl_multi_val *isl_multi_val_set_val(
2898                 __isl_take isl_multi_val *mv, int pos,
2899                 __isl_take isl_val *val);
2901         #include <isl/aff.h>
2902         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
2903                 __isl_take isl_multi_aff *multi, int pos,
2904                 __isl_take isl_aff *aff);
2905         __isl_give isl_multi_union_pw_aff *
2906         isl_multi_union_pw_aff_set_union_pw_aff(
2907                 __isl_take isl_multi_union_pw_aff *mupa, int pos,
2908                 __isl_take isl_union_pw_aff *upa);
2910 As a convenience, a sequence of base expressions that have
2911 their domains in a given space can be extracted from a sequence
2912 of union expressions using the following function.
2914         #include <isl/aff.h>
2915         __isl_give isl_multi_pw_aff *
2916         isl_multi_union_pw_aff_extract_multi_pw_aff(
2917                 __isl_keep isl_multi_union_pw_aff *mupa,
2918                 __isl_take isl_space *space);
2920 Note that there is a difference between C<isl_multi_union_pw_aff>
2921 and C<isl_union_pw_multi_aff> objects.  The first is a sequence
2922 of unions of piecewise expressions, while the second is a union
2923 of piecewise sequences.  In particular, multiple affine expressions
2924 in an C<isl_union_pw_multi_aff> may live in different spaces,
2925 while there is only a single multiple expression in
2926 an C<isl_multi_union_pw_aff>, which can therefore only live
2927 in a single space.  This means that not every
2928 C<isl_union_pw_multi_aff> can be converted to
2929 an C<isl_multi_union_pw_aff>.  Conversely, a zero-dimensional
2930 C<isl_multi_union_pw_aff> carries no information
2931 about any possible domain and therefore cannot be converted
2932 to an C<isl_union_pw_multi_aff>.  Moreover, the elements
2933 of an C<isl_multi_union_pw_aff> may be defined over different domains,
2934 while each multiple expression inside an C<isl_union_pw_multi_aff>
2935 has a single domain.  The conversion of an C<isl_union_pw_multi_aff>
2936 of dimension greater than one may therefore not be exact.
2937 The following functions can
2938 be used to perform these conversions when they are possible.
2940         #include <isl/aff.h>
2941         __isl_give isl_multi_union_pw_aff *
2942         isl_multi_union_pw_aff_from_union_pw_multi_aff(
2943                 __isl_take isl_union_pw_multi_aff *upma);
2944         __isl_give isl_union_pw_multi_aff *
2945         isl_union_pw_multi_aff_from_multi_union_pw_aff(
2946                 __isl_take isl_multi_union_pw_aff *mupa);
2948 =head3 Piecewise Expressions
2950 A piecewise expression is an expression that is described
2951 using zero or more base expression defined over the same
2952 number of cells in the domain space of the base expressions.
2953 All base expressions are defined over the same
2954 domain space and the cells are disjoint.
2955 The space of a piecewise expression is the same as
2956 that of the base expressions.
2957 If the union of the cells is a strict subset of the domain
2958 space, then the value of the piecewise expression outside
2959 this union is different for types derived from quasi-affine
2960 expressions and those derived from quasipolynomials.
2961 Piecewise expressions derived from quasi-affine expressions
2962 are considered to be undefined outside the union of their cells.
2963 Piecewise expressions derived from quasipolynomials
2964 are considered to be zero outside the union of their cells.
2966 Piecewise quasipolynomials are mainly used by the C<barvinok>
2967 library for representing the number of elements in a parametric set or map.
2968 For example, the piecewise quasipolynomial
2970         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
2972 represents the number of points in the map
2974         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
2976 The piecewise expression types defined by C<isl>
2977 are C<isl_pw_aff>, C<isl_pw_multi_aff>,
2978 C<isl_pw_qpolynomial> and C<isl_pw_qpolynomial_fold>.
2980 A piecewise expression with no cells can be created using
2981 the following functions.
2983         #include <isl/aff.h>
2984         __isl_give isl_pw_aff *isl_pw_aff_empty(
2985                 __isl_take isl_space *space);
2986         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
2987                 __isl_take isl_space *space);
2989 A piecewise expression with a single universe cell can be
2990 created using the following functions.
2992         #include <isl/aff.h>
2993         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2994                 __isl_take isl_aff *aff);
2995         __isl_give isl_pw_multi_aff *
2996         isl_pw_multi_aff_from_multi_aff(
2997                 __isl_take isl_multi_aff *ma);
2999         #include <isl/polynomial.h>
3000         __isl_give isl_pw_qpolynomial *
3001         isl_pw_qpolynomial_from_qpolynomial(
3002                 __isl_take isl_qpolynomial *qp);
3004 A piecewise expression with a single specified cell can be
3005 created using the following functions.
3007         #include <isl/aff.h>
3008         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3009                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3010         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3011                 __isl_take isl_set *set,
3012                 __isl_take isl_multi_aff *maff);
3014         #include <isl/polynomial.h>
3015         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
3016                 __isl_take isl_set *set,
3017                 __isl_take isl_qpolynomial *qp);
3019 The following convenience functions first create a base expression and
3020 then create a piecewise expression over a universe domain.
3022         #include <isl/aff.h>
3023         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3024                 __isl_take isl_local_space *ls);
3025         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3026                 __isl_take isl_local_space *ls,
3027                 enum isl_dim_type type, unsigned pos);
3028         __isl_give isl_pw_aff *isl_pw_aff_nan_on_domain(
3029                 __isl_take isl_local_space *ls);
3030         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_zero(
3031                 __isl_take isl_space *space);
3032         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3033                 __isl_take isl_space *space);
3034         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_range_map(
3035                 __isl_take isl_space *space);
3036         __isl_give isl_pw_multi_aff *
3037         isl_pw_multi_aff_project_out_map(
3038                 __isl_take isl_space *space,
3039                 enum isl_dim_type type,
3040                 unsigned first, unsigned n);
3042         #include <isl/polynomial.h>
3043         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
3044                 __isl_take isl_space *space);
3046 The following convenience functions first create a base expression and
3047 then create a piecewise expression over a given domain.
3049         #include <isl/aff.h>
3050         __isl_give isl_pw_aff *isl_pw_aff_val_on_domain(
3051                 __isl_take isl_set *domain,
3052                 __isl_take isl_val *v);
3053         __isl_give isl_pw_multi_aff *
3054         isl_pw_multi_aff_multi_val_on_domain(
3055                 __isl_take isl_set *domain,
3056                 __isl_take isl_multi_val *mv);
3058 As a convenience, a piecewise multiple expression can
3059 also be created from a piecewise expression.
3060 Each multiple expression in the result is derived
3061 from the corresponding base expression.
3063         #include <isl/aff.h>
3064         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_pw_aff(
3065                 __isl_take isl_pw_aff *pa);
3067 Similarly, a piecewise quasipolynomial can be
3068 created from a piecewise quasi-affine expression using
3069 the following function.
3071         #include <isl/polynomial.h>
3072         __isl_give isl_pw_qpolynomial *
3073         isl_pw_qpolynomial_from_pw_aff(
3074                 __isl_take isl_pw_aff *pwaff);
3076 Piecewise expressions can be copied and freed using the following functions.
3078         #include <isl/aff.h>
3079         __isl_give isl_pw_aff *isl_pw_aff_copy(
3080                 __isl_keep isl_pw_aff *pwaff);
3081         __isl_null isl_pw_aff *isl_pw_aff_free(
3082                 __isl_take isl_pw_aff *pwaff);
3083         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3084                 __isl_keep isl_pw_multi_aff *pma);
3085         __isl_null isl_pw_multi_aff *isl_pw_multi_aff_free(
3086                 __isl_take isl_pw_multi_aff *pma);
3088         #include <isl/polynomial.h>
3089         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
3090                 __isl_keep isl_pw_qpolynomial *pwqp);
3091         __isl_null isl_pw_qpolynomial *isl_pw_qpolynomial_free(
3092                 __isl_take isl_pw_qpolynomial *pwqp);
3093         __isl_give isl_pw_qpolynomial_fold *
3094         isl_pw_qpolynomial_fold_copy(
3095                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3096         __isl_null isl_pw_qpolynomial_fold *
3097         isl_pw_qpolynomial_fold_free(
3098                 __isl_take isl_pw_qpolynomial_fold *pwf);
3100 To iterate over the different cells of a piecewise expression,
3101 use the following functions.
3103         #include <isl/aff.h>
3104         isl_bool isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3105         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3106         isl_stat isl_pw_aff_foreach_piece(
3107                 __isl_keep isl_pw_aff *pwaff,
3108                 isl_stat (*fn)(__isl_take isl_set *set,
3109                           __isl_take isl_aff *aff,
3110                           void *user), void *user);
3111         int isl_pw_multi_aff_n_piece(
3112                 __isl_keep isl_pw_multi_aff *pma);
3113         isl_stat isl_pw_multi_aff_foreach_piece(
3114                 __isl_keep isl_pw_multi_aff *pma,
3115                 isl_stat (*fn)(__isl_take isl_set *set,
3116                             __isl_take isl_multi_aff *maff,
3117                             void *user), void *user);
3119         #include <isl/polynomial.h>
3120         int isl_pw_qpolynomial_n_piece(
3121                 __isl_keep isl_pw_qpolynomial *pwqp);
3122         isl_stat isl_pw_qpolynomial_foreach_piece(
3123                 __isl_keep isl_pw_qpolynomial *pwqp,
3124                 isl_stat (*fn)(__isl_take isl_set *set,
3125                           __isl_take isl_qpolynomial *qp,
3126                           void *user), void *user);
3127         isl_stat isl_pw_qpolynomial_foreach_lifted_piece(
3128                 __isl_keep isl_pw_qpolynomial *pwqp,
3129                 isl_stat (*fn)(__isl_take isl_set *set,
3130                           __isl_take isl_qpolynomial *qp,
3131                           void *user), void *user);
3132         int isl_pw_qpolynomial_fold_n_piece(
3133                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3134         isl_stat isl_pw_qpolynomial_fold_foreach_piece(
3135                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3136                 isl_stat (*fn)(__isl_take isl_set *set,
3137                           __isl_take isl_qpolynomial_fold *fold,
3138                           void *user), void *user);
3139         isl_stat isl_pw_qpolynomial_fold_foreach_lifted_piece(
3140                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3141                 isl_stat (*fn)(__isl_take isl_set *set,
3142                           __isl_take isl_qpolynomial_fold *fold,
3143                           void *user), void *user);
3145 As usual, the function C<fn> should return C<0> on success
3146 and C<-1> on failure.  The difference between
3147 C<isl_pw_qpolynomial_foreach_piece> and
3148 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
3149 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
3150 compute unique representations for all existentially quantified
3151 variables and then turn these existentially quantified variables
3152 into extra set variables, adapting the associated quasipolynomial
3153 accordingly.  This means that the C<set> passed to C<fn>
3154 will not have any existentially quantified variables, but that
3155 the dimensions of the sets may be different for different
3156 invocations of C<fn>.
3157 Similarly for C<isl_pw_qpolynomial_fold_foreach_piece>
3158 and C<isl_pw_qpolynomial_fold_foreach_lifted_piece>.
3160 A piecewise expression consisting of the expressions at a given
3161 position of a piecewise multiple expression can be extracted
3162 using the following function.
3164         #include <isl/aff.h>
3165         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3166                 __isl_keep isl_pw_multi_aff *pma, int pos);
3168 These expressions can be replaced using the following function.
3170         #include <isl/aff.h>
3171         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
3172                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
3173                 __isl_take isl_pw_aff *pa);
3175 Note that there is a difference between C<isl_multi_pw_aff> and
3176 C<isl_pw_multi_aff> objects.  The first is a sequence of piecewise
3177 affine expressions, while the second is a piecewise sequence
3178 of affine expressions.  In particular, each of the piecewise
3179 affine expressions in an C<isl_multi_pw_aff> may have a different
3180 domain, while all multiple expressions associated to a cell
3181 in an C<isl_pw_multi_aff> have the same domain.
3182 It is possible to convert between the two, but when converting
3183 an C<isl_multi_pw_aff> to an C<isl_pw_multi_aff>, the domain
3184 of the result is the intersection of the domains of the input.
3185 The reverse conversion is exact.
3187         #include <isl/aff.h>
3188         __isl_give isl_pw_multi_aff *
3189         isl_pw_multi_aff_from_multi_pw_aff(
3190                 __isl_take isl_multi_pw_aff *mpa);
3191         __isl_give isl_multi_pw_aff *
3192         isl_multi_pw_aff_from_pw_multi_aff(
3193                 __isl_take isl_pw_multi_aff *pma);
3195 =head3 Union Expressions
3197 A union expression collects base expressions defined
3198 over different domains.  The space of a union expression
3199 is that of the shared parameter space.
3201 The union expression types defined by C<isl>
3202 are C<isl_union_pw_aff>, C<isl_union_pw_multi_aff>,
3203 C<isl_union_pw_qpolynomial> and C<isl_union_pw_qpolynomial_fold>.
3204 In case of
3205 C<isl_union_pw_aff>,
3206 C<isl_union_pw_qpolynomial> and C<isl_union_pw_qpolynomial_fold>,
3207 there can be at most one base expression for a given domain space.
3208 In case of
3209 C<isl_union_pw_multi_aff>,
3210 there can be multiple such expressions for a given domain space,
3211 but the domains of these expressions need to be disjoint.
3213 An empty union expression can be created using the following functions.
3215         #include <isl/aff.h>
3216         __isl_give isl_union_pw_aff *isl_union_pw_aff_empty(
3217                 __isl_take isl_space *space);
3218         __isl_give isl_union_pw_multi_aff *
3219         isl_union_pw_multi_aff_empty(
3220                 __isl_take isl_space *space);
3222         #include <isl/polynomial.h>
3223         __isl_give isl_union_pw_qpolynomial *
3224         isl_union_pw_qpolynomial_zero(
3225                 __isl_take isl_space *space);
3227 A union expression containing a single base expression
3228 can be created using the following functions.
3230         #include <isl/aff.h>
3231         __isl_give isl_union_pw_aff *
3232         isl_union_pw_aff_from_pw_aff(
3233                 __isl_take isl_pw_aff *pa);
3234         __isl_give isl_union_pw_multi_aff *
3235         isl_union_pw_multi_aff_from_aff(
3236                 __isl_take isl_aff *aff);
3237         __isl_give isl_union_pw_multi_aff *
3238         isl_union_pw_multi_aff_from_pw_multi_aff(
3239                 __isl_take isl_pw_multi_aff *pma);
3241         #include <isl/polynomial.h>
3242         __isl_give isl_union_pw_qpolynomial *
3243         isl_union_pw_qpolynomial_from_pw_qpolynomial(
3244                 __isl_take isl_pw_qpolynomial *pwqp);
3246 The following functions create a base expression on each
3247 of the sets in the union set and collect the results.
3249         #include <isl/aff.h>
3250         __isl_give isl_union_pw_multi_aff *
3251         isl_union_pw_multi_aff_from_union_pw_aff(
3252                 __isl_take isl_union_pw_aff *upa);
3253         __isl_give isl_union_pw_aff *
3254         isl_union_pw_multi_aff_get_union_pw_aff(
3255                 __isl_keep isl_union_pw_multi_aff *upma, int pos);
3256         __isl_give isl_union_pw_aff *
3257         isl_union_pw_aff_val_on_domain(
3258                 __isl_take isl_union_set *domain,
3259                 __isl_take isl_val *v);
3260         __isl_give isl_union_pw_multi_aff *
3261         isl_union_pw_multi_aff_multi_val_on_domain(
3262                 __isl_take isl_union_set *domain,
3263                 __isl_take isl_multi_val *mv);
3265 An C<isl_union_pw_aff> that is equal to a (parametric) affine
3266 expression on a given domain can be created using the following
3267 function.
3269         #include <isl/aff.h>
3270         __isl_give isl_union_pw_aff *
3271         isl_union_pw_aff_aff_on_domain(
3272                 __isl_take isl_union_set *domain,
3273                 __isl_take isl_aff *aff);
3275 A base expression can be added to a union expression using
3276 the following functions.
3278         #include <isl/aff.h>
3279         __isl_give isl_union_pw_aff *
3280         isl_union_pw_aff_add_pw_aff(
3281                 __isl_take isl_union_pw_aff *upa,
3282                 __isl_take isl_pw_aff *pa);
3283         __isl_give isl_union_pw_multi_aff *
3284         isl_union_pw_multi_aff_add_pw_multi_aff(
3285                 __isl_take isl_union_pw_multi_aff *upma,
3286                 __isl_take isl_pw_multi_aff *pma);
3288         #include <isl/polynomial.h>
3289         __isl_give isl_union_pw_qpolynomial *
3290         isl_union_pw_qpolynomial_add_pw_qpolynomial(
3291                 __isl_take isl_union_pw_qpolynomial *upwqp,
3292                 __isl_take isl_pw_qpolynomial *pwqp);
3294 Union expressions can be copied and freed using
3295 the following functions.
3297         #include <isl/aff.h>
3298         __isl_give isl_union_pw_aff *isl_union_pw_aff_copy(
3299                 __isl_keep isl_union_pw_aff *upa);
3300         __isl_null isl_union_pw_aff *isl_union_pw_aff_free(
3301                 __isl_take isl_union_pw_aff *upa);
3302         __isl_give isl_union_pw_multi_aff *
3303         isl_union_pw_multi_aff_copy(
3304                 __isl_keep isl_union_pw_multi_aff *upma);
3305         __isl_null isl_union_pw_multi_aff *
3306         isl_union_pw_multi_aff_free(
3307                 __isl_take isl_union_pw_multi_aff *upma);
3309         #include <isl/polynomial.h>
3310         __isl_give isl_union_pw_qpolynomial *
3311         isl_union_pw_qpolynomial_copy(
3312                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3313         __isl_null isl_union_pw_qpolynomial *
3314         isl_union_pw_qpolynomial_free(
3315                 __isl_take isl_union_pw_qpolynomial *upwqp);
3316         __isl_give isl_union_pw_qpolynomial_fold *
3317         isl_union_pw_qpolynomial_fold_copy(
3318                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3319         __isl_null isl_union_pw_qpolynomial_fold *
3320         isl_union_pw_qpolynomial_fold_free(
3321                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3323 To iterate over the base expressions in a union expression,
3324 use the following functions.
3326         #include <isl/aff.h>
3327         int isl_union_pw_aff_n_pw_aff(
3328                 __isl_keep isl_union_pw_aff *upa);
3329         isl_stat isl_union_pw_aff_foreach_pw_aff(
3330                 __isl_keep isl_union_pw_aff *upa,
3331                 isl_stat (*fn)(__isl_take isl_pw_aff *pa,
3332                         void *user), void *user);
3333         int isl_union_pw_multi_aff_n_pw_multi_aff(
3334                 __isl_keep isl_union_pw_multi_aff *upma);
3335         isl_stat isl_union_pw_multi_aff_foreach_pw_multi_aff(
3336                 __isl_keep isl_union_pw_multi_aff *upma,
3337                 isl_stat (*fn)(__isl_take isl_pw_multi_aff *pma,
3338                             void *user), void *user);
3340         #include <isl/polynomial.h>
3341         int isl_union_pw_qpolynomial_n_pw_qpolynomial(
3342                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3343         isl_stat isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
3344                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3345                 isl_stat (*fn)(__isl_take isl_pw_qpolynomial *pwqp,
3346                             void *user), void *user);
3347         int isl_union_pw_qpolynomial_fold_n_pw_qpolynomial_fold(
3348                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3349         isl_stat isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
3350                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
3351                 isl_stat (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
3352                             void *user), void *user);
3354 To extract the base expression in a given space from a union, use
3355 the following functions.
3357         #include <isl/aff.h>
3358         __isl_give isl_pw_aff *isl_union_pw_aff_extract_pw_aff(
3359                 __isl_keep isl_union_pw_aff *upa,
3360                 __isl_take isl_space *space);
3361         __isl_give isl_pw_multi_aff *
3362         isl_union_pw_multi_aff_extract_pw_multi_aff(
3363                 __isl_keep isl_union_pw_multi_aff *upma,
3364                 __isl_take isl_space *space);
3366         #include <isl/polynomial.h>
3367         __isl_give isl_pw_qpolynomial *
3368         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
3369                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3370                 __isl_take isl_space *space);
3372 =head2 Input and Output
3374 For set and relation,
3375 C<isl> supports its own input/output format, which is similar
3376 to the C<Omega> format, but also supports the C<PolyLib> format
3377 in some cases.
3378 For other object types, typically only an C<isl> format is supported.
3380 =head3 C<isl> format
3382 The C<isl> format is similar to that of C<Omega>, but has a different
3383 syntax for describing the parameters and allows for the definition
3384 of an existentially quantified variable as the integer division
3385 of an affine expression.
3386 For example, the set of integers C<i> between C<0> and C<n>
3387 such that C<i % 10 <= 6> can be described as
3389         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
3390                                 i - 10 a <= 6) }
3392 A set or relation can have several disjuncts, separated
3393 by the keyword C<or>.  Each disjunct is either a conjunction
3394 of constraints or a projection (C<exists>) of a conjunction
3395 of constraints.  The constraints are separated by the keyword
3396 C<and>.
3398 =head3 C<PolyLib> format
3400 If the represented set is a union, then the first line
3401 contains a single number representing the number of disjuncts.
3402 Otherwise, a line containing the number C<1> is optional.
3404 Each disjunct is represented by a matrix of constraints.
3405 The first line contains two numbers representing
3406 the number of rows and columns,
3407 where the number of rows is equal to the number of constraints
3408 and the number of columns is equal to two plus the number of variables.
3409 The following lines contain the actual rows of the constraint matrix.
3410 In each row, the first column indicates whether the constraint
3411 is an equality (C<0>) or inequality (C<1>).  The final column
3412 corresponds to the constant term.
3414 If the set is parametric, then the coefficients of the parameters
3415 appear in the last columns before the constant column.
3416 The coefficients of any existentially quantified variables appear
3417 between those of the set variables and those of the parameters.
3419 =head3 Extended C<PolyLib> format
3421 The extended C<PolyLib> format is nearly identical to the
3422 C<PolyLib> format.  The only difference is that the line
3423 containing the number of rows and columns of a constraint matrix
3424 also contains four additional numbers:
3425 the number of output dimensions, the number of input dimensions,
3426 the number of local dimensions (i.e., the number of existentially
3427 quantified variables) and the number of parameters.
3428 For sets, the number of ``output'' dimensions is equal
3429 to the number of set dimensions, while the number of ``input''
3430 dimensions is zero.
3432 =head3 Input
3434 Objects can be read from input using the following functions.
3436         #include <isl/val.h>
3437         __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
3438                 const char *str);
3439         __isl_give isl_multi_val *isl_multi_val_read_from_str(
3440                 isl_ctx *ctx, const char *str);
3442         #include <isl/set.h>
3443         __isl_give isl_basic_set *isl_basic_set_read_from_file(
3444                 isl_ctx *ctx, FILE *input);
3445         __isl_give isl_basic_set *isl_basic_set_read_from_str(
3446                 isl_ctx *ctx, const char *str);
3447         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
3448                 FILE *input);
3449         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
3450                 const char *str);
3452         #include <isl/map.h>
3453         __isl_give isl_basic_map *isl_basic_map_read_from_file(
3454                 isl_ctx *ctx, FILE *input);
3455         __isl_give isl_basic_map *isl_basic_map_read_from_str(
3456                 isl_ctx *ctx, const char *str);
3457         __isl_give isl_map *isl_map_read_from_file(
3458                 isl_ctx *ctx, FILE *input);
3459         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
3460                 const char *str);
3462         #include <isl/union_set.h>
3463         __isl_give isl_union_set *isl_union_set_read_from_file(
3464                 isl_ctx *ctx, FILE *input);
3465         __isl_give isl_union_set *isl_union_set_read_from_str(
3466                 isl_ctx *ctx, const char *str);
3468         #include <isl/union_map.h>
3469         __isl_give isl_union_map *isl_union_map_read_from_file(
3470                 isl_ctx *ctx, FILE *input);
3471         __isl_give isl_union_map *isl_union_map_read_from_str(
3472                 isl_ctx *ctx, const char *str);
3474         #include <isl/aff.h>
3475         __isl_give isl_aff *isl_aff_read_from_str(
3476                 isl_ctx *ctx, const char *str);
3477         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3478                 isl_ctx *ctx, const char *str);
3479         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3480                 isl_ctx *ctx, const char *str);
3481         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3482                 isl_ctx *ctx, const char *str);
3483         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_read_from_str(
3484                 isl_ctx *ctx, const char *str);
3485         __isl_give isl_union_pw_aff *
3486         isl_union_pw_aff_read_from_str(
3487                 isl_ctx *ctx, const char *str);
3488         __isl_give isl_union_pw_multi_aff *
3489         isl_union_pw_multi_aff_read_from_str(
3490                 isl_ctx *ctx, const char *str);
3491         __isl_give isl_multi_union_pw_aff *
3492         isl_multi_union_pw_aff_read_from_str(
3493                 isl_ctx *ctx, const char *str);
3495         #include <isl/polynomial.h>
3496         __isl_give isl_union_pw_qpolynomial *
3497         isl_union_pw_qpolynomial_read_from_str(
3498                 isl_ctx *ctx, const char *str);
3500 For sets and relations,
3501 the input format is autodetected and may be either the C<PolyLib> format
3502 or the C<isl> format.
3504 =head3 Output
3506 Before anything can be printed, an C<isl_printer> needs to
3507 be created.
3509         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
3510                 FILE *file);
3511         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
3512         __isl_null isl_printer *isl_printer_free(
3513                 __isl_take isl_printer *printer);
3515 C<isl_printer_to_file> prints to the given file, while
3516 C<isl_printer_to_str> prints to a string that can be extracted
3517 using the following function.
3519         #include <isl/printer.h>
3520         __isl_give char *isl_printer_get_str(
3521                 __isl_keep isl_printer *printer);
3523 The printer can be inspected using the following functions.
3525         FILE *isl_printer_get_file(
3526                 __isl_keep isl_printer *printer);
3527         int isl_printer_get_output_format(
3528                 __isl_keep isl_printer *p);
3529         int isl_printer_get_yaml_style(__isl_keep isl_printer *p);
3531 The behavior of the printer can be modified in various ways
3533         __isl_give isl_printer *isl_printer_set_output_format(
3534                 __isl_take isl_printer *p, int output_format);
3535         __isl_give isl_printer *isl_printer_set_indent(
3536                 __isl_take isl_printer *p, int indent);
3537         __isl_give isl_printer *isl_printer_set_indent_prefix(
3538                 __isl_take isl_printer *p, const char *prefix);
3539         __isl_give isl_printer *isl_printer_indent(
3540                 __isl_take isl_printer *p, int indent);
3541         __isl_give isl_printer *isl_printer_set_prefix(
3542                 __isl_take isl_printer *p, const char *prefix);
3543         __isl_give isl_printer *isl_printer_set_suffix(
3544                 __isl_take isl_printer *p, const char *suffix);
3545         __isl_give isl_printer *isl_printer_set_yaml_style(
3546                 __isl_take isl_printer *p, int yaml_style);
3548 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
3549 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
3550 and defaults to C<ISL_FORMAT_ISL>.
3551 Each line in the output is prefixed by C<indent_prefix>,
3552 indented by C<indent> (set by C<isl_printer_set_indent>) spaces
3553 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
3554 In the C<PolyLib> format output,
3555 the coefficients of the existentially quantified variables
3556 appear between those of the set variables and those
3557 of the parameters.
3558 The function C<isl_printer_indent> increases the indentation
3559 by the specified amount (which may be negative).
3560 The YAML style may be either C<ISL_YAML_STYLE_BLOCK> or
3561 C<ISL_YAML_STYLE_FLOW> and when we are printing something
3562 in YAML format.
3564 To actually print something, use
3566         #include <isl/printer.h>
3567         __isl_give isl_printer *isl_printer_print_double(
3568                 __isl_take isl_printer *p, double d);
3570         #include <isl/val.h>
3571         __isl_give isl_printer *isl_printer_print_val(
3572                 __isl_take isl_printer *p, __isl_keep isl_val *v);
3574         #include <isl/set.h>
3575         __isl_give isl_printer *isl_printer_print_basic_set(
3576                 __isl_take isl_printer *printer,
3577                 __isl_keep isl_basic_set *bset);
3578         __isl_give isl_printer *isl_printer_print_set(
3579                 __isl_take isl_printer *printer,
3580                 __isl_keep isl_set *set);
3582         #include <isl/map.h>
3583         __isl_give isl_printer *isl_printer_print_basic_map(
3584                 __isl_take isl_printer *printer,
3585                 __isl_keep isl_basic_map *bmap);
3586         __isl_give isl_printer *isl_printer_print_map(
3587                 __isl_take isl_printer *printer,
3588                 __isl_keep isl_map *map);
3590         #include <isl/union_set.h>
3591         __isl_give isl_printer *isl_printer_print_union_set(
3592                 __isl_take isl_printer *p,
3593                 __isl_keep isl_union_set *uset);
3595         #include <isl/union_map.h>
3596         __isl_give isl_printer *isl_printer_print_union_map(
3597                 __isl_take isl_printer *p,
3598                 __isl_keep isl_union_map *umap);
3600         #include <isl/val.h>
3601         __isl_give isl_printer *isl_printer_print_multi_val(
3602                 __isl_take isl_printer *p,
3603                 __isl_keep isl_multi_val *mv);
3605         #include <isl/aff.h>
3606         __isl_give isl_printer *isl_printer_print_aff(
3607                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3608         __isl_give isl_printer *isl_printer_print_multi_aff(
3609                 __isl_take isl_printer *p,
3610                 __isl_keep isl_multi_aff *maff);
3611         __isl_give isl_printer *isl_printer_print_pw_aff(
3612                 __isl_take isl_printer *p,
3613                 __isl_keep isl_pw_aff *pwaff);
3614         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3615                 __isl_take isl_printer *p,
3616                 __isl_keep isl_pw_multi_aff *pma);
3617         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
3618                 __isl_take isl_printer *p,
3619                 __isl_keep isl_multi_pw_aff *mpa);
3620         __isl_give isl_printer *isl_printer_print_union_pw_aff(
3621                 __isl_take isl_printer *p,
3622                 __isl_keep isl_union_pw_aff *upa);
3623         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
3624                 __isl_take isl_printer *p,
3625                 __isl_keep isl_union_pw_multi_aff *upma);
3626         __isl_give isl_printer *
3627         isl_printer_print_multi_union_pw_aff(
3628                 __isl_take isl_printer *p,
3629                 __isl_keep isl_multi_union_pw_aff *mupa);
3631         #include <isl/polynomial.h>
3632         __isl_give isl_printer *isl_printer_print_qpolynomial(
3633                 __isl_take isl_printer *p,
3634                 __isl_keep isl_qpolynomial *qp);
3635         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3636                 __isl_take isl_printer *p,
3637                 __isl_keep isl_pw_qpolynomial *pwqp);
3638         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3639                 __isl_take isl_printer *p,
3640                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3642         __isl_give isl_printer *
3643         isl_printer_print_pw_qpolynomial_fold(
3644                 __isl_take isl_printer *p,
3645                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3646         __isl_give isl_printer *
3647         isl_printer_print_union_pw_qpolynomial_fold(
3648                 __isl_take isl_printer *p,
3649                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3651 For C<isl_printer_print_qpolynomial>,
3652 C<isl_printer_print_pw_qpolynomial> and
3653 C<isl_printer_print_pw_qpolynomial_fold>,
3654 the output format of the printer
3655 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3656 For C<isl_printer_print_union_pw_qpolynomial> and
3657 C<isl_printer_print_union_pw_qpolynomial_fold>, only C<ISL_FORMAT_ISL>
3658 is supported.
3659 In case of printing in C<ISL_FORMAT_C>, the user may want
3660 to set the names of all dimensions first.
3662 C<isl> also provides limited support for printing YAML documents,
3663 just enough for the internal use for printing such documents.
3665         #include <isl/printer.h>
3666         __isl_give isl_printer *isl_printer_yaml_start_mapping(
3667                 __isl_take isl_printer *p);
3668         __isl_give isl_printer *isl_printer_yaml_end_mapping(
3669                 __isl_take isl_printer *p);
3670         __isl_give isl_printer *isl_printer_yaml_start_sequence(
3671                 __isl_take isl_printer *p);
3672         __isl_give isl_printer *isl_printer_yaml_end_sequence(
3673                 __isl_take isl_printer *p);
3674         __isl_give isl_printer *isl_printer_yaml_next(
3675                 __isl_take isl_printer *p);
3677 A document is started by a call to either
3678 C<isl_printer_yaml_start_mapping> or C<isl_printer_yaml_start_sequence>.
3679 Anything printed to the printer after such a call belong to the
3680 first key of the mapping or the first element in the sequence.
3681 The function C<isl_printer_yaml_next> moves to the value if
3682 we are currently printing a mapping key, the next key if we
3683 are printing a value or the next element if we are printing
3684 an element in a sequence.
3685 Nested mappings and sequences are initiated by the same
3686 C<isl_printer_yaml_start_mapping> or C<isl_printer_yaml_start_sequence>.
3687 Each call to these functions needs to have a corresponding call to
3688 C<isl_printer_yaml_end_mapping> or C<isl_printer_yaml_end_sequence>.
3690 When called on a file printer, the following function flushes
3691 the file.  When called on a string printer, the buffer is cleared.
3693         __isl_give isl_printer *isl_printer_flush(
3694                 __isl_take isl_printer *p);
3696 The following functions allow the user to attach
3697 notes to a printer in order to keep track of additional state.
3699         #include <isl/printer.h>
3700         isl_bool isl_printer_has_note(__isl_keep isl_printer *p,
3701                 __isl_keep isl_id *id);
3702         __isl_give isl_id *isl_printer_get_note(
3703                 __isl_keep isl_printer *p, __isl_take isl_id *id);
3704         __isl_give isl_printer *isl_printer_set_note(
3705                 __isl_take isl_printer *p,
3706                 __isl_take isl_id *id, __isl_take isl_id *note);
3708 C<isl_printer_set_note> associates the given note to the given
3709 identifier in the printer.
3710 C<isl_printer_get_note> retrieves a note associated to an
3711 identifier, while
3712 C<isl_printer_has_note> checks if there is such a note.
3713 C<isl_printer_get_note> fails if the requested note does not exist.
3715 Alternatively, a string representation can be obtained
3716 directly using the following functions, which always print
3717 in isl format.
3719         #include <isl/id.h>
3720         __isl_give char *isl_id_to_str(
3721                 __isl_keep isl_id *id);
3723         #include <isl/space.h>
3724         __isl_give char *isl_space_to_str(
3725                 __isl_keep isl_space *space);
3727         #include <isl/val.h>
3728         __isl_give char *isl_val_to_str(__isl_keep isl_val *v);
3729         __isl_give char *isl_multi_val_to_str(
3730                 __isl_keep isl_multi_val *mv);
3732         #include <isl/set.h>
3733         __isl_give char *isl_basic_set_to_str(
3734                 __isl_keep isl_basic_set *bset);
3735         __isl_give char *isl_set_to_str(
3736                 __isl_keep isl_set *set);
3738         #include <isl/union_set.h>
3739         __isl_give char *isl_union_set_to_str(
3740                 __isl_keep isl_union_set *uset);
3742         #include <isl/map.h>
3743         __isl_give char *isl_basic_map_to_str(
3744                 __isl_keep isl_basic_map *bmap);
3745         __isl_give char *isl_map_to_str(
3746                 __isl_keep isl_map *map);
3748         #include <isl/union_map.h>
3749         __isl_give char *isl_union_map_to_str(
3750                 __isl_keep isl_union_map *umap);
3752         #include <isl/aff.h>
3753         __isl_give char *isl_aff_to_str(__isl_keep isl_aff *aff);
3754         __isl_give char *isl_pw_aff_to_str(
3755                 __isl_keep isl_pw_aff *pa);
3756         __isl_give char *isl_multi_aff_to_str(
3757                 __isl_keep isl_multi_aff *ma);
3758         __isl_give char *isl_pw_multi_aff_to_str(
3759                 __isl_keep isl_pw_multi_aff *pma);
3760         __isl_give char *isl_multi_pw_aff_to_str(
3761                 __isl_keep isl_multi_pw_aff *mpa);
3762         __isl_give char *isl_union_pw_aff_to_str(
3763                 __isl_keep isl_union_pw_aff *upa);
3764         __isl_give char *isl_union_pw_multi_aff_to_str(
3765                 __isl_keep isl_union_pw_multi_aff *upma);
3766         __isl_give char *isl_multi_union_pw_aff_to_str(
3767                 __isl_keep isl_multi_union_pw_aff *mupa);
3769         #include <isl/point.h>
3770         __isl_give char *isl_point_to_str(
3771                 __isl_keep isl_point *pnt);
3773         #include <isl/polynomial.h>
3774         __isl_give char *isl_pw_qpolynomial_to_str(
3775                 __isl_keep isl_pw_qpolynomial *pwqp);
3776         __isl_give char *isl_union_pw_qpolynomial_to_str(
3777                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3779 =head2 Properties
3781 =head3 Unary Properties
3783 =over
3785 =item * Emptiness
3787 The following functions test whether the given set or relation
3788 contains any integer points.  The ``plain'' variants do not perform
3789 any computations, but simply check if the given set or relation
3790 is already known to be empty.
3792         isl_bool isl_basic_set_plain_is_empty(
3793                 __isl_keep isl_basic_set *bset);
3794         isl_bool isl_basic_set_is_empty(
3795                 __isl_keep isl_basic_set *bset);
3796         isl_bool isl_set_plain_is_empty(
3797                 __isl_keep isl_set *set);
3798         isl_bool isl_set_is_empty(__isl_keep isl_set *set);
3799         isl_bool isl_union_set_is_empty(
3800                 __isl_keep isl_union_set *uset);
3801         isl_bool isl_basic_map_plain_is_empty(
3802                 __isl_keep isl_basic_map *bmap);
3803         isl_bool isl_basic_map_is_empty(
3804                 __isl_keep isl_basic_map *bmap);
3805         isl_bool isl_map_plain_is_empty(
3806                 __isl_keep isl_map *map);
3807         isl_bool isl_map_is_empty(__isl_keep isl_map *map);
3808         isl_bool isl_union_map_is_empty(
3809                 __isl_keep isl_union_map *umap);
3811 =item * Universality
3813         isl_bool isl_basic_set_plain_is_universe(
3814                 __isl_keep isl_basic_set *bset);
3815         isl_bool isl_basic_set_is_universe(
3816                 __isl_keep isl_basic_set *bset);
3817         isl_bool isl_basic_map_plain_is_universe(
3818                 __isl_keep isl_basic_map *bmap);
3819         isl_bool isl_basic_map_is_universe(
3820                 __isl_keep isl_basic_map *bmap);
3821         isl_bool isl_set_plain_is_universe(
3822                 __isl_keep isl_set *set);
3823         isl_bool isl_map_plain_is_universe(
3824                 __isl_keep isl_map *map);
3826 =item * Single-valuedness
3828         #include <isl/set.h>
3829         isl_bool isl_set_is_singleton(__isl_keep isl_set *set);
3831         #include <isl/map.h>
3832         isl_bool isl_basic_map_is_single_valued(
3833                 __isl_keep isl_basic_map *bmap);
3834         isl_bool isl_map_plain_is_single_valued(
3835                 __isl_keep isl_map *map);
3836         isl_bool isl_map_is_single_valued(__isl_keep isl_map *map);
3838         #include <isl/union_map.h>
3839         isl_bool isl_union_map_is_single_valued(
3840                 __isl_keep isl_union_map *umap);
3842 =item * Injectivity
3844         isl_bool isl_map_plain_is_injective(
3845                 __isl_keep isl_map *map);
3846         isl_bool isl_map_is_injective(
3847                 __isl_keep isl_map *map);
3848         isl_bool isl_union_map_plain_is_injective(
3849                 __isl_keep isl_union_map *umap);
3850         isl_bool isl_union_map_is_injective(
3851                 __isl_keep isl_union_map *umap);
3853 =item * Bijectivity
3855         isl_bool isl_map_is_bijective(
3856                 __isl_keep isl_map *map);
3857         isl_bool isl_union_map_is_bijective(
3858                 __isl_keep isl_union_map *umap);
3860 =item * Identity
3862 The following functions test whether the given relation
3863 only maps elements to themselves.
3865         #include <isl/map.h>
3866         isl_bool isl_map_is_identity(
3867                 __isl_keep isl_map *map);
3869         #include <isl/union_map.h>
3870         isl_bool isl_union_map_is_identity(
3871                 __isl_keep isl_union_map *umap);
3873 =item * Position
3875         __isl_give isl_val *
3876         isl_basic_map_plain_get_val_if_fixed(
3877                 __isl_keep isl_basic_map *bmap,
3878                 enum isl_dim_type type, unsigned pos);
3879         __isl_give isl_val *isl_set_plain_get_val_if_fixed(
3880                 __isl_keep isl_set *set,
3881                 enum isl_dim_type type, unsigned pos);
3882         __isl_give isl_val *isl_map_plain_get_val_if_fixed(
3883                 __isl_keep isl_map *map,
3884                 enum isl_dim_type type, unsigned pos);
3886 If the set or relation obviously lies on a hyperplane where the given dimension
3887 has a fixed value, then return that value.
3888 Otherwise return NaN.
3890 =item * Stride
3892         isl_stat isl_set_dim_residue_class_val(
3893                 __isl_keep isl_set *set,
3894                 int pos, __isl_give isl_val **modulo,
3895                 __isl_give isl_val **residue);
3897 Check if the values of the given set dimension are equal to a fixed
3898 value modulo some integer value.  If so, assign the modulo to C<*modulo>
3899 and the fixed value to C<*residue>.  If the given dimension attains only
3900 a single value, then assign C<0> to C<*modulo> and the fixed value to
3901 C<*residue>.
3902 If the dimension does not attain only a single value and if no modulo
3903 can be found then assign C<1> to C<*modulo> and C<1> to C<*residue>.
3905 =item * Dependence
3907 To check whether the description of a set, relation or function depends
3908 on one or more given dimensions,
3909 the following functions can be used.
3911         #include <isl/constraint.h>
3912         isl_bool isl_constraint_involves_dims(
3913                 __isl_keep isl_constraint *constraint,
3914                 enum isl_dim_type type, unsigned first, unsigned n);
3916         #include <isl/set.h>
3917         isl_bool isl_basic_set_involves_dims(
3918                 __isl_keep isl_basic_set *bset,
3919                 enum isl_dim_type type, unsigned first, unsigned n);
3920         isl_bool isl_set_involves_dims(__isl_keep isl_set *set,
3921                 enum isl_dim_type type, unsigned first, unsigned n);
3923         #include <isl/map.h>
3924         isl_bool isl_basic_map_involves_dims(
3925                 __isl_keep isl_basic_map *bmap,
3926                 enum isl_dim_type type, unsigned first, unsigned n);
3927         isl_bool isl_map_involves_dims(__isl_keep isl_map *map,
3928                 enum isl_dim_type type, unsigned first, unsigned n);
3930         #include <isl/union_map.h>
3931         isl_bool isl_union_map_involves_dims(
3932                 __isl_keep isl_union_map *umap,
3933                 enum isl_dim_type type, unsigned first, unsigned n);
3935         #include <isl/aff.h>
3936         isl_bool isl_aff_involves_dims(__isl_keep isl_aff *aff,
3937                 enum isl_dim_type type, unsigned first, unsigned n);
3938         isl_bool isl_pw_aff_involves_dims(
3939                 __isl_keep isl_pw_aff *pwaff,
3940                 enum isl_dim_type type, unsigned first, unsigned n);
3941         isl_bool isl_multi_aff_involves_dims(
3942                 __isl_keep isl_multi_aff *ma,
3943                 enum isl_dim_type type, unsigned first, unsigned n);
3944         isl_bool isl_multi_pw_aff_involves_dims(
3945                 __isl_keep isl_multi_pw_aff *mpa,
3946                 enum isl_dim_type type, unsigned first, unsigned n);
3948         #include <isl/polynomial.h>
3949         isl_bool isl_qpolynomial_involves_dims(
3950                 __isl_keep isl_qpolynomial *qp,
3951                 enum isl_dim_type type, unsigned first, unsigned n);
3953 Similarly, the following functions can be used to check whether
3954 a given dimension is involved in any lower or upper bound.
3956         #include <isl/set.h>
3957         isl_bool isl_set_dim_has_any_lower_bound(
3958                 __isl_keep isl_set *set,
3959                 enum isl_dim_type type, unsigned pos);
3960         isl_bool isl_set_dim_has_any_upper_bound(
3961                 __isl_keep isl_set *set,
3962                 enum isl_dim_type type, unsigned pos);
3964 Note that these functions return true even if there is a bound on
3965 the dimension on only some of the basic sets of C<set>.
3966 To check if they have a bound for all of the basic sets in C<set>,
3967 use the following functions instead.
3969         #include <isl/set.h>
3970         isl_bool isl_set_dim_has_lower_bound(
3971                 __isl_keep isl_set *set,
3972                 enum isl_dim_type type, unsigned pos);
3973         isl_bool isl_set_dim_has_upper_bound(
3974                 __isl_keep isl_set *set,
3975                 enum isl_dim_type type, unsigned pos);
3977 =item * Space
3979 To check whether a set is a parameter domain, use this function:
3981         isl_bool isl_set_is_params(__isl_keep isl_set *set);
3982         isl_bool isl_union_set_is_params(
3983                 __isl_keep isl_union_set *uset);
3985 =item * Wrapping
3987 The following functions check whether the space of the given
3988 (basic) set or relation domain and/or range is a wrapped relation.
3990         #include <isl/space.h>
3991         isl_bool isl_space_is_wrapping(
3992                 __isl_keep isl_space *space);
3993         isl_bool isl_space_domain_is_wrapping(
3994                 __isl_keep isl_space *space);
3995         isl_bool isl_space_range_is_wrapping(
3996                 __isl_keep isl_space *space);
3997         isl_bool isl_space_is_product(
3998                 __isl_keep isl_space *space);
4000         #include <isl/set.h>
4001         isl_bool isl_basic_set_is_wrapping(
4002                 __isl_keep isl_basic_set *bset);
4003         isl_bool isl_set_is_wrapping(__isl_keep isl_set *set);
4005         #include <isl/map.h>
4006         isl_bool isl_map_domain_is_wrapping(
4007                 __isl_keep isl_map *map);
4008         isl_bool isl_map_range_is_wrapping(
4009                 __isl_keep isl_map *map);
4010         isl_bool isl_map_is_product(__isl_keep isl_map *map);
4012         #include <isl/val.h>
4013         isl_bool isl_multi_val_range_is_wrapping(
4014                 __isl_keep isl_multi_val *mv);
4016         #include <isl/aff.h>
4017         isl_bool isl_multi_aff_range_is_wrapping(
4018                 __isl_keep isl_multi_aff *ma);
4019         isl_bool isl_multi_pw_aff_range_is_wrapping(
4020                 __isl_keep isl_multi_pw_aff *mpa);
4021         isl_bool isl_multi_union_pw_aff_range_is_wrapping(
4022                 __isl_keep isl_multi_union_pw_aff *mupa);
4024 The input to C<isl_space_is_wrapping> should
4025 be the space of a set, while that of
4026 C<isl_space_domain_is_wrapping> and
4027 C<isl_space_range_is_wrapping> should be the space of a relation.
4028 The input to C<isl_space_is_product> can be either the space
4029 of a set or that of a binary relation.
4030 In case the input is the space of a binary relation, it checks
4031 whether both domain and range are wrapping.
4033 =item * Internal Product
4035         isl_bool isl_basic_map_can_zip(
4036                 __isl_keep isl_basic_map *bmap);
4037         isl_bool isl_map_can_zip(__isl_keep isl_map *map);
4039 Check whether the product of domain and range of the given relation
4040 can be computed,
4041 i.e., whether both domain and range are nested relations.
4043 =item * Currying
4045         #include <isl/space.h>
4046         isl_bool isl_space_can_curry(
4047                 __isl_keep isl_space *space);
4049         #include <isl/map.h>
4050         isl_bool isl_basic_map_can_curry(
4051                 __isl_keep isl_basic_map *bmap);
4052         isl_bool isl_map_can_curry(__isl_keep isl_map *map);
4054 Check whether the domain of the (basic) relation is a wrapped relation.
4056         #include <isl/space.h>
4057         __isl_give isl_space *isl_space_uncurry(
4058                 __isl_take isl_space *space);
4060         #include <isl/map.h>
4061         isl_bool isl_basic_map_can_uncurry(
4062                 __isl_keep isl_basic_map *bmap);
4063         isl_bool isl_map_can_uncurry(__isl_keep isl_map *map);
4065 Check whether the range of the (basic) relation is a wrapped relation.
4067         #include <isl/space.h>
4068         isl_bool isl_space_can_range_curry(
4069                 __isl_keep isl_space *space);
4071         #include <isl/map.h>
4072         isl_bool isl_map_can_range_curry(
4073                 __isl_keep isl_map *map);
4075 Check whether the domain of the relation wrapped in the range of
4076 the input is itself a wrapped relation.
4078 =item * Special Values
4080         #include <isl/aff.h>
4081         isl_bool isl_aff_is_cst(__isl_keep isl_aff *aff);
4082         isl_bool isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
4083         isl_bool isl_multi_pw_aff_is_cst(
4084                 __isl_keep isl_multi_pw_aff *mpa);
4086 Check whether the given expression is a constant.
4088         #include <isl/val.h>
4089         isl_bool isl_multi_val_involves_nan(
4090                 __isl_keep isl_multi_val *mv);
4092         #include <isl/aff.h>
4093         isl_bool isl_aff_is_nan(__isl_keep isl_aff *aff);
4094         isl_bool isl_multi_aff_involves_nan(
4095                 __isl_keep isl_multi_aff *ma);
4096         isl_bool isl_pw_aff_involves_nan(
4097                 __isl_keep isl_pw_aff *pa);
4098         isl_bool isl_pw_multi_aff_involves_nan(
4099                 __isl_keep isl_pw_multi_aff *pma);
4100         isl_bool isl_multi_pw_aff_involves_nan(
4101                 __isl_keep isl_multi_pw_aff *mpa);
4102         isl_bool isl_union_pw_aff_involves_nan(
4103                 __isl_keep isl_union_pw_aff *upa);
4104         isl_bool isl_union_pw_multi_aff_involves_nan(
4105                 __isl_keep isl_union_pw_multi_aff *upma);
4106         isl_bool isl_multi_union_pw_aff_involves_nan(
4107                 __isl_keep isl_multi_union_pw_aff *mupa);
4109         #include <isl/polynomial.h>
4110         isl_bool isl_qpolynomial_is_nan(
4111                 __isl_keep isl_qpolynomial *qp);
4112         isl_bool isl_qpolynomial_fold_is_nan(
4113                 __isl_keep isl_qpolynomial_fold *fold);
4114         isl_bool isl_pw_qpolynomial_involves_nan(
4115                 __isl_keep isl_pw_qpolynomial *pwqp);
4116         isl_bool isl_pw_qpolynomial_fold_involves_nan(
4117                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4118         isl_bool isl_union_pw_qpolynomial_involves_nan(
4119                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4120         isl_bool isl_union_pw_qpolynomial_fold_involves_nan(
4121                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4123 Check whether the given expression is equal to or involves NaN.
4125         #include <isl/aff.h>
4126         isl_bool isl_aff_plain_is_zero(
4127                 __isl_keep isl_aff *aff);
4129 Check whether the affine expression is obviously zero.
4131 =back
4133 =head3 Binary Properties
4135 =over
4137 =item * Equality
4139 The following functions check whether two objects
4140 represent the same set, relation or function.
4141 The C<plain> variants only return true if the objects
4142 are obviously the same.  That is, they may return false
4143 even if the objects are the same, but they will never
4144 return true if the objects are not the same.
4146         #include <isl/set.h>
4147         isl_bool isl_basic_set_plain_is_equal(
4148                 __isl_keep isl_basic_set *bset1,
4149                 __isl_keep isl_basic_set *bset2);
4150         isl_bool isl_basic_set_is_equal(
4151                 __isl_keep isl_basic_set *bset1,
4152                 __isl_keep isl_basic_set *bset2);
4153         isl_bool isl_set_plain_is_equal(
4154                 __isl_keep isl_set *set1,
4155                 __isl_keep isl_set *set2);
4156         isl_bool isl_set_is_equal(__isl_keep isl_set *set1,
4157                 __isl_keep isl_set *set2);
4159         #include <isl/map.h>
4160         isl_bool isl_basic_map_is_equal(
4161                 __isl_keep isl_basic_map *bmap1,
4162                 __isl_keep isl_basic_map *bmap2);
4163         isl_bool isl_map_is_equal(__isl_keep isl_map *map1,
4164                 __isl_keep isl_map *map2);
4165         isl_bool isl_map_plain_is_equal(
4166                 __isl_keep isl_map *map1,
4167                 __isl_keep isl_map *map2);
4169         #include <isl/union_set.h>
4170         isl_bool isl_union_set_is_equal(
4171                 __isl_keep isl_union_set *uset1,
4172                 __isl_keep isl_union_set *uset2);
4174         #include <isl/union_map.h>
4175         isl_bool isl_union_map_is_equal(
4176                 __isl_keep isl_union_map *umap1,
4177                 __isl_keep isl_union_map *umap2);
4179         #include <isl/aff.h>
4180         isl_bool isl_aff_plain_is_equal(
4181                 __isl_keep isl_aff *aff1,
4182                 __isl_keep isl_aff *aff2);
4183         isl_bool isl_multi_aff_plain_is_equal(
4184                 __isl_keep isl_multi_aff *maff1,
4185                 __isl_keep isl_multi_aff *maff2);
4186         isl_bool isl_pw_aff_plain_is_equal(
4187                 __isl_keep isl_pw_aff *pwaff1,
4188                 __isl_keep isl_pw_aff *pwaff2);
4189         isl_bool isl_pw_aff_is_equal(
4190                 __isl_keep isl_pw_aff *pa1,
4191                 __isl_keep isl_pw_aff *pa2);
4192         isl_bool isl_pw_multi_aff_plain_is_equal(
4193                 __isl_keep isl_pw_multi_aff *pma1,
4194                 __isl_keep isl_pw_multi_aff *pma2);
4195         isl_bool isl_pw_multi_aff_is_equal(
4196                 __isl_keep isl_pw_multi_aff *pma1,
4197                 __isl_keep isl_pw_multi_aff *pma2);
4198         isl_bool isl_multi_pw_aff_plain_is_equal(
4199                 __isl_keep isl_multi_pw_aff *mpa1,
4200                 __isl_keep isl_multi_pw_aff *mpa2);
4201         isl_bool isl_multi_pw_aff_is_equal(
4202                 __isl_keep isl_multi_pw_aff *mpa1,
4203                 __isl_keep isl_multi_pw_aff *mpa2);
4204         isl_bool isl_union_pw_aff_plain_is_equal(
4205                 __isl_keep isl_union_pw_aff *upa1,
4206                 __isl_keep isl_union_pw_aff *upa2);
4207         isl_bool isl_union_pw_multi_aff_plain_is_equal(
4208                 __isl_keep isl_union_pw_multi_aff *upma1,
4209                 __isl_keep isl_union_pw_multi_aff *upma2);
4210         isl_bool isl_multi_union_pw_aff_plain_is_equal(
4211                 __isl_keep isl_multi_union_pw_aff *mupa1,
4212                 __isl_keep isl_multi_union_pw_aff *mupa2);
4214         #include <isl/polynomial.h>
4215         isl_bool isl_union_pw_qpolynomial_plain_is_equal(
4216                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4217                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4218         isl_bool isl_union_pw_qpolynomial_fold_plain_is_equal(
4219                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4220                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4222 =item * Disjointness
4224         #include <isl/set.h>
4225         isl_bool isl_basic_set_is_disjoint(
4226                 __isl_keep isl_basic_set *bset1,
4227                 __isl_keep isl_basic_set *bset2);
4228         isl_bool isl_set_plain_is_disjoint(
4229                 __isl_keep isl_set *set1,
4230                 __isl_keep isl_set *set2);
4231         isl_bool isl_set_is_disjoint(__isl_keep isl_set *set1,
4232                 __isl_keep isl_set *set2);
4234         #include <isl/map.h>
4235         isl_bool isl_basic_map_is_disjoint(
4236                 __isl_keep isl_basic_map *bmap1,
4237                 __isl_keep isl_basic_map *bmap2);
4238         isl_bool isl_map_is_disjoint(__isl_keep isl_map *map1,
4239                 __isl_keep isl_map *map2);
4241         #include <isl/union_set.h>
4242         isl_bool isl_union_set_is_disjoint(
4243                 __isl_keep isl_union_set *uset1,
4244                 __isl_keep isl_union_set *uset2);
4246         #include <isl/union_map.h>
4247         isl_bool isl_union_map_is_disjoint(
4248                 __isl_keep isl_union_map *umap1,
4249                 __isl_keep isl_union_map *umap2);
4251 =item * Subset
4253         isl_bool isl_basic_set_is_subset(
4254                 __isl_keep isl_basic_set *bset1,
4255                 __isl_keep isl_basic_set *bset2);
4256         isl_bool isl_set_is_subset(__isl_keep isl_set *set1,
4257                 __isl_keep isl_set *set2);
4258         isl_bool isl_set_is_strict_subset(
4259                 __isl_keep isl_set *set1,
4260                 __isl_keep isl_set *set2);
4261         isl_bool isl_union_set_is_subset(
4262                 __isl_keep isl_union_set *uset1,
4263                 __isl_keep isl_union_set *uset2);
4264         isl_bool isl_union_set_is_strict_subset(
4265                 __isl_keep isl_union_set *uset1,
4266                 __isl_keep isl_union_set *uset2);
4267         isl_bool isl_basic_map_is_subset(
4268                 __isl_keep isl_basic_map *bmap1,
4269                 __isl_keep isl_basic_map *bmap2);
4270         isl_bool isl_basic_map_is_strict_subset(
4271                 __isl_keep isl_basic_map *bmap1,
4272                 __isl_keep isl_basic_map *bmap2);
4273         isl_bool isl_map_is_subset(
4274                 __isl_keep isl_map *map1,
4275                 __isl_keep isl_map *map2);
4276         isl_bool isl_map_is_strict_subset(
4277                 __isl_keep isl_map *map1,
4278                 __isl_keep isl_map *map2);
4279         isl_bool isl_union_map_is_subset(
4280                 __isl_keep isl_union_map *umap1,
4281                 __isl_keep isl_union_map *umap2);
4282         isl_bool isl_union_map_is_strict_subset(
4283                 __isl_keep isl_union_map *umap1,
4284                 __isl_keep isl_union_map *umap2);
4286 Check whether the first argument is a (strict) subset of the
4287 second argument.
4289 =item * Order
4291 Every comparison function returns a negative value if the first
4292 argument is considered smaller than the second, a positive value
4293 if the first argument is considered greater and zero if the two
4294 constraints are considered the same by the comparison criterion.
4296         #include <isl/constraint.h>
4297         int isl_constraint_plain_cmp(
4298                 __isl_keep isl_constraint *c1,
4299                 __isl_keep isl_constraint *c2);
4301 This function is useful for sorting C<isl_constraint>s.
4302 The order depends on the internal representation of the inputs.
4303 The order is fixed over different calls to the function (assuming
4304 the internal representation of the inputs has not changed), but may
4305 change over different versions of C<isl>.
4307         #include <isl/constraint.h>
4308         int isl_constraint_cmp_last_non_zero(
4309                 __isl_keep isl_constraint *c1,
4310                 __isl_keep isl_constraint *c2);
4312 This function can be used to sort constraints that live in the same
4313 local space.  Constraints that involve ``earlier'' dimensions or
4314 that have a smaller coefficient for the shared latest dimension
4315 are considered smaller than other constraints.
4316 This function only defines a B<partial> order.
4318         #include <isl/set.h>
4319         int isl_set_plain_cmp(__isl_keep isl_set *set1,
4320                 __isl_keep isl_set *set2);
4322 This function is useful for sorting C<isl_set>s.
4323 The order depends on the internal representation of the inputs.
4324 The order is fixed over different calls to the function (assuming
4325 the internal representation of the inputs has not changed), but may
4326 change over different versions of C<isl>.
4328         #include <isl/aff.h>
4329         int isl_multi_aff_plain_cmp(
4330                 __isl_keep isl_multi_aff *ma1,
4331                 __isl_keep isl_multi_aff *ma2);
4332         int isl_pw_aff_plain_cmp(__isl_keep isl_pw_aff *pa1,
4333                 __isl_keep isl_pw_aff *pa2);
4335 The functions C<isl_multi_aff_plain_cmp> and
4336 C<isl_pw_aff_plain_cmp> can be used to sort C<isl_multi_aff>s and
4337 C<isl_pw_aff>s.  The order is not strictly defined.
4338 The current order sorts expressions that only involve
4339 earlier dimensions before those that involve later dimensions.
4341 =back
4343 =head2 Unary Operations
4345 =over
4347 =item * Complement
4349         __isl_give isl_set *isl_set_complement(
4350                 __isl_take isl_set *set);
4351         __isl_give isl_map *isl_map_complement(
4352                 __isl_take isl_map *map);
4354 =item * Inverse map
4356         #include <isl/space.h>
4357         __isl_give isl_space *isl_space_reverse(
4358                 __isl_take isl_space *space);
4360         #include <isl/map.h>
4361         __isl_give isl_basic_map *isl_basic_map_reverse(
4362                 __isl_take isl_basic_map *bmap);
4363         __isl_give isl_map *isl_map_reverse(
4364                 __isl_take isl_map *map);
4366         #include <isl/union_map.h>
4367         __isl_give isl_union_map *isl_union_map_reverse(
4368                 __isl_take isl_union_map *umap);
4370 =item * Projection
4372         #include <isl/space.h>
4373         __isl_give isl_space *isl_space_domain(
4374                 __isl_take isl_space *space);
4375         __isl_give isl_space *isl_space_range(
4376                 __isl_take isl_space *space);
4377         __isl_give isl_space *isl_space_params(
4378                 __isl_take isl_space *space);
4380         #include <isl/local_space.h>
4381         __isl_give isl_local_space *isl_local_space_domain(
4382                 __isl_take isl_local_space *ls);
4383         __isl_give isl_local_space *isl_local_space_range(
4384                 __isl_take isl_local_space *ls);
4386         #include <isl/set.h>
4387         __isl_give isl_basic_set *isl_basic_set_project_out(
4388                 __isl_take isl_basic_set *bset,
4389                 enum isl_dim_type type, unsigned first, unsigned n);
4390         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
4391                 enum isl_dim_type type, unsigned first, unsigned n);
4392         __isl_give isl_map *isl_set_project_onto_map(
4393                 __isl_take isl_set *set,
4394                 enum isl_dim_type type, unsigned first,
4395                 unsigned n);
4396         __isl_give isl_basic_set *isl_basic_set_params(
4397                 __isl_take isl_basic_set *bset);
4398         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
4400 The function C<isl_set_project_onto_map> returns a relation
4401 that projects the input set onto the given set dimensions.
4403         #include <isl/map.h>
4404         __isl_give isl_basic_map *isl_basic_map_project_out(
4405                 __isl_take isl_basic_map *bmap,
4406                 enum isl_dim_type type, unsigned first, unsigned n);
4407         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
4408                 enum isl_dim_type type, unsigned first, unsigned n);
4409         __isl_give isl_basic_set *isl_basic_map_domain(
4410                 __isl_take isl_basic_map *bmap);
4411         __isl_give isl_basic_set *isl_basic_map_range(
4412                 __isl_take isl_basic_map *bmap);
4413         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
4414         __isl_give isl_set *isl_map_domain(
4415                 __isl_take isl_map *bmap);
4416         __isl_give isl_set *isl_map_range(
4417                 __isl_take isl_map *map);
4419         #include <isl/union_set.h>
4420         __isl_give isl_union_set *isl_union_set_project_out(
4421                 __isl_take isl_union_set *uset,
4422                 enum isl_dim_type type,
4423                 unsigned first, unsigned n);
4424         __isl_give isl_set *isl_union_set_params(
4425                 __isl_take isl_union_set *uset);
4427 The function C<isl_union_set_project_out> can only project out
4428 parameters.
4430         #include <isl/union_map.h>
4431         __isl_give isl_union_map *isl_union_map_project_out(
4432                 __isl_take isl_union_map *umap,
4433                 enum isl_dim_type type, unsigned first, unsigned n);
4434         __isl_give isl_set *isl_union_map_params(
4435                 __isl_take isl_union_map *umap);
4436         __isl_give isl_union_set *isl_union_map_domain(
4437                 __isl_take isl_union_map *umap);
4438         __isl_give isl_union_set *isl_union_map_range(
4439                 __isl_take isl_union_map *umap);
4441 The function C<isl_union_map_project_out> can only project out
4442 parameters.
4444         #include <isl/aff.h>
4445         __isl_give isl_aff *isl_aff_project_domain_on_params(
4446                 __isl_take isl_aff *aff);
4447         __isl_give isl_pw_aff *
4448         isl_pw_aff_project_domain_on_params(
4449                 __isl_take isl_pw_aff *pa);
4450         __isl_give isl_pw_multi_aff *
4451         isl_pw_multi_aff_project_domain_on_params(
4452                 __isl_take isl_pw_multi_aff *pma);
4453         __isl_give isl_set *isl_pw_aff_domain(
4454                 __isl_take isl_pw_aff *pwaff);
4455         __isl_give isl_set *isl_pw_multi_aff_domain(
4456                 __isl_take isl_pw_multi_aff *pma);
4457         __isl_give isl_set *isl_multi_pw_aff_domain(
4458                 __isl_take isl_multi_pw_aff *mpa);
4459         __isl_give isl_union_set *isl_union_pw_aff_domain(
4460                 __isl_take isl_union_pw_aff *upa);
4461         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4462                 __isl_take isl_union_pw_multi_aff *upma);
4463         __isl_give isl_union_set *
4464         isl_multi_union_pw_aff_domain(
4465                 __isl_take isl_multi_union_pw_aff *mupa);
4466         __isl_give isl_set *isl_pw_aff_params(
4467                 __isl_take isl_pw_aff *pwa);
4469 The function C<isl_multi_union_pw_aff_domain> requires its
4470 input to have at least one set dimension.
4472         #include <isl/polynomial.h>
4473         __isl_give isl_qpolynomial *
4474         isl_qpolynomial_project_domain_on_params(
4475                 __isl_take isl_qpolynomial *qp);
4476         __isl_give isl_pw_qpolynomial *
4477         isl_pw_qpolynomial_project_domain_on_params(
4478                 __isl_take isl_pw_qpolynomial *pwqp);
4479         __isl_give isl_pw_qpolynomial_fold *
4480         isl_pw_qpolynomial_fold_project_domain_on_params(
4481                 __isl_take isl_pw_qpolynomial_fold *pwf);
4482         __isl_give isl_set *isl_pw_qpolynomial_domain(
4483                 __isl_take isl_pw_qpolynomial *pwqp);
4484         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4485                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4486         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4487                 __isl_take isl_union_pw_qpolynomial *upwqp);
4489         #include <isl/space.h>
4490         __isl_give isl_space *isl_space_domain_map(
4491                 __isl_take isl_space *space);
4492         __isl_give isl_space *isl_space_range_map(
4493                 __isl_take isl_space *space);
4495         #include <isl/map.h>
4496         __isl_give isl_map *isl_set_wrapped_domain_map(
4497                 __isl_take isl_set *set);
4498         __isl_give isl_basic_map *isl_basic_map_domain_map(
4499                 __isl_take isl_basic_map *bmap);
4500         __isl_give isl_basic_map *isl_basic_map_range_map(
4501                 __isl_take isl_basic_map *bmap);
4502         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
4503         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
4505         #include <isl/union_map.h>
4506         __isl_give isl_union_map *isl_union_map_domain_map(
4507                 __isl_take isl_union_map *umap);
4508         __isl_give isl_union_pw_multi_aff *
4509         isl_union_map_domain_map_union_pw_multi_aff(
4510                 __isl_take isl_union_map *umap);
4511         __isl_give isl_union_map *isl_union_map_range_map(
4512                 __isl_take isl_union_map *umap);
4513         __isl_give isl_union_map *
4514         isl_union_set_wrapped_domain_map(
4515                 __isl_take isl_union_set *uset);
4517 The functions above construct a (basic, regular or union) relation
4518 that maps (a wrapped version of) the input relation to its domain or range.
4519 C<isl_set_wrapped_domain_map> maps the input set to the domain
4520 of its wrapped relation.
4522 =item * Elimination
4524         __isl_give isl_basic_set *isl_basic_set_eliminate(
4525                 __isl_take isl_basic_set *bset,
4526                 enum isl_dim_type type,
4527                 unsigned first, unsigned n);
4528         __isl_give isl_set *isl_set_eliminate(
4529                 __isl_take isl_set *set, enum isl_dim_type type,
4530                 unsigned first, unsigned n);
4531         __isl_give isl_basic_map *isl_basic_map_eliminate(
4532                 __isl_take isl_basic_map *bmap,
4533                 enum isl_dim_type type,
4534                 unsigned first, unsigned n);
4535         __isl_give isl_map *isl_map_eliminate(
4536                 __isl_take isl_map *map, enum isl_dim_type type,
4537                 unsigned first, unsigned n);
4539 Eliminate the coefficients for the given dimensions from the constraints,
4540 without removing the dimensions.
4542 =item * Constructing a set from a parameter domain
4544 A zero-dimensional space or (basic) set can be constructed
4545 on a given parameter domain using the following functions.
4547         #include <isl/space.h>
4548         __isl_give isl_space *isl_space_set_from_params(
4549                 __isl_take isl_space *space);
4551         #include <isl/set.h>
4552         __isl_give isl_basic_set *isl_basic_set_from_params(
4553                 __isl_take isl_basic_set *bset);
4554         __isl_give isl_set *isl_set_from_params(
4555                 __isl_take isl_set *set);
4557 =item * Constructing a relation from one or two sets
4559 Create a relation with the given set(s) as domain and/or range.
4560 If only the domain or the range is specified, then
4561 the range or domain of the created relation is a zero-dimensional
4562 flat anonymous space.
4564         #include <isl/space.h>
4565         __isl_give isl_space *isl_space_from_domain(
4566                 __isl_take isl_space *space);
4567         __isl_give isl_space *isl_space_from_range(
4568                 __isl_take isl_space *space);
4569         __isl_give isl_space *isl_space_map_from_set(
4570                 __isl_take isl_space *space);
4571         __isl_give isl_space *isl_space_map_from_domain_and_range(
4572                 __isl_take isl_space *domain,
4573                 __isl_take isl_space *range);
4575         #include <isl/local_space.h>
4576         __isl_give isl_local_space *isl_local_space_from_domain(
4577                 __isl_take isl_local_space *ls);
4579         #include <isl/map.h>
4580         __isl_give isl_map *isl_map_from_domain(
4581                 __isl_take isl_set *set);
4582         __isl_give isl_map *isl_map_from_range(
4583                 __isl_take isl_set *set);
4585         #include <isl/union_map.h>
4586         __isl_give isl_union_map *
4587         isl_union_map_from_domain_and_range(
4588                 __isl_take isl_union_set *domain,
4589                 __isl_take isl_union_set *range);
4591         #include <isl/val.h>
4592         __isl_give isl_multi_val *isl_multi_val_from_range(
4593                 __isl_take isl_multi_val *mv);
4595         #include <isl/aff.h>
4596         __isl_give isl_multi_aff *isl_multi_aff_from_range(
4597                 __isl_take isl_multi_aff *ma);
4598         __isl_give isl_pw_aff *isl_pw_aff_from_range(
4599                 __isl_take isl_pw_aff *pwa);
4600         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_range(
4601                 __isl_take isl_multi_pw_aff *mpa);
4602         __isl_give isl_multi_union_pw_aff *
4603         isl_multi_union_pw_aff_from_range(
4604                 __isl_take isl_multi_union_pw_aff *mupa);
4605         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4606                 __isl_take isl_set *set);
4607         __isl_give isl_union_pw_multi_aff *
4608         isl_union_pw_multi_aff_from_domain(
4609                 __isl_take isl_union_set *uset);
4611         #include <isl/polynomial.h>
4612         __isl_give isl_pw_qpolynomial *
4613         isl_pw_qpolynomial_from_range(
4614                 __isl_take isl_pw_qpolynomial *pwqp);
4615         __isl_give isl_pw_qpolynomial_fold *
4616         isl_pw_qpolynomial_fold_from_range(
4617                 __isl_take isl_pw_qpolynomial_fold *pwf);
4619 =item * Slicing
4621         #include <isl/set.h>
4622         __isl_give isl_basic_set *isl_basic_set_fix_si(
4623                 __isl_take isl_basic_set *bset,
4624                 enum isl_dim_type type, unsigned pos, int value);
4625         __isl_give isl_basic_set *isl_basic_set_fix_val(
4626                 __isl_take isl_basic_set *bset,
4627                 enum isl_dim_type type, unsigned pos,
4628                 __isl_take isl_val *v);
4629         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
4630                 enum isl_dim_type type, unsigned pos, int value);
4631         __isl_give isl_set *isl_set_fix_val(
4632                 __isl_take isl_set *set,
4633                 enum isl_dim_type type, unsigned pos,
4634                 __isl_take isl_val *v);
4636         #include <isl/map.h>
4637         __isl_give isl_basic_map *isl_basic_map_fix_si(
4638                 __isl_take isl_basic_map *bmap,
4639                 enum isl_dim_type type, unsigned pos, int value);
4640         __isl_give isl_basic_map *isl_basic_map_fix_val(
4641                 __isl_take isl_basic_map *bmap,
4642                 enum isl_dim_type type, unsigned pos,
4643                 __isl_take isl_val *v);
4644         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
4645                 enum isl_dim_type type, unsigned pos, int value);
4646         __isl_give isl_map *isl_map_fix_val(
4647                 __isl_take isl_map *map,
4648                 enum isl_dim_type type, unsigned pos,
4649                 __isl_take isl_val *v);
4651         #include <isl/aff.h>
4652         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_fix_si(
4653                 __isl_take isl_pw_multi_aff *pma,
4654                 enum isl_dim_type type, unsigned pos, int value);
4656         #include <isl/polynomial.h>
4657         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_fix_val(
4658                 __isl_take isl_pw_qpolynomial *pwqp,
4659                 enum isl_dim_type type, unsigned n,
4660                 __isl_take isl_val *v);
4662 Intersect the set, relation or function domain
4663 with the hyperplane where the given
4664 dimension has the fixed given value.
4666         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
4667                 __isl_take isl_basic_map *bmap,
4668                 enum isl_dim_type type, unsigned pos, int value);
4669         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
4670                 __isl_take isl_basic_map *bmap,
4671                 enum isl_dim_type type, unsigned pos, int value);
4672         __isl_give isl_set *isl_set_lower_bound_si(
4673                 __isl_take isl_set *set,
4674                 enum isl_dim_type type, unsigned pos, int value);
4675         __isl_give isl_set *isl_set_lower_bound_val(
4676                 __isl_take isl_set *set,
4677                 enum isl_dim_type type, unsigned pos,
4678                 __isl_take isl_val *value);
4679         __isl_give isl_map *isl_map_lower_bound_si(
4680                 __isl_take isl_map *map,
4681                 enum isl_dim_type type, unsigned pos, int value);
4682         __isl_give isl_set *isl_set_upper_bound_si(
4683                 __isl_take isl_set *set,
4684                 enum isl_dim_type type, unsigned pos, int value);
4685         __isl_give isl_set *isl_set_upper_bound_val(
4686                 __isl_take isl_set *set,
4687                 enum isl_dim_type type, unsigned pos,
4688                 __isl_take isl_val *value);
4689         __isl_give isl_map *isl_map_upper_bound_si(
4690                 __isl_take isl_map *map,
4691                 enum isl_dim_type type, unsigned pos, int value);
4693 Intersect the set or relation with the half-space where the given
4694 dimension has a value bounded by the fixed given integer value.
4696         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
4697                 enum isl_dim_type type1, int pos1,
4698                 enum isl_dim_type type2, int pos2);
4699         __isl_give isl_basic_map *isl_basic_map_equate(
4700                 __isl_take isl_basic_map *bmap,
4701                 enum isl_dim_type type1, int pos1,
4702                 enum isl_dim_type type2, int pos2);
4703         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
4704                 enum isl_dim_type type1, int pos1,
4705                 enum isl_dim_type type2, int pos2);
4707 Intersect the set or relation with the hyperplane where the given
4708 dimensions are equal to each other.
4710         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
4711                 enum isl_dim_type type1, int pos1,
4712                 enum isl_dim_type type2, int pos2);
4714 Intersect the relation with the hyperplane where the given
4715 dimensions have opposite values.
4717         __isl_give isl_map *isl_map_order_le(
4718                 __isl_take isl_map *map,
4719                 enum isl_dim_type type1, int pos1,
4720                 enum isl_dim_type type2, int pos2);
4721         __isl_give isl_basic_map *isl_basic_map_order_ge(
4722                 __isl_take isl_basic_map *bmap,
4723                 enum isl_dim_type type1, int pos1,
4724                 enum isl_dim_type type2, int pos2);
4725         __isl_give isl_map *isl_map_order_ge(
4726                 __isl_take isl_map *map,
4727                 enum isl_dim_type type1, int pos1,
4728                 enum isl_dim_type type2, int pos2);
4729         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
4730                 enum isl_dim_type type1, int pos1,
4731                 enum isl_dim_type type2, int pos2);
4732         __isl_give isl_basic_map *isl_basic_map_order_gt(
4733                 __isl_take isl_basic_map *bmap,
4734                 enum isl_dim_type type1, int pos1,
4735                 enum isl_dim_type type2, int pos2);
4736         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
4737                 enum isl_dim_type type1, int pos1,
4738                 enum isl_dim_type type2, int pos2);
4740 Intersect the relation with the half-space where the given
4741 dimensions satisfy the given ordering.
4743 =item * Locus
4745         #include <isl/aff.h>
4746         __isl_give isl_basic_set *isl_aff_zero_basic_set(
4747                 __isl_take isl_aff *aff);
4748         __isl_give isl_basic_set *isl_aff_neg_basic_set(
4749                 __isl_take isl_aff *aff);
4750         __isl_give isl_set *isl_pw_aff_pos_set(
4751                 __isl_take isl_pw_aff *pa);
4752         __isl_give isl_set *isl_pw_aff_nonneg_set(
4753                 __isl_take isl_pw_aff *pwaff);
4754         __isl_give isl_set *isl_pw_aff_zero_set(
4755                 __isl_take isl_pw_aff *pwaff);
4756         __isl_give isl_set *isl_pw_aff_non_zero_set(
4757                 __isl_take isl_pw_aff *pwaff);
4758         __isl_give isl_union_set *
4759         isl_union_pw_aff_zero_union_set(
4760                 __isl_take isl_union_pw_aff *upa);
4761         __isl_give isl_union_set *
4762         isl_multi_union_pw_aff_zero_union_set(
4763                 __isl_take isl_multi_union_pw_aff *mupa);
4765 The function C<isl_aff_neg_basic_set> returns a basic set
4766 containing those elements in the domain space
4767 of C<aff> where C<aff> is negative.
4768 The function C<isl_pw_aff_nonneg_set> returns a set
4769 containing those elements in the domain
4770 of C<pwaff> where C<pwaff> is non-negative.
4771 The function C<isl_multi_union_pw_aff_zero_union_set>
4772 returns a union set containing those elements
4773 in the domains of its elements where they are all zero.
4775 =item * Identity
4777         __isl_give isl_map *isl_set_identity(
4778                 __isl_take isl_set *set);
4779         __isl_give isl_union_map *isl_union_set_identity(
4780                 __isl_take isl_union_set *uset);
4781         __isl_give isl_union_pw_multi_aff *
4782         isl_union_set_identity_union_pw_multi_aff(
4783                 __isl_take isl_union_set *uset);
4785 Construct an identity relation on the given (union) set.
4787 =item * Function Extraction
4789 A piecewise quasi affine expression that is equal to 1 on a set
4790 and 0 outside the set can be created using the following function.
4792         #include <isl/aff.h>
4793         __isl_give isl_pw_aff *isl_set_indicator_function(
4794                 __isl_take isl_set *set);
4796 A piecewise multiple quasi affine expression can be extracted
4797 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4798 and the C<isl_map> is single-valued.
4799 In case of a conversion from an C<isl_union_map>
4800 to an C<isl_union_pw_multi_aff>, these properties need to hold
4801 in each domain space.
4802 A conversion to a C<isl_multi_union_pw_aff> additionally
4803 requires that the input is non-empty and involves only a single
4804 range space.
4806         #include <isl/aff.h>
4807         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4808                 __isl_take isl_set *set);
4809         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4810                 __isl_take isl_map *map);
4812         __isl_give isl_union_pw_multi_aff *
4813         isl_union_pw_multi_aff_from_union_set(
4814                 __isl_take isl_union_set *uset);
4815         __isl_give isl_union_pw_multi_aff *
4816         isl_union_pw_multi_aff_from_union_map(
4817                 __isl_take isl_union_map *umap);
4819         __isl_give isl_multi_union_pw_aff *
4820         isl_multi_union_pw_aff_from_union_map(
4821                 __isl_take isl_union_map *umap);
4823 =item * Deltas
4825         __isl_give isl_basic_set *isl_basic_map_deltas(
4826                 __isl_take isl_basic_map *bmap);
4827         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
4828         __isl_give isl_union_set *isl_union_map_deltas(
4829                 __isl_take isl_union_map *umap);
4831 These functions return a (basic) set containing the differences
4832 between image elements and corresponding domain elements in the input.
4834         __isl_give isl_basic_map *isl_basic_map_deltas_map(
4835                 __isl_take isl_basic_map *bmap);
4836         __isl_give isl_map *isl_map_deltas_map(
4837                 __isl_take isl_map *map);
4838         __isl_give isl_union_map *isl_union_map_deltas_map(
4839                 __isl_take isl_union_map *umap);
4841 The functions above construct a (basic, regular or union) relation
4842 that maps (a wrapped version of) the input relation to its delta set.
4844 =item * Coalescing
4846 Simplify the representation of a set, relation or functions by trying
4847 to combine pairs of basic sets or relations into a single
4848 basic set or relation.
4850         #include <isl/set.h>
4851         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
4853         #include <isl/map.h>
4854         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
4856         #include <isl/union_set.h>
4857         __isl_give isl_union_set *isl_union_set_coalesce(
4858                 __isl_take isl_union_set *uset);
4860         #include <isl/union_map.h>
4861         __isl_give isl_union_map *isl_union_map_coalesce(
4862                 __isl_take isl_union_map *umap);
4864         #include <isl/aff.h>
4865         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
4866                 __isl_take isl_pw_aff *pwqp);
4867         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4868                 __isl_take isl_pw_multi_aff *pma);
4869         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_coalesce(
4870                 __isl_take isl_multi_pw_aff *mpa);
4871         __isl_give isl_union_pw_aff *isl_union_pw_aff_coalesce(
4872                 __isl_take isl_union_pw_aff *upa);
4873         __isl_give isl_union_pw_multi_aff *
4874         isl_union_pw_multi_aff_coalesce(
4875                 __isl_take isl_union_pw_multi_aff *upma);
4876         __isl_give isl_multi_union_pw_aff *
4877         isl_multi_union_pw_aff_coalesce(
4878                 __isl_take isl_multi_union_pw_aff *aff);
4880         #include <isl/polynomial.h>
4881         __isl_give isl_pw_qpolynomial_fold *
4882         isl_pw_qpolynomial_fold_coalesce(
4883                 __isl_take isl_pw_qpolynomial_fold *pwf);
4884         __isl_give isl_union_pw_qpolynomial *
4885         isl_union_pw_qpolynomial_coalesce(
4886                 __isl_take isl_union_pw_qpolynomial *upwqp);
4887         __isl_give isl_union_pw_qpolynomial_fold *
4888         isl_union_pw_qpolynomial_fold_coalesce(
4889                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4891 One of the methods for combining pairs of basic sets or relations
4892 can result in coefficients that are much larger than those that appear
4893 in the constraints of the input.  By default, the coefficients are
4894 not allowed to grow larger, but this can be changed by unsetting
4895 the following option.
4897         isl_stat isl_options_set_coalesce_bounded_wrapping(
4898                 isl_ctx *ctx, int val);
4899         int isl_options_get_coalesce_bounded_wrapping(
4900                 isl_ctx *ctx);
4902 =item * Detecting equalities
4904         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
4905                 __isl_take isl_basic_set *bset);
4906         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
4907                 __isl_take isl_basic_map *bmap);
4908         __isl_give isl_set *isl_set_detect_equalities(
4909                 __isl_take isl_set *set);
4910         __isl_give isl_map *isl_map_detect_equalities(
4911                 __isl_take isl_map *map);
4912         __isl_give isl_union_set *isl_union_set_detect_equalities(
4913                 __isl_take isl_union_set *uset);
4914         __isl_give isl_union_map *isl_union_map_detect_equalities(
4915                 __isl_take isl_union_map *umap);
4917 Simplify the representation of a set or relation by detecting implicit
4918 equalities.
4920 =item * Removing redundant constraints
4922         #include <isl/set.h>
4923         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
4924                 __isl_take isl_basic_set *bset);
4925         __isl_give isl_set *isl_set_remove_redundancies(
4926                 __isl_take isl_set *set);
4928         #include <isl/union_set.h>
4929         __isl_give isl_union_set *
4930         isl_union_set_remove_redundancies(
4931                 __isl_take isl_union_set *uset);
4933         #include <isl/map.h>
4934         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
4935                 __isl_take isl_basic_map *bmap);
4936         __isl_give isl_map *isl_map_remove_redundancies(
4937                 __isl_take isl_map *map);
4939         #include <isl/union_map.h>
4940         __isl_give isl_union_map *
4941         isl_union_map_remove_redundancies(
4942                 __isl_take isl_union_map *umap);
4944 =item * Convex hull
4946         __isl_give isl_basic_set *isl_set_convex_hull(
4947                 __isl_take isl_set *set);
4948         __isl_give isl_basic_map *isl_map_convex_hull(
4949                 __isl_take isl_map *map);
4951 If the input set or relation has any existentially quantified
4952 variables, then the result of these operations is currently undefined.
4954 =item * Simple hull
4956         #include <isl/set.h>
4957         __isl_give isl_basic_set *
4958         isl_set_unshifted_simple_hull(
4959                 __isl_take isl_set *set);
4960         __isl_give isl_basic_set *isl_set_simple_hull(
4961                 __isl_take isl_set *set);
4962         __isl_give isl_basic_set *
4963         isl_set_plain_unshifted_simple_hull(
4964                 __isl_take isl_set *set);
4965         __isl_give isl_basic_set *
4966         isl_set_unshifted_simple_hull_from_set_list(
4967                 __isl_take isl_set *set,
4968                 __isl_take isl_set_list *list);
4970         #include <isl/map.h>
4971         __isl_give isl_basic_map *
4972         isl_map_unshifted_simple_hull(
4973                 __isl_take isl_map *map);
4974         __isl_give isl_basic_map *isl_map_simple_hull(
4975                 __isl_take isl_map *map);
4976         __isl_give isl_basic_map *
4977         isl_map_plain_unshifted_simple_hull(
4978                 __isl_take isl_map *map);
4979                 __isl_give isl_basic_map *
4980         isl_map_unshifted_simple_hull_from_map_list(
4981                 __isl_take isl_map *map,
4982                 __isl_take isl_map_list *list);
4984         #include <isl/union_map.h>
4985         __isl_give isl_union_map *isl_union_map_simple_hull(
4986                 __isl_take isl_union_map *umap);
4988 These functions compute a single basic set or relation
4989 that contains the whole input set or relation.
4990 In particular, the output is described by translates
4991 of the constraints describing the basic sets or relations in the input.
4992 In case of C<isl_set_unshifted_simple_hull>, only the original
4993 constraints are used, without any translation.
4994 In case of C<isl_set_plain_unshifted_simple_hull> and
4995 C<isl_map_plain_unshifted_simple_hull>, the result is described
4996 by original constraints that are obviously satisfied
4997 by the entire input set or relation.
4998 In case of C<isl_set_unshifted_simple_hull_from_set_list> and
4999 C<isl_map_unshifted_simple_hull_from_map_list>, the
5000 constraints are taken from the elements of the second argument.
5002 =begin latex
5004 (See \autoref{s:simple hull}.)
5006 =end latex
5008 =item * Affine hull
5010         __isl_give isl_basic_set *isl_basic_set_affine_hull(
5011                 __isl_take isl_basic_set *bset);
5012         __isl_give isl_basic_set *isl_set_affine_hull(
5013                 __isl_take isl_set *set);
5014         __isl_give isl_union_set *isl_union_set_affine_hull(
5015                 __isl_take isl_union_set *uset);
5016         __isl_give isl_basic_map *isl_basic_map_affine_hull(
5017                 __isl_take isl_basic_map *bmap);
5018         __isl_give isl_basic_map *isl_map_affine_hull(
5019                 __isl_take isl_map *map);
5020         __isl_give isl_union_map *isl_union_map_affine_hull(
5021                 __isl_take isl_union_map *umap);
5023 In case of union sets and relations, the affine hull is computed
5024 per space.
5026 =item * Polyhedral hull
5028         __isl_give isl_basic_set *isl_set_polyhedral_hull(
5029                 __isl_take isl_set *set);
5030         __isl_give isl_basic_map *isl_map_polyhedral_hull(
5031                 __isl_take isl_map *map);
5032         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
5033                 __isl_take isl_union_set *uset);
5034         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
5035                 __isl_take isl_union_map *umap);
5037 These functions compute a single basic set or relation
5038 not involving any existentially quantified variables
5039 that contains the whole input set or relation.
5040 In case of union sets and relations, the polyhedral hull is computed
5041 per space.
5043 =item * Other approximations
5045         #include <isl/set.h>
5046         __isl_give isl_basic_set *
5047         isl_basic_set_drop_constraints_involving_dims(
5048                 __isl_take isl_basic_set *bset,
5049                 enum isl_dim_type type,
5050                 unsigned first, unsigned n);
5051         __isl_give isl_basic_set *
5052         isl_basic_set_drop_constraints_not_involving_dims(
5053                 __isl_take isl_basic_set *bset,
5054                 enum isl_dim_type type,
5055                 unsigned first, unsigned n);
5056         __isl_give isl_set *
5057         isl_set_drop_constraints_involving_dims(
5058                 __isl_take isl_set *set,
5059                 enum isl_dim_type type,
5060                 unsigned first, unsigned n);
5061         __isl_give isl_set *
5062         isl_set_drop_constraints_not_involving_dims(
5063                 __isl_take isl_set *set,
5064                 enum isl_dim_type type,
5065                 unsigned first, unsigned n);
5067         #include <isl/map.h>
5068         __isl_give isl_basic_map *
5069         isl_basic_map_drop_constraints_involving_dims(
5070                 __isl_take isl_basic_map *bmap,
5071                 enum isl_dim_type type,
5072                 unsigned first, unsigned n);
5073         __isl_give isl_basic_map *
5074         isl_basic_map_drop_constraints_not_involving_dims(
5075                 __isl_take isl_basic_map *bmap,
5076                 enum isl_dim_type type,
5077                 unsigned first, unsigned n);
5078         __isl_give isl_map *
5079         isl_map_drop_constraints_involving_dims(
5080                 __isl_take isl_map *map,
5081                 enum isl_dim_type type,
5082                 unsigned first, unsigned n);
5083         __isl_give isl_map *
5084         isl_map_drop_constraints_not_involving_dims(
5085                 __isl_take isl_map *map,
5086                 enum isl_dim_type type,
5087                 unsigned first, unsigned n);
5089 These functions drop any constraints (not) involving the specified dimensions.
5090 Note that the result depends on the representation of the input.
5092         #include <isl/polynomial.h>
5093         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
5094                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
5095         __isl_give isl_union_pw_qpolynomial *
5096         isl_union_pw_qpolynomial_to_polynomial(
5097                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
5099 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
5100 the polynomial will be an overapproximation.  If C<sign> is negative,
5101 it will be an underapproximation.  If C<sign> is zero, the approximation
5102 will lie somewhere in between.
5104 =item * Feasibility
5106         __isl_give isl_basic_set *isl_basic_set_sample(
5107                 __isl_take isl_basic_set *bset);
5108         __isl_give isl_basic_set *isl_set_sample(
5109                 __isl_take isl_set *set);
5110         __isl_give isl_basic_map *isl_basic_map_sample(
5111                 __isl_take isl_basic_map *bmap);
5112         __isl_give isl_basic_map *isl_map_sample(
5113                 __isl_take isl_map *map);
5115 If the input (basic) set or relation is non-empty, then return
5116 a singleton subset of the input.  Otherwise, return an empty set.
5118 =item * Optimization
5120         #include <isl/ilp.h>
5121         __isl_give isl_val *isl_basic_set_max_val(
5122                 __isl_keep isl_basic_set *bset,
5123                 __isl_keep isl_aff *obj);
5124         __isl_give isl_val *isl_set_min_val(
5125                 __isl_keep isl_set *set,
5126                 __isl_keep isl_aff *obj);
5127         __isl_give isl_val *isl_set_max_val(
5128                 __isl_keep isl_set *set,
5129                 __isl_keep isl_aff *obj);
5130         __isl_give isl_multi_val *
5131         isl_union_set_min_multi_union_pw_aff(
5132                 __isl_keep isl_union_set *set,
5133                 __isl_keep isl_multi_union_pw_aff *obj);
5135 Compute the minimum or maximum of the integer affine expression C<obj>
5136 over the points in C<set>, returning the result in C<opt>.
5137 The result is C<NULL> in case of an error, the optimal value in case
5138 there is one, negative infinity or infinity if the problem is unbounded and
5139 NaN if the problem is empty.
5141 =item * Parametric optimization
5143         __isl_give isl_pw_aff *isl_set_dim_min(
5144                 __isl_take isl_set *set, int pos);
5145         __isl_give isl_pw_aff *isl_set_dim_max(
5146                 __isl_take isl_set *set, int pos);
5147         __isl_give isl_pw_aff *isl_map_dim_min(
5148                 __isl_take isl_map *map, int pos);
5149         __isl_give isl_pw_aff *isl_map_dim_max(
5150                 __isl_take isl_map *map, int pos);
5152 Compute the minimum or maximum of the given set or output dimension
5153 as a function of the parameters (and input dimensions), but independently
5154 of the other set or output dimensions.
5155 For lexicographic optimization, see L<"Lexicographic Optimization">.
5157 =item * Dual
5159 The following functions compute either the set of (rational) coefficient
5160 values of valid constraints for the given set or the set of (rational)
5161 values satisfying the constraints with coefficients from the given set.
5162 Internally, these two sets of functions perform essentially the
5163 same operations, except that the set of coefficients is assumed to
5164 be a cone, while the set of values may be any polyhedron.
5165 The current implementation is based on the Farkas lemma and
5166 Fourier-Motzkin elimination, but this may change or be made optional
5167 in future.  In particular, future implementations may use different
5168 dualization algorithms or skip the elimination step.
5170         #include <isl/set.h>
5171         __isl_give isl_basic_set *isl_basic_set_coefficients(
5172                 __isl_take isl_basic_set *bset);
5173         __isl_give isl_basic_set_list *
5174         isl_basic_set_list_coefficients(
5175                 __isl_take isl_basic_set_list *list);
5176         __isl_give isl_basic_set *isl_set_coefficients(
5177                 __isl_take isl_set *set);
5178         __isl_give isl_union_set *isl_union_set_coefficients(
5179                 __isl_take isl_union_set *bset);
5180         __isl_give isl_basic_set *isl_basic_set_solutions(
5181                 __isl_take isl_basic_set *bset);
5182         __isl_give isl_basic_set *isl_set_solutions(
5183                 __isl_take isl_set *set);
5184         __isl_give isl_union_set *isl_union_set_solutions(
5185                 __isl_take isl_union_set *bset);
5187 =item * Power
5189         __isl_give isl_map *isl_map_fixed_power_val(
5190                 __isl_take isl_map *map,
5191                 __isl_take isl_val *exp);
5192         __isl_give isl_union_map *
5193         isl_union_map_fixed_power_val(
5194                 __isl_take isl_union_map *umap,
5195                 __isl_take isl_val *exp);
5197 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
5198 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
5199 of C<map> is computed.
5201         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
5202                 int *exact);
5203         __isl_give isl_union_map *isl_union_map_power(
5204                 __isl_take isl_union_map *umap, int *exact);
5206 Compute a parametric representation for all positive powers I<k> of C<map>.
5207 The result maps I<k> to a nested relation corresponding to the
5208 I<k>th power of C<map>.
5209 The result may be an overapproximation.  If the result is known to be exact,
5210 then C<*exact> is set to C<1>.
5212 =item * Transitive closure
5214         __isl_give isl_map *isl_map_transitive_closure(
5215                 __isl_take isl_map *map, int *exact);
5216         __isl_give isl_union_map *isl_union_map_transitive_closure(
5217                 __isl_take isl_union_map *umap, int *exact);
5219 Compute the transitive closure of C<map>.
5220 The result may be an overapproximation.  If the result is known to be exact,
5221 then C<*exact> is set to C<1>.
5223 =item * Reaching path lengths
5225         __isl_give isl_map *isl_map_reaching_path_lengths(
5226                 __isl_take isl_map *map, int *exact);
5228 Compute a relation that maps each element in the range of C<map>
5229 to the lengths of all paths composed of edges in C<map> that
5230 end up in the given element.
5231 The result may be an overapproximation.  If the result is known to be exact,
5232 then C<*exact> is set to C<1>.
5233 To compute the I<maximal> path length, the resulting relation
5234 should be postprocessed by C<isl_map_lexmax>.
5235 In particular, if the input relation is a dependence relation
5236 (mapping sources to sinks), then the maximal path length corresponds
5237 to the free schedule.
5238 Note, however, that C<isl_map_lexmax> expects the maximum to be
5239 finite, so if the path lengths are unbounded (possibly due to
5240 the overapproximation), then you will get an error message.
5242 =item * Wrapping
5244         #include <isl/space.h>
5245         __isl_give isl_space *isl_space_wrap(
5246                 __isl_take isl_space *space);
5247         __isl_give isl_space *isl_space_unwrap(
5248                 __isl_take isl_space *space);
5250         #include <isl/local_space.h>
5251         __isl_give isl_local_space *isl_local_space_wrap(
5252                 __isl_take isl_local_space *ls);
5254         #include <isl/set.h>
5255         __isl_give isl_basic_map *isl_basic_set_unwrap(
5256                 __isl_take isl_basic_set *bset);
5257         __isl_give isl_map *isl_set_unwrap(
5258                 __isl_take isl_set *set);
5260         #include <isl/map.h>
5261         __isl_give isl_basic_set *isl_basic_map_wrap(
5262                 __isl_take isl_basic_map *bmap);
5263         __isl_give isl_set *isl_map_wrap(
5264                 __isl_take isl_map *map);
5266         #include <isl/union_set.h>
5267         __isl_give isl_union_map *isl_union_set_unwrap(
5268                 __isl_take isl_union_set *uset);
5270         #include <isl/union_map.h>
5271         __isl_give isl_union_set *isl_union_map_wrap(
5272                 __isl_take isl_union_map *umap);
5274 The input to C<isl_space_unwrap> should
5275 be the space of a set, while that of
5276 C<isl_space_wrap> should be the space of a relation.
5277 Conversely, the output of C<isl_space_unwrap> is the space
5278 of a relation, while that of C<isl_space_wrap> is the space of a set.
5280 =item * Flattening
5282 Remove any internal structure of domain (and range) of the given
5283 set or relation.  If there is any such internal structure in the input,
5284 then the name of the space is also removed.
5286         #include <isl/local_space.h>
5287         __isl_give isl_local_space *
5288         isl_local_space_flatten_domain(
5289                 __isl_take isl_local_space *ls);
5290         __isl_give isl_local_space *
5291         isl_local_space_flatten_range(
5292                 __isl_take isl_local_space *ls);
5294         #include <isl/set.h>
5295         __isl_give isl_basic_set *isl_basic_set_flatten(
5296                 __isl_take isl_basic_set *bset);
5297         __isl_give isl_set *isl_set_flatten(
5298                 __isl_take isl_set *set);
5300         #include <isl/map.h>
5301         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
5302                 __isl_take isl_basic_map *bmap);
5303         __isl_give isl_basic_map *isl_basic_map_flatten_range(
5304                 __isl_take isl_basic_map *bmap);
5305         __isl_give isl_map *isl_map_flatten_range(
5306                 __isl_take isl_map *map);
5307         __isl_give isl_map *isl_map_flatten_domain(
5308                 __isl_take isl_map *map);
5309         __isl_give isl_basic_map *isl_basic_map_flatten(
5310                 __isl_take isl_basic_map *bmap);
5311         __isl_give isl_map *isl_map_flatten(
5312                 __isl_take isl_map *map);
5314         #include <isl/val.h>
5315         __isl_give isl_multi_val *isl_multi_val_flatten_range(
5316                 __isl_take isl_multi_val *mv);
5318         #include <isl/aff.h>
5319         __isl_give isl_multi_aff *isl_multi_aff_flatten_domain(
5320                 __isl_take isl_multi_aff *ma);
5321         __isl_give isl_multi_aff *isl_multi_aff_flatten_range(
5322                 __isl_take isl_multi_aff *ma);
5323         __isl_give isl_multi_pw_aff *
5324         isl_multi_pw_aff_flatten_range(
5325                 __isl_take isl_multi_pw_aff *mpa);
5326         __isl_give isl_multi_union_pw_aff *
5327         isl_multi_union_pw_aff_flatten_range(
5328                 __isl_take isl_multi_union_pw_aff *mupa);
5330         #include <isl/map.h>
5331         __isl_give isl_map *isl_set_flatten_map(
5332                 __isl_take isl_set *set);
5334 The function above constructs a relation
5335 that maps the input set to a flattened version of the set.
5337 =item * Lifting
5339 Lift the input set to a space with extra dimensions corresponding
5340 to the existentially quantified variables in the input.
5341 In particular, the result lives in a wrapped map where the domain
5342 is the original space and the range corresponds to the original
5343 existentially quantified variables.
5345         #include <isl/set.h>
5346         __isl_give isl_basic_set *isl_basic_set_lift(
5347                 __isl_take isl_basic_set *bset);
5348         __isl_give isl_set *isl_set_lift(
5349                 __isl_take isl_set *set);
5350         __isl_give isl_union_set *isl_union_set_lift(
5351                 __isl_take isl_union_set *uset);
5353 Given a local space that contains the existentially quantified
5354 variables of a set, a basic relation that, when applied to
5355 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
5356 can be constructed using the following function.
5358         #include <isl/local_space.h>
5359         __isl_give isl_basic_map *isl_local_space_lifting(
5360                 __isl_take isl_local_space *ls);
5362         #include <isl/aff.h>
5363         __isl_give isl_multi_aff *isl_multi_aff_lift(
5364                 __isl_take isl_multi_aff *maff,
5365                 __isl_give isl_local_space **ls);
5367 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
5368 then it is assigned the local space that lies at the basis of
5369 the lifting applied.
5371 =item * Internal Product
5373         #include <isl/space.h>
5374         __isl_give isl_space *isl_space_zip(
5375                 __isl_take isl_space *space);
5377         #include <isl/map.h>
5378         __isl_give isl_basic_map *isl_basic_map_zip(
5379                 __isl_take isl_basic_map *bmap);
5380         __isl_give isl_map *isl_map_zip(
5381                 __isl_take isl_map *map);
5383         #include <isl/union_map.h>
5384         __isl_give isl_union_map *isl_union_map_zip(
5385                 __isl_take isl_union_map *umap);
5387 Given a relation with nested relations for domain and range,
5388 interchange the range of the domain with the domain of the range.
5390 =item * Currying
5392         #include <isl/space.h>
5393         __isl_give isl_space *isl_space_curry(
5394                 __isl_take isl_space *space);
5395         __isl_give isl_space *isl_space_uncurry(
5396                 __isl_take isl_space *space);
5398         #include <isl/map.h>
5399         __isl_give isl_basic_map *isl_basic_map_curry(
5400                 __isl_take isl_basic_map *bmap);
5401         __isl_give isl_basic_map *isl_basic_map_uncurry(
5402                 __isl_take isl_basic_map *bmap);
5403         __isl_give isl_map *isl_map_curry(
5404                 __isl_take isl_map *map);
5405         __isl_give isl_map *isl_map_uncurry(
5406                 __isl_take isl_map *map);
5408         #include <isl/union_map.h>
5409         __isl_give isl_union_map *isl_union_map_curry(
5410                 __isl_take isl_union_map *umap);
5411         __isl_give isl_union_map *isl_union_map_uncurry(
5412                 __isl_take isl_union_map *umap);
5414 Given a relation with a nested relation for domain,
5415 the C<curry> functions
5416 move the range of the nested relation out of the domain
5417 and use it as the domain of a nested relation in the range,
5418 with the original range as range of this nested relation.
5419 The C<uncurry> functions perform the inverse operation.
5421         #include <isl/space.h>
5422         __isl_give isl_space *isl_space_range_curry(
5423                 __isl_take isl_space *space);
5425         #include <isl/map.h>
5426         __isl_give isl_map *isl_map_range_curry(
5427                 __isl_take isl_map *map);
5429         #include <isl/union_map.h>
5430         __isl_give isl_union_map *isl_union_map_range_curry(
5431                 __isl_take isl_union_map *umap);
5433 These functions apply the currying to the relation that
5434 is nested inside the range of the input.
5436 =item * Aligning parameters
5438 Change the order of the parameters of the given set, relation
5439 or function
5440 such that the first parameters match those of C<model>.
5441 This may involve the introduction of extra parameters.
5442 All parameters need to be named.
5444         #include <isl/space.h>
5445         __isl_give isl_space *isl_space_align_params(
5446                 __isl_take isl_space *space1,
5447                 __isl_take isl_space *space2)
5449         #include <isl/set.h>
5450         __isl_give isl_basic_set *isl_basic_set_align_params(
5451                 __isl_take isl_basic_set *bset,
5452                 __isl_take isl_space *model);
5453         __isl_give isl_set *isl_set_align_params(
5454                 __isl_take isl_set *set,
5455                 __isl_take isl_space *model);
5457         #include <isl/map.h>
5458         __isl_give isl_basic_map *isl_basic_map_align_params(
5459                 __isl_take isl_basic_map *bmap,
5460                 __isl_take isl_space *model);
5461         __isl_give isl_map *isl_map_align_params(
5462                 __isl_take isl_map *map,
5463                 __isl_take isl_space *model);
5465         #include <isl/val.h>
5466         __isl_give isl_multi_val *isl_multi_val_align_params(
5467                 __isl_take isl_multi_val *mv,
5468                 __isl_take isl_space *model);
5470         #include <isl/aff.h>
5471         __isl_give isl_aff *isl_aff_align_params(
5472                 __isl_take isl_aff *aff,
5473                 __isl_take isl_space *model);
5474         __isl_give isl_multi_aff *isl_multi_aff_align_params(
5475                 __isl_take isl_multi_aff *multi,
5476                 __isl_take isl_space *model);
5477         __isl_give isl_pw_aff *isl_pw_aff_align_params(
5478                 __isl_take isl_pw_aff *pwaff,
5479                 __isl_take isl_space *model);
5480         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
5481                 __isl_take isl_pw_multi_aff *pma,
5482                 __isl_take isl_space *model);
5483         __isl_give isl_union_pw_aff *
5484         isl_union_pw_aff_align_params(
5485                 __isl_take isl_union_pw_aff *upa,
5486                 __isl_take isl_space *model);
5487         __isl_give isl_union_pw_multi_aff *
5488         isl_union_pw_multi_aff_align_params(
5489                 __isl_take isl_union_pw_multi_aff *upma,
5490                 __isl_take isl_space *model);
5491         __isl_give isl_multi_union_pw_aff *
5492         isl_multi_union_pw_aff_align_params(
5493                 __isl_take isl_multi_union_pw_aff *mupa,
5494                 __isl_take isl_space *model);
5496         #include <isl/polynomial.h>
5497         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
5498                 __isl_take isl_qpolynomial *qp,
5499                 __isl_take isl_space *model);
5501 =item * Unary Arithmetic Operations
5503         #include <isl/set.h>
5504         __isl_give isl_set *isl_set_neg(
5505                 __isl_take isl_set *set);
5506         #include <isl/map.h>
5507         __isl_give isl_map *isl_map_neg(
5508                 __isl_take isl_map *map);
5510 C<isl_set_neg> constructs a set containing the opposites of
5511 the elements in its argument.
5512 The domain of the result of C<isl_map_neg> is the same
5513 as the domain of its argument.  The corresponding range
5514 elements are the opposites of the corresponding range
5515 elements in the argument.
5517         #include <isl/val.h>
5518         __isl_give isl_multi_val *isl_multi_val_neg(
5519                 __isl_take isl_multi_val *mv);
5521         #include <isl/aff.h>
5522         __isl_give isl_aff *isl_aff_neg(
5523                 __isl_take isl_aff *aff);
5524         __isl_give isl_multi_aff *isl_multi_aff_neg(
5525                 __isl_take isl_multi_aff *ma);
5526         __isl_give isl_pw_aff *isl_pw_aff_neg(
5527                 __isl_take isl_pw_aff *pwaff);
5528         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_neg(
5529                 __isl_take isl_pw_multi_aff *pma);
5530         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_neg(
5531                 __isl_take isl_multi_pw_aff *mpa);
5532         __isl_give isl_union_pw_aff *isl_union_pw_aff_neg(
5533                 __isl_take isl_union_pw_aff *upa);
5534         __isl_give isl_union_pw_multi_aff *
5535         isl_union_pw_multi_aff_neg(
5536                 __isl_take isl_union_pw_multi_aff *upma);
5537         __isl_give isl_multi_union_pw_aff *
5538         isl_multi_union_pw_aff_neg(
5539                 __isl_take isl_multi_union_pw_aff *mupa);
5540         __isl_give isl_aff *isl_aff_ceil(
5541                 __isl_take isl_aff *aff);
5542         __isl_give isl_pw_aff *isl_pw_aff_ceil(
5543                 __isl_take isl_pw_aff *pwaff);
5544         __isl_give isl_aff *isl_aff_floor(
5545                 __isl_take isl_aff *aff);
5546         __isl_give isl_multi_aff *isl_multi_aff_floor(
5547                 __isl_take isl_multi_aff *ma);
5548         __isl_give isl_pw_aff *isl_pw_aff_floor(
5549                 __isl_take isl_pw_aff *pwaff);
5550         __isl_give isl_union_pw_aff *isl_union_pw_aff_floor(
5551                 __isl_take isl_union_pw_aff *upa);
5552         __isl_give isl_multi_union_pw_aff *
5553         isl_multi_union_pw_aff_floor(
5554                 __isl_take isl_multi_union_pw_aff *mupa);
5556         #include <isl/aff.h>
5557         __isl_give isl_pw_aff *isl_pw_aff_list_min(
5558                 __isl_take isl_pw_aff_list *list);
5559         __isl_give isl_pw_aff *isl_pw_aff_list_max(
5560                 __isl_take isl_pw_aff_list *list);
5562         #include <isl/polynomial.h>
5563         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
5564                 __isl_take isl_qpolynomial *qp);
5565         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
5566                 __isl_take isl_pw_qpolynomial *pwqp);
5567         __isl_give isl_union_pw_qpolynomial *
5568         isl_union_pw_qpolynomial_neg(
5569                 __isl_take isl_union_pw_qpolynomial *upwqp);
5570         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
5571                 __isl_take isl_qpolynomial *qp,
5572                 unsigned exponent);
5573         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
5574                 __isl_take isl_pw_qpolynomial *pwqp,
5575                 unsigned exponent);
5577 =item * Evaluation
5579 The following functions evaluate a function in a point.
5581         #include <isl/polynomial.h>
5582         __isl_give isl_val *isl_pw_qpolynomial_eval(
5583                 __isl_take isl_pw_qpolynomial *pwqp,
5584                 __isl_take isl_point *pnt);
5585         __isl_give isl_val *isl_pw_qpolynomial_fold_eval(
5586                 __isl_take isl_pw_qpolynomial_fold *pwf,
5587                 __isl_take isl_point *pnt);
5588         __isl_give isl_val *isl_union_pw_qpolynomial_eval(
5589                 __isl_take isl_union_pw_qpolynomial *upwqp,
5590                 __isl_take isl_point *pnt);
5591         __isl_give isl_val *isl_union_pw_qpolynomial_fold_eval(
5592                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5593                 __isl_take isl_point *pnt);
5595 =item * Dimension manipulation
5597 It is usually not advisable to directly change the (input or output)
5598 space of a set or a relation as this removes the name and the internal
5599 structure of the space.  However, the functions below can be useful
5600 to add new parameters, assuming
5601 C<isl_set_align_params> and C<isl_map_align_params>
5602 are not sufficient.
5604         #include <isl/space.h>
5605         __isl_give isl_space *isl_space_add_dims(
5606                 __isl_take isl_space *space,
5607                 enum isl_dim_type type, unsigned n);
5608         __isl_give isl_space *isl_space_insert_dims(
5609                 __isl_take isl_space *space,
5610                 enum isl_dim_type type, unsigned pos, unsigned n);
5611         __isl_give isl_space *isl_space_drop_dims(
5612                 __isl_take isl_space *space,
5613                 enum isl_dim_type type, unsigned first, unsigned n);
5614         __isl_give isl_space *isl_space_move_dims(
5615                 __isl_take isl_space *space,
5616                 enum isl_dim_type dst_type, unsigned dst_pos,
5617                 enum isl_dim_type src_type, unsigned src_pos,
5618                 unsigned n);
5620         #include <isl/local_space.h>
5621         __isl_give isl_local_space *isl_local_space_add_dims(
5622                 __isl_take isl_local_space *ls,
5623                 enum isl_dim_type type, unsigned n);
5624         __isl_give isl_local_space *isl_local_space_insert_dims(
5625                 __isl_take isl_local_space *ls,
5626                 enum isl_dim_type type, unsigned first, unsigned n);
5627         __isl_give isl_local_space *isl_local_space_drop_dims(
5628                 __isl_take isl_local_space *ls,
5629                 enum isl_dim_type type, unsigned first, unsigned n);
5631         #include <isl/set.h>
5632         __isl_give isl_basic_set *isl_basic_set_add_dims(
5633                 __isl_take isl_basic_set *bset,
5634                 enum isl_dim_type type, unsigned n);
5635         __isl_give isl_set *isl_set_add_dims(
5636                 __isl_take isl_set *set,
5637                 enum isl_dim_type type, unsigned n);
5638         __isl_give isl_basic_set *isl_basic_set_insert_dims(
5639                 __isl_take isl_basic_set *bset,
5640                 enum isl_dim_type type, unsigned pos,
5641                 unsigned n);
5642         __isl_give isl_set *isl_set_insert_dims(
5643                 __isl_take isl_set *set,
5644                 enum isl_dim_type type, unsigned pos, unsigned n);
5645         __isl_give isl_basic_set *isl_basic_set_move_dims(
5646                 __isl_take isl_basic_set *bset,
5647                 enum isl_dim_type dst_type, unsigned dst_pos,
5648                 enum isl_dim_type src_type, unsigned src_pos,
5649                 unsigned n);
5650         __isl_give isl_set *isl_set_move_dims(
5651                 __isl_take isl_set *set,
5652                 enum isl_dim_type dst_type, unsigned dst_pos,
5653                 enum isl_dim_type src_type, unsigned src_pos,
5654                 unsigned n);
5656         #include <isl/map.h>
5657         __isl_give isl_basic_map *isl_basic_map_add_dims(
5658                 __isl_take isl_basic_map *bmap,
5659                 enum isl_dim_type type, unsigned n);
5660         __isl_give isl_map *isl_map_add_dims(
5661                 __isl_take isl_map *map,
5662                 enum isl_dim_type type, unsigned n);
5663         __isl_give isl_basic_map *isl_basic_map_insert_dims(
5664                 __isl_take isl_basic_map *bmap,
5665                 enum isl_dim_type type, unsigned pos,
5666                 unsigned n);
5667         __isl_give isl_map *isl_map_insert_dims(
5668                 __isl_take isl_map *map,
5669                 enum isl_dim_type type, unsigned pos, unsigned n);
5670         __isl_give isl_basic_map *isl_basic_map_move_dims(
5671                 __isl_take isl_basic_map *bmap,
5672                 enum isl_dim_type dst_type, unsigned dst_pos,
5673                 enum isl_dim_type src_type, unsigned src_pos,
5674                 unsigned n);
5675         __isl_give isl_map *isl_map_move_dims(
5676                 __isl_take isl_map *map,
5677                 enum isl_dim_type dst_type, unsigned dst_pos,
5678                 enum isl_dim_type src_type, unsigned src_pos,
5679                 unsigned n);
5681         #include <isl/val.h>
5682         __isl_give isl_multi_val *isl_multi_val_insert_dims(
5683                 __isl_take isl_multi_val *mv,
5684                 enum isl_dim_type type, unsigned first, unsigned n);
5685         __isl_give isl_multi_val *isl_multi_val_add_dims(
5686                 __isl_take isl_multi_val *mv,
5687                 enum isl_dim_type type, unsigned n);
5688         __isl_give isl_multi_val *isl_multi_val_drop_dims(
5689                 __isl_take isl_multi_val *mv,
5690                 enum isl_dim_type type, unsigned first, unsigned n);
5692         #include <isl/aff.h>
5693         __isl_give isl_aff *isl_aff_insert_dims(
5694                 __isl_take isl_aff *aff,
5695                 enum isl_dim_type type, unsigned first, unsigned n);
5696         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
5697                 __isl_take isl_multi_aff *ma,
5698                 enum isl_dim_type type, unsigned first, unsigned n);
5699         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
5700                 __isl_take isl_pw_aff *pwaff,
5701                 enum isl_dim_type type, unsigned first, unsigned n);
5702         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
5703                 __isl_take isl_multi_pw_aff *mpa,
5704                 enum isl_dim_type type, unsigned first, unsigned n);
5705         __isl_give isl_aff *isl_aff_add_dims(
5706                 __isl_take isl_aff *aff,
5707                 enum isl_dim_type type, unsigned n);
5708         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
5709                 __isl_take isl_multi_aff *ma,
5710                 enum isl_dim_type type, unsigned n);
5711         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
5712                 __isl_take isl_pw_aff *pwaff,
5713                 enum isl_dim_type type, unsigned n);
5714         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
5715                 __isl_take isl_multi_pw_aff *mpa,
5716                 enum isl_dim_type type, unsigned n);
5717         __isl_give isl_aff *isl_aff_drop_dims(
5718                 __isl_take isl_aff *aff,
5719                 enum isl_dim_type type, unsigned first, unsigned n);
5720         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
5721                 __isl_take isl_multi_aff *maff,
5722                 enum isl_dim_type type, unsigned first, unsigned n);
5723         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
5724                 __isl_take isl_pw_aff *pwaff,
5725                 enum isl_dim_type type, unsigned first, unsigned n);
5726         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
5727                 __isl_take isl_pw_multi_aff *pma,
5728                 enum isl_dim_type type, unsigned first, unsigned n);
5729         __isl_give isl_union_pw_aff *isl_union_pw_aff_drop_dims(
5730                 __isl_take isl_union_pw_aff *upa,
5731                 enum isl_dim_type type, unsigned first, unsigned n);
5732         __isl_give isl_union_pw_multi_aff *
5733                 isl_union_pw_multi_aff_drop_dims(
5734                 __isl_take isl_union_pw_multi_aff *upma,
5735                 enum isl_dim_type type,
5736                 unsigned first, unsigned n);
5737         __isl_give isl_multi_union_pw_aff *
5738         isl_multi_union_pw_aff_drop_dims(
5739                 __isl_take isl_multi_union_pw_aff *mupa,
5740                 enum isl_dim_type type, unsigned first,
5741                 unsigned n);
5742         __isl_give isl_aff *isl_aff_move_dims(
5743                 __isl_take isl_aff *aff,
5744                 enum isl_dim_type dst_type, unsigned dst_pos,
5745                 enum isl_dim_type src_type, unsigned src_pos,
5746                 unsigned n);
5747         __isl_give isl_multi_aff *isl_multi_aff_move_dims(
5748                 __isl_take isl_multi_aff *ma,
5749                 enum isl_dim_type dst_type, unsigned dst_pos,
5750                 enum isl_dim_type src_type, unsigned src_pos,
5751                 unsigned n);
5752         __isl_give isl_pw_aff *isl_pw_aff_move_dims(
5753                 __isl_take isl_pw_aff *pa,
5754                 enum isl_dim_type dst_type, unsigned dst_pos,
5755                 enum isl_dim_type src_type, unsigned src_pos,
5756                 unsigned n);
5757         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_move_dims(
5758                 __isl_take isl_multi_pw_aff *pma,
5759                 enum isl_dim_type dst_type, unsigned dst_pos,
5760                 enum isl_dim_type src_type, unsigned src_pos,
5761                 unsigned n);
5763         #include <isl/polynomial.h>
5764         __isl_give isl_union_pw_qpolynomial *
5765         isl_union_pw_qpolynomial_drop_dims(
5766                 __isl_take isl_union_pw_qpolynomial *upwqp,
5767                 enum isl_dim_type type,
5768                 unsigned first, unsigned n);
5769         __isl_give isl_union_pw_qpolynomial_fold *
5770                 isl_union_pw_qpolynomial_fold_drop_dims(
5771                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5772                 enum isl_dim_type type,
5773                 unsigned first, unsigned n);
5775 The operations on union expressions can only manipulate parameters.
5777 =back
5779 =head2 Binary Operations
5781 The two arguments of a binary operation not only need to live
5782 in the same C<isl_ctx>, they currently also need to have
5783 the same (number of) parameters.
5785 =head3 Basic Operations
5787 =over
5789 =item * Intersection
5791         #include <isl/local_space.h>
5792         __isl_give isl_local_space *isl_local_space_intersect(
5793                 __isl_take isl_local_space *ls1,
5794                 __isl_take isl_local_space *ls2);
5796         #include <isl/set.h>
5797         __isl_give isl_basic_set *isl_basic_set_intersect_params(
5798                 __isl_take isl_basic_set *bset1,
5799                 __isl_take isl_basic_set *bset2);
5800         __isl_give isl_basic_set *isl_basic_set_intersect(
5801                 __isl_take isl_basic_set *bset1,
5802                 __isl_take isl_basic_set *bset2);
5803         __isl_give isl_basic_set *isl_basic_set_list_intersect(
5804                 __isl_take struct isl_basic_set_list *list);
5805         __isl_give isl_set *isl_set_intersect_params(
5806                 __isl_take isl_set *set,
5807                 __isl_take isl_set *params);
5808         __isl_give isl_set *isl_set_intersect(
5809                 __isl_take isl_set *set1,
5810                 __isl_take isl_set *set2);
5812         #include <isl/map.h>
5813         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
5814                 __isl_take isl_basic_map *bmap,
5815                 __isl_take isl_basic_set *bset);
5816         __isl_give isl_basic_map *isl_basic_map_intersect_range(
5817                 __isl_take isl_basic_map *bmap,
5818                 __isl_take isl_basic_set *bset);
5819         __isl_give isl_basic_map *isl_basic_map_intersect(
5820                 __isl_take isl_basic_map *bmap1,
5821                 __isl_take isl_basic_map *bmap2);
5822         __isl_give isl_basic_map *isl_basic_map_list_intersect(
5823                 __isl_take isl_basic_map_list *list);
5824         __isl_give isl_map *isl_map_intersect_params(
5825                 __isl_take isl_map *map,
5826                 __isl_take isl_set *params);
5827         __isl_give isl_map *isl_map_intersect_domain(
5828                 __isl_take isl_map *map,
5829                 __isl_take isl_set *set);
5830         __isl_give isl_map *isl_map_intersect_range(
5831                 __isl_take isl_map *map,
5832                 __isl_take isl_set *set);
5833         __isl_give isl_map *isl_map_intersect(
5834                 __isl_take isl_map *map1,
5835                 __isl_take isl_map *map2);
5837         #include <isl/union_set.h>
5838         __isl_give isl_union_set *isl_union_set_intersect_params(
5839                 __isl_take isl_union_set *uset,
5840                 __isl_take isl_set *set);
5841         __isl_give isl_union_set *isl_union_set_intersect(
5842                 __isl_take isl_union_set *uset1,
5843                 __isl_take isl_union_set *uset2);
5845         #include <isl/union_map.h>
5846         __isl_give isl_union_map *isl_union_map_intersect_params(
5847                 __isl_take isl_union_map *umap,
5848                 __isl_take isl_set *set);
5849         __isl_give isl_union_map *isl_union_map_intersect_domain(
5850                 __isl_take isl_union_map *umap,
5851                 __isl_take isl_union_set *uset);
5852         __isl_give isl_union_map *isl_union_map_intersect_range(
5853                 __isl_take isl_union_map *umap,
5854                 __isl_take isl_union_set *uset);
5855         __isl_give isl_union_map *isl_union_map_intersect(
5856                 __isl_take isl_union_map *umap1,
5857                 __isl_take isl_union_map *umap2);
5859         #include <isl/aff.h>
5860         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
5861                 __isl_take isl_pw_aff *pa,
5862                 __isl_take isl_set *set);
5863         __isl_give isl_multi_pw_aff *
5864         isl_multi_pw_aff_intersect_domain(
5865                 __isl_take isl_multi_pw_aff *mpa,
5866                 __isl_take isl_set *domain);
5867         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
5868                 __isl_take isl_pw_multi_aff *pma,
5869                 __isl_take isl_set *set);
5870         __isl_give isl_union_pw_aff *isl_union_pw_aff_intersect_domain(
5871                 __isl_take isl_union_pw_aff *upa,
5872                 __isl_take isl_union_set *uset);
5873         __isl_give isl_union_pw_multi_aff *
5874         isl_union_pw_multi_aff_intersect_domain(
5875                 __isl_take isl_union_pw_multi_aff *upma,
5876                 __isl_take isl_union_set *uset);
5877         __isl_give isl_multi_union_pw_aff *
5878         isl_multi_union_pw_aff_intersect_domain(
5879                 __isl_take isl_multi_union_pw_aff *mupa,
5880                 __isl_take isl_union_set *uset);
5881         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
5882                 __isl_take isl_pw_aff *pa,
5883                 __isl_take isl_set *set);
5884         __isl_give isl_multi_pw_aff *
5885         isl_multi_pw_aff_intersect_params(
5886                 __isl_take isl_multi_pw_aff *mpa,
5887                 __isl_take isl_set *set);
5888         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
5889                 __isl_take isl_pw_multi_aff *pma,
5890                 __isl_take isl_set *set);
5891         __isl_give isl_union_pw_aff *
5892         isl_union_pw_aff_intersect_params(
5893                 __isl_take isl_union_pw_aff *upa,
5894         __isl_give isl_union_pw_multi_aff *
5895         isl_union_pw_multi_aff_intersect_params(
5896                 __isl_take isl_union_pw_multi_aff *upma,
5897                 __isl_take isl_set *set);
5898         __isl_give isl_multi_union_pw_aff *
5899         isl_multi_union_pw_aff_intersect_params(
5900                 __isl_take isl_multi_union_pw_aff *mupa,
5901                 __isl_take isl_set *params);
5902         isl_multi_union_pw_aff_intersect_range(
5903                 __isl_take isl_multi_union_pw_aff *mupa,
5904                 __isl_take isl_set *set);
5906         #include <isl/polynomial.h>
5907         __isl_give isl_pw_qpolynomial *
5908         isl_pw_qpolynomial_intersect_domain(
5909                 __isl_take isl_pw_qpolynomial *pwpq,
5910                 __isl_take isl_set *set);
5911         __isl_give isl_union_pw_qpolynomial *
5912         isl_union_pw_qpolynomial_intersect_domain(
5913                 __isl_take isl_union_pw_qpolynomial *upwpq,
5914                 __isl_take isl_union_set *uset);
5915         __isl_give isl_union_pw_qpolynomial_fold *
5916         isl_union_pw_qpolynomial_fold_intersect_domain(
5917                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5918                 __isl_take isl_union_set *uset);
5919         __isl_give isl_pw_qpolynomial *
5920         isl_pw_qpolynomial_intersect_params(
5921                 __isl_take isl_pw_qpolynomial *pwpq,
5922                 __isl_take isl_set *set);
5923         __isl_give isl_pw_qpolynomial_fold *
5924         isl_pw_qpolynomial_fold_intersect_params(
5925                 __isl_take isl_pw_qpolynomial_fold *pwf,
5926                 __isl_take isl_set *set);
5927         __isl_give isl_union_pw_qpolynomial *
5928         isl_union_pw_qpolynomial_intersect_params(
5929                 __isl_take isl_union_pw_qpolynomial *upwpq,
5930                 __isl_take isl_set *set);
5931         __isl_give isl_union_pw_qpolynomial_fold *
5932         isl_union_pw_qpolynomial_fold_intersect_params(
5933                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5934                 __isl_take isl_set *set);
5936 The second argument to the C<_params> functions needs to be
5937 a parametric (basic) set.  For the other functions, a parametric set
5938 for either argument is only allowed if the other argument is
5939 a parametric set as well.
5940 The list passed to C<isl_basic_set_list_intersect> needs to have
5941 at least one element and all elements need to live in the same space.
5942 The function C<isl_multi_union_pw_aff_intersect_range>
5943 restricts the input function to those shared domain elements
5944 that map to the specified range.
5946 =item * Union
5948         #include <isl/set.h>
5949         __isl_give isl_set *isl_basic_set_union(
5950                 __isl_take isl_basic_set *bset1,
5951                 __isl_take isl_basic_set *bset2);
5952         __isl_give isl_set *isl_set_union(
5953                 __isl_take isl_set *set1,
5954                 __isl_take isl_set *set2);
5955         __isl_give isl_set *isl_set_list_union(
5956                 __isl_take isl_set_list *list);
5958         #include <isl/map.h>
5959         __isl_give isl_map *isl_basic_map_union(
5960                 __isl_take isl_basic_map *bmap1,
5961                 __isl_take isl_basic_map *bmap2);
5962         __isl_give isl_map *isl_map_union(
5963                 __isl_take isl_map *map1,
5964                 __isl_take isl_map *map2);
5966         #include <isl/union_set.h>
5967         __isl_give isl_union_set *isl_union_set_union(
5968                 __isl_take isl_union_set *uset1,
5969                 __isl_take isl_union_set *uset2);
5970         __isl_give isl_union_set *isl_union_set_list_union(
5971                 __isl_take isl_union_set_list *list);
5973         #include <isl/union_map.h>
5974         __isl_give isl_union_map *isl_union_map_union(
5975                 __isl_take isl_union_map *umap1,
5976                 __isl_take isl_union_map *umap2);
5978 The list passed to C<isl_set_list_union> needs to have
5979 at least one element and all elements need to live in the same space.
5981 =item * Set difference
5983         #include <isl/set.h>
5984         __isl_give isl_set *isl_set_subtract(
5985                 __isl_take isl_set *set1,
5986                 __isl_take isl_set *set2);
5988         #include <isl/map.h>
5989         __isl_give isl_map *isl_map_subtract(
5990                 __isl_take isl_map *map1,
5991                 __isl_take isl_map *map2);
5992         __isl_give isl_map *isl_map_subtract_domain(
5993                 __isl_take isl_map *map,
5994                 __isl_take isl_set *dom);
5995         __isl_give isl_map *isl_map_subtract_range(
5996                 __isl_take isl_map *map,
5997                 __isl_take isl_set *dom);
5999         #include <isl/union_set.h>
6000         __isl_give isl_union_set *isl_union_set_subtract(
6001                 __isl_take isl_union_set *uset1,
6002                 __isl_take isl_union_set *uset2);
6004         #include <isl/union_map.h>
6005         __isl_give isl_union_map *isl_union_map_subtract(
6006                 __isl_take isl_union_map *umap1,
6007                 __isl_take isl_union_map *umap2);
6008         __isl_give isl_union_map *isl_union_map_subtract_domain(
6009                 __isl_take isl_union_map *umap,
6010                 __isl_take isl_union_set *dom);
6011         __isl_give isl_union_map *isl_union_map_subtract_range(
6012                 __isl_take isl_union_map *umap,
6013                 __isl_take isl_union_set *dom);
6015         #include <isl/aff.h>
6016         __isl_give isl_pw_aff *isl_pw_aff_subtract_domain(
6017                 __isl_take isl_pw_aff *pa,
6018                 __isl_take isl_set *set);
6019         __isl_give isl_pw_multi_aff *
6020         isl_pw_multi_aff_subtract_domain(
6021                 __isl_take isl_pw_multi_aff *pma,
6022                 __isl_take isl_set *set);
6023         __isl_give isl_union_pw_aff *
6024         isl_union_pw_aff_subtract_domain(
6025                 __isl_take isl_union_pw_aff *upa,
6026                 __isl_take isl_union_set *uset);
6027         __isl_give isl_union_pw_multi_aff *
6028         isl_union_pw_multi_aff_subtract_domain(
6029                 __isl_take isl_union_pw_multi_aff *upma,
6030                 __isl_take isl_set *set);
6032         #include <isl/polynomial.h>
6033         __isl_give isl_pw_qpolynomial *
6034         isl_pw_qpolynomial_subtract_domain(
6035                 __isl_take isl_pw_qpolynomial *pwpq,
6036                 __isl_take isl_set *set);
6037         __isl_give isl_pw_qpolynomial_fold *
6038         isl_pw_qpolynomial_fold_subtract_domain(
6039                 __isl_take isl_pw_qpolynomial_fold *pwf,
6040                 __isl_take isl_set *set);
6041         __isl_give isl_union_pw_qpolynomial *
6042         isl_union_pw_qpolynomial_subtract_domain(
6043                 __isl_take isl_union_pw_qpolynomial *upwpq,
6044                 __isl_take isl_union_set *uset);
6045         __isl_give isl_union_pw_qpolynomial_fold *
6046         isl_union_pw_qpolynomial_fold_subtract_domain(
6047                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6048                 __isl_take isl_union_set *uset);
6050 =item * Application
6052         #include <isl/space.h>
6053         __isl_give isl_space *isl_space_join(
6054                 __isl_take isl_space *left,
6055                 __isl_take isl_space *right);
6057         #include <isl/map.h>
6058         __isl_give isl_basic_set *isl_basic_set_apply(
6059                 __isl_take isl_basic_set *bset,
6060                 __isl_take isl_basic_map *bmap);
6061         __isl_give isl_set *isl_set_apply(
6062                 __isl_take isl_set *set,
6063                 __isl_take isl_map *map);
6064         __isl_give isl_union_set *isl_union_set_apply(
6065                 __isl_take isl_union_set *uset,
6066                 __isl_take isl_union_map *umap);
6067         __isl_give isl_basic_map *isl_basic_map_apply_domain(
6068                 __isl_take isl_basic_map *bmap1,
6069                 __isl_take isl_basic_map *bmap2);
6070         __isl_give isl_basic_map *isl_basic_map_apply_range(
6071                 __isl_take isl_basic_map *bmap1,
6072                 __isl_take isl_basic_map *bmap2);
6073         __isl_give isl_map *isl_map_apply_domain(
6074                 __isl_take isl_map *map1,
6075                 __isl_take isl_map *map2);
6076         __isl_give isl_map *isl_map_apply_range(
6077                 __isl_take isl_map *map1,
6078                 __isl_take isl_map *map2);
6080         #include <isl/union_map.h>
6081         __isl_give isl_union_map *isl_union_map_apply_domain(
6082                 __isl_take isl_union_map *umap1,
6083                 __isl_take isl_union_map *umap2);
6084         __isl_give isl_union_map *isl_union_map_apply_range(
6085                 __isl_take isl_union_map *umap1,
6086                 __isl_take isl_union_map *umap2);
6088         #include <isl/aff.h>
6089         __isl_give isl_union_pw_aff *
6090         isl_multi_union_pw_aff_apply_aff(
6091                 __isl_take isl_multi_union_pw_aff *mupa,
6092                 __isl_take isl_aff *aff);
6093         __isl_give isl_union_pw_aff *
6094         isl_multi_union_pw_aff_apply_pw_aff(
6095                 __isl_take isl_multi_union_pw_aff *mupa,
6096                 __isl_take isl_pw_aff *pa);
6097         __isl_give isl_multi_union_pw_aff *
6098         isl_multi_union_pw_aff_apply_multi_aff(
6099                 __isl_take isl_multi_union_pw_aff *mupa,
6100                 __isl_take isl_multi_aff *ma);
6101         __isl_give isl_multi_union_pw_aff *
6102         isl_multi_union_pw_aff_apply_pw_multi_aff(
6103                 __isl_take isl_multi_union_pw_aff *mupa,
6104                 __isl_take isl_pw_multi_aff *pma);
6106 The result of C<isl_multi_union_pw_aff_apply_aff> is defined
6107 over the shared domain of the elements of the input.  The dimension is
6108 required to be greater than zero.
6109 The C<isl_multi_union_pw_aff> argument of
6110 C<isl_multi_union_pw_aff_apply_multi_aff> is allowed to be zero-dimensional,
6111 but only if the range of the C<isl_multi_aff> argument
6112 is also zero-dimensional.
6113 Similarly for C<isl_multi_union_pw_aff_apply_pw_multi_aff>.
6115         #include <isl/polynomial.h>
6116         __isl_give isl_pw_qpolynomial_fold *
6117         isl_set_apply_pw_qpolynomial_fold(
6118                 __isl_take isl_set *set,
6119                 __isl_take isl_pw_qpolynomial_fold *pwf,
6120                 int *tight);
6121         __isl_give isl_pw_qpolynomial_fold *
6122         isl_map_apply_pw_qpolynomial_fold(
6123                 __isl_take isl_map *map,
6124                 __isl_take isl_pw_qpolynomial_fold *pwf,
6125                 int *tight);
6126         __isl_give isl_union_pw_qpolynomial_fold *
6127         isl_union_set_apply_union_pw_qpolynomial_fold(
6128                 __isl_take isl_union_set *uset,
6129                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6130                 int *tight);
6131         __isl_give isl_union_pw_qpolynomial_fold *
6132         isl_union_map_apply_union_pw_qpolynomial_fold(
6133                 __isl_take isl_union_map *umap,
6134                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6135                 int *tight);
6137 The functions taking a map
6138 compose the given map with the given piecewise quasipolynomial reduction.
6139 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
6140 over all elements in the intersection of the range of the map
6141 and the domain of the piecewise quasipolynomial reduction
6142 as a function of an element in the domain of the map.
6143 The functions taking a set compute a bound over all elements in the
6144 intersection of the set and the domain of the
6145 piecewise quasipolynomial reduction.
6147 =item * Preimage
6149         #include <isl/set.h>
6150         __isl_give isl_basic_set *
6151         isl_basic_set_preimage_multi_aff(
6152                 __isl_take isl_basic_set *bset,
6153                 __isl_take isl_multi_aff *ma);
6154         __isl_give isl_set *isl_set_preimage_multi_aff(
6155                 __isl_take isl_set *set,
6156                 __isl_take isl_multi_aff *ma);
6157         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
6158                 __isl_take isl_set *set,
6159                 __isl_take isl_pw_multi_aff *pma);
6160         __isl_give isl_set *isl_set_preimage_multi_pw_aff(
6161                 __isl_take isl_set *set,
6162                 __isl_take isl_multi_pw_aff *mpa);
6164         #include <isl/union_set.h>
6165         __isl_give isl_union_set *
6166         isl_union_set_preimage_multi_aff(
6167                 __isl_take isl_union_set *uset,
6168                 __isl_take isl_multi_aff *ma);
6169         __isl_give isl_union_set *
6170         isl_union_set_preimage_pw_multi_aff(
6171                 __isl_take isl_union_set *uset,
6172                 __isl_take isl_pw_multi_aff *pma);
6173         __isl_give isl_union_set *
6174         isl_union_set_preimage_union_pw_multi_aff(
6175                 __isl_take isl_union_set *uset,
6176                 __isl_take isl_union_pw_multi_aff *upma);
6178         #include <isl/map.h>
6179         __isl_give isl_basic_map *
6180         isl_basic_map_preimage_domain_multi_aff(
6181                 __isl_take isl_basic_map *bmap,
6182                 __isl_take isl_multi_aff *ma);
6183         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
6184                 __isl_take isl_map *map,
6185                 __isl_take isl_multi_aff *ma);
6186         __isl_give isl_map *isl_map_preimage_range_multi_aff(
6187                 __isl_take isl_map *map,
6188                 __isl_take isl_multi_aff *ma);
6189         __isl_give isl_map *
6190         isl_map_preimage_domain_pw_multi_aff(
6191                 __isl_take isl_map *map,
6192                 __isl_take isl_pw_multi_aff *pma);
6193         __isl_give isl_map *
6194         isl_map_preimage_range_pw_multi_aff(
6195                 __isl_take isl_map *map,
6196                 __isl_take isl_pw_multi_aff *pma);
6197         __isl_give isl_map *
6198         isl_map_preimage_domain_multi_pw_aff(
6199                 __isl_take isl_map *map,
6200                 __isl_take isl_multi_pw_aff *mpa);
6201         __isl_give isl_basic_map *
6202         isl_basic_map_preimage_range_multi_aff(
6203                 __isl_take isl_basic_map *bmap,
6204                 __isl_take isl_multi_aff *ma);
6206         #include <isl/union_map.h>
6207         __isl_give isl_union_map *
6208         isl_union_map_preimage_domain_multi_aff(
6209                 __isl_take isl_union_map *umap,
6210                 __isl_take isl_multi_aff *ma);
6211         __isl_give isl_union_map *
6212         isl_union_map_preimage_range_multi_aff(
6213                 __isl_take isl_union_map *umap,
6214                 __isl_take isl_multi_aff *ma);
6215         __isl_give isl_union_map *
6216         isl_union_map_preimage_domain_pw_multi_aff(
6217                 __isl_take isl_union_map *umap,
6218                 __isl_take isl_pw_multi_aff *pma);
6219         __isl_give isl_union_map *
6220         isl_union_map_preimage_range_pw_multi_aff(
6221                 __isl_take isl_union_map *umap,
6222                 __isl_take isl_pw_multi_aff *pma);
6223         __isl_give isl_union_map *
6224         isl_union_map_preimage_domain_union_pw_multi_aff(
6225                 __isl_take isl_union_map *umap,
6226                 __isl_take isl_union_pw_multi_aff *upma);
6227         __isl_give isl_union_map *
6228         isl_union_map_preimage_range_union_pw_multi_aff(
6229                 __isl_take isl_union_map *umap,
6230                 __isl_take isl_union_pw_multi_aff *upma);
6232 These functions compute the preimage of the given set or map domain/range under
6233 the given function.  In other words, the expression is plugged
6234 into the set description or into the domain/range of the map.
6236 =item * Pullback
6238         #include <isl/aff.h>
6239         __isl_give isl_aff *isl_aff_pullback_aff(
6240                 __isl_take isl_aff *aff1,
6241                 __isl_take isl_aff *aff2);
6242         __isl_give isl_aff *isl_aff_pullback_multi_aff(
6243                 __isl_take isl_aff *aff,
6244                 __isl_take isl_multi_aff *ma);
6245         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
6246                 __isl_take isl_pw_aff *pa,
6247                 __isl_take isl_multi_aff *ma);
6248         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
6249                 __isl_take isl_pw_aff *pa,
6250                 __isl_take isl_pw_multi_aff *pma);
6251         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_pw_aff(
6252                 __isl_take isl_pw_aff *pa,
6253                 __isl_take isl_multi_pw_aff *mpa);
6254         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
6255                 __isl_take isl_multi_aff *ma1,
6256                 __isl_take isl_multi_aff *ma2);
6257         __isl_give isl_pw_multi_aff *
6258         isl_pw_multi_aff_pullback_multi_aff(
6259                 __isl_take isl_pw_multi_aff *pma,
6260                 __isl_take isl_multi_aff *ma);
6261         __isl_give isl_multi_pw_aff *
6262         isl_multi_pw_aff_pullback_multi_aff(
6263                 __isl_take isl_multi_pw_aff *mpa,
6264                 __isl_take isl_multi_aff *ma);
6265         __isl_give isl_pw_multi_aff *
6266         isl_pw_multi_aff_pullback_pw_multi_aff(
6267                 __isl_take isl_pw_multi_aff *pma1,
6268                 __isl_take isl_pw_multi_aff *pma2);
6269         __isl_give isl_multi_pw_aff *
6270         isl_multi_pw_aff_pullback_pw_multi_aff(
6271                 __isl_take isl_multi_pw_aff *mpa,
6272                 __isl_take isl_pw_multi_aff *pma);
6273         __isl_give isl_multi_pw_aff *
6274         isl_multi_pw_aff_pullback_multi_pw_aff(
6275                 __isl_take isl_multi_pw_aff *mpa1,
6276                 __isl_take isl_multi_pw_aff *mpa2);
6277         __isl_give isl_union_pw_aff *
6278         isl_union_pw_aff_pullback_union_pw_multi_aff(
6279                 __isl_take isl_union_pw_aff *upa,
6280                 __isl_take isl_union_pw_multi_aff *upma);
6281         __isl_give isl_union_pw_multi_aff *
6282         isl_union_pw_multi_aff_pullback_union_pw_multi_aff(
6283                 __isl_take isl_union_pw_multi_aff *upma1,
6284                 __isl_take isl_union_pw_multi_aff *upma2);
6285         __isl_give isl_multi_union_pw_aff *
6286         isl_multi_union_pw_aff_pullback_union_pw_multi_aff(
6287                 __isl_take isl_multi_union_pw_aff *mupa,
6288                 __isl_take isl_union_pw_multi_aff *upma);
6290 These functions precompose the first expression by the second function.
6291 In other words, the second function is plugged
6292 into the first expression.
6294 =item * Locus
6296         #include <isl/aff.h>
6297         __isl_give isl_basic_set *isl_aff_eq_basic_set(
6298                 __isl_take isl_aff *aff1,
6299                 __isl_take isl_aff *aff2);
6300         __isl_give isl_set *isl_aff_eq_set(
6301                 __isl_take isl_aff *aff1,
6302                 __isl_take isl_aff *aff2);
6303         __isl_give isl_basic_set *isl_aff_le_basic_set(
6304                 __isl_take isl_aff *aff1,
6305                 __isl_take isl_aff *aff2);
6306         __isl_give isl_set *isl_aff_le_set(
6307                 __isl_take isl_aff *aff1,
6308                 __isl_take isl_aff *aff2);
6309         __isl_give isl_basic_set *isl_aff_lt_basic_set(
6310                 __isl_take isl_aff *aff1,
6311                 __isl_take isl_aff *aff2);
6312         __isl_give isl_set *isl_aff_lt_set(
6313                 __isl_take isl_aff *aff1,
6314                 __isl_take isl_aff *aff2);
6315         __isl_give isl_basic_set *isl_aff_ge_basic_set(
6316                 __isl_take isl_aff *aff1,
6317                 __isl_take isl_aff *aff2);
6318         __isl_give isl_set *isl_aff_ge_set(
6319                 __isl_take isl_aff *aff1,
6320                 __isl_take isl_aff *aff2);
6321         __isl_give isl_basic_set *isl_aff_gt_basic_set(
6322                 __isl_take isl_aff *aff1,
6323                 __isl_take isl_aff *aff2);
6324         __isl_give isl_set *isl_pw_aff_eq_set(
6325                 __isl_take isl_pw_aff *pwaff1,
6326                 __isl_take isl_pw_aff *pwaff2);
6327         __isl_give isl_set *isl_pw_aff_ne_set(
6328                 __isl_take isl_pw_aff *pwaff1,
6329                 __isl_take isl_pw_aff *pwaff2);
6330         __isl_give isl_set *isl_pw_aff_le_set(
6331                 __isl_take isl_pw_aff *pwaff1,
6332                 __isl_take isl_pw_aff *pwaff2);
6333         __isl_give isl_set *isl_pw_aff_lt_set(
6334                 __isl_take isl_pw_aff *pwaff1,
6335                 __isl_take isl_pw_aff *pwaff2);
6336         __isl_give isl_set *isl_pw_aff_ge_set(
6337                 __isl_take isl_pw_aff *pwaff1,
6338                 __isl_take isl_pw_aff *pwaff2);
6339         __isl_give isl_set *isl_pw_aff_gt_set(
6340                 __isl_take isl_pw_aff *pwaff1,
6341                 __isl_take isl_pw_aff *pwaff2);
6343         __isl_give isl_set *isl_multi_aff_lex_le_set(
6344                 __isl_take isl_multi_aff *ma1,
6345                 __isl_take isl_multi_aff *ma2);
6346         __isl_give isl_set *isl_multi_aff_lex_lt_set(
6347                 __isl_take isl_multi_aff *ma1,
6348                 __isl_take isl_multi_aff *ma2);
6349         __isl_give isl_set *isl_multi_aff_lex_ge_set(
6350                 __isl_take isl_multi_aff *ma1,
6351                 __isl_take isl_multi_aff *ma2);
6352         __isl_give isl_set *isl_multi_aff_lex_gt_set(
6353                 __isl_take isl_multi_aff *ma1,
6354                 __isl_take isl_multi_aff *ma2);
6356         __isl_give isl_set *isl_pw_aff_list_eq_set(
6357                 __isl_take isl_pw_aff_list *list1,
6358                 __isl_take isl_pw_aff_list *list2);
6359         __isl_give isl_set *isl_pw_aff_list_ne_set(
6360                 __isl_take isl_pw_aff_list *list1,
6361                 __isl_take isl_pw_aff_list *list2);
6362         __isl_give isl_set *isl_pw_aff_list_le_set(
6363                 __isl_take isl_pw_aff_list *list1,
6364                 __isl_take isl_pw_aff_list *list2);
6365         __isl_give isl_set *isl_pw_aff_list_lt_set(
6366                 __isl_take isl_pw_aff_list *list1,
6367                 __isl_take isl_pw_aff_list *list2);
6368         __isl_give isl_set *isl_pw_aff_list_ge_set(
6369                 __isl_take isl_pw_aff_list *list1,
6370                 __isl_take isl_pw_aff_list *list2);
6371         __isl_give isl_set *isl_pw_aff_list_gt_set(
6372                 __isl_take isl_pw_aff_list *list1,
6373                 __isl_take isl_pw_aff_list *list2);
6375 The function C<isl_aff_ge_basic_set> returns a basic set
6376 containing those elements in the shared space
6377 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
6378 The function C<isl_pw_aff_ge_set> returns a set
6379 containing those elements in the shared domain
6380 of C<pwaff1> and C<pwaff2> where C<pwaff1> is
6381 greater than or equal to C<pwaff2>.
6382 The function C<isl_multi_aff_lex_le_set> returns a set
6383 containing those elements in the shared domain space
6384 where C<ma1> is lexicographically smaller than or
6385 equal to C<ma2>.
6386 The functions operating on C<isl_pw_aff_list> apply the corresponding
6387 C<isl_pw_aff> function to each pair of elements in the two lists.
6389         #include <isl/aff.h>
6390         __isl_give isl_map *isl_pw_aff_eq_map(
6391                 __isl_take isl_pw_aff *pa1,
6392                 __isl_take isl_pw_aff *pa2);
6393         __isl_give isl_map *isl_pw_aff_lt_map(
6394                 __isl_take isl_pw_aff *pa1,
6395                 __isl_take isl_pw_aff *pa2);
6396         __isl_give isl_map *isl_pw_aff_gt_map(
6397                 __isl_take isl_pw_aff *pa1,
6398                 __isl_take isl_pw_aff *pa2);
6400         __isl_give isl_map *isl_multi_pw_aff_eq_map(
6401                 __isl_take isl_multi_pw_aff *mpa1,
6402                 __isl_take isl_multi_pw_aff *mpa2);
6403         __isl_give isl_map *isl_multi_pw_aff_lex_lt_map(
6404                 __isl_take isl_multi_pw_aff *mpa1,
6405                 __isl_take isl_multi_pw_aff *mpa2);
6406         __isl_give isl_map *isl_multi_pw_aff_lex_gt_map(
6407                 __isl_take isl_multi_pw_aff *mpa1,
6408                 __isl_take isl_multi_pw_aff *mpa2);
6410 These functions return a map between domain elements of the arguments
6411 where the function values satisfy the given relation.
6413         #include <isl/union_map.h>
6414         __isl_give isl_union_map *
6415         isl_union_map_eq_at_multi_union_pw_aff(
6416                 __isl_take isl_union_map *umap,
6417                 __isl_take isl_multi_union_pw_aff *mupa);
6418         __isl_give isl_union_map *
6419         isl_union_map_lex_lt_at_multi_union_pw_aff(
6420                 __isl_take isl_union_map *umap,
6421                 __isl_take isl_multi_union_pw_aff *mupa);
6422         __isl_give isl_union_map *
6423         isl_union_map_lex_gt_at_multi_union_pw_aff(
6424                 __isl_take isl_union_map *umap,
6425                 __isl_take isl_multi_union_pw_aff *mupa);
6427 These functions select the subset of elements in the union map
6428 that have an equal or lexicographically smaller function value.
6430 =item * Cartesian Product
6432         #include <isl/space.h>
6433         __isl_give isl_space *isl_space_product(
6434                 __isl_take isl_space *space1,
6435                 __isl_take isl_space *space2);
6436         __isl_give isl_space *isl_space_domain_product(
6437                 __isl_take isl_space *space1,
6438                 __isl_take isl_space *space2);
6439         __isl_give isl_space *isl_space_range_product(
6440                 __isl_take isl_space *space1,
6441                 __isl_take isl_space *space2);
6443 The functions
6444 C<isl_space_product>, C<isl_space_domain_product>
6445 and C<isl_space_range_product> take pairs or relation spaces and
6446 produce a single relations space, where either the domain, the range
6447 or both domain and range are wrapped spaces of relations between
6448 the domains and/or ranges of the input spaces.
6449 If the product is only constructed over the domain or the range
6450 then the ranges or the domains of the inputs should be the same.
6451 The function C<isl_space_product> also accepts a pair of set spaces,
6452 in which case it returns a wrapped space of a relation between the
6453 two input spaces.
6455         #include <isl/set.h>
6456         __isl_give isl_set *isl_set_product(
6457                 __isl_take isl_set *set1,
6458                 __isl_take isl_set *set2);
6460         #include <isl/map.h>
6461         __isl_give isl_basic_map *isl_basic_map_domain_product(
6462                 __isl_take isl_basic_map *bmap1,
6463                 __isl_take isl_basic_map *bmap2);
6464         __isl_give isl_basic_map *isl_basic_map_range_product(
6465                 __isl_take isl_basic_map *bmap1,
6466                 __isl_take isl_basic_map *bmap2);
6467         __isl_give isl_basic_map *isl_basic_map_product(
6468                 __isl_take isl_basic_map *bmap1,
6469                 __isl_take isl_basic_map *bmap2);
6470         __isl_give isl_map *isl_map_domain_product(
6471                 __isl_take isl_map *map1,
6472                 __isl_take isl_map *map2);
6473         __isl_give isl_map *isl_map_range_product(
6474                 __isl_take isl_map *map1,
6475                 __isl_take isl_map *map2);
6476         __isl_give isl_map *isl_map_product(
6477                 __isl_take isl_map *map1,
6478                 __isl_take isl_map *map2);
6480         #include <isl/union_set.h>
6481         __isl_give isl_union_set *isl_union_set_product(
6482                 __isl_take isl_union_set *uset1,
6483                 __isl_take isl_union_set *uset2);
6485         #include <isl/union_map.h>
6486         __isl_give isl_union_map *isl_union_map_domain_product(
6487                 __isl_take isl_union_map *umap1,
6488                 __isl_take isl_union_map *umap2);
6489         __isl_give isl_union_map *isl_union_map_range_product(
6490                 __isl_take isl_union_map *umap1,
6491                 __isl_take isl_union_map *umap2);
6492         __isl_give isl_union_map *isl_union_map_product(
6493                 __isl_take isl_union_map *umap1,
6494                 __isl_take isl_union_map *umap2);
6496         #include <isl/val.h>
6497         __isl_give isl_multi_val *isl_multi_val_range_product(
6498                 __isl_take isl_multi_val *mv1,
6499                 __isl_take isl_multi_val *mv2);
6500         __isl_give isl_multi_val *isl_multi_val_product(
6501                 __isl_take isl_multi_val *mv1,
6502                 __isl_take isl_multi_val *mv2);
6504         #include <isl/aff.h>
6505         __isl_give isl_multi_aff *isl_multi_aff_range_product(
6506                 __isl_take isl_multi_aff *ma1,
6507                 __isl_take isl_multi_aff *ma2);
6508         __isl_give isl_multi_aff *isl_multi_aff_product(
6509                 __isl_take isl_multi_aff *ma1,
6510                 __isl_take isl_multi_aff *ma2);
6511         __isl_give isl_multi_pw_aff *
6512         isl_multi_pw_aff_range_product(
6513                 __isl_take isl_multi_pw_aff *mpa1,
6514                 __isl_take isl_multi_pw_aff *mpa2);
6515         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_product(
6516                 __isl_take isl_multi_pw_aff *mpa1,
6517                 __isl_take isl_multi_pw_aff *mpa2);
6518         __isl_give isl_pw_multi_aff *
6519         isl_pw_multi_aff_range_product(
6520                 __isl_take isl_pw_multi_aff *pma1,
6521                 __isl_take isl_pw_multi_aff *pma2);
6522         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
6523                 __isl_take isl_pw_multi_aff *pma1,
6524                 __isl_take isl_pw_multi_aff *pma2);
6525         __isl_give isl_multi_union_pw_aff *
6526         isl_multi_union_pw_aff_range_product(
6527                 __isl_take isl_multi_union_pw_aff *mupa1,
6528                 __isl_take isl_multi_union_pw_aff *mupa2);
6530 The above functions compute the cross product of the given
6531 sets, relations or functions.  The domains and ranges of the results
6532 are wrapped maps between domains and ranges of the inputs.
6533 To obtain a ``flat'' product, use the following functions
6534 instead.
6536         #include <isl/set.h>
6537         __isl_give isl_basic_set *isl_basic_set_flat_product(
6538                 __isl_take isl_basic_set *bset1,
6539                 __isl_take isl_basic_set *bset2);
6540         __isl_give isl_set *isl_set_flat_product(
6541                 __isl_take isl_set *set1,
6542                 __isl_take isl_set *set2);
6544         #include <isl/map.h>
6545         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
6546                 __isl_take isl_basic_map *bmap1,
6547                 __isl_take isl_basic_map *bmap2);
6548         __isl_give isl_map *isl_map_flat_domain_product(
6549                 __isl_take isl_map *map1,
6550                 __isl_take isl_map *map2);
6551         __isl_give isl_map *isl_map_flat_range_product(
6552                 __isl_take isl_map *map1,
6553                 __isl_take isl_map *map2);
6554         __isl_give isl_basic_map *isl_basic_map_flat_product(
6555                 __isl_take isl_basic_map *bmap1,
6556                 __isl_take isl_basic_map *bmap2);
6557         __isl_give isl_map *isl_map_flat_product(
6558                 __isl_take isl_map *map1,
6559                 __isl_take isl_map *map2);
6561         #include <isl/union_map.h>
6562         __isl_give isl_union_map *
6563         isl_union_map_flat_domain_product(
6564                 __isl_take isl_union_map *umap1,
6565                 __isl_take isl_union_map *umap2);
6566         __isl_give isl_union_map *
6567         isl_union_map_flat_range_product(
6568                 __isl_take isl_union_map *umap1,
6569                 __isl_take isl_union_map *umap2);
6571         #include <isl/val.h>
6572         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
6573                 __isl_take isl_multi_val *mv1,
6574                 __isl_take isl_multi_aff *mv2);
6576         #include <isl/aff.h>
6577         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
6578                 __isl_take isl_multi_aff *ma1,
6579                 __isl_take isl_multi_aff *ma2);
6580         __isl_give isl_pw_multi_aff *
6581         isl_pw_multi_aff_flat_range_product(
6582                 __isl_take isl_pw_multi_aff *pma1,
6583                 __isl_take isl_pw_multi_aff *pma2);
6584         __isl_give isl_multi_pw_aff *
6585         isl_multi_pw_aff_flat_range_product(
6586                 __isl_take isl_multi_pw_aff *mpa1,
6587                 __isl_take isl_multi_pw_aff *mpa2);
6588         __isl_give isl_union_pw_multi_aff *
6589         isl_union_pw_multi_aff_flat_range_product(
6590                 __isl_take isl_union_pw_multi_aff *upma1,
6591                 __isl_take isl_union_pw_multi_aff *upma2);
6592         __isl_give isl_multi_union_pw_aff *
6593         isl_multi_union_pw_aff_flat_range_product(
6594                 __isl_take isl_multi_union_pw_aff *mupa1,
6595                 __isl_take isl_multi_union_pw_aff *mupa2);
6597         #include <isl/space.h>
6598         __isl_give isl_space *isl_space_factor_domain(
6599                 __isl_take isl_space *space);
6600         __isl_give isl_space *isl_space_factor_range(
6601                 __isl_take isl_space *space);
6602         __isl_give isl_space *isl_space_domain_factor_domain(
6603                 __isl_take isl_space *space);
6604         __isl_give isl_space *isl_space_domain_factor_range(
6605                 __isl_take isl_space *space);
6606         __isl_give isl_space *isl_space_range_factor_domain(
6607                 __isl_take isl_space *space);
6608         __isl_give isl_space *isl_space_range_factor_range(
6609                 __isl_take isl_space *space);
6611 The functions C<isl_space_range_factor_domain> and
6612 C<isl_space_range_factor_range> extract the two arguments from
6613 the result of a call to C<isl_space_range_product>.
6615 The arguments of a call to a product can be extracted
6616 from the result using the following functions.
6618         #include <isl/map.h>
6619         __isl_give isl_map *isl_map_factor_domain(
6620                 __isl_take isl_map *map);
6621         __isl_give isl_map *isl_map_factor_range(
6622                 __isl_take isl_map *map);
6623         __isl_give isl_map *isl_map_domain_factor_domain(
6624                 __isl_take isl_map *map);
6625         __isl_give isl_map *isl_map_domain_factor_range(
6626                 __isl_take isl_map *map);
6627         __isl_give isl_map *isl_map_range_factor_domain(
6628                 __isl_take isl_map *map);
6629         __isl_give isl_map *isl_map_range_factor_range(
6630                 __isl_take isl_map *map);
6632         #include <isl/union_map.h>
6633         __isl_give isl_union_map *isl_union_map_factor_domain(
6634                 __isl_take isl_union_map *umap);
6635         __isl_give isl_union_map *isl_union_map_factor_range(
6636                 __isl_take isl_union_map *umap);
6637         __isl_give isl_union_map *
6638         isl_union_map_domain_factor_domain(
6639                 __isl_take isl_union_map *umap);
6640         __isl_give isl_union_map *
6641         isl_union_map_domain_factor_range(
6642                 __isl_take isl_union_map *umap);
6643         __isl_give isl_union_map *
6644         isl_union_map_range_factor_domain(
6645                 __isl_take isl_union_map *umap);
6646         __isl_give isl_union_map *
6647         isl_union_map_range_factor_range(
6648                 __isl_take isl_union_map *umap);
6650         #include <isl/val.h>
6651         __isl_give isl_multi_val *isl_multi_val_factor_range(
6652                 __isl_take isl_multi_val *mv);
6653         __isl_give isl_multi_val *
6654         isl_multi_val_range_factor_domain(
6655                 __isl_take isl_multi_val *mv);
6656         __isl_give isl_multi_val *
6657         isl_multi_val_range_factor_range(
6658                 __isl_take isl_multi_val *mv);
6660         #include <isl/aff.h>
6661         __isl_give isl_multi_aff *isl_multi_aff_factor_range(
6662                 __isl_take isl_multi_aff *ma);
6663         __isl_give isl_multi_aff *
6664         isl_multi_aff_range_factor_domain(
6665                 __isl_take isl_multi_aff *ma);
6666         __isl_give isl_multi_aff *
6667         isl_multi_aff_range_factor_range(
6668                 __isl_take isl_multi_aff *ma);
6669         __isl_give isl_multi_pw_aff *
6670         isl_multi_pw_aff_factor_range(
6671                 __isl_take isl_multi_pw_aff *mpa);
6672         __isl_give isl_multi_pw_aff *
6673         isl_multi_pw_aff_range_factor_domain(
6674                 __isl_take isl_multi_pw_aff *mpa);
6675         __isl_give isl_multi_pw_aff *
6676         isl_multi_pw_aff_range_factor_range(
6677                 __isl_take isl_multi_pw_aff *mpa);
6678         __isl_give isl_multi_union_pw_aff *
6679         isl_multi_union_pw_aff_factor_range(
6680                 __isl_take isl_multi_union_pw_aff *mupa);
6681         __isl_give isl_multi_union_pw_aff *
6682         isl_multi_union_pw_aff_range_factor_domain(
6683                 __isl_take isl_multi_union_pw_aff *mupa);
6684         __isl_give isl_multi_union_pw_aff *
6685         isl_multi_union_pw_aff_range_factor_range(
6686                 __isl_take isl_multi_union_pw_aff *mupa);
6688 The splice functions are a generalization of the flat product functions,
6689 where the second argument may be inserted at any position inside
6690 the first argument rather than being placed at the end.
6691 The functions C<isl_multi_val_factor_range>,
6692 C<isl_multi_aff_factor_range>,
6693 C<isl_multi_pw_aff_factor_range> and
6694 C<isl_multi_union_pw_aff_factor_range>
6695 take functions that live in a set space.
6697         #include <isl/val.h>
6698         __isl_give isl_multi_val *isl_multi_val_range_splice(
6699                 __isl_take isl_multi_val *mv1, unsigned pos,
6700                 __isl_take isl_multi_val *mv2);
6702         #include <isl/aff.h>
6703         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
6704                 __isl_take isl_multi_aff *ma1, unsigned pos,
6705                 __isl_take isl_multi_aff *ma2);
6706         __isl_give isl_multi_aff *isl_multi_aff_splice(
6707                 __isl_take isl_multi_aff *ma1,
6708                 unsigned in_pos, unsigned out_pos,
6709                 __isl_take isl_multi_aff *ma2);
6710         __isl_give isl_multi_pw_aff *
6711         isl_multi_pw_aff_range_splice(
6712                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
6713                 __isl_take isl_multi_pw_aff *mpa2);
6714         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
6715                 __isl_take isl_multi_pw_aff *mpa1,
6716                 unsigned in_pos, unsigned out_pos,
6717                 __isl_take isl_multi_pw_aff *mpa2);
6718         __isl_give isl_multi_union_pw_aff *
6719         isl_multi_union_pw_aff_range_splice(
6720                 __isl_take isl_multi_union_pw_aff *mupa1,
6721                 unsigned pos,
6722                 __isl_take isl_multi_union_pw_aff *mupa2);
6724 =item * Simplification
6726 When applied to a set or relation,
6727 the gist operation returns a set or relation that has the
6728 same intersection with the context as the input set or relation.
6729 Any implicit equality in the intersection is made explicit in the result,
6730 while all inequalities that are redundant with respect to the intersection
6731 are removed.
6732 In case of union sets and relations, the gist operation is performed
6733 per space.
6735 When applied to a function,
6736 the gist operation applies the set gist operation to each of
6737 the cells in the domain of the input piecewise expression.
6738 The context is also exploited
6739 to simplify the expression associated to each cell.
6741         #include <isl/set.h>
6742         __isl_give isl_basic_set *isl_basic_set_gist(
6743                 __isl_take isl_basic_set *bset,
6744                 __isl_take isl_basic_set *context);
6745         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
6746                 __isl_take isl_set *context);
6747         __isl_give isl_set *isl_set_gist_params(
6748                 __isl_take isl_set *set,
6749                 __isl_take isl_set *context);
6751         #include <isl/map.h>
6752         __isl_give isl_basic_map *isl_basic_map_gist(
6753                 __isl_take isl_basic_map *bmap,
6754                 __isl_take isl_basic_map *context);
6755         __isl_give isl_basic_map *isl_basic_map_gist_domain(
6756                 __isl_take isl_basic_map *bmap,
6757                 __isl_take isl_basic_set *context);
6758         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
6759                 __isl_take isl_map *context);
6760         __isl_give isl_map *isl_map_gist_params(
6761                 __isl_take isl_map *map,
6762                 __isl_take isl_set *context);
6763         __isl_give isl_map *isl_map_gist_domain(
6764                 __isl_take isl_map *map,
6765                 __isl_take isl_set *context);
6766         __isl_give isl_map *isl_map_gist_range(
6767                 __isl_take isl_map *map,
6768                 __isl_take isl_set *context);
6770         #include <isl/union_set.h>
6771         __isl_give isl_union_set *isl_union_set_gist(
6772                 __isl_take isl_union_set *uset,
6773                 __isl_take isl_union_set *context);
6774         __isl_give isl_union_set *isl_union_set_gist_params(
6775                 __isl_take isl_union_set *uset,
6776                 __isl_take isl_set *set);
6778         #include <isl/union_map.h>
6779         __isl_give isl_union_map *isl_union_map_gist(
6780                 __isl_take isl_union_map *umap,
6781                 __isl_take isl_union_map *context);
6782         __isl_give isl_union_map *isl_union_map_gist_params(
6783                 __isl_take isl_union_map *umap,
6784                 __isl_take isl_set *set);
6785         __isl_give isl_union_map *isl_union_map_gist_domain(
6786                 __isl_take isl_union_map *umap,
6787                 __isl_take isl_union_set *uset);
6788         __isl_give isl_union_map *isl_union_map_gist_range(
6789                 __isl_take isl_union_map *umap,
6790                 __isl_take isl_union_set *uset);
6792         #include <isl/aff.h>
6793         __isl_give isl_aff *isl_aff_gist_params(
6794                 __isl_take isl_aff *aff,
6795                 __isl_take isl_set *context);
6796         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
6797                 __isl_take isl_set *context);
6798         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
6799                 __isl_take isl_multi_aff *maff,
6800                 __isl_take isl_set *context);
6801         __isl_give isl_multi_aff *isl_multi_aff_gist(
6802                 __isl_take isl_multi_aff *maff,
6803                 __isl_take isl_set *context);
6804         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
6805                 __isl_take isl_pw_aff *pwaff,
6806                 __isl_take isl_set *context);
6807         __isl_give isl_pw_aff *isl_pw_aff_gist(
6808                 __isl_take isl_pw_aff *pwaff,
6809                 __isl_take isl_set *context);
6810         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
6811                 __isl_take isl_pw_multi_aff *pma,
6812                 __isl_take isl_set *set);
6813         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
6814                 __isl_take isl_pw_multi_aff *pma,
6815                 __isl_take isl_set *set);
6816         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist_params(
6817                 __isl_take isl_multi_pw_aff *mpa,
6818                 __isl_take isl_set *set);
6819         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist(
6820                 __isl_take isl_multi_pw_aff *mpa,
6821                 __isl_take isl_set *set);
6822         __isl_give isl_union_pw_aff *isl_union_pw_aff_gist(
6823                 __isl_take isl_union_pw_aff *upa,
6824                 __isl_take isl_union_set *context);
6825         __isl_give isl_union_pw_aff *isl_union_pw_aff_gist_params(
6826                 __isl_take isl_union_pw_aff *upa,
6827                 __isl_take isl_set *context);
6828         __isl_give isl_union_pw_multi_aff *
6829         isl_union_pw_multi_aff_gist_params(
6830                 __isl_take isl_union_pw_multi_aff *upma,
6831                 __isl_take isl_set *context);
6832         __isl_give isl_union_pw_multi_aff *
6833         isl_union_pw_multi_aff_gist(
6834                 __isl_take isl_union_pw_multi_aff *upma,
6835                 __isl_take isl_union_set *context);
6836         __isl_give isl_multi_union_pw_aff *
6837         isl_multi_union_pw_aff_gist_params(
6838                 __isl_take isl_multi_union_pw_aff *aff,
6839                 __isl_take isl_set *context);
6840         __isl_give isl_multi_union_pw_aff *
6841         isl_multi_union_pw_aff_gist(
6842                 __isl_take isl_multi_union_pw_aff *aff,
6843                 __isl_take isl_union_set *context);
6845         #include <isl/polynomial.h>
6846         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
6847                 __isl_take isl_qpolynomial *qp,
6848                 __isl_take isl_set *context);
6849         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
6850                 __isl_take isl_qpolynomial *qp,
6851                 __isl_take isl_set *context);
6852         __isl_give isl_qpolynomial_fold *
6853         isl_qpolynomial_fold_gist_params(
6854                 __isl_take isl_qpolynomial_fold *fold,
6855                 __isl_take isl_set *context);
6856         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
6857                 __isl_take isl_qpolynomial_fold *fold,
6858                 __isl_take isl_set *context);
6859         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
6860                 __isl_take isl_pw_qpolynomial *pwqp,
6861                 __isl_take isl_set *context);
6862         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
6863                 __isl_take isl_pw_qpolynomial *pwqp,
6864                 __isl_take isl_set *context);
6865         __isl_give isl_pw_qpolynomial_fold *
6866         isl_pw_qpolynomial_fold_gist(
6867                 __isl_take isl_pw_qpolynomial_fold *pwf,
6868                 __isl_take isl_set *context);
6869         __isl_give isl_pw_qpolynomial_fold *
6870         isl_pw_qpolynomial_fold_gist_params(
6871                 __isl_take isl_pw_qpolynomial_fold *pwf,
6872                 __isl_take isl_set *context);
6873         __isl_give isl_union_pw_qpolynomial *
6874         isl_union_pw_qpolynomial_gist_params(
6875                 __isl_take isl_union_pw_qpolynomial *upwqp,
6876                 __isl_take isl_set *context);
6877         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
6878                 __isl_take isl_union_pw_qpolynomial *upwqp,
6879                 __isl_take isl_union_set *context);
6880         __isl_give isl_union_pw_qpolynomial_fold *
6881         isl_union_pw_qpolynomial_fold_gist(
6882                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6883                 __isl_take isl_union_set *context);
6884         __isl_give isl_union_pw_qpolynomial_fold *
6885         isl_union_pw_qpolynomial_fold_gist_params(
6886                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6887                 __isl_take isl_set *context);
6889 =item * Binary Arithmetic Operations
6891         #include <isl/set.h>
6892         __isl_give isl_set *isl_set_sum(
6893                 __isl_take isl_set *set1,
6894                 __isl_take isl_set *set2);
6895         #include <isl/map.h>
6896         __isl_give isl_map *isl_map_sum(
6897                 __isl_take isl_map *map1,
6898                 __isl_take isl_map *map2);
6900 C<isl_set_sum> computes the Minkowski sum of its two arguments,
6901 i.e., the set containing the sums of pairs of elements from
6902 C<set1> and C<set2>.
6903 The domain of the result of C<isl_map_sum> is the intersection
6904 of the domains of its two arguments.  The corresponding range
6905 elements are the sums of the corresponding range elements
6906 in the two arguments.
6908         #include <isl/val.h>
6909         __isl_give isl_multi_val *isl_multi_val_add(
6910                 __isl_take isl_multi_val *mv1,
6911                 __isl_take isl_multi_val *mv2);
6912         __isl_give isl_multi_val *isl_multi_val_sub(
6913                 __isl_take isl_multi_val *mv1,
6914                 __isl_take isl_multi_val *mv2);
6916         #include <isl/aff.h>
6917         __isl_give isl_aff *isl_aff_add(
6918                 __isl_take isl_aff *aff1,
6919                 __isl_take isl_aff *aff2);
6920         __isl_give isl_multi_aff *isl_multi_aff_add(
6921                 __isl_take isl_multi_aff *maff1,
6922                 __isl_take isl_multi_aff *maff2);
6923         __isl_give isl_pw_aff *isl_pw_aff_add(
6924                 __isl_take isl_pw_aff *pwaff1,
6925                 __isl_take isl_pw_aff *pwaff2);
6926         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add(
6927                 __isl_take isl_multi_pw_aff *mpa1,
6928                 __isl_take isl_multi_pw_aff *mpa2);
6929         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
6930                 __isl_take isl_pw_multi_aff *pma1,
6931                 __isl_take isl_pw_multi_aff *pma2);
6932         __isl_give isl_union_pw_aff *isl_union_pw_aff_add(
6933                 __isl_take isl_union_pw_aff *upa1,
6934                 __isl_take isl_union_pw_aff *upa2);
6935         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
6936                 __isl_take isl_union_pw_multi_aff *upma1,
6937                 __isl_take isl_union_pw_multi_aff *upma2);
6938         __isl_give isl_multi_union_pw_aff *
6939         isl_multi_union_pw_aff_add(
6940                 __isl_take isl_multi_union_pw_aff *mupa1,
6941                 __isl_take isl_multi_union_pw_aff *mupa2);
6942         __isl_give isl_pw_aff *isl_pw_aff_min(
6943                 __isl_take isl_pw_aff *pwaff1,
6944                 __isl_take isl_pw_aff *pwaff2);
6945         __isl_give isl_pw_aff *isl_pw_aff_max(
6946                 __isl_take isl_pw_aff *pwaff1,
6947                 __isl_take isl_pw_aff *pwaff2);
6948         __isl_give isl_aff *isl_aff_sub(
6949                 __isl_take isl_aff *aff1,
6950                 __isl_take isl_aff *aff2);
6951         __isl_give isl_multi_aff *isl_multi_aff_sub(
6952                 __isl_take isl_multi_aff *ma1,
6953                 __isl_take isl_multi_aff *ma2);
6954         __isl_give isl_pw_aff *isl_pw_aff_sub(
6955                 __isl_take isl_pw_aff *pwaff1,
6956                 __isl_take isl_pw_aff *pwaff2);
6957         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_sub(
6958                 __isl_take isl_multi_pw_aff *mpa1,
6959                 __isl_take isl_multi_pw_aff *mpa2);
6960         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
6961                 __isl_take isl_pw_multi_aff *pma1,
6962                 __isl_take isl_pw_multi_aff *pma2);
6963         __isl_give isl_union_pw_aff *isl_union_pw_aff_sub(
6964                 __isl_take isl_union_pw_aff *upa1,
6965                 __isl_take isl_union_pw_aff *upa2);
6966         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
6967                 __isl_take isl_union_pw_multi_aff *upma1,
6968                 __isl_take isl_union_pw_multi_aff *upma2);
6969         __isl_give isl_multi_union_pw_aff *
6970         isl_multi_union_pw_aff_sub(
6971                 __isl_take isl_multi_union_pw_aff *mupa1,
6972                 __isl_take isl_multi_union_pw_aff *mupa2);
6974 C<isl_aff_sub> subtracts the second argument from the first.
6976         #include <isl/polynomial.h>
6977         __isl_give isl_qpolynomial *isl_qpolynomial_add(
6978                 __isl_take isl_qpolynomial *qp1,
6979                 __isl_take isl_qpolynomial *qp2);
6980         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
6981                 __isl_take isl_pw_qpolynomial *pwqp1,
6982                 __isl_take isl_pw_qpolynomial *pwqp2);
6983         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
6984                 __isl_take isl_pw_qpolynomial *pwqp1,
6985                 __isl_take isl_pw_qpolynomial *pwqp2);
6986         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
6987                 __isl_take isl_pw_qpolynomial_fold *pwf1,
6988                 __isl_take isl_pw_qpolynomial_fold *pwf2);
6989         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
6990                 __isl_take isl_union_pw_qpolynomial *upwqp1,
6991                 __isl_take isl_union_pw_qpolynomial *upwqp2);
6992         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
6993                 __isl_take isl_qpolynomial *qp1,
6994                 __isl_take isl_qpolynomial *qp2);
6995         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
6996                 __isl_take isl_pw_qpolynomial *pwqp1,
6997                 __isl_take isl_pw_qpolynomial *pwqp2);
6998         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
6999                 __isl_take isl_union_pw_qpolynomial *upwqp1,
7000                 __isl_take isl_union_pw_qpolynomial *upwqp2);
7001         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
7002                 __isl_take isl_pw_qpolynomial_fold *pwf1,
7003                 __isl_take isl_pw_qpolynomial_fold *pwf2);
7004         __isl_give isl_union_pw_qpolynomial_fold *
7005         isl_union_pw_qpolynomial_fold_fold(
7006                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
7007                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
7009         #include <isl/aff.h>
7010         __isl_give isl_pw_aff *isl_pw_aff_union_add(
7011                 __isl_take isl_pw_aff *pwaff1,
7012                 __isl_take isl_pw_aff *pwaff2);
7013         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
7014                 __isl_take isl_pw_multi_aff *pma1,
7015                 __isl_take isl_pw_multi_aff *pma2);
7016         __isl_give isl_union_pw_aff *isl_union_pw_aff_union_add(
7017                 __isl_take isl_union_pw_aff *upa1,
7018                 __isl_take isl_union_pw_aff *upa2);
7019         __isl_give isl_union_pw_multi_aff *
7020         isl_union_pw_multi_aff_union_add(
7021                 __isl_take isl_union_pw_multi_aff *upma1,
7022                 __isl_take isl_union_pw_multi_aff *upma2);
7023         __isl_give isl_multi_union_pw_aff *
7024         isl_multi_union_pw_aff_union_add(
7025                 __isl_take isl_multi_union_pw_aff *mupa1,
7026                 __isl_take isl_multi_union_pw_aff *mupa2);
7027         __isl_give isl_pw_aff *isl_pw_aff_union_min(
7028                 __isl_take isl_pw_aff *pwaff1,
7029                 __isl_take isl_pw_aff *pwaff2);
7030         __isl_give isl_pw_aff *isl_pw_aff_union_max(
7031                 __isl_take isl_pw_aff *pwaff1,
7032                 __isl_take isl_pw_aff *pwaff2);
7034 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
7035 expression with a domain that is the union of those of C<pwaff1> and
7036 C<pwaff2> and such that on each cell, the quasi-affine expression is
7037 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
7038 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
7039 associated expression is the defined one.
7040 This in contrast to the C<isl_pw_aff_max> function, which is
7041 only defined on the shared definition domain of the arguments.
7043         #include <isl/val.h>
7044         __isl_give isl_multi_val *isl_multi_val_add_val(
7045                 __isl_take isl_multi_val *mv,
7046                 __isl_take isl_val *v);
7047         __isl_give isl_multi_val *isl_multi_val_mod_val(
7048                 __isl_take isl_multi_val *mv,
7049                 __isl_take isl_val *v);
7050         __isl_give isl_multi_val *isl_multi_val_scale_val(
7051                 __isl_take isl_multi_val *mv,
7052                 __isl_take isl_val *v);
7053         __isl_give isl_multi_val *isl_multi_val_scale_down_val(
7054                 __isl_take isl_multi_val *mv,
7055                 __isl_take isl_val *v);
7057         #include <isl/aff.h>
7058         __isl_give isl_aff *isl_aff_mod_val(__isl_take isl_aff *aff,
7059                 __isl_take isl_val *mod);
7060         __isl_give isl_pw_aff *isl_pw_aff_mod_val(
7061                 __isl_take isl_pw_aff *pa,
7062                 __isl_take isl_val *mod);
7063         __isl_give isl_union_pw_aff *isl_union_pw_aff_mod_val(
7064                 __isl_take isl_union_pw_aff *upa,
7065                 __isl_take isl_val *f);
7066         __isl_give isl_aff *isl_aff_scale_val(__isl_take isl_aff *aff,
7067                 __isl_take isl_val *v);
7068         __isl_give isl_multi_aff *isl_multi_aff_scale_val(
7069                 __isl_take isl_multi_aff *ma,
7070                 __isl_take isl_val *v);
7071         __isl_give isl_pw_aff *isl_pw_aff_scale_val(
7072                 __isl_take isl_pw_aff *pa, __isl_take isl_val *v);
7073         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_val(
7074                 __isl_take isl_multi_pw_aff *mpa,
7075                 __isl_take isl_val *v);
7076         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_val(
7077                 __isl_take isl_pw_multi_aff *pma,
7078                 __isl_take isl_val *v);
7079         __isl_give isl_union_pw_multi_aff *
7080         __isl_give isl_union_pw_aff *isl_union_pw_aff_scale_val(
7081                 __isl_take isl_union_pw_aff *upa,
7082                 __isl_take isl_val *f);
7083         isl_union_pw_multi_aff_scale_val(
7084                 __isl_take isl_union_pw_multi_aff *upma,
7085                 __isl_take isl_val *val);
7086         __isl_give isl_multi_union_pw_aff *
7087         isl_multi_union_pw_aff_scale_val(
7088                 __isl_take isl_multi_union_pw_aff *mupa,
7089                 __isl_take isl_val *v);
7090         __isl_give isl_aff *isl_aff_scale_down_ui(
7091                 __isl_take isl_aff *aff, unsigned f);
7092         __isl_give isl_aff *isl_aff_scale_down_val(
7093                 __isl_take isl_aff *aff, __isl_take isl_val *v);
7094         __isl_give isl_multi_aff *isl_multi_aff_scale_down_val(
7095                 __isl_take isl_multi_aff *ma,
7096                 __isl_take isl_val *v);
7097         __isl_give isl_pw_aff *isl_pw_aff_scale_down_val(
7098                 __isl_take isl_pw_aff *pa,
7099                 __isl_take isl_val *f);
7100         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_down_val(
7101                 __isl_take isl_multi_pw_aff *mpa,
7102                 __isl_take isl_val *v);
7103         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_down_val(
7104                 __isl_take isl_pw_multi_aff *pma,
7105                 __isl_take isl_val *v);
7106         __isl_give isl_union_pw_aff *isl_union_pw_aff_scale_down_val(
7107                 __isl_take isl_union_pw_aff *upa,
7108                 __isl_take isl_val *v);
7109         __isl_give isl_union_pw_multi_aff *
7110         isl_union_pw_multi_aff_scale_down_val(
7111                 __isl_take isl_union_pw_multi_aff *upma,
7112                 __isl_take isl_val *val);
7113         __isl_give isl_multi_union_pw_aff *
7114         isl_multi_union_pw_aff_scale_down_val(
7115                 __isl_take isl_multi_union_pw_aff *mupa,
7116                 __isl_take isl_val *v);
7118         #include <isl/polynomial.h>
7119         __isl_give isl_qpolynomial *isl_qpolynomial_scale_val(
7120                 __isl_take isl_qpolynomial *qp,
7121                 __isl_take isl_val *v);
7122         __isl_give isl_qpolynomial_fold *
7123         isl_qpolynomial_fold_scale_val(
7124                 __isl_take isl_qpolynomial_fold *fold,
7125                 __isl_take isl_val *v);
7126         __isl_give isl_pw_qpolynomial *
7127         isl_pw_qpolynomial_scale_val(
7128                 __isl_take isl_pw_qpolynomial *pwqp,
7129                 __isl_take isl_val *v);
7130         __isl_give isl_pw_qpolynomial_fold *
7131         isl_pw_qpolynomial_fold_scale_val(
7132                 __isl_take isl_pw_qpolynomial_fold *pwf,
7133                 __isl_take isl_val *v);
7134         __isl_give isl_union_pw_qpolynomial *
7135         isl_union_pw_qpolynomial_scale_val(
7136                 __isl_take isl_union_pw_qpolynomial *upwqp,
7137                 __isl_take isl_val *v);
7138         __isl_give isl_union_pw_qpolynomial_fold *
7139         isl_union_pw_qpolynomial_fold_scale_val(
7140                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
7141                 __isl_take isl_val *v);
7142         __isl_give isl_qpolynomial *
7143         isl_qpolynomial_scale_down_val(
7144                 __isl_take isl_qpolynomial *qp,
7145                 __isl_take isl_val *v);
7146         __isl_give isl_qpolynomial_fold *
7147         isl_qpolynomial_fold_scale_down_val(
7148                 __isl_take isl_qpolynomial_fold *fold,
7149                 __isl_take isl_val *v);
7150         __isl_give isl_pw_qpolynomial *
7151         isl_pw_qpolynomial_scale_down_val(
7152                 __isl_take isl_pw_qpolynomial *pwqp,
7153                 __isl_take isl_val *v);
7154         __isl_give isl_pw_qpolynomial_fold *
7155         isl_pw_qpolynomial_fold_scale_down_val(
7156                 __isl_take isl_pw_qpolynomial_fold *pwf,
7157                 __isl_take isl_val *v);
7158         __isl_give isl_union_pw_qpolynomial *
7159         isl_union_pw_qpolynomial_scale_down_val(
7160                 __isl_take isl_union_pw_qpolynomial *upwqp,
7161                 __isl_take isl_val *v);
7162         __isl_give isl_union_pw_qpolynomial_fold *
7163         isl_union_pw_qpolynomial_fold_scale_down_val(
7164                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
7165                 __isl_take isl_val *v);
7167         #include <isl/val.h>
7168         __isl_give isl_multi_val *isl_multi_val_mod_multi_val(
7169                 __isl_take isl_multi_val *mv1,
7170                 __isl_take isl_multi_val *mv2);
7171         __isl_give isl_multi_val *isl_multi_val_scale_multi_val(
7172                 __isl_take isl_multi_val *mv1,
7173                 __isl_take isl_multi_val *mv2);
7174         __isl_give isl_multi_val *
7175         isl_multi_val_scale_down_multi_val(
7176                 __isl_take isl_multi_val *mv1,
7177                 __isl_take isl_multi_val *mv2);
7179         #include <isl/aff.h>
7180         __isl_give isl_multi_aff *isl_multi_aff_mod_multi_val(
7181                 __isl_take isl_multi_aff *ma,
7182                 __isl_take isl_multi_val *mv);
7183         __isl_give isl_multi_union_pw_aff *
7184         isl_multi_union_pw_aff_mod_multi_val(
7185                 __isl_take isl_multi_union_pw_aff *upma,
7186                 __isl_take isl_multi_val *mv);
7187         __isl_give isl_multi_pw_aff *
7188         isl_multi_pw_aff_mod_multi_val(
7189                 __isl_take isl_multi_pw_aff *mpa,
7190                 __isl_take isl_multi_val *mv);
7191         __isl_give isl_multi_aff *isl_multi_aff_scale_multi_val(
7192                 __isl_take isl_multi_aff *ma,
7193                 __isl_take isl_multi_val *mv);
7194         __isl_give isl_pw_multi_aff *
7195         isl_pw_multi_aff_scale_multi_val(
7196                 __isl_take isl_pw_multi_aff *pma,
7197                 __isl_take isl_multi_val *mv);
7198         __isl_give isl_multi_pw_aff *
7199         isl_multi_pw_aff_scale_multi_val(
7200                 __isl_take isl_multi_pw_aff *mpa,
7201                 __isl_take isl_multi_val *mv);
7202         __isl_give isl_multi_union_pw_aff *
7203         isl_multi_union_pw_aff_scale_multi_val(
7204                 __isl_take isl_multi_union_pw_aff *mupa,
7205                 __isl_take isl_multi_val *mv);
7206         __isl_give isl_union_pw_multi_aff *
7207         isl_union_pw_multi_aff_scale_multi_val(
7208                 __isl_take isl_union_pw_multi_aff *upma,
7209                 __isl_take isl_multi_val *mv);
7210         __isl_give isl_multi_aff *
7211         isl_multi_aff_scale_down_multi_val(
7212                 __isl_take isl_multi_aff *ma,
7213                 __isl_take isl_multi_val *mv);
7214         __isl_give isl_multi_pw_aff *
7215         isl_multi_pw_aff_scale_down_multi_val(
7216                 __isl_take isl_multi_pw_aff *mpa,
7217                 __isl_take isl_multi_val *mv);
7218         __isl_give isl_multi_union_pw_aff *
7219         isl_multi_union_pw_aff_scale_down_multi_val(
7220                 __isl_take isl_multi_union_pw_aff *mupa,
7221                 __isl_take isl_multi_val *mv);
7223 C<isl_multi_aff_scale_multi_val> scales the elements of C<ma>
7224 by the corresponding elements of C<mv>.
7226         #include <isl/aff.h>
7227         __isl_give isl_aff *isl_aff_mul(
7228                 __isl_take isl_aff *aff1,
7229                 __isl_take isl_aff *aff2);
7230         __isl_give isl_aff *isl_aff_div(
7231                 __isl_take isl_aff *aff1,
7232                 __isl_take isl_aff *aff2);
7233         __isl_give isl_pw_aff *isl_pw_aff_mul(
7234                 __isl_take isl_pw_aff *pwaff1,
7235                 __isl_take isl_pw_aff *pwaff2);
7236         __isl_give isl_pw_aff *isl_pw_aff_div(
7237                 __isl_take isl_pw_aff *pa1,
7238                 __isl_take isl_pw_aff *pa2);
7239         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
7240                 __isl_take isl_pw_aff *pa1,
7241                 __isl_take isl_pw_aff *pa2);
7242         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
7243                 __isl_take isl_pw_aff *pa1,
7244                 __isl_take isl_pw_aff *pa2);
7246 When multiplying two affine expressions, at least one of the two needs
7247 to be a constant.  Similarly, when dividing an affine expression by another,
7248 the second expression needs to be a constant.
7249 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
7250 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
7251 remainder.
7253         #include <isl/polynomial.h>
7254         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
7255                 __isl_take isl_qpolynomial *qp1,
7256                 __isl_take isl_qpolynomial *qp2);
7257         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
7258                 __isl_take isl_pw_qpolynomial *pwqp1,
7259                 __isl_take isl_pw_qpolynomial *pwqp2);
7260         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
7261                 __isl_take isl_union_pw_qpolynomial *upwqp1,
7262                 __isl_take isl_union_pw_qpolynomial *upwqp2);
7264 =back
7266 =head3 Lexicographic Optimization
7268 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
7269 the following functions
7270 compute a set that contains the lexicographic minimum or maximum
7271 of the elements in C<set> (or C<bset>) for those values of the parameters
7272 that satisfy C<dom>.
7273 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
7274 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
7275 has no elements.
7276 In other words, the union of the parameter values
7277 for which the result is non-empty and of C<*empty>
7278 is equal to C<dom>.
7280         #include <isl/set.h>
7281         __isl_give isl_set *isl_basic_set_partial_lexmin(
7282                 __isl_take isl_basic_set *bset,
7283                 __isl_take isl_basic_set *dom,
7284                 __isl_give isl_set **empty);
7285         __isl_give isl_set *isl_basic_set_partial_lexmax(
7286                 __isl_take isl_basic_set *bset,
7287                 __isl_take isl_basic_set *dom,
7288                 __isl_give isl_set **empty);
7289         __isl_give isl_set *isl_set_partial_lexmin(
7290                 __isl_take isl_set *set, __isl_take isl_set *dom,
7291                 __isl_give isl_set **empty);
7292         __isl_give isl_set *isl_set_partial_lexmax(
7293                 __isl_take isl_set *set, __isl_take isl_set *dom,
7294                 __isl_give isl_set **empty);
7296 Given a (basic) set C<set> (or C<bset>), the following functions simply
7297 return a set containing the lexicographic minimum or maximum
7298 of the elements in C<set> (or C<bset>).
7299 In case of union sets, the optimum is computed per space.
7301         #include <isl/set.h>
7302         __isl_give isl_set *isl_basic_set_lexmin(
7303                 __isl_take isl_basic_set *bset);
7304         __isl_give isl_set *isl_basic_set_lexmax(
7305                 __isl_take isl_basic_set *bset);
7306         __isl_give isl_set *isl_set_lexmin(
7307                 __isl_take isl_set *set);
7308         __isl_give isl_set *isl_set_lexmax(
7309                 __isl_take isl_set *set);
7310         __isl_give isl_union_set *isl_union_set_lexmin(
7311                 __isl_take isl_union_set *uset);
7312         __isl_give isl_union_set *isl_union_set_lexmax(
7313                 __isl_take isl_union_set *uset);
7315 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
7316 the following functions
7317 compute a relation that maps each element of C<dom>
7318 to the single lexicographic minimum or maximum
7319 of the elements that are associated to that same
7320 element in C<map> (or C<bmap>).
7321 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
7322 that contains the elements in C<dom> that do not map
7323 to any elements in C<map> (or C<bmap>).
7324 In other words, the union of the domain of the result and of C<*empty>
7325 is equal to C<dom>.
7327         #include <isl/map.h>
7328         __isl_give isl_map *isl_basic_map_partial_lexmax(
7329                 __isl_take isl_basic_map *bmap,
7330                 __isl_take isl_basic_set *dom,
7331                 __isl_give isl_set **empty);
7332         __isl_give isl_map *isl_basic_map_partial_lexmin(
7333                 __isl_take isl_basic_map *bmap,
7334                 __isl_take isl_basic_set *dom,
7335                 __isl_give isl_set **empty);
7336         __isl_give isl_map *isl_map_partial_lexmax(
7337                 __isl_take isl_map *map, __isl_take isl_set *dom,
7338                 __isl_give isl_set **empty);
7339         __isl_give isl_map *isl_map_partial_lexmin(
7340                 __isl_take isl_map *map, __isl_take isl_set *dom,
7341                 __isl_give isl_set **empty);
7343 Given a (basic) map C<map> (or C<bmap>), the following functions simply
7344 return a map mapping each element in the domain of
7345 C<map> (or C<bmap>) to the lexicographic minimum or maximum
7346 of all elements associated to that element.
7347 In case of union relations, the optimum is computed per space.
7349         #include <isl/map.h>
7350         __isl_give isl_map *isl_basic_map_lexmin(
7351                 __isl_take isl_basic_map *bmap);
7352         __isl_give isl_map *isl_basic_map_lexmax(
7353                 __isl_take isl_basic_map *bmap);
7354         __isl_give isl_map *isl_map_lexmin(
7355                 __isl_take isl_map *map);
7356         __isl_give isl_map *isl_map_lexmax(
7357                 __isl_take isl_map *map);
7358         __isl_give isl_union_map *isl_union_map_lexmin(
7359                 __isl_take isl_union_map *umap);
7360         __isl_give isl_union_map *isl_union_map_lexmax(
7361                 __isl_take isl_union_map *umap);
7363 The following functions return their result in the form of
7364 a piecewise multi-affine expression,
7365 but are otherwise equivalent to the corresponding functions
7366 returning a basic set or relation.
7368         #include <isl/set.h>
7369         __isl_give isl_pw_multi_aff *
7370         isl_basic_set_partial_lexmin_pw_multi_aff(
7371                 __isl_take isl_basic_set *bset,
7372                 __isl_take isl_basic_set *dom,
7373                 __isl_give isl_set **empty);
7374         __isl_give isl_pw_multi_aff *
7375         isl_basic_set_partial_lexmax_pw_multi_aff(
7376                 __isl_take isl_basic_set *bset,
7377                 __isl_take isl_basic_set *dom,
7378                 __isl_give isl_set **empty);
7379         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
7380                 __isl_take isl_set *set);
7381         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
7382                 __isl_take isl_set *set);
7384         #include <isl/map.h>
7385         __isl_give isl_pw_multi_aff *
7386         isl_basic_map_lexmin_pw_multi_aff(
7387                 __isl_take isl_basic_map *bmap);
7388         __isl_give isl_pw_multi_aff *
7389         isl_basic_map_partial_lexmin_pw_multi_aff(
7390                 __isl_take isl_basic_map *bmap,
7391                 __isl_take isl_basic_set *dom,
7392                 __isl_give isl_set **empty);
7393         __isl_give isl_pw_multi_aff *
7394         isl_basic_map_partial_lexmax_pw_multi_aff(
7395                 __isl_take isl_basic_map *bmap,
7396                 __isl_take isl_basic_set *dom,
7397                 __isl_give isl_set **empty);
7398         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
7399                 __isl_take isl_map *map);
7400         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
7401                 __isl_take isl_map *map);
7403 The following functions return the lexicographic minimum or maximum
7404 on the shared domain of the inputs and the single defined function
7405 on those parts of the domain where only a single function is defined.
7407         #include <isl/aff.h>
7408         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
7409                 __isl_take isl_pw_multi_aff *pma1,
7410                 __isl_take isl_pw_multi_aff *pma2);
7411         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
7412                 __isl_take isl_pw_multi_aff *pma1,
7413                 __isl_take isl_pw_multi_aff *pma2);
7415 If the input to a lexicographic optimization problem has
7416 multiple constraints with the same coefficients for the optimized
7417 variables, then, by default, this symmetry is exploited by
7418 replacing those constraints by a single constraint with
7419 an abstract bound, which is in turn bounded by the corresponding terms
7420 in the original constraints.
7421 Without this optimization, the solver would typically consider
7422 all possible orderings of those original bounds, resulting in a needless
7423 decomposition of the domain.
7424 However, the optimization can also result in slowdowns since
7425 an extra parameter is introduced that may get used in additional
7426 integer divisions.
7427 The following option determines whether symmetry detection is applied
7428 during lexicographic optimization.
7430         #include <isl/options.h>
7431         isl_stat isl_options_set_pip_symmetry(isl_ctx *ctx,
7432                 int val);
7433         int isl_options_get_pip_symmetry(isl_ctx *ctx);
7435 =begin latex
7437 See also \autoref{s:offline}.
7439 =end latex
7441 =head2 Ternary Operations
7443         #include <isl/aff.h>
7444         __isl_give isl_pw_aff *isl_pw_aff_cond(
7445                 __isl_take isl_pw_aff *cond,
7446                 __isl_take isl_pw_aff *pwaff_true,
7447                 __isl_take isl_pw_aff *pwaff_false);
7449 The function C<isl_pw_aff_cond> performs a conditional operator
7450 and returns an expression that is equal to C<pwaff_true>
7451 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
7452 where C<cond> is zero.
7454 =head2 Lists
7456 Lists are defined over several element types, including
7457 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_union_pw_aff>,
7458 C<isl_union_pw_multi_aff>, C<isl_constraint>,
7459 C<isl_basic_set>, C<isl_set>, C<isl_basic_map>, C<isl_map>, C<isl_union_set>,
7460 C<isl_union_map>, C<isl_ast_expr> and C<isl_ast_node>.
7461 Here we take lists of C<isl_set>s as an example.
7462 Lists can be created, copied, modified and freed using the following functions.
7464         #include <isl/set.h>
7465         __isl_give isl_set_list *isl_set_list_from_set(
7466                 __isl_take isl_set *el);
7467         __isl_give isl_set_list *isl_set_list_alloc(
7468                 isl_ctx *ctx, int n);
7469         __isl_give isl_set_list *isl_set_list_copy(
7470                 __isl_keep isl_set_list *list);
7471         __isl_give isl_set_list *isl_set_list_insert(
7472                 __isl_take isl_set_list *list, unsigned pos,
7473                 __isl_take isl_set *el);
7474         __isl_give isl_set_list *isl_set_list_add(
7475                 __isl_take isl_set_list *list,
7476                 __isl_take isl_set *el);
7477         __isl_give isl_set_list *isl_set_list_drop(
7478                 __isl_take isl_set_list *list,
7479                 unsigned first, unsigned n);
7480         __isl_give isl_set_list *isl_set_list_set_set(
7481                 __isl_take isl_set_list *list, int index,
7482                 __isl_take isl_set *set);
7483         __isl_give isl_set_list *isl_set_list_concat(
7484                 __isl_take isl_set_list *list1,
7485                 __isl_take isl_set_list *list2);
7486         __isl_give isl_set_list *isl_set_list_map(
7487                 __isl_take isl_set_list *list,
7488                 __isl_give isl_set *(*fn)(__isl_take isl_set *el,
7489                         void *user),
7490                 void *user);
7491         __isl_give isl_set_list *isl_set_list_sort(
7492                 __isl_take isl_set_list *list,
7493                 int (*cmp)(__isl_keep isl_set *a,
7494                         __isl_keep isl_set *b, void *user),
7495                 void *user);
7496         __isl_null isl_set_list *isl_set_list_free(
7497                 __isl_take isl_set_list *list);
7499 C<isl_set_list_alloc> creates an empty list with an initial capacity
7500 for C<n> elements.  C<isl_set_list_insert> and C<isl_set_list_add>
7501 add elements to a list, increasing its capacity as needed.
7502 C<isl_set_list_from_set> creates a list with a single element.
7504 Lists can be inspected using the following functions.
7506         #include <isl/set.h>
7507         int isl_set_list_n_set(__isl_keep isl_set_list *list);
7508         __isl_give isl_set *isl_set_list_get_set(
7509                 __isl_keep isl_set_list *list, int index);
7510         isl_stat isl_set_list_foreach(__isl_keep isl_set_list *list,
7511                 isl_stat (*fn)(__isl_take isl_set *el, void *user),
7512                 void *user);
7513         isl_stat isl_set_list_foreach_scc(
7514                 __isl_keep isl_set_list *list,
7515                 isl_bool (*follows)(__isl_keep isl_set *a,
7516                         __isl_keep isl_set *b, void *user),
7517                 void *follows_user,
7518                 isl_stat (*fn)(__isl_take isl_set *el, void *user),
7519                 void *fn_user);
7521 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
7522 strongly connected components of the graph with as vertices the elements
7523 of C<list> and a directed edge from vertex C<b> to vertex C<a>
7524 iff C<follows(a, b)> returns C<isl_bool_true>.  The callbacks C<follows> and
7525 C<fn> should return C<isl_bool_error> or C<isl_stat_error> on error.
7527 Lists can be printed using
7529         #include <isl/set.h>
7530         __isl_give isl_printer *isl_printer_print_set_list(
7531                 __isl_take isl_printer *p,
7532                 __isl_keep isl_set_list *list);
7534 =head2 Associative arrays
7536 Associative arrays map isl objects of a specific type to isl objects
7537 of some (other) specific type.  They are defined for several pairs
7538 of types, including (C<isl_map>, C<isl_basic_set>),
7539 (C<isl_id>, C<isl_ast_expr>),
7540 (C<isl_id>, C<isl_id>) and
7541 (C<isl_id>, C<isl_pw_aff>).
7542 Here, we take associative arrays that map C<isl_id>s to C<isl_ast_expr>s
7543 as an example.
7545 Associative arrays can be created, copied and freed using
7546 the following functions.
7548         #include <isl/id_to_ast_expr.h>
7549         __isl_give isl_id_to_ast_expr *isl_id_to_ast_expr_alloc(
7550                 isl_ctx *ctx, int min_size);
7551         __isl_give isl_id_to_ast_expr *isl_id_to_ast_expr_copy(
7552                 __isl_keep isl_id_to_ast_expr *id2expr);
7553         __isl_null isl_id_to_ast_expr *isl_id_to_ast_expr_free(
7554                 __isl_take isl_id_to_ast_expr *id2expr);
7556 The C<min_size> argument to C<isl_id_to_ast_expr_alloc> can be used
7557 to specify the expected size of the associative array.
7558 The associative array will be grown automatically as needed.
7560 Associative arrays can be inspected using the following functions.
7562         #include <isl/id_to_ast_expr.h>
7563         __isl_give isl_maybe_isl_ast_expr
7564         isl_id_to_ast_expr_try_get(
7565                 __isl_keep isl_id_to_ast_expr *id2expr,
7566                 __isl_keep isl_id *key);
7567         isl_bool isl_id_to_ast_expr_has(
7568                 __isl_keep isl_id_to_ast_expr *id2expr,
7569                 __isl_keep isl_id *key);
7570         __isl_give isl_ast_expr *isl_id_to_ast_expr_get(
7571                 __isl_keep isl_id_to_ast_expr *id2expr,
7572                 __isl_take isl_id *key);
7573         isl_stat isl_id_to_ast_expr_foreach(
7574                 __isl_keep isl_id_to_ast_expr *id2expr,
7575                 isl_stat (*fn)(__isl_take isl_id *key,
7576                         __isl_take isl_ast_expr *val, void *user),
7577                 void *user);
7579 The function C<isl_id_to_ast_expr_try_get> returns a structure
7580 containing two elements, C<valid> and C<value>.
7581 If there is a value associated to the key, then C<valid>
7582 is set to C<isl_bool_true> and C<value> contains a copy of
7583 the associated value.  Otherwise C<value> is C<NULL> and
7584 C<valid> may be C<isl_bool_error> or C<isl_bool_false> depending
7585 on whether some error has occurred or there simply is no associated value.
7586 The function C<isl_id_to_ast_expr_has> returns the C<valid> field
7587 in the structure and
7588 the function C<isl_id_to_ast_expr_get> returns the C<value> field.
7590 Associative arrays can be modified using the following functions.
7592         #include <isl/id_to_ast_expr.h>
7593         __isl_give isl_id_to_ast_expr *isl_id_to_ast_expr_set(
7594                 __isl_take isl_id_to_ast_expr *id2expr,
7595                 __isl_take isl_id *key,
7596                 __isl_take isl_ast_expr *val);
7597         __isl_give isl_id_to_ast_expr *isl_id_to_ast_expr_drop(
7598                 __isl_take isl_id_to_ast_expr *id2expr,
7599                 __isl_take isl_id *key);
7601 Associative arrays can be printed using the following function.
7603         #include <isl/id_to_ast_expr.h>
7604         __isl_give isl_printer *isl_printer_print_id_to_ast_expr(
7605                 __isl_take isl_printer *p,
7606                 __isl_keep isl_id_to_ast_expr *id2expr);
7608 =head2 Vectors
7610 Vectors can be created, copied and freed using the following functions.
7612         #include <isl/vec.h>
7613         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
7614                 unsigned size);
7615         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
7616         __isl_null isl_vec *isl_vec_free(__isl_take isl_vec *vec);
7618 Note that the elements of a newly created vector may have arbitrary values.
7619 The elements can be changed and inspected using the following functions.
7621         int isl_vec_size(__isl_keep isl_vec *vec);
7622         __isl_give isl_val *isl_vec_get_element_val(
7623                 __isl_keep isl_vec *vec, int pos);
7624         __isl_give isl_vec *isl_vec_set_element_si(
7625                 __isl_take isl_vec *vec, int pos, int v);
7626         __isl_give isl_vec *isl_vec_set_element_val(
7627                 __isl_take isl_vec *vec, int pos,
7628                 __isl_take isl_val *v);
7629         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
7630                 int v);
7631         __isl_give isl_vec *isl_vec_set_val(
7632                 __isl_take isl_vec *vec, __isl_take isl_val *v);
7633         int isl_vec_cmp_element(__isl_keep isl_vec *vec1,
7634                 __isl_keep isl_vec *vec2, int pos);
7636 C<isl_vec_get_element> will return a negative value if anything went wrong.
7637 In that case, the value of C<*v> is undefined.
7639 The following function can be used to concatenate two vectors.
7641         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
7642                 __isl_take isl_vec *vec2);
7644 =head2 Matrices
7646 Matrices can be created, copied and freed using the following functions.
7648         #include <isl/mat.h>
7649         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
7650                 unsigned n_row, unsigned n_col);
7651         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
7652         __isl_null isl_mat *isl_mat_free(__isl_take isl_mat *mat);
7654 Note that the elements of a newly created matrix may have arbitrary values.
7655 The elements can be changed and inspected using the following functions.
7657         int isl_mat_rows(__isl_keep isl_mat *mat);
7658         int isl_mat_cols(__isl_keep isl_mat *mat);
7659         __isl_give isl_val *isl_mat_get_element_val(
7660                 __isl_keep isl_mat *mat, int row, int col);
7661         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
7662                 int row, int col, int v);
7663         __isl_give isl_mat *isl_mat_set_element_val(
7664                 __isl_take isl_mat *mat, int row, int col,
7665                 __isl_take isl_val *v);
7667 C<isl_mat_get_element> will return a negative value if anything went wrong.
7668 In that case, the value of C<*v> is undefined.
7670 The following function can be used to compute the (right) inverse
7671 of a matrix, i.e., a matrix such that the product of the original
7672 and the inverse (in that order) is a multiple of the identity matrix.
7673 The input matrix is assumed to be of full row-rank.
7675         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
7677 The following function can be used to compute the (right) kernel
7678 (or null space) of a matrix, i.e., a matrix such that the product of
7679 the original and the kernel (in that order) is the zero matrix.
7681         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
7683 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
7685 The following functions determine
7686 an upper or lower bound on a quasipolynomial over its domain.
7688         __isl_give isl_pw_qpolynomial_fold *
7689         isl_pw_qpolynomial_bound(
7690                 __isl_take isl_pw_qpolynomial *pwqp,
7691                 enum isl_fold type, int *tight);
7693         __isl_give isl_union_pw_qpolynomial_fold *
7694         isl_union_pw_qpolynomial_bound(
7695                 __isl_take isl_union_pw_qpolynomial *upwqp,
7696                 enum isl_fold type, int *tight);
7698 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
7699 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
7700 is the returned bound is known be tight, i.e., for each value
7701 of the parameters there is at least
7702 one element in the domain that reaches the bound.
7703 If the domain of C<pwqp> is not wrapping, then the bound is computed
7704 over all elements in that domain and the result has a purely parametric
7705 domain.  If the domain of C<pwqp> is wrapping, then the bound is
7706 computed over the range of the wrapped relation.  The domain of the
7707 wrapped relation becomes the domain of the result.
7709 =head2 Parametric Vertex Enumeration
7711 The parametric vertex enumeration described in this section
7712 is mainly intended to be used internally and by the C<barvinok>
7713 library.
7715         #include <isl/vertices.h>
7716         __isl_give isl_vertices *isl_basic_set_compute_vertices(
7717                 __isl_keep isl_basic_set *bset);
7719 The function C<isl_basic_set_compute_vertices> performs the
7720 actual computation of the parametric vertices and the chamber
7721 decomposition and stores the result in an C<isl_vertices> object.
7722 This information can be queried by either iterating over all
7723 the vertices or iterating over all the chambers or cells
7724 and then iterating over all vertices that are active on the chamber.
7726         isl_stat isl_vertices_foreach_vertex(
7727                 __isl_keep isl_vertices *vertices,
7728                 isl_stat (*fn)(__isl_take isl_vertex *vertex,
7729                         void *user), void *user);
7731         isl_stat isl_vertices_foreach_cell(
7732                 __isl_keep isl_vertices *vertices,
7733                 isl_stat (*fn)(__isl_take isl_cell *cell,
7734                         void *user), void *user);
7735         isl_stat isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
7736                 isl_stat (*fn)(__isl_take isl_vertex *vertex,
7737                         void *user), void *user);
7739 Other operations that can be performed on an C<isl_vertices> object are
7740 the following.
7742         int isl_vertices_get_n_vertices(
7743                 __isl_keep isl_vertices *vertices);
7744         __isl_null isl_vertices *isl_vertices_free(
7745                 __isl_take isl_vertices *vertices);
7747 Vertices can be inspected and destroyed using the following functions.
7749         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
7750         __isl_give isl_basic_set *isl_vertex_get_domain(
7751                 __isl_keep isl_vertex *vertex);
7752         __isl_give isl_multi_aff *isl_vertex_get_expr(
7753                 __isl_keep isl_vertex *vertex);
7754         void isl_vertex_free(__isl_take isl_vertex *vertex);
7756 C<isl_vertex_get_expr> returns a multiple quasi-affine expression
7757 describing the vertex in terms of the parameters,
7758 while C<isl_vertex_get_domain> returns the activity domain
7759 of the vertex.
7761 Chambers can be inspected and destroyed using the following functions.
7763         __isl_give isl_basic_set *isl_cell_get_domain(
7764                 __isl_keep isl_cell *cell);
7765         void isl_cell_free(__isl_take isl_cell *cell);
7767 =head1 Polyhedral Compilation Library
7769 This section collects functionality in C<isl> that has been specifically
7770 designed for use during polyhedral compilation.
7772 =head2 Schedule Trees
7774 A schedule tree is a structured representation of a schedule,
7775 assigning a relative order to a set of domain elements.
7776 The relative order expressed by the schedule tree is
7777 defined recursively.  In particular, the order between
7778 two domain elements is determined by the node that is closest
7779 to the root that refers to both elements and that orders them apart.
7780 Each node in the tree is of one of several types.
7781 The root node is always of type C<isl_schedule_node_domain>
7782 (or C<isl_schedule_node_extension>)
7783 and it describes the (extra) domain elements to which the schedule applies.
7784 The other types of nodes are as follows.
7786 =over
7788 =item C<isl_schedule_node_band>
7790 A band of schedule dimensions.  Each schedule dimension is represented
7791 by a union piecewise quasi-affine expression.  If this expression
7792 assigns a different value to two domain elements, while all previous
7793 schedule dimensions in the same band assign them the same value,
7794 then the two domain elements are ordered according to these two
7795 different values.
7796 Each expression is required to be total in the domain elements
7797 that reach the band node.
7799 =item C<isl_schedule_node_expansion>
7801 An expansion node maps each of the domain elements that reach the node
7802 to one or more domain elements.  The image of this mapping forms
7803 the set of domain elements that reach the child of the expansion node.
7804 The function that maps each of the expanded domain elements
7805 to the original domain element from which it was expanded
7806 is called the contraction.
7808 =item C<isl_schedule_node_filter>
7810 A filter node does not impose any ordering, but rather intersects
7811 the set of domain elements that the current subtree refers to
7812 with a given union set.  The subtree of the filter node only
7813 refers to domain elements in the intersection.
7814 A filter node is typically only used as a child of a sequence or
7815 set node.
7817 =item C<isl_schedule_node_leaf>
7819 A leaf of the schedule tree.  Leaf nodes do not impose any ordering.
7821 =item C<isl_schedule_node_mark>
7823 A mark node can be used to attach any kind of information to a subtree
7824 of the schedule tree.
7826 =item C<isl_schedule_node_sequence>
7828 A sequence node has one or more children, each of which is a filter node.
7829 The filters on these filter nodes form a partition of
7830 the domain elements that the current subtree refers to.
7831 If two domain elements appear in distinct filters then the sequence
7832 node orders them according to the child positions of the corresponding
7833 filter nodes.
7835 =item C<isl_schedule_node_set>
7837 A set node is similar to a sequence node, except that
7838 it expresses that domain elements appearing in distinct filters
7839 may have any order.  The order of the children of a set node
7840 is therefore also immaterial.
7842 =back
7844 The following node types are only supported by the AST generator.
7846 =over
7848 =item C<isl_schedule_node_context>
7850 The context describes constraints on the parameters and
7851 the schedule dimensions of outer
7852 bands that the AST generator may assume to hold.  It is also the only
7853 kind of node that may introduce additional parameters.
7854 The space of the context is that of the flat product of the outer
7855 band nodes.  In particular, if there are no outer band nodes, then
7856 this space is the unnamed zero-dimensional space.
7857 Since a context node references the outer band nodes, any tree
7858 containing a context node is considered to be anchored.
7860 =item C<isl_schedule_node_extension>
7862 An extension node instructs the AST generator to add additional
7863 domain elements that need to be scheduled.
7864 The additional domain elements are described by the range of
7865 the extension map in terms of the outer schedule dimensions,
7866 i.e., the flat product of the outer band nodes.
7867 Note that domain elements are added whenever the AST generator
7868 reaches the extension node, meaning that there are still some
7869 active domain elements for which an AST needs to be generated.
7870 The conditions under which some domain elements are still active
7871 may however not be completely described by the outer AST nodes
7872 generated at that point.
7874 An extension node may also appear as the root of a schedule tree,
7875 when it is intended to be inserted into another tree
7876 using C<isl_schedule_node_graft_before> or C<isl_schedule_node_graft_after>.
7877 In this case, the domain of the extension node should
7878 correspond to the flat product of the outer band nodes
7879 in this other schedule tree at the point where the extension tree
7880 will be inserted.
7882 =item C<isl_schedule_node_guard>
7884 The guard describes constraints on the parameters and
7885 the schedule dimensions of outer
7886 bands that need to be enforced by the outer nodes
7887 in the generated AST.
7888 The space of the guard is that of the flat product of the outer
7889 band nodes.  In particular, if there are no outer band nodes, then
7890 this space is the unnamed zero-dimensional space.
7891 Since a guard node references the outer band nodes, any tree
7892 containing a guard node is considered to be anchored.
7894 =back
7896 Except for the C<isl_schedule_node_context> nodes,
7897 none of the nodes may introduce any parameters that were not
7898 already present in the root domain node.
7900 A schedule tree is encapsulated in an C<isl_schedule> object.
7901 The simplest such objects, those with a tree consisting of single domain node,
7902 can be created using the following functions with either an empty
7903 domain or a given domain.
7905         #include <isl/schedule.h>
7906         __isl_give isl_schedule *isl_schedule_empty(
7907                 __isl_take isl_space *space);
7908         __isl_give isl_schedule *isl_schedule_from_domain(
7909                 __isl_take isl_union_set *domain);
7911 The function C<isl_schedule_constraints_compute_schedule> described
7912 in L</"Scheduling"> can also be used to construct schedules.
7914 C<isl_schedule> objects may be copied and freed using the following functions.
7916         #include <isl/schedule.h>
7917         __isl_give isl_schedule *isl_schedule_copy(
7918                 __isl_keep isl_schedule *sched);
7919         __isl_null isl_schedule *isl_schedule_free(
7920                 __isl_take isl_schedule *sched);
7922 The following functions checks whether two C<isl_schedule> objects
7923 are obviously the same.
7925         #include <isl/schedule.h>
7926         isl_bool isl_schedule_plain_is_equal(
7927                 __isl_keep isl_schedule *schedule1,
7928                 __isl_keep isl_schedule *schedule2);
7930 The domain of the schedule, i.e., the domain described by the root node,
7931 can be obtained using the following function.
7933         #include <isl/schedule.h>
7934         __isl_give isl_union_set *isl_schedule_get_domain(
7935                 __isl_keep isl_schedule *schedule);
7937 An extra top-level band node (right underneath the domain node) can
7938 be introduced into the schedule using the following function.
7939 The schedule tree is assumed not to have any anchored nodes.
7941         #include <isl/schedule.h>
7942         __isl_give isl_schedule *
7943         isl_schedule_insert_partial_schedule(
7944                 __isl_take isl_schedule *schedule,
7945                 __isl_take isl_multi_union_pw_aff *partial);
7947 A top-level context node (right underneath the domain node) can
7948 be introduced into the schedule using the following function.
7950         #include <isl/schedule.h>
7951         __isl_give isl_schedule *isl_schedule_insert_context(
7952                 __isl_take isl_schedule *schedule,
7953                 __isl_take isl_set *context)
7955 A top-level guard node (right underneath the domain node) can
7956 be introduced into the schedule using the following function.
7958         #include <isl/schedule.h>
7959         __isl_give isl_schedule *isl_schedule_insert_guard(
7960                 __isl_take isl_schedule *schedule,
7961                 __isl_take isl_set *guard)
7963 A schedule that combines two schedules either in the given
7964 order or in an arbitrary order, i.e., with an C<isl_schedule_node_sequence>
7965 or an C<isl_schedule_node_set> node,
7966 can be created using the following functions.
7968         #include <isl/schedule.h>
7969         __isl_give isl_schedule *isl_schedule_sequence(
7970                 __isl_take isl_schedule *schedule1,
7971                 __isl_take isl_schedule *schedule2);
7972         __isl_give isl_schedule *isl_schedule_set(
7973                 __isl_take isl_schedule *schedule1,
7974                 __isl_take isl_schedule *schedule2);
7976 The domains of the two input schedules need to be disjoint.
7978 The following function can be used to restrict the domain
7979 of a schedule with a domain node as root to be a subset of the given union set.
7980 This operation may remove nodes in the tree that have become
7981 redundant.
7983         #include <isl/schedule.h>
7984         __isl_give isl_schedule *isl_schedule_intersect_domain(
7985                 __isl_take isl_schedule *schedule,
7986                 __isl_take isl_union_set *domain);
7988 The following function can be used to simplify the domain
7989 of a schedule with a domain node as root with respect to the given
7990 parameter domain.
7992         #include <isl/schedule.h>
7993         __isl_give isl_schedule *isl_schedule_gist_domain_params(
7994                 __isl_take isl_schedule *schedule,
7995                 __isl_take isl_set *context);
7997 The following function resets the user pointers on all parameter
7998 and tuple identifiers referenced by the nodes of the given schedule.
8000         #include <isl/schedule.h>
8001         __isl_give isl_schedule *isl_schedule_reset_user(
8002                 __isl_take isl_schedule *schedule);
8004 The following function aligns the parameters of all nodes
8005 in the given schedule to the given space.
8007         #include <isl/schedule.h>
8008         __isl_give isl_schedule *isl_schedule_align_params(
8009                 __isl_take isl_schedule *schedule,
8010                 __isl_take isl_space *space);
8012 The following function allows the user to plug in a given function
8013 in the iteration domains.  The input schedule is not allowed to contain
8014 any expansion nodes.
8016         #include <isl/schedule.h>
8017         __isl_give isl_schedule *
8018         isl_schedule_pullback_union_pw_multi_aff(
8019                 __isl_take isl_schedule *schedule,
8020                 __isl_take isl_union_pw_multi_aff *upma);
8022 The following function can be used to plug in the schedule C<expansion>
8023 in the leaves of C<schedule>, where C<contraction> describes how
8024 the domain elements of C<expansion> map to the domain elements
8025 at the original leaves of C<schedule>.
8026 The resulting schedule will contain expansion nodes, unless
8027 C<contraction> is an identity function.
8029         #include <isl/schedule.h>
8030         __isl_give isl_schedule *isl_schedule_expand(
8031                 __isl_take isl_schedule *schedule,
8032                 __isl_take isl_union_pw_multi_aff *contraction,
8033                 __isl_take isl_schedule *expansion);
8035 An C<isl_union_map> representation of the schedule can be obtained
8036 from an C<isl_schedule> using the following function.
8038         #include <isl/schedule.h>
8039         __isl_give isl_union_map *isl_schedule_get_map(
8040                 __isl_keep isl_schedule *sched);
8042 The resulting relation encodes the same relative ordering as
8043 the schedule by mapping the domain elements to a common schedule space.
8044 If the schedule_separate_components option is set, then the order
8045 of the children of a set node is explicitly encoded in the result.
8046 If the tree contains any expansion nodes, then the relation
8047 is formulated in terms of the expanded domain elements.
8049 Schedules can be read from input using the following functions.
8051         #include <isl/schedule.h>
8052         __isl_give isl_schedule *isl_schedule_read_from_file(
8053                 isl_ctx *ctx, FILE *input);
8054         __isl_give isl_schedule *isl_schedule_read_from_str(
8055                 isl_ctx *ctx, const char *str);
8057 A representation of the schedule can be printed using
8059         #include <isl/schedule.h>
8060         __isl_give isl_printer *isl_printer_print_schedule(
8061                 __isl_take isl_printer *p,
8062                 __isl_keep isl_schedule *schedule);
8063         __isl_give char *isl_schedule_to_str(
8064                 __isl_keep isl_schedule *schedule);
8066 C<isl_schedule_to_str> prints the schedule in flow format.
8068 The schedule tree can be traversed through the use of
8069 C<isl_schedule_node> objects that point to a particular
8070 position in the schedule tree.  Whenever a C<isl_schedule_node>
8071 is use to modify a node in the schedule tree, the original schedule
8072 tree is left untouched and the modifications are performed to a copy
8073 of the tree.  The returned C<isl_schedule_node> then points to
8074 this modified copy of the tree.
8076 The root of the schedule tree can be obtained using the following function.
8078         #include <isl/schedule.h>
8079         __isl_give isl_schedule_node *isl_schedule_get_root(
8080                 __isl_keep isl_schedule *schedule);
8082 A pointer to a newly created schedule tree with a single domain
8083 node can be created using the following functions.
8085         #include <isl/schedule_node.h>
8086         __isl_give isl_schedule_node *
8087         isl_schedule_node_from_domain(
8088                 __isl_take isl_union_set *domain);
8089         __isl_give isl_schedule_node *
8090         isl_schedule_node_from_extension(
8091                 __isl_take isl_union_map *extension);
8093 C<isl_schedule_node_from_extension> creates a tree with an extension
8094 node as root.
8096 Schedule nodes can be copied and freed using the following functions.
8098         #include <isl/schedule_node.h>
8099         __isl_give isl_schedule_node *isl_schedule_node_copy(
8100                 __isl_keep isl_schedule_node *node);
8101         __isl_null isl_schedule_node *isl_schedule_node_free(
8102                 __isl_take isl_schedule_node *node);
8104 The following functions can be used to check if two schedule
8105 nodes point to the same position in the same schedule.
8107         #include <isl/schedule_node.h>
8108         isl_bool isl_schedule_node_is_equal(
8109                 __isl_keep isl_schedule_node *node1,
8110                 __isl_keep isl_schedule_node *node2);
8112 The following properties can be obtained from a schedule node.
8114         #include <isl/schedule_node.h>
8115         enum isl_schedule_node_type isl_schedule_node_get_type(
8116                 __isl_keep isl_schedule_node *node);
8117         enum isl_schedule_node_type
8118         isl_schedule_node_get_parent_type(
8119                 __isl_keep isl_schedule_node *node);
8120         __isl_give isl_schedule *isl_schedule_node_get_schedule(
8121                 __isl_keep isl_schedule_node *node);
8123 The function C<isl_schedule_node_get_type> returns the type of
8124 the node, while C<isl_schedule_node_get_parent_type> returns
8125 type of the parent of the node, which is required to exist.
8126 The function C<isl_schedule_node_get_schedule> returns a copy
8127 to the schedule to which the node belongs.
8129 The following functions can be used to move the schedule node
8130 to a different position in the tree or to check if such a position
8131 exists.
8133         #include <isl/schedule_node.h>
8134         isl_bool isl_schedule_node_has_parent(
8135                 __isl_keep isl_schedule_node *node);
8136         __isl_give isl_schedule_node *isl_schedule_node_parent(
8137                 __isl_take isl_schedule_node *node);
8138         __isl_give isl_schedule_node *isl_schedule_node_root(
8139                 __isl_take isl_schedule_node *node);
8140         __isl_give isl_schedule_node *isl_schedule_node_ancestor(
8141                 __isl_take isl_schedule_node *node,
8142                 int generation);
8143         int isl_schedule_node_n_children(
8144                 __isl_keep isl_schedule_node *node);
8145         __isl_give isl_schedule_node *isl_schedule_node_child(
8146                 __isl_take isl_schedule_node *node, int pos);
8147         isl_bool isl_schedule_node_has_children(
8148                 __isl_keep isl_schedule_node *node);
8149         __isl_give isl_schedule_node *isl_schedule_node_first_child(
8150                 __isl_take isl_schedule_node *node);
8151         isl_bool isl_schedule_node_has_previous_sibling(
8152                 __isl_keep isl_schedule_node *node);
8153         __isl_give isl_schedule_node *
8154         isl_schedule_node_previous_sibling(
8155                 __isl_take isl_schedule_node *node);
8156         isl_bool isl_schedule_node_has_next_sibling(
8157                 __isl_keep isl_schedule_node *node);
8158         __isl_give isl_schedule_node *
8159         isl_schedule_node_next_sibling(
8160                 __isl_take isl_schedule_node *node);
8162 For C<isl_schedule_node_ancestor>, the ancestor of generation 0
8163 is the node itself, the ancestor of generation 1 is its parent and so on.
8165 It is also possible to query the number of ancestors of a node,
8166 the position of the current node
8167 within the children of its parent, the position of the subtree
8168 containing a node within the children of an ancestor
8169 or to obtain a copy of a given
8170 child without destroying the current node.
8171 Given two nodes that point to the same schedule, their closest
8172 shared ancestor can be obtained using
8173 C<isl_schedule_node_get_shared_ancestor>.
8175         #include <isl/schedule_node.h>
8176         int isl_schedule_node_get_tree_depth(
8177                 __isl_keep isl_schedule_node *node);
8178         int isl_schedule_node_get_child_position(
8179                 __isl_keep isl_schedule_node *node);
8180         int isl_schedule_node_get_ancestor_child_position(
8181                 __isl_keep isl_schedule_node *node,
8182                 __isl_keep isl_schedule_node *ancestor);
8183         __isl_give isl_schedule_node *isl_schedule_node_get_child(
8184                 __isl_keep isl_schedule_node *node, int pos);
8185         __isl_give isl_schedule_node *
8186         isl_schedule_node_get_shared_ancestor(
8187                 __isl_keep isl_schedule_node *node1,
8188                 __isl_keep isl_schedule_node *node2);
8190 All nodes in a schedule tree or
8191 all descendants of a specific node (including the node) can be visited
8192 in depth-first pre-order using the following functions.
8194         #include <isl/schedule.h>
8195         isl_stat isl_schedule_foreach_schedule_node_top_down(
8196                 __isl_keep isl_schedule *sched,
8197                 isl_bool (*fn)(__isl_keep isl_schedule_node *node,
8198                         void *user), void *user);
8200         #include <isl/schedule_node.h>
8201         isl_stat isl_schedule_node_foreach_descendant_top_down(
8202                 __isl_keep isl_schedule_node *node,
8203                 isl_bool (*fn)(__isl_keep isl_schedule_node *node,
8204                         void *user), void *user);
8206 The callback function is slightly different from the usual
8207 callbacks in that it not only indicates success (non-negative result)
8208 or failure (negative result), but also indicates whether the children
8209 of the given node should be visited.  In particular, if the callback
8210 returns a positive value, then the children are visited, but if
8211 the callback returns zero, then the children are not visited.
8213 The ancestors of a node in a schedule tree can be visited from
8214 the root down to and including the parent of the node using
8215 the following function.
8217         #include <isl/schedule_node.h>
8218         isl_stat isl_schedule_node_foreach_ancestor_top_down(
8219                 __isl_keep isl_schedule_node *node,
8220                 isl_stat (*fn)(__isl_keep isl_schedule_node *node,
8221                         void *user), void *user);
8223 The following functions allows for a depth-first post-order
8224 traversal of the nodes in a schedule tree or
8225 of the descendants of a specific node (including the node
8226 itself), where the user callback is allowed to modify the
8227 visited node.
8229         #include <isl/schedule.h>
8230         __isl_give isl_schedule *
8231         isl_schedule_map_schedule_node_bottom_up(
8232                 __isl_take isl_schedule *schedule,
8233                 __isl_give isl_schedule_node *(*fn)(
8234                         __isl_take isl_schedule_node *node,
8235                         void *user), void *user);
8237         #include <isl/schedule_node.h>
8238         __isl_give isl_schedule_node *
8239         isl_schedule_node_map_descendant_bottom_up(
8240                 __isl_take isl_schedule_node *node,
8241                 __isl_give isl_schedule_node *(*fn)(
8242                         __isl_take isl_schedule_node *node,
8243                         void *user), void *user);
8245 The traversal continues from the node returned by the callback function.
8246 It is the responsibility of the user to ensure that this does not
8247 lead to an infinite loop.  It is safest to always return a pointer
8248 to the same position (same ancestors and child positions) as the input node.
8250 The following function removes a node (along with its descendants)
8251 from a schedule tree and returns a pointer to the leaf at the
8252 same position in the updated tree.
8253 It is not allowed to remove the root of a schedule tree or
8254 a child of a set or sequence node.
8256         #include <isl/schedule_node.h>
8257         __isl_give isl_schedule_node *isl_schedule_node_cut(
8258                 __isl_take isl_schedule_node *node);
8260 The following function removes a single node
8261 from a schedule tree and returns a pointer to the child
8262 of the node, now located at the position of the original node
8263 or to a leaf node at that position if there was no child.
8264 It is not allowed to remove the root of a schedule tree,
8265 a set or sequence node, a child of a set or sequence node or
8266 a band node with an anchored subtree.
8268         #include <isl/schedule_node.h>
8269         __isl_give isl_schedule_node *isl_schedule_node_delete(
8270                 __isl_take isl_schedule_node *node);
8272 Most nodes in a schedule tree only contain local information.
8273 In some cases, however, a node may also refer to the schedule dimensions
8274 of its outer band nodes.
8275 This means that the position of the node within the tree should
8276 not be changed, or at least that no changes are performed to the
8277 outer band nodes.  The following function can be used to test
8278 whether the subtree rooted at a given node contains any such nodes.
8280         #include <isl/schedule_node.h>
8281         isl_bool isl_schedule_node_is_subtree_anchored(
8282                 __isl_keep isl_schedule_node *node);
8284 The following function resets the user pointers on all parameter
8285 and tuple identifiers referenced by the given schedule node.
8287         #include <isl/schedule_node.h>
8288         __isl_give isl_schedule_node *isl_schedule_node_reset_user(
8289                 __isl_take isl_schedule_node *node);
8291 The following function aligns the parameters of the given schedule
8292 node to the given space.
8294         #include <isl/schedule_node.h>
8295         __isl_give isl_schedule_node *
8296         isl_schedule_node_align_params(
8297                 __isl_take isl_schedule_node *node,
8298                 __isl_take isl_space *space);
8300 Several node types have their own functions for querying
8301 (and in some cases setting) some node type specific properties.
8303         #include <isl/schedule_node.h>
8304         __isl_give isl_space *isl_schedule_node_band_get_space(
8305                 __isl_keep isl_schedule_node *node);
8306         __isl_give isl_multi_union_pw_aff *
8307         isl_schedule_node_band_get_partial_schedule(
8308                 __isl_keep isl_schedule_node *node);
8309         __isl_give isl_union_map *
8310         isl_schedule_node_band_get_partial_schedule_union_map(
8311                 __isl_keep isl_schedule_node *node);
8312         unsigned isl_schedule_node_band_n_member(
8313                 __isl_keep isl_schedule_node *node);
8314         isl_bool isl_schedule_node_band_member_get_coincident(
8315                 __isl_keep isl_schedule_node *node, int pos);
8316         __isl_give isl_schedule_node *
8317         isl_schedule_node_band_member_set_coincident(
8318                 __isl_take isl_schedule_node *node, int pos,
8319                 int coincident);
8320         isl_bool isl_schedule_node_band_get_permutable(
8321                 __isl_keep isl_schedule_node *node);
8322         __isl_give isl_schedule_node *
8323         isl_schedule_node_band_set_permutable(
8324                 __isl_take isl_schedule_node *node, int permutable);
8325         enum isl_ast_loop_type
8326         isl_schedule_node_band_member_get_ast_loop_type(
8327                 __isl_keep isl_schedule_node *node, int pos);
8328         __isl_give isl_schedule_node *
8329         isl_schedule_node_band_member_set_ast_loop_type(
8330                 __isl_take isl_schedule_node *node, int pos,
8331                 enum isl_ast_loop_type type);
8332         __isl_give isl_union_set *
8333         enum isl_ast_loop_type
8334         isl_schedule_node_band_member_get_isolate_ast_loop_type(
8335                 __isl_keep isl_schedule_node *node, int pos);
8336         __isl_give isl_schedule_node *
8337         isl_schedule_node_band_member_set_isolate_ast_loop_type(
8338                 __isl_take isl_schedule_node *node, int pos,
8339                 enum isl_ast_loop_type type);
8340         isl_schedule_node_band_get_ast_build_options(
8341                 __isl_keep isl_schedule_node *node);
8342         __isl_give isl_schedule_node *
8343         isl_schedule_node_band_set_ast_build_options(
8344                 __isl_take isl_schedule_node *node,
8345                 __isl_take isl_union_set *options);
8346         __isl_give isl_set *
8347         isl_schedule_node_band_get_ast_isolate_option(
8348                 __isl_keep isl_schedule_node *node);
8350 The function C<isl_schedule_node_band_get_space> returns the space
8351 of the partial schedule of the band.
8352 The function C<isl_schedule_node_band_get_partial_schedule_union_map>
8353 returns a representation of the partial schedule of the band node
8354 in the form of an C<isl_union_map>.
8355 The coincident and permutable properties are set by
8356 C<isl_schedule_constraints_compute_schedule> on the schedule tree
8357 it produces.
8358 A scheduling dimension is considered to be ``coincident''
8359 if it satisfies the coincidence constraints within its band.
8360 That is, if the dependence distances of the coincidence
8361 constraints are all zero in that direction (for fixed
8362 iterations of outer bands).
8363 A band is marked permutable if it was produced using the Pluto-like scheduler.
8364 Note that the scheduler may have to resort to a Feautrier style scheduling
8365 step even if the default scheduler is used.
8366 An C<isl_ast_loop_type> is one of C<isl_ast_loop_default>,
8367 C<isl_ast_loop_atomic>, C<isl_ast_loop_unroll> or C<isl_ast_loop_separate>.
8368 For the meaning of these loop AST generation types and the difference
8369 between the regular loop AST generation type and the isolate
8370 loop AST generation type, see L</"AST Generation Options (Schedule Tree)">.
8371 The functions C<isl_schedule_node_band_member_get_ast_loop_type>
8372 and C<isl_schedule_node_band_member_get_isolate_ast_loop_type>
8373 may return C<isl_ast_loop_error> if an error occurs.
8374 The AST build options govern how an AST is generated for
8375 the individual schedule dimensions during AST generation.
8376 See L</"AST Generation Options (Schedule Tree)">.
8377 The isolate option for the given node can be extracted from these
8378 AST build options using the function
8379 C<isl_schedule_node_band_get_ast_isolate_option>.
8381         #include <isl/schedule_node.h>
8382         __isl_give isl_set *
8383         isl_schedule_node_context_get_context(
8384                 __isl_keep isl_schedule_node *node);
8386         #include <isl/schedule_node.h>
8387         __isl_give isl_union_set *
8388         isl_schedule_node_domain_get_domain(
8389                 __isl_keep isl_schedule_node *node);
8391         #include <isl/schedule_node.h>
8392         __isl_give isl_union_map *
8393         isl_schedule_node_expansion_get_expansion(
8394                 __isl_keep isl_schedule_node *node);
8395         __isl_give isl_union_pw_multi_aff *
8396         isl_schedule_node_expansion_get_contraction(
8397                 __isl_keep isl_schedule_node *node);
8399         #include <isl/schedule_node.h>
8400         __isl_give isl_union_map *
8401         isl_schedule_node_extension_get_extension(
8402                 __isl_keep isl_schedule_node *node);
8404         #include <isl/schedule_node.h>
8405         __isl_give isl_union_set *
8406         isl_schedule_node_filter_get_filter(
8407                 __isl_keep isl_schedule_node *node);
8409         #include <isl/schedule_node.h>
8410         __isl_give isl_set *isl_schedule_node_guard_get_guard(
8411                 __isl_keep isl_schedule_node *node);
8413         #include <isl/schedule_node.h>
8414         __isl_give isl_id *isl_schedule_node_mark_get_id(
8415                 __isl_keep isl_schedule_node *node);
8417 The following functions can be used to obtain an C<isl_multi_union_pw_aff>,
8418 an C<isl_union_pw_multi_aff> or C<isl_union_map> representation of
8419 partial schedules related to the node.
8421         #include <isl/schedule_node.h>
8422         __isl_give isl_multi_union_pw_aff *
8423         isl_schedule_node_get_prefix_schedule_multi_union_pw_aff(
8424                 __isl_keep isl_schedule_node *node);
8425         __isl_give isl_union_pw_multi_aff *
8426         isl_schedule_node_get_prefix_schedule_union_pw_multi_aff(
8427                 __isl_keep isl_schedule_node *node);
8428         __isl_give isl_union_map *
8429         isl_schedule_node_get_prefix_schedule_union_map(
8430                 __isl_keep isl_schedule_node *node);
8431         __isl_give isl_union_map *
8432         isl_schedule_node_get_prefix_schedule_relation(
8433                 __isl_keep isl_schedule_node *node);
8434         __isl_give isl_union_map *
8435         isl_schedule_node_get_subtree_schedule_union_map(
8436                 __isl_keep isl_schedule_node *node);
8438 In particular, the functions
8439 C<isl_schedule_node_get_prefix_schedule_multi_union_pw_aff>,
8440 C<isl_schedule_node_get_prefix_schedule_union_pw_multi_aff>
8441 and C<isl_schedule_node_get_prefix_schedule_union_map>
8442 return a relative ordering on the domain elements that reach the given
8443 node determined by its ancestors.
8444 The function C<isl_schedule_node_get_prefix_schedule_relation>
8445 additionally includes the domain constraints in the result.
8446 The function C<isl_schedule_node_get_subtree_schedule_union_map>
8447 returns a representation of the partial schedule defined by the
8448 subtree rooted at the given node.
8449 If the tree contains any expansion nodes, then the subtree schedule
8450 is formulated in terms of the expanded domain elements.
8451 The tree passed to functions returning a prefix schedule
8452 may only contain extension nodes if these would not affect
8453 the result of these functions.  That is, if one of the ancestors
8454 is an extension node, then all of the domain elements that were
8455 added by the extension node need to have been filtered out
8456 by filter nodes between the extension node and the input node.
8457 The tree passed to C<isl_schedule_node_get_subtree_schedule_union_map>
8458 may not contain in extension nodes in the selected subtree.
8460 The expansion/contraction defined by an entire subtree, combining
8461 the expansions/contractions
8462 on the expansion nodes in the subtree, can be obtained using
8463 the following functions.
8465         #include <isl/schedule_node.h>
8466         __isl_give isl_union_map *
8467         isl_schedule_node_get_subtree_expansion(
8468                 __isl_keep isl_schedule_node *node);
8469         __isl_give isl_union_pw_multi_aff *
8470         isl_schedule_node_get_subtree_contraction(
8471                 __isl_keep isl_schedule_node *node);
8473 The total number of outer band members of given node, i.e.,
8474 the shared output dimension of the maps in the result
8475 of C<isl_schedule_node_get_prefix_schedule_union_map> can be obtained
8476 using the following function.
8478         #include <isl/schedule_node.h>
8479         int isl_schedule_node_get_schedule_depth(
8480                 __isl_keep isl_schedule_node *node);
8482 The following functions return the elements that reach the given node
8483 or the union of universes in the spaces that contain these elements.
8485         #include <isl/schedule_node.h>
8486         __isl_give isl_union_set *
8487         isl_schedule_node_get_domain(
8488                 __isl_keep isl_schedule_node *node);
8489         __isl_give isl_union_set *
8490         isl_schedule_node_get_universe_domain(
8491                 __isl_keep isl_schedule_node *node);
8493 The input tree of C<isl_schedule_node_get_domain>
8494 may only contain extension nodes if these would not affect
8495 the result of this function.  That is, if one of the ancestors
8496 is an extension node, then all of the domain elements that were
8497 added by the extension node need to have been filtered out
8498 by filter nodes between the extension node and the input node.
8500 The following functions can be used to introduce additional nodes
8501 in the schedule tree.  The new node is introduced at the point
8502 in the tree where the C<isl_schedule_node> points to and
8503 the results points to the new node.
8505         #include <isl/schedule_node.h>
8506         __isl_give isl_schedule_node *
8507         isl_schedule_node_insert_partial_schedule(
8508                 __isl_take isl_schedule_node *node,
8509                 __isl_take isl_multi_union_pw_aff *schedule);
8511 This function inserts a new band node with (the greatest integer
8512 part of) the given partial schedule.
8513 The subtree rooted at the given node is assumed not to have
8514 any anchored nodes.
8516         #include <isl/schedule_node.h>
8517         __isl_give isl_schedule_node *
8518         isl_schedule_node_insert_context(
8519                 __isl_take isl_schedule_node *node,
8520                 __isl_take isl_set *context);
8522 This function inserts a new context node with the given context constraints.
8524         #include <isl/schedule_node.h>
8525         __isl_give isl_schedule_node *
8526         isl_schedule_node_insert_filter(
8527                 __isl_take isl_schedule_node *node,
8528                 __isl_take isl_union_set *filter);
8530 This function inserts a new filter node with the given filter.
8531 If the original node already pointed to a filter node, then the
8532 two filter nodes are merged into one.
8534         #include <isl/schedule_node.h>
8535         __isl_give isl_schedule_node *
8536         isl_schedule_node_insert_guard(
8537                 __isl_take isl_schedule_node *node,
8538                 __isl_take isl_set *guard);
8540 This function inserts a new guard node with the given guard constraints.
8542         #include <isl/schedule_node.h>
8543         __isl_give isl_schedule_node *
8544         isl_schedule_node_insert_mark(
8545                 __isl_take isl_schedule_node *node,
8546                 __isl_take isl_id *mark);
8548 This function inserts a new mark node with the give mark identifier.
8550         #include <isl/schedule_node.h>
8551         __isl_give isl_schedule_node *
8552         isl_schedule_node_insert_sequence(
8553                 __isl_take isl_schedule_node *node,
8554                 __isl_take isl_union_set_list *filters);
8555         __isl_give isl_schedule_node *
8556         isl_schedule_node_insert_set(
8557                 __isl_take isl_schedule_node *node,
8558                 __isl_take isl_union_set_list *filters);
8560 These functions insert a new sequence or set node with the given
8561 filters as children.
8563         #include <isl/schedule_node.h>
8564         __isl_give isl_schedule_node *isl_schedule_node_group(
8565                 __isl_take isl_schedule_node *node,
8566                 __isl_take isl_id *group_id);
8568 This function introduces an expansion node in between the current
8569 node and its parent that expands instances of a space with tuple
8570 identifier C<group_id> to the original domain elements that reach
8571 the node.  The group instances are identified by the prefix schedule
8572 of those domain elements.  The ancestors of the node are adjusted
8573 to refer to the group instances instead of the original domain
8574 elements.  The return value points to the same node in the updated
8575 schedule tree as the input node, i.e., to the child of the newly
8576 introduced expansion node.  Grouping instances of different statements
8577 ensures that they will be treated as a single statement by the
8578 AST generator up to the point of the expansion node.
8580 The following function can be used to flatten a nested
8581 sequence.
8583         #include <isl/schedule_node.h>
8584         __isl_give isl_schedule_node *
8585         isl_schedule_node_sequence_splice_child(
8586                 __isl_take isl_schedule_node *node, int pos);
8588 That is, given a sequence node C<node> that has another sequence node
8589 in its child at position C<pos> (in particular, the child of that filter
8590 node is a sequence node), attach the children of that other sequence
8591 node as children of C<node>, replacing the original child at position
8592 C<pos>.
8594 The partial schedule of a band node can be scaled (down) or reduced using
8595 the following functions.
8597         #include <isl/schedule_node.h>
8598         __isl_give isl_schedule_node *
8599         isl_schedule_node_band_scale(
8600                 __isl_take isl_schedule_node *node,
8601                 __isl_take isl_multi_val *mv);
8602         __isl_give isl_schedule_node *
8603         isl_schedule_node_band_scale_down(
8604                 __isl_take isl_schedule_node *node,
8605                 __isl_take isl_multi_val *mv);
8606         __isl_give isl_schedule_node *
8607         isl_schedule_node_band_mod(
8608                 __isl_take isl_schedule_node *node,
8609                 __isl_take isl_multi_val *mv);
8611 The spaces of the two arguments need to match.
8612 After scaling, the partial schedule is replaced by its greatest
8613 integer part to ensure that the schedule remains integral.
8615 The partial schedule of a band node can be shifted by an
8616 C<isl_multi_union_pw_aff> with a domain that is a superset
8617 of the domain of the partial schedule using
8618 the following function.
8620         #include <isl/schedule_node.h>
8621         __isl_give isl_schedule_node *
8622         isl_schedule_node_band_shift(
8623                 __isl_take isl_schedule_node *node,
8624                 __isl_take isl_multi_union_pw_aff *shift);
8626 A band node can be tiled using the following function.
8628         #include <isl/schedule_node.h>
8629         __isl_give isl_schedule_node *isl_schedule_node_band_tile(
8630                 __isl_take isl_schedule_node *node,
8631                 __isl_take isl_multi_val *sizes);
8633         isl_stat isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
8634                 int val);
8635         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
8636         isl_stat isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
8637                 int val);
8638         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
8640 The C<isl_schedule_node_band_tile> function tiles
8641 the band using the given tile sizes inside its schedule.
8642 A new child band node is created to represent the point loops and it is
8643 inserted between the modified band and its children.
8644 The subtree rooted at the given node is assumed not to have
8645 any anchored nodes.
8646 The C<tile_scale_tile_loops> option specifies whether the tile
8647 loops iterators should be scaled by the tile sizes.
8648 If the C<tile_shift_point_loops> option is set, then the point loops
8649 are shifted to start at zero.
8651 A band node can be split into two nested band nodes
8652 using the following function.
8654         #include <isl/schedule_node.h>
8655         __isl_give isl_schedule_node *isl_schedule_node_band_split(
8656                 __isl_take isl_schedule_node *node, int pos);
8658 The resulting outer band node contains the first C<pos> dimensions of
8659 the schedule of C<node> while the inner band contains the remaining dimensions.
8660 The schedules of the two band nodes live in anonymous spaces.
8661 The loop AST generation type options and the isolate option
8662 are split over the the two band nodes.
8664 A band node can be moved down to the leaves of the subtree rooted
8665 at the band node using the following function.
8667         #include <isl/schedule_node.h>
8668         __isl_give isl_schedule_node *isl_schedule_node_band_sink(
8669                 __isl_take isl_schedule_node *node);
8671 The subtree rooted at the given node is assumed not to have
8672 any anchored nodes.
8673 The result points to the node in the resulting tree that is in the same
8674 position as the node pointed to by C<node> in the original tree.
8676         #include <isl/schedule_node.h>
8677         __isl_give isl_schedule_node *
8678         isl_schedule_node_order_before(
8679                 __isl_take isl_schedule_node *node,
8680                 __isl_take isl_union_set *filter);
8681         __isl_give isl_schedule_node *
8682         isl_schedule_node_order_after(
8683                 __isl_take isl_schedule_node *node,
8684                 __isl_take isl_union_set *filter);
8686 These functions split the domain elements that reach C<node>
8687 into those that satisfy C<filter> and those that do not and
8688 arranges for the elements that do satisfy the filter to be
8689 executed before (in case of C<isl_schedule_node_order_before>)
8690 or after (in case of C<isl_schedule_node_order_after>)
8691 those that do not.  The order is imposed by
8692 a sequence node, possibly reusing the grandparent of C<node>
8693 on two copies of the subtree attached to the original C<node>.
8694 Both copies are simplified with respect to their filter.
8696 Return a pointer to the copy of the subtree that does not
8697 satisfy C<filter>.  If there is no such copy (because all
8698 reaching domain elements satisfy the filter), then return
8699 the original pointer.
8701         #include <isl/schedule_node.h>
8702         __isl_give isl_schedule_node *
8703         isl_schedule_node_graft_before(
8704                 __isl_take isl_schedule_node *node,
8705                 __isl_take isl_schedule_node *graft);
8706         __isl_give isl_schedule_node *
8707         isl_schedule_node_graft_after(
8708                 __isl_take isl_schedule_node *node,
8709                 __isl_take isl_schedule_node *graft);
8711 This function inserts the C<graft> tree into the tree containing C<node>
8712 such that it is executed before (in case of C<isl_schedule_node_graft_before>)
8713 or after (in case of C<isl_schedule_node_graft_after>) C<node>.
8714 The root node of C<graft>
8715 should be an extension node where the domain of the extension
8716 is the flat product of all outer band nodes of C<node>.
8717 The root node may also be a domain node.
8718 The elements of the domain or the range of the extension may not
8719 intersect with the domain elements that reach "node".
8720 The schedule tree of C<graft> may not be anchored.
8722 The schedule tree of C<node> is modified to include an extension node
8723 corresponding to the root node of C<graft> as a child of the original
8724 parent of C<node>.  The original node that C<node> points to and the
8725 child of the root node of C<graft> are attached to this extension node
8726 through a sequence, with appropriate filters and with the child
8727 of C<graft> appearing before or after the original C<node>.
8729 If C<node> already appears inside a sequence that is the child of
8730 an extension node and if the spaces of the new domain elements
8731 do not overlap with those of the original domain elements,
8732 then that extension node is extended with the new extension
8733 rather than introducing a new segment of extension and sequence nodes.
8735 Return a pointer to the same node in the modified tree that
8736 C<node> pointed to in the original tree.
8738 A representation of the schedule node can be printed using
8740         #include <isl/schedule_node.h>
8741         __isl_give isl_printer *isl_printer_print_schedule_node(
8742                 __isl_take isl_printer *p,
8743                 __isl_keep isl_schedule_node *node);
8744         __isl_give char *isl_schedule_node_to_str(
8745                 __isl_keep isl_schedule_node *node);
8747 C<isl_schedule_node_to_str> prints the schedule node in block format.
8749 =head2 Dependence Analysis
8751 C<isl> contains specialized functionality for performing
8752 array dataflow analysis.  That is, given a I<sink> access relation
8753 and a collection of possible I<source> access relations,
8754 C<isl> can compute relations that describe
8755 for each iteration of the sink access, which iteration
8756 of which of the source access relations was the last
8757 to access the same data element before the given iteration
8758 of the sink access.
8759 The resulting dependence relations map source iterations
8760 to either the corresponding sink iterations or
8761 pairs of corresponding sink iterations and accessed data elements.
8762 To compute standard flow dependences, the sink should be
8763 a read, while the sources should be writes.
8764 If any of the source accesses are marked as being I<may>
8765 accesses, then there will be a (may) dependence from the last
8766 I<must> access B<and> from any I<may> access that follows
8767 this last I<must> access, but still precedes the sink access.
8768 Only dependences originating in a must access and without
8769 any may accesses between the must access and the sink access
8770 are considered to be must dependences.
8771 In particular, if I<all> sources are I<may> accesses,
8772 then memory based dependence analysis is performed.
8773 If, on the other hand, all sources are I<must> accesses,
8774 then value based dependence analysis is performed.
8776 =head3 High-level Interface
8778 A high-level interface to dependence analysis is provided
8779 by the following function.
8781         #include <isl/flow.h>
8782         __isl_give isl_union_flow *
8783         isl_union_access_info_compute_flow(
8784                 __isl_take isl_union_access_info *access);
8786 The input C<isl_union_access_info> object describes the sink
8787 access relations, the source access relations and a schedule,
8788 while the output C<isl_union_flow> object describes
8789 the resulting dependence relations and the subsets of the
8790 sink relations for which no source was found.
8792 An C<isl_union_access_info> is created, modified, copied and freed using
8793 the following functions.
8795         #include <isl/flow.h>
8796         __isl_give isl_union_access_info *
8797         isl_union_access_info_from_sink(
8798                 __isl_take isl_union_map *sink);
8799         __isl_give isl_union_access_info *
8800         isl_union_access_info_set_must_source(
8801                 __isl_take isl_union_access_info *access,
8802                 __isl_take isl_union_map *must_source);
8803         __isl_give isl_union_access_info *
8804         isl_union_access_info_set_may_source(
8805                 __isl_take isl_union_access_info *access,
8806                 __isl_take isl_union_map *may_source);
8807         __isl_give isl_union_access_info *
8808         isl_union_access_info_set_schedule(
8809                 __isl_take isl_union_access_info *access,
8810                 __isl_take isl_schedule *schedule);
8811         __isl_give isl_union_access_info *
8812         isl_union_access_info_set_schedule_map(
8813                 __isl_take isl_union_access_info *access,
8814                 __isl_take isl_union_map *schedule_map);
8815         __isl_give isl_union_access_info *
8816         isl_union_access_info_copy(
8817                 __isl_keep isl_union_access_info *access);
8818         __isl_null isl_union_access_info *
8819         isl_union_access_info_free(
8820                 __isl_take isl_union_access_info *access);
8822 The may sources set by C<isl_union_access_info_set_may_source>
8823 do not need to include the must sources set by
8824 C<isl_union_access_info_set_must_source> as a subset.
8825 The user is free not to call one (or both) of these functions,
8826 in which case the corresponding set is kept to its empty default.
8827 Similarly, the default schedule initialized by
8828 C<isl_union_access_info_from_sink> is empty.
8829 The current schedule is determined by the last call to either
8830 C<isl_union_access_info_set_schedule> or
8831 C<isl_union_access_info_set_schedule_map>.
8832 The domain of the schedule corresponds to the domains of
8833 the access relations.  In particular, the domains of the access
8834 relations are effectively intersected with the domain of the schedule
8835 and only the resulting accesses are considered by the dependence analysis.
8837 A representation of the information contained in an object
8838 of type C<isl_union_access_info> can be obtained using
8840         #include <isl/flow.h>
8841         __isl_give isl_printer *
8842         isl_printer_print_union_access_info(
8843                 __isl_take isl_printer *p,
8844                 __isl_keep isl_union_access_info *access);
8845         __isl_give char *isl_union_access_info_to_str(
8846                 __isl_keep isl_union_access_info *access);
8848 C<isl_union_access_info_to_str> prints the information in flow format.
8850 The output of C<isl_union_access_info_compute_flow> can be examined,
8851 copied, and freed using the following functions.
8853         #include <isl/flow.h>
8854         __isl_give isl_union_map *isl_union_flow_get_must_dependence(
8855                 __isl_keep isl_union_flow *flow);
8856         __isl_give isl_union_map *isl_union_flow_get_may_dependence(
8857                 __isl_keep isl_union_flow *flow);
8858         __isl_give isl_union_map *
8859         isl_union_flow_get_full_must_dependence(
8860                 __isl_keep isl_union_flow *flow);
8861         __isl_give isl_union_map *
8862         isl_union_flow_get_full_may_dependence(
8863                 __isl_keep isl_union_flow *flow);
8864         __isl_give isl_union_map *isl_union_flow_get_must_no_source(
8865                 __isl_keep isl_union_flow *flow);
8866         __isl_give isl_union_map *isl_union_flow_get_may_no_source(
8867                 __isl_keep isl_union_flow *flow);
8868         __isl_give isl_union_flow *isl_union_flow_copy(
8869                 __isl_keep isl_union_flow *flow);
8870         __isl_null isl_union_flow *isl_union_flow_free(
8871                 __isl_take isl_union_flow *flow);
8873 The relation returned by C<isl_union_flow_get_must_dependence>
8874 relates domain elements of must sources to domain elements of the sink.
8875 The relation returned by C<isl_union_flow_get_may_dependence>
8876 relates domain elements of must or may sources to domain elements of the sink
8877 and includes the previous relation as a subset.
8878 The relation returned by C<isl_union_flow_get_full_must_dependence>
8879 relates domain elements of must sources to pairs of domain elements of the sink
8880 and accessed data elements.
8881 The relation returned by C<isl_union_flow_get_full_may_dependence>
8882 relates domain elements of must or may sources to pairs of
8883 domain elements of the sink and accessed data elements.
8884 This relation includes the previous relation as a subset.
8885 The relation returned by C<isl_union_flow_get_must_no_source> is the subset
8886 of the sink relation for which no dependences have been found.
8887 The relation returned by C<isl_union_flow_get_may_no_source> is the subset
8888 of the sink relation for which no definite dependences have been found.
8889 That is, it contains those sink access that do not contribute to any
8890 of the elements in the relation returned
8891 by C<isl_union_flow_get_must_dependence>.
8893 A representation of the information contained in an object
8894 of type C<isl_union_flow> can be obtained using
8896         #include <isl/flow.h>
8897         __isl_give isl_printer *isl_printer_print_union_flow(
8898                 __isl_take isl_printer *p,
8899                 __isl_keep isl_union_flow *flow);
8900         __isl_give char *isl_union_flow_to_str(
8901                 __isl_keep isl_union_flow *flow);
8903 C<isl_union_flow_to_str> prints the information in flow format.
8905 =head3 Low-level Interface
8907 A lower-level interface is provided by the following functions.
8909         #include <isl/flow.h>
8911         typedef int (*isl_access_level_before)(void *first, void *second);
8913         __isl_give isl_access_info *isl_access_info_alloc(
8914                 __isl_take isl_map *sink,
8915                 void *sink_user, isl_access_level_before fn,
8916                 int max_source);
8917         __isl_give isl_access_info *isl_access_info_add_source(
8918                 __isl_take isl_access_info *acc,
8919                 __isl_take isl_map *source, int must,
8920                 void *source_user);
8921         __isl_null isl_access_info *isl_access_info_free(
8922                 __isl_take isl_access_info *acc);
8924         __isl_give isl_flow *isl_access_info_compute_flow(
8925                 __isl_take isl_access_info *acc);
8927         isl_stat isl_flow_foreach(__isl_keep isl_flow *deps,
8928                 isl_stat (*fn)(__isl_take isl_map *dep, int must,
8929                           void *dep_user, void *user),
8930                 void *user);
8931         __isl_give isl_map *isl_flow_get_no_source(
8932                 __isl_keep isl_flow *deps, int must);
8933         void isl_flow_free(__isl_take isl_flow *deps);
8935 The function C<isl_access_info_compute_flow> performs the actual
8936 dependence analysis.  The other functions are used to construct
8937 the input for this function or to read off the output.
8939 The input is collected in an C<isl_access_info>, which can
8940 be created through a call to C<isl_access_info_alloc>.
8941 The arguments to this functions are the sink access relation
8942 C<sink>, a token C<sink_user> used to identify the sink
8943 access to the user, a callback function for specifying the
8944 relative order of source and sink accesses, and the number
8945 of source access relations that will be added.
8946 The callback function has type C<int (*)(void *first, void *second)>.
8947 The function is called with two user supplied tokens identifying
8948 either a source or the sink and it should return the shared nesting
8949 level and the relative order of the two accesses.
8950 In particular, let I<n> be the number of loops shared by
8951 the two accesses.  If C<first> precedes C<second> textually,
8952 then the function should return I<2 * n + 1>; otherwise,
8953 it should return I<2 * n>.
8954 The sources can be added to the C<isl_access_info> by performing
8955 (at most) C<max_source> calls to C<isl_access_info_add_source>.
8956 C<must> indicates whether the source is a I<must> access
8957 or a I<may> access.  Note that a multi-valued access relation
8958 should only be marked I<must> if every iteration in the domain
8959 of the relation accesses I<all> elements in its image.
8960 The C<source_user> token is again used to identify
8961 the source access.  The range of the source access relation
8962 C<source> should have the same dimension as the range
8963 of the sink access relation.
8964 The C<isl_access_info_free> function should usually not be
8965 called explicitly, because it is called implicitly by
8966 C<isl_access_info_compute_flow>.
8968 The result of the dependence analysis is collected in an
8969 C<isl_flow>.  There may be elements of
8970 the sink access for which no preceding source access could be
8971 found or for which all preceding sources are I<may> accesses.
8972 The relations containing these elements can be obtained through
8973 calls to C<isl_flow_get_no_source>, the first with C<must> set
8974 and the second with C<must> unset.
8975 In the case of standard flow dependence analysis,
8976 with the sink a read and the sources I<must> writes,
8977 the first relation corresponds to the reads from uninitialized
8978 array elements and the second relation is empty.
8979 The actual flow dependences can be extracted using
8980 C<isl_flow_foreach>.  This function will call the user-specified
8981 callback function C<fn> for each B<non-empty> dependence between
8982 a source and the sink.  The callback function is called
8983 with four arguments, the actual flow dependence relation
8984 mapping source iterations to sink iterations, a boolean that
8985 indicates whether it is a I<must> or I<may> dependence, a token
8986 identifying the source and an additional C<void *> with value
8987 equal to the third argument of the C<isl_flow_foreach> call.
8988 A dependence is marked I<must> if it originates from a I<must>
8989 source and if it is not followed by any I<may> sources.
8991 After finishing with an C<isl_flow>, the user should call
8992 C<isl_flow_free> to free all associated memory.
8994 =head3 Interaction with the Low-level Interface
8996 During the dependence analysis, we frequently need to perform
8997 the following operation.  Given a relation between sink iterations
8998 and potential source iterations from a particular source domain,
8999 what is the last potential source iteration corresponding to each
9000 sink iteration.  It can sometimes be convenient to adjust
9001 the set of potential source iterations before or after each such operation.
9002 The prototypical example is fuzzy array dataflow analysis,
9003 where we need to analyze if, based on data-dependent constraints,
9004 the sink iteration can ever be executed without one or more of
9005 the corresponding potential source iterations being executed.
9006 If so, we can introduce extra parameters and select an unknown
9007 but fixed source iteration from the potential source iterations.
9008 To be able to perform such manipulations, C<isl> provides the following
9009 function.
9011         #include <isl/flow.h>
9013         typedef __isl_give isl_restriction *(*isl_access_restrict)(
9014                 __isl_keep isl_map *source_map,
9015                 __isl_keep isl_set *sink, void *source_user,
9016                 void *user);
9017         __isl_give isl_access_info *isl_access_info_set_restrict(
9018                 __isl_take isl_access_info *acc,
9019                 isl_access_restrict fn, void *user);
9021 The function C<isl_access_info_set_restrict> should be called
9022 before calling C<isl_access_info_compute_flow> and registers a callback function
9023 that will be called any time C<isl> is about to compute the last
9024 potential source.  The first argument is the (reverse) proto-dependence,
9025 mapping sink iterations to potential source iterations.
9026 The second argument represents the sink iterations for which
9027 we want to compute the last source iteration.
9028 The third argument is the token corresponding to the source
9029 and the final argument is the token passed to C<isl_access_info_set_restrict>.
9030 The callback is expected to return a restriction on either the input or
9031 the output of the operation computing the last potential source.
9032 If the input needs to be restricted then restrictions are needed
9033 for both the source and the sink iterations.  The sink iterations
9034 and the potential source iterations will be intersected with these sets.
9035 If the output needs to be restricted then only a restriction on the source
9036 iterations is required.
9037 If any error occurs, the callback should return C<NULL>.
9038 An C<isl_restriction> object can be created, freed and inspected
9039 using the following functions.
9041         #include <isl/flow.h>
9043         __isl_give isl_restriction *isl_restriction_input(
9044                 __isl_take isl_set *source_restr,
9045                 __isl_take isl_set *sink_restr);
9046         __isl_give isl_restriction *isl_restriction_output(
9047                 __isl_take isl_set *source_restr);
9048         __isl_give isl_restriction *isl_restriction_none(
9049                 __isl_take isl_map *source_map);
9050         __isl_give isl_restriction *isl_restriction_empty(
9051                 __isl_take isl_map *source_map);
9052         __isl_null isl_restriction *isl_restriction_free(
9053                 __isl_take isl_restriction *restr);
9055 C<isl_restriction_none> and C<isl_restriction_empty> are special
9056 cases of C<isl_restriction_input>.  C<isl_restriction_none>
9057 is essentially equivalent to
9059         isl_restriction_input(isl_set_universe(
9060             isl_space_range(isl_map_get_space(source_map))),
9061                             isl_set_universe(
9062             isl_space_domain(isl_map_get_space(source_map))));
9064 whereas C<isl_restriction_empty> is essentially equivalent to
9066         isl_restriction_input(isl_set_empty(
9067             isl_space_range(isl_map_get_space(source_map))),
9068                             isl_set_universe(
9069             isl_space_domain(isl_map_get_space(source_map))));
9071 =head2 Scheduling
9073         #include <isl/schedule.h>
9074         __isl_give isl_schedule *
9075         isl_schedule_constraints_compute_schedule(
9076                 __isl_take isl_schedule_constraints *sc);
9078 The function C<isl_schedule_constraints_compute_schedule> can be
9079 used to compute a schedule that satisfies the given schedule constraints.
9080 These schedule constraints include the iteration domain for which
9081 a schedule should be computed and dependences between pairs of
9082 iterations.  In particular, these dependences include
9083 I<validity> dependences and I<proximity> dependences.
9084 By default, the algorithm used to construct the schedule is similar
9085 to that of C<Pluto>.
9086 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
9087 be selected.
9088 The generated schedule respects all validity dependences.
9089 That is, all dependence distances over these dependences in the
9090 scheduled space are lexicographically positive.
9092 The default algorithm tries to ensure that the dependence distances
9093 over coincidence constraints are zero and to minimize the
9094 dependence distances over proximity dependences.
9095 Moreover, it tries to obtain sequences (bands) of schedule dimensions
9096 for groups of domains where the dependence distances over validity
9097 dependences have only non-negative values.
9098 Note that when minimizing the maximal dependence distance
9099 over proximity dependences, a single affine expression in the parameters
9100 is constructed that bounds all dependence distances.  If no such expression
9101 exists, then the algorithm will fail and resort to an alternative
9102 scheduling algorithm.  In particular, this means that adding proximity
9103 dependences may eliminate valid solutions.  A typical example where this
9104 phenomenon may occur is when some subset of the proximity dependences
9105 has no restriction on some parameter, forcing the coefficient of that
9106 parameter to be zero, while some other subset forces the dependence
9107 distance to depend on that parameter, requiring the same coefficient
9108 to be non-zero.
9109 When using Feautrier's algorithm, the coincidence and proximity constraints
9110 are only taken into account during the extension to a
9111 full-dimensional schedule.
9113 An C<isl_schedule_constraints> object can be constructed
9114 and manipulated using the following functions.
9116         #include <isl/schedule.h>
9117         __isl_give isl_schedule_constraints *
9118         isl_schedule_constraints_copy(
9119                 __isl_keep isl_schedule_constraints *sc);
9120         __isl_give isl_schedule_constraints *
9121         isl_schedule_constraints_on_domain(
9122                 __isl_take isl_union_set *domain);
9123         __isl_give isl_schedule_constraints *
9124         isl_schedule_constraints_set_context(
9125                 __isl_take isl_schedule_constraints *sc,
9126                 __isl_take isl_set *context);
9127         __isl_give isl_schedule_constraints *
9128         isl_schedule_constraints_set_validity(
9129                 __isl_take isl_schedule_constraints *sc,
9130                 __isl_take isl_union_map *validity);
9131         __isl_give isl_schedule_constraints *
9132         isl_schedule_constraints_set_coincidence(
9133                 __isl_take isl_schedule_constraints *sc,
9134                 __isl_take isl_union_map *coincidence);
9135         __isl_give isl_schedule_constraints *
9136         isl_schedule_constraints_set_proximity(
9137                 __isl_take isl_schedule_constraints *sc,
9138                 __isl_take isl_union_map *proximity);
9139         __isl_give isl_schedule_constraints *
9140         isl_schedule_constraints_set_conditional_validity(
9141                 __isl_take isl_schedule_constraints *sc,
9142                 __isl_take isl_union_map *condition,
9143                 __isl_take isl_union_map *validity);
9144         __isl_give isl_schedule_constraints *
9145         isl_schedule_constraints_apply(
9146                 __isl_take isl_schedule_constraints *sc,
9147                 __isl_take isl_union_map *umap);
9148         __isl_null isl_schedule_constraints *
9149         isl_schedule_constraints_free(
9150                 __isl_take isl_schedule_constraints *sc);
9152 The initial C<isl_schedule_constraints> object created by
9153 C<isl_schedule_constraints_on_domain> does not impose any constraints.
9154 That is, it has an empty set of dependences.
9155 The function C<isl_schedule_constraints_set_context> allows the user
9156 to specify additional constraints on the parameters that may
9157 be assumed to hold during the construction of the schedule.
9158 The function C<isl_schedule_constraints_set_validity> replaces the
9159 validity dependences, mapping domain elements I<i> to domain
9160 elements that should be scheduled after I<i>.
9161 The function C<isl_schedule_constraints_set_coincidence> replaces the
9162 coincidence dependences, mapping domain elements I<i> to domain
9163 elements that should be scheduled together with I<I>, if possible.
9164 The function C<isl_schedule_constraints_set_proximity> replaces the
9165 proximity dependences, mapping domain elements I<i> to domain
9166 elements that should be scheduled either before I<I>
9167 or as early as possible after I<i>.
9169 The function C<isl_schedule_constraints_set_conditional_validity>
9170 replaces the conditional validity constraints.
9171 A conditional validity constraint is only imposed when any of the corresponding
9172 conditions is satisfied, i.e., when any of them is non-zero.
9173 That is, the scheduler ensures that within each band if the dependence
9174 distances over the condition constraints are not all zero
9175 then all corresponding conditional validity constraints are respected.
9176 A conditional validity constraint corresponds to a condition
9177 if the two are adjacent, i.e., if the domain of one relation intersect
9178 the range of the other relation.
9179 The typical use case of conditional validity constraints is
9180 to allow order constraints between live ranges to be violated
9181 as long as the live ranges themselves are local to the band.
9182 To allow more fine-grained control over which conditions correspond
9183 to which conditional validity constraints, the domains and ranges
9184 of these relations may include I<tags>.  That is, the domains and
9185 ranges of those relation may themselves be wrapped relations
9186 where the iteration domain appears in the domain of those wrapped relations
9187 and the range of the wrapped relations can be arbitrarily chosen
9188 by the user.  Conditions and conditional validity constraints are only
9189 considered adjacent to each other if the entire wrapped relation matches.
9190 In particular, a relation with a tag will never be considered adjacent
9191 to a relation without a tag.
9193 The function C<isl_schedule_constraints_compute_schedule> takes
9194 schedule constraints that are defined on some set of domain elements
9195 and transforms them to schedule constraints on the elements
9196 to which these domain elements are mapped by the given transformation.
9198 An C<isl_schedule_constraints> object can be inspected
9199 using the following functions.
9201         #include <isl/schedule.h>
9202         __isl_give isl_union_set *
9203         isl_schedule_constraints_get_domain(
9204                 __isl_keep isl_schedule_constraints *sc);
9205         __isl_give isl_set *isl_schedule_constraints_get_context(
9206                 __isl_keep isl_schedule_constraints *sc);
9207         __isl_give isl_union_map *
9208         isl_schedule_constraints_get_validity(
9209                 __isl_keep isl_schedule_constraints *sc);
9210         __isl_give isl_union_map *
9211         isl_schedule_constraints_get_coincidence(
9212                 __isl_keep isl_schedule_constraints *sc);
9213         __isl_give isl_union_map *
9214         isl_schedule_constraints_get_proximity(
9215                 __isl_keep isl_schedule_constraints *sc);
9216         __isl_give isl_union_map *
9217         isl_schedule_constraints_get_conditional_validity(
9218                 __isl_keep isl_schedule_constraints *sc);
9219         __isl_give isl_union_map *
9220         isl_schedule_constraints_get_conditional_validity_condition(
9221                 __isl_keep isl_schedule_constraints *sc);
9223 An C<isl_schedule_constraints> object can be read from input
9224 using the following functions.
9226         #include <isl/schedule.h>
9227         __isl_give isl_schedule_constraints *
9228         isl_schedule_constraints_read_from_str(isl_ctx *ctx,
9229                 const char *str);
9230         __isl_give isl_schedule_constraints *
9231         isl_schedule_constraints_read_from_file(isl_ctx *ctx,
9232                 FILE *input);
9234 The contents of an C<isl_schedule_constraints> object can be printed
9235 using the following functions.
9237         #include <isl/schedule.h>
9238         __isl_give isl_printer *
9239         isl_printer_print_schedule_constraints(
9240                 __isl_take isl_printer *p,
9241                 __isl_keep isl_schedule_constraints *sc);
9242         __isl_give char *isl_schedule_constraints_to_str(
9243                 __isl_keep isl_schedule_constraints *sc);
9245 The following function computes a schedule directly from
9246 an iteration domain and validity and proximity dependences
9247 and is implemented in terms of the functions described above.
9248 The use of C<isl_union_set_compute_schedule> is discouraged.
9250         #include <isl/schedule.h>
9251         __isl_give isl_schedule *isl_union_set_compute_schedule(
9252                 __isl_take isl_union_set *domain,
9253                 __isl_take isl_union_map *validity,
9254                 __isl_take isl_union_map *proximity);
9256 The generated schedule represents a schedule tree.
9257 For more information on schedule trees, see
9258 L</"Schedule Trees">.
9260 =head3 Options
9262         #include <isl/schedule.h>
9263         isl_stat isl_options_set_schedule_max_coefficient(
9264                 isl_ctx *ctx, int val);
9265         int isl_options_get_schedule_max_coefficient(
9266                 isl_ctx *ctx);
9267         isl_stat isl_options_set_schedule_max_constant_term(
9268                 isl_ctx *ctx, int val);
9269         int isl_options_get_schedule_max_constant_term(
9270                 isl_ctx *ctx);
9271         isl_stat isl_options_set_schedule_serialize_sccs(
9272                 isl_ctx *ctx, int val);
9273         int isl_options_get_schedule_serialize_sccs(isl_ctx *ctx);
9274         isl_stat isl_options_set_schedule_whole_component(
9275                 isl_ctx *ctx, int val);
9276         int isl_options_get_schedule_whole_component(
9277                 isl_ctx *ctx);
9278         isl_stat isl_options_set_schedule_maximize_band_depth(
9279                 isl_ctx *ctx, int val);
9280         int isl_options_get_schedule_maximize_band_depth(
9281                 isl_ctx *ctx);
9282         isl_stat isl_options_set_schedule_maximize_coincidence(
9283                 isl_ctx *ctx, int val);
9284         int isl_options_get_schedule_maximize_coincidence(
9285                 isl_ctx *ctx);
9286         isl_stat isl_options_set_schedule_outer_coincidence(
9287                 isl_ctx *ctx, int val);
9288         int isl_options_get_schedule_outer_coincidence(
9289                 isl_ctx *ctx);
9290         isl_stat isl_options_set_schedule_split_scaled(
9291                 isl_ctx *ctx, int val);
9292         int isl_options_get_schedule_split_scaled(
9293                 isl_ctx *ctx);
9294         isl_stat isl_options_set_schedule_treat_coalescing(
9295                 isl_ctx *ctx, int val);
9296         int isl_options_get_schedule_treat_coalescing(
9297                 isl_ctx *ctx);
9298         isl_stat isl_options_set_schedule_algorithm(
9299                 isl_ctx *ctx, int val);
9300         int isl_options_get_schedule_algorithm(
9301                 isl_ctx *ctx);
9302         isl_stat isl_options_set_schedule_carry_self_first(
9303                 isl_ctx *ctx, int val);
9304         int isl_options_get_schedule_carry_self_first(
9305                 isl_ctx *ctx);
9306         isl_stat isl_options_set_schedule_separate_components(
9307                 isl_ctx *ctx, int val);
9308         int isl_options_get_schedule_separate_components(
9309                 isl_ctx *ctx);
9311 =over
9313 =item * schedule_max_coefficient
9315 This option enforces that the coefficients for variable and parameter
9316 dimensions in the calculated schedule are not larger than the specified value.
9317 This option can significantly increase the speed of the scheduling calculation
9318 and may also prevent fusing of unrelated dimensions. A value of -1 means that
9319 this option does not introduce bounds on the variable or parameter
9320 coefficients.
9322 =item * schedule_max_constant_term
9324 This option enforces that the constant coefficients in the calculated schedule
9325 are not larger than the maximal constant term. This option can significantly
9326 increase the speed of the scheduling calculation and may also prevent fusing of
9327 unrelated dimensions. A value of -1 means that this option does not introduce
9328 bounds on the constant coefficients.
9330 =item * schedule_serialize_sccs
9332 If this option is set, then all strongly connected components
9333 in the dependence graph are serialized as soon as they are detected.
9334 This means in particular that instances of statements will only
9335 appear in the same band node if these statements belong
9336 to the same strongly connected component at the point where
9337 the band node is constructed.
9339 =item * schedule_whole_component
9341 If this option is set, then entire (weakly) connected
9342 components in the dependence graph are scheduled together
9343 as a whole.
9344 Otherwise, each strongly connected component within
9345 such a weakly connected component is first scheduled separately
9346 and then combined with other strongly connected components.
9347 This option has no effect if C<schedule_serialize_sccs> is set.
9349 =item * schedule_maximize_band_depth
9351 If this option is set, then the scheduler tries to maximize
9352 the width of the bands.  Wider bands give more possibilities for tiling.
9353 In particular, if the C<schedule_whole_component> option is set,
9354 then bands are split if this might result in wider bands.
9355 Otherwise, the effect of this option is to only allow
9356 strongly connected components to be combined if this does
9357 not reduce the width of the bands.
9358 Note that if the C<schedule_serialize_sccs> options is set, then
9359 the C<schedule_maximize_band_depth> option therefore has no effect.
9361 =item * schedule_maximize_coincidence
9363 This option is only effective if the C<schedule_whole_component>
9364 option is turned off.
9365 If the C<schedule_maximize_coincidence> option is set, then (clusters of)
9366 strongly connected components are only combined with each other
9367 if this does not reduce the number of coincident band members.
9369 =item * schedule_outer_coincidence
9371 If this option is set, then we try to construct schedules
9372 where the outermost scheduling dimension in each band
9373 satisfies the coincidence constraints.
9375 =item * schedule_algorithm
9377 Selects the scheduling algorithm to be used.
9378 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
9379 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
9381 =item * schedule_split_scaled
9383 If this option is set, then we try to construct schedules in which the
9384 constant term is split off from the linear part if the linear parts of
9385 the scheduling rows for all nodes in the graph have a common non-trivial
9386 divisor.
9387 The constant term is then dropped and the linear
9388 part is reduced.
9389 This option is only effective when the Feautrier style scheduler is
9390 being used, either as the main scheduler or as a fallback for the
9391 Pluto-like scheduler.
9393 =item * schedule_treat_coalescing
9395 If this option is set, then the scheduler will try and avoid
9396 producing schedules that perform loop coalescing.
9397 In particular, for the Pluto-like scheduler, this option places
9398 bounds on the schedule coefficients based on the sizes of the instance sets.
9399 For the Feautrier style scheduler, this option detects potentially
9400 coalescing schedules and then tries to adjust the schedule to avoid
9401 the coalescing.
9403 =item * schedule_carry_self_first
9405 If this option is set, then the Feautrier style scheduler
9406 (when used as a fallback for the Pluto-like scheduler) will
9407 first try to only carry self-dependences.
9409 =item * schedule_separate_components
9411 If this option is set then the function C<isl_schedule_get_map>
9412 will treat set nodes in the same way as sequence nodes.
9414 =back
9416 =head2 AST Generation
9418 This section describes the C<isl> functionality for generating
9419 ASTs that visit all the elements
9420 in a domain in an order specified by a schedule tree or
9421 a schedule map.
9422 In case the schedule given as a C<isl_union_map>, an AST is generated
9423 that visits all the elements in the domain of the C<isl_union_map>
9424 according to the lexicographic order of the corresponding image
9425 element(s).  If the range of the C<isl_union_map> consists of
9426 elements in more than one space, then each of these spaces is handled
9427 separately in an arbitrary order.
9428 It should be noted that the schedule tree or the image elements
9429 in a schedule map only specify the I<order>
9430 in which the corresponding domain elements should be visited.
9431 No direct relation between the partial schedule values
9432 or the image elements on the one hand and the loop iterators
9433 in the generated AST on the other hand should be assumed.
9435 Each AST is generated within a build.  The initial build
9436 simply specifies the constraints on the parameters (if any)
9437 and can be created, inspected, copied and freed using the following functions.
9439         #include <isl/ast_build.h>
9440         __isl_give isl_ast_build *isl_ast_build_alloc(
9441                 isl_ctx *ctx);
9442         __isl_give isl_ast_build *isl_ast_build_from_context(
9443                 __isl_take isl_set *set);
9444         __isl_give isl_ast_build *isl_ast_build_copy(
9445                 __isl_keep isl_ast_build *build);
9446         __isl_null isl_ast_build *isl_ast_build_free(
9447                 __isl_take isl_ast_build *build);
9449 The C<set> argument is usually a parameter set with zero or more parameters.
9450 In fact, when creating an AST using C<isl_ast_build_node_from_schedule>,
9451 this set is required to be a parameter set.
9452 An C<isl_ast_build> created using C<isl_ast_build_alloc> does not
9453 specify any parameter constraints.
9454 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
9455 and L</"Fine-grained Control over AST Generation">.
9456 Finally, the AST itself can be constructed using one of the following
9457 functions.
9459         #include <isl/ast_build.h>
9460         __isl_give isl_ast_node *isl_ast_build_node_from_schedule(
9461                 __isl_keep isl_ast_build *build,
9462                 __isl_take isl_schedule *schedule);
9463         __isl_give isl_ast_node *
9464         isl_ast_build_node_from_schedule_map(
9465                 __isl_keep isl_ast_build *build,
9466                 __isl_take isl_union_map *schedule);
9468 =head3 Inspecting the AST
9470 The basic properties of an AST node can be obtained as follows.
9472         #include <isl/ast.h>
9473         enum isl_ast_node_type isl_ast_node_get_type(
9474                 __isl_keep isl_ast_node *node);
9476 The type of an AST node is one of
9477 C<isl_ast_node_for>,
9478 C<isl_ast_node_if>,
9479 C<isl_ast_node_block>,
9480 C<isl_ast_node_mark> or
9481 C<isl_ast_node_user>.
9482 An C<isl_ast_node_for> represents a for node.
9483 An C<isl_ast_node_if> represents an if node.
9484 An C<isl_ast_node_block> represents a compound node.
9485 An C<isl_ast_node_mark> introduces a mark in the AST.
9486 An C<isl_ast_node_user> represents an expression statement.
9487 An expression statement typically corresponds to a domain element, i.e.,
9488 one of the elements that is visited by the AST.
9490 Each type of node has its own additional properties.
9492         #include <isl/ast.h>
9493         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
9494                 __isl_keep isl_ast_node *node);
9495         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
9496                 __isl_keep isl_ast_node *node);
9497         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
9498                 __isl_keep isl_ast_node *node);
9499         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
9500                 __isl_keep isl_ast_node *node);
9501         __isl_give isl_ast_node *isl_ast_node_for_get_body(
9502                 __isl_keep isl_ast_node *node);
9503         isl_bool isl_ast_node_for_is_degenerate(
9504                 __isl_keep isl_ast_node *node);
9506 An C<isl_ast_for> is considered degenerate if it is known to execute
9507 exactly once.
9509         #include <isl/ast.h>
9510         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
9511                 __isl_keep isl_ast_node *node);
9512         __isl_give isl_ast_node *isl_ast_node_if_get_then(
9513                 __isl_keep isl_ast_node *node);
9514         isl_bool isl_ast_node_if_has_else(
9515                 __isl_keep isl_ast_node *node);
9516         __isl_give isl_ast_node *isl_ast_node_if_get_else(
9517                 __isl_keep isl_ast_node *node);
9519         __isl_give isl_ast_node_list *
9520         isl_ast_node_block_get_children(
9521                 __isl_keep isl_ast_node *node);
9523         __isl_give isl_id *isl_ast_node_mark_get_id(
9524                 __isl_keep isl_ast_node *node);
9525         __isl_give isl_ast_node *isl_ast_node_mark_get_node(
9526                 __isl_keep isl_ast_node *node);
9528 C<isl_ast_node_mark_get_id> returns the identifier of the mark.
9529 C<isl_ast_node_mark_get_node> returns the child node that is being marked.
9531         #include <isl/ast.h>
9532         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
9533                 __isl_keep isl_ast_node *node);
9535 All descendants of a specific node in the AST (including the node itself)
9536 can be visited
9537 in depth-first pre-order using the following function.
9539         #include <isl/ast.h>
9540         isl_stat isl_ast_node_foreach_descendant_top_down(
9541                 __isl_keep isl_ast_node *node,
9542                 isl_bool (*fn)(__isl_keep isl_ast_node *node,
9543                         void *user), void *user);
9545 The callback function should return C<isl_bool_true> if the children
9546 of the given node should be visited and C<isl_bool_false> if they should not.
9547 It should return C<isl_bool_error> in case of failure, in which case
9548 the entire traversal is aborted.
9550 Each of the returned C<isl_ast_expr>s can in turn be inspected using
9551 the following functions.
9553         #include <isl/ast.h>
9554         enum isl_ast_expr_type isl_ast_expr_get_type(
9555                 __isl_keep isl_ast_expr *expr);
9557 The type of an AST expression is one of
9558 C<isl_ast_expr_op>,
9559 C<isl_ast_expr_id> or
9560 C<isl_ast_expr_int>.
9561 An C<isl_ast_expr_op> represents the result of an operation.
9562 An C<isl_ast_expr_id> represents an identifier.
9563 An C<isl_ast_expr_int> represents an integer value.
9565 Each type of expression has its own additional properties.
9567         #include <isl/ast.h>
9568         enum isl_ast_op_type isl_ast_expr_get_op_type(
9569                 __isl_keep isl_ast_expr *expr);
9570         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
9571         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
9572                 __isl_keep isl_ast_expr *expr, int pos);
9573         isl_stat isl_ast_expr_foreach_ast_op_type(
9574                 __isl_keep isl_ast_expr *expr,
9575                 isl_stat (*fn)(enum isl_ast_op_type type,
9576                         void *user), void *user);
9577         isl_stat isl_ast_node_foreach_ast_op_type(
9578                 __isl_keep isl_ast_node *node,
9579                 isl_stat (*fn)(enum isl_ast_op_type type,
9580                         void *user), void *user);
9582 C<isl_ast_expr_get_op_type> returns the type of the operation
9583 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
9584 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
9585 argument.
9586 C<isl_ast_expr_foreach_ast_op_type> calls C<fn> for each distinct
9587 C<isl_ast_op_type> that appears in C<expr>.
9588 C<isl_ast_node_foreach_ast_op_type> does the same for each distinct
9589 C<isl_ast_op_type> that appears in C<node>.
9590 The operation type is one of the following.
9592 =over
9594 =item C<isl_ast_op_and>
9596 Logical I<and> of two arguments.
9597 Both arguments can be evaluated.
9599 =item C<isl_ast_op_and_then>
9601 Logical I<and> of two arguments.
9602 The second argument can only be evaluated if the first evaluates to true.
9604 =item C<isl_ast_op_or>
9606 Logical I<or> of two arguments.
9607 Both arguments can be evaluated.
9609 =item C<isl_ast_op_or_else>
9611 Logical I<or> of two arguments.
9612 The second argument can only be evaluated if the first evaluates to false.
9614 =item C<isl_ast_op_max>
9616 Maximum of two or more arguments.
9618 =item C<isl_ast_op_min>
9620 Minimum of two or more arguments.
9622 =item C<isl_ast_op_minus>
9624 Change sign.
9626 =item C<isl_ast_op_add>
9628 Sum of two arguments.
9630 =item C<isl_ast_op_sub>
9632 Difference of two arguments.
9634 =item C<isl_ast_op_mul>
9636 Product of two arguments.
9638 =item C<isl_ast_op_div>
9640 Exact division.  That is, the result is known to be an integer.
9642 =item C<isl_ast_op_fdiv_q>
9644 Result of integer division, rounded towards negative
9645 infinity.
9647 =item C<isl_ast_op_pdiv_q>
9649 Result of integer division, where dividend is known to be non-negative.
9651 =item C<isl_ast_op_pdiv_r>
9653 Remainder of integer division, where dividend is known to be non-negative.
9655 =item C<isl_ast_op_zdiv_r>
9657 Equal to zero iff the remainder on integer division is zero.
9659 =item C<isl_ast_op_cond>
9661 Conditional operator defined on three arguments.
9662 If the first argument evaluates to true, then the result
9663 is equal to the second argument.  Otherwise, the result
9664 is equal to the third argument.
9665 The second and third argument may only be evaluated if
9666 the first argument evaluates to true and false, respectively.
9667 Corresponds to C<a ? b : c> in C.
9669 =item C<isl_ast_op_select>
9671 Conditional operator defined on three arguments.
9672 If the first argument evaluates to true, then the result
9673 is equal to the second argument.  Otherwise, the result
9674 is equal to the third argument.
9675 The second and third argument may be evaluated independently
9676 of the value of the first argument.
9677 Corresponds to C<a * b + (1 - a) * c> in C.
9679 =item C<isl_ast_op_eq>
9681 Equality relation.
9683 =item C<isl_ast_op_le>
9685 Less than or equal relation.
9687 =item C<isl_ast_op_lt>
9689 Less than relation.
9691 =item C<isl_ast_op_ge>
9693 Greater than or equal relation.
9695 =item C<isl_ast_op_gt>
9697 Greater than relation.
9699 =item C<isl_ast_op_call>
9701 A function call.
9702 The number of arguments of the C<isl_ast_expr> is one more than
9703 the number of arguments in the function call, the first argument
9704 representing the function being called.
9706 =item C<isl_ast_op_access>
9708 An array access.
9709 The number of arguments of the C<isl_ast_expr> is one more than
9710 the number of index expressions in the array access, the first argument
9711 representing the array being accessed.
9713 =item C<isl_ast_op_member>
9715 A member access.
9716 This operation has two arguments, a structure and the name of
9717 the member of the structure being accessed.
9719 =back
9721         #include <isl/ast.h>
9722         __isl_give isl_id *isl_ast_expr_get_id(
9723                 __isl_keep isl_ast_expr *expr);
9725 Return the identifier represented by the AST expression.
9727         #include <isl/ast.h>
9728         __isl_give isl_val *isl_ast_expr_get_val(
9729                 __isl_keep isl_ast_expr *expr);
9731 Return the integer represented by the AST expression.
9733 =head3 Properties of ASTs
9735         #include <isl/ast.h>
9736         isl_bool isl_ast_expr_is_equal(
9737                 __isl_keep isl_ast_expr *expr1,
9738                 __isl_keep isl_ast_expr *expr2);
9740 Check if two C<isl_ast_expr>s are equal to each other.
9742 =head3 Manipulating and printing the AST
9744 AST nodes can be copied and freed using the following functions.
9746         #include <isl/ast.h>
9747         __isl_give isl_ast_node *isl_ast_node_copy(
9748                 __isl_keep isl_ast_node *node);
9749         __isl_null isl_ast_node *isl_ast_node_free(
9750                 __isl_take isl_ast_node *node);
9752 AST expressions can be copied and freed using the following functions.
9754         #include <isl/ast.h>
9755         __isl_give isl_ast_expr *isl_ast_expr_copy(
9756                 __isl_keep isl_ast_expr *expr);
9757         __isl_null isl_ast_expr *isl_ast_expr_free(
9758                 __isl_take isl_ast_expr *expr);
9760 New AST expressions can be created either directly or within
9761 the context of an C<isl_ast_build>.
9763         #include <isl/ast.h>
9764         __isl_give isl_ast_expr *isl_ast_expr_from_val(
9765                 __isl_take isl_val *v);
9766         __isl_give isl_ast_expr *isl_ast_expr_from_id(
9767                 __isl_take isl_id *id);
9768         __isl_give isl_ast_expr *isl_ast_expr_neg(
9769                 __isl_take isl_ast_expr *expr);
9770         __isl_give isl_ast_expr *isl_ast_expr_address_of(
9771                 __isl_take isl_ast_expr *expr);
9772         __isl_give isl_ast_expr *isl_ast_expr_add(
9773                 __isl_take isl_ast_expr *expr1,
9774                 __isl_take isl_ast_expr *expr2);
9775         __isl_give isl_ast_expr *isl_ast_expr_sub(
9776                 __isl_take isl_ast_expr *expr1,
9777                 __isl_take isl_ast_expr *expr2);
9778         __isl_give isl_ast_expr *isl_ast_expr_mul(
9779                 __isl_take isl_ast_expr *expr1,
9780                 __isl_take isl_ast_expr *expr2);
9781         __isl_give isl_ast_expr *isl_ast_expr_div(
9782                 __isl_take isl_ast_expr *expr1,
9783                 __isl_take isl_ast_expr *expr2);
9784         __isl_give isl_ast_expr *isl_ast_expr_pdiv_q(
9785                 __isl_take isl_ast_expr *expr1,
9786                 __isl_take isl_ast_expr *expr2);
9787         __isl_give isl_ast_expr *isl_ast_expr_pdiv_r(
9788                 __isl_take isl_ast_expr *expr1,
9789                 __isl_take isl_ast_expr *expr2);
9790         __isl_give isl_ast_expr *isl_ast_expr_and(
9791                 __isl_take isl_ast_expr *expr1,
9792                 __isl_take isl_ast_expr *expr2)
9793         __isl_give isl_ast_expr *isl_ast_expr_and_then(
9794                 __isl_take isl_ast_expr *expr1,
9795                 __isl_take isl_ast_expr *expr2)
9796         __isl_give isl_ast_expr *isl_ast_expr_or(
9797                 __isl_take isl_ast_expr *expr1,
9798                 __isl_take isl_ast_expr *expr2)
9799         __isl_give isl_ast_expr *isl_ast_expr_or_else(
9800                 __isl_take isl_ast_expr *expr1,
9801                 __isl_take isl_ast_expr *expr2)
9802         __isl_give isl_ast_expr *isl_ast_expr_eq(
9803                 __isl_take isl_ast_expr *expr1,
9804                 __isl_take isl_ast_expr *expr2);
9805         __isl_give isl_ast_expr *isl_ast_expr_le(
9806                 __isl_take isl_ast_expr *expr1,
9807                 __isl_take isl_ast_expr *expr2);
9808         __isl_give isl_ast_expr *isl_ast_expr_lt(
9809                 __isl_take isl_ast_expr *expr1,
9810                 __isl_take isl_ast_expr *expr2);
9811         __isl_give isl_ast_expr *isl_ast_expr_ge(
9812                 __isl_take isl_ast_expr *expr1,
9813                 __isl_take isl_ast_expr *expr2);
9814         __isl_give isl_ast_expr *isl_ast_expr_gt(
9815                 __isl_take isl_ast_expr *expr1,
9816                 __isl_take isl_ast_expr *expr2);
9817         __isl_give isl_ast_expr *isl_ast_expr_access(
9818                 __isl_take isl_ast_expr *array,
9819                 __isl_take isl_ast_expr_list *indices);
9820         __isl_give isl_ast_expr *isl_ast_expr_call(
9821                 __isl_take isl_ast_expr *function,
9822                 __isl_take isl_ast_expr_list *arguments);
9824 The function C<isl_ast_expr_address_of> can be applied to an
9825 C<isl_ast_expr> of type C<isl_ast_op_access> only. It is meant
9826 to represent the address of the C<isl_ast_expr_access>. The function
9827 C<isl_ast_expr_and_then> as well as C<isl_ast_expr_or_else> are short-circuit
9828 versions of C<isl_ast_expr_and> and C<isl_ast_expr_or>, respectively.
9830         #include <isl/ast_build.h>
9831         __isl_give isl_ast_expr *isl_ast_build_expr_from_set(
9832                 __isl_keep isl_ast_build *build,
9833                 __isl_take isl_set *set);
9834         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
9835                 __isl_keep isl_ast_build *build,
9836                 __isl_take isl_pw_aff *pa);
9837         __isl_give isl_ast_expr *
9838         isl_ast_build_access_from_pw_multi_aff(
9839                 __isl_keep isl_ast_build *build,
9840                 __isl_take isl_pw_multi_aff *pma);
9841         __isl_give isl_ast_expr *
9842         isl_ast_build_access_from_multi_pw_aff(
9843                 __isl_keep isl_ast_build *build,
9844                 __isl_take isl_multi_pw_aff *mpa);
9845         __isl_give isl_ast_expr *
9846         isl_ast_build_call_from_pw_multi_aff(
9847                 __isl_keep isl_ast_build *build,
9848                 __isl_take isl_pw_multi_aff *pma);
9849         __isl_give isl_ast_expr *
9850         isl_ast_build_call_from_multi_pw_aff(
9851                 __isl_keep isl_ast_build *build,
9852                 __isl_take isl_multi_pw_aff *mpa);
9854 The set <set> and
9855 the domains of C<pa>, C<mpa> and C<pma> should correspond
9856 to the schedule space of C<build>.
9857 The tuple id of C<mpa> or C<pma> is used as the array being accessed or
9858 the function being called.
9859 If the accessed space is a nested relation, then it is taken
9860 to represent an access of the member specified by the range
9861 of this nested relation of the structure specified by the domain
9862 of the nested relation.
9864 The following functions can be used to modify an C<isl_ast_expr>.
9866         #include <isl/ast.h>
9867         __isl_give isl_ast_expr *isl_ast_expr_set_op_arg(
9868                 __isl_take isl_ast_expr *expr, int pos,
9869                 __isl_take isl_ast_expr *arg);
9871 Replace the argument of C<expr> at position C<pos> by C<arg>.
9873         #include <isl/ast.h>
9874         __isl_give isl_ast_expr *isl_ast_expr_substitute_ids(
9875                 __isl_take isl_ast_expr *expr,
9876                 __isl_take isl_id_to_ast_expr *id2expr);
9878 The function C<isl_ast_expr_substitute_ids> replaces the
9879 subexpressions of C<expr> of type C<isl_ast_expr_id>
9880 by the corresponding expression in C<id2expr>, if there is any.
9883 User specified data can be attached to an C<isl_ast_node> and obtained
9884 from the same C<isl_ast_node> using the following functions.
9886         #include <isl/ast.h>
9887         __isl_give isl_ast_node *isl_ast_node_set_annotation(
9888                 __isl_take isl_ast_node *node,
9889                 __isl_take isl_id *annotation);
9890         __isl_give isl_id *isl_ast_node_get_annotation(
9891                 __isl_keep isl_ast_node *node);
9893 Basic printing can be performed using the following functions.
9895         #include <isl/ast.h>
9896         __isl_give isl_printer *isl_printer_print_ast_expr(
9897                 __isl_take isl_printer *p,
9898                 __isl_keep isl_ast_expr *expr);
9899         __isl_give isl_printer *isl_printer_print_ast_node(
9900                 __isl_take isl_printer *p,
9901                 __isl_keep isl_ast_node *node);
9902         __isl_give char *isl_ast_expr_to_str(
9903                 __isl_keep isl_ast_expr *expr);
9904         __isl_give char *isl_ast_node_to_str(
9905                 __isl_keep isl_ast_node *node);
9906         __isl_give char *isl_ast_expr_to_C_str(
9907                 __isl_keep isl_ast_expr *expr);
9908         __isl_give char *isl_ast_node_to_C_str(
9909                 __isl_keep isl_ast_node *node);
9911 The functions C<isl_ast_expr_to_C_str> and
9912 C<isl_ast_node_to_C_str> are convenience functions
9913 that return a string representation of the input in C format.
9915 More advanced printing can be performed using the following functions.
9917         #include <isl/ast.h>
9918         __isl_give isl_printer *isl_ast_op_type_set_print_name(
9919                 __isl_take isl_printer *p,
9920                 enum isl_ast_op_type type,
9921                 __isl_keep const char *name);
9922         isl_stat isl_options_set_ast_print_macro_once(
9923                 isl_ctx *ctx, int val);
9924         int isl_options_get_ast_print_macro_once(isl_ctx *ctx);
9925         __isl_give isl_printer *isl_ast_op_type_print_macro(
9926                 enum isl_ast_op_type type,
9927                 __isl_take isl_printer *p);
9928         __isl_give isl_printer *isl_ast_expr_print_macros(
9929                 __isl_keep isl_ast_expr *expr,
9930                 __isl_take isl_printer *p);
9931         __isl_give isl_printer *isl_ast_node_print_macros(
9932                 __isl_keep isl_ast_node *node,
9933                 __isl_take isl_printer *p);
9934         __isl_give isl_printer *isl_ast_node_print(
9935                 __isl_keep isl_ast_node *node,
9936                 __isl_take isl_printer *p,
9937                 __isl_take isl_ast_print_options *options);
9938         __isl_give isl_printer *isl_ast_node_for_print(
9939                 __isl_keep isl_ast_node *node,
9940                 __isl_take isl_printer *p,
9941                 __isl_take isl_ast_print_options *options);
9942         __isl_give isl_printer *isl_ast_node_if_print(
9943                 __isl_keep isl_ast_node *node,
9944                 __isl_take isl_printer *p,
9945                 __isl_take isl_ast_print_options *options);
9947 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
9948 C<isl> may print out an AST that makes use of macros such
9949 as C<floord>, C<min> and C<max>.
9950 The names of these macros may be modified by a call
9951 to C<isl_ast_op_type_set_print_name>.  The user-specified
9952 names are associated to the printer object.
9953 C<isl_ast_op_type_print_macro> prints out the macro
9954 corresponding to a specific C<isl_ast_op_type>.
9955 If the print-macro-once option is set, then a given macro definition
9956 is only printed once to any given printer object.
9957 C<isl_ast_expr_print_macros> scans the C<isl_ast_expr>
9958 for subexpressions where these macros would be used and prints
9959 out the required macro definitions.
9960 Essentially, C<isl_ast_expr_print_macros> calls
9961 C<isl_ast_expr_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
9962 as function argument.
9963 C<isl_ast_node_print_macros> does the same
9964 for expressions in its C<isl_ast_node> argument.
9965 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
9966 C<isl_ast_node_if_print> print an C<isl_ast_node>
9967 in C<ISL_FORMAT_C>, but allow for some extra control
9968 through an C<isl_ast_print_options> object.
9969 This object can be created using the following functions.
9971         #include <isl/ast.h>
9972         __isl_give isl_ast_print_options *
9973         isl_ast_print_options_alloc(isl_ctx *ctx);
9974         __isl_give isl_ast_print_options *
9975         isl_ast_print_options_copy(
9976                 __isl_keep isl_ast_print_options *options);
9977         __isl_null isl_ast_print_options *
9978         isl_ast_print_options_free(
9979                 __isl_take isl_ast_print_options *options);
9981         __isl_give isl_ast_print_options *
9982         isl_ast_print_options_set_print_user(
9983                 __isl_take isl_ast_print_options *options,
9984                 __isl_give isl_printer *(*print_user)(
9985                         __isl_take isl_printer *p,
9986                         __isl_take isl_ast_print_options *options,
9987                         __isl_keep isl_ast_node *node, void *user),
9988                 void *user);
9989         __isl_give isl_ast_print_options *
9990         isl_ast_print_options_set_print_for(
9991                 __isl_take isl_ast_print_options *options,
9992                 __isl_give isl_printer *(*print_for)(
9993                         __isl_take isl_printer *p,
9994                         __isl_take isl_ast_print_options *options,
9995                         __isl_keep isl_ast_node *node, void *user),
9996                 void *user);
9998 The callback set by C<isl_ast_print_options_set_print_user>
9999 is called whenever a node of type C<isl_ast_node_user> needs to
10000 be printed.
10001 The callback set by C<isl_ast_print_options_set_print_for>
10002 is called whenever a node of type C<isl_ast_node_for> needs to
10003 be printed.
10004 Note that C<isl_ast_node_for_print> will I<not> call the
10005 callback set by C<isl_ast_print_options_set_print_for> on the node
10006 on which C<isl_ast_node_for_print> is called, but only on nested
10007 nodes of type C<isl_ast_node_for>.  It is therefore safe to
10008 call C<isl_ast_node_for_print> from within the callback set by
10009 C<isl_ast_print_options_set_print_for>.
10011 The following option determines the type to be used for iterators
10012 while printing the AST.
10014         isl_stat isl_options_set_ast_iterator_type(
10015                 isl_ctx *ctx, const char *val);
10016         const char *isl_options_get_ast_iterator_type(
10017                 isl_ctx *ctx);
10019 The AST printer only prints body nodes as blocks if these
10020 blocks cannot be safely omitted.
10021 For example, a C<for> node with one body node will not be
10022 surrounded with braces in C<ISL_FORMAT_C>.
10023 A block will always be printed by setting the following option.
10025         isl_stat isl_options_set_ast_always_print_block(isl_ctx *ctx,
10026                 int val);
10027         int isl_options_get_ast_always_print_block(isl_ctx *ctx);
10029 =head3 Options
10031         #include <isl/ast_build.h>
10032         isl_stat isl_options_set_ast_build_atomic_upper_bound(
10033                 isl_ctx *ctx, int val);
10034         int isl_options_get_ast_build_atomic_upper_bound(
10035                 isl_ctx *ctx);
10036         isl_stat isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
10037                 int val);
10038         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
10039         isl_stat isl_options_set_ast_build_detect_min_max(
10040                 isl_ctx *ctx, int val);
10041         int isl_options_get_ast_build_detect_min_max(
10042                 isl_ctx *ctx);
10043         isl_stat isl_options_set_ast_build_exploit_nested_bounds(
10044                 isl_ctx *ctx, int val);
10045         int isl_options_get_ast_build_exploit_nested_bounds(
10046                 isl_ctx *ctx);
10047         isl_stat isl_options_set_ast_build_group_coscheduled(
10048                 isl_ctx *ctx, int val);
10049         int isl_options_get_ast_build_group_coscheduled(
10050                 isl_ctx *ctx);
10051         isl_stat isl_options_set_ast_build_scale_strides(
10052                 isl_ctx *ctx, int val);
10053         int isl_options_get_ast_build_scale_strides(
10054                 isl_ctx *ctx);
10055         isl_stat isl_options_set_ast_build_allow_else(isl_ctx *ctx,
10056                 int val);
10057         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
10058         isl_stat isl_options_set_ast_build_allow_or(isl_ctx *ctx,
10059                 int val);
10060         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
10062 =over
10064 =item * ast_build_atomic_upper_bound
10066 Generate loop upper bounds that consist of the current loop iterator,
10067 an operator and an expression not involving the iterator.
10068 If this option is not set, then the current loop iterator may appear
10069 several times in the upper bound.
10070 For example, when this option is turned off, AST generation
10071 for the schedule
10073         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
10075 produces
10077         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
10078           A(c0);
10080 When the option is turned on, the following AST is generated
10082         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
10083           A(c0);
10085 =item * ast_build_prefer_pdiv
10087 If this option is turned off, then the AST generation will
10088 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
10089 operators, but no C<isl_ast_op_pdiv_q> or
10090 C<isl_ast_op_pdiv_r> operators.
10091 If this option is turned on, then C<isl> will try to convert
10092 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
10093 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
10095 =item * ast_build_detect_min_max
10097 If this option is turned on, then C<isl> will try and detect
10098 min or max-expressions when building AST expressions from
10099 piecewise affine expressions.
10101 =item * ast_build_exploit_nested_bounds
10103 Simplify conditions based on bounds of nested for loops.
10104 In particular, remove conditions that are implied by the fact
10105 that one or more nested loops have at least one iteration,
10106 meaning that the upper bound is at least as large as the lower bound.
10107 For example, when this option is turned off, AST generation
10108 for the schedule
10110         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
10111                                         0 <= j <= M }
10113 produces
10115         if (M >= 0)
10116           for (int c0 = 0; c0 <= N; c0 += 1)
10117             for (int c1 = 0; c1 <= M; c1 += 1)
10118               A(c0, c1);
10120 When the option is turned on, the following AST is generated
10122         for (int c0 = 0; c0 <= N; c0 += 1)
10123           for (int c1 = 0; c1 <= M; c1 += 1)
10124             A(c0, c1);
10126 =item * ast_build_group_coscheduled
10128 If two domain elements are assigned the same schedule point, then
10129 they may be executed in any order and they may even appear in different
10130 loops.  If this options is set, then the AST generator will make
10131 sure that coscheduled domain elements do not appear in separate parts
10132 of the AST.  This is useful in case of nested AST generation
10133 if the outer AST generation is given only part of a schedule
10134 and the inner AST generation should handle the domains that are
10135 coscheduled by this initial part of the schedule together.
10136 For example if an AST is generated for a schedule
10138         { A[i] -> [0]; B[i] -> [0] }
10140 then the C<isl_ast_build_set_create_leaf> callback described
10141 below may get called twice, once for each domain.
10142 Setting this option ensures that the callback is only called once
10143 on both domains together.
10145 =item * ast_build_separation_bounds
10147 This option specifies which bounds to use during separation.
10148 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
10149 then all (possibly implicit) bounds on the current dimension will
10150 be used during separation.
10151 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
10152 then only those bounds that are explicitly available will
10153 be used during separation.
10155 =item * ast_build_scale_strides
10157 This option specifies whether the AST generator is allowed
10158 to scale down iterators of strided loops.
10160 =item * ast_build_allow_else
10162 This option specifies whether the AST generator is allowed
10163 to construct if statements with else branches.
10165 =item * ast_build_allow_or
10167 This option specifies whether the AST generator is allowed
10168 to construct if conditions with disjunctions.
10170 =back
10172 =head3 AST Generation Options (Schedule Tree)
10174 In case of AST construction from a schedule tree, the options
10175 that control how an AST is created from the individual schedule
10176 dimensions are stored in the band nodes of the tree
10177 (see L</"Schedule Trees">).
10179 In particular, a schedule dimension can be handled in four
10180 different ways, atomic, separate, unroll or the default.
10181 This loop AST generation type can be set using
10182 C<isl_schedule_node_band_member_set_ast_loop_type>.
10183 Alternatively,
10184 the first three can be selected by including a one-dimensional
10185 element with as value the position of the schedule dimension
10186 within the band and as name one of C<atomic>, C<separate>
10187 or C<unroll> in the options
10188 set by C<isl_schedule_node_band_set_ast_build_options>.
10189 Only one of these three may be specified for
10190 any given schedule dimension within a band node.
10191 If none of these is specified, then the default
10192 is used.  The meaning of the options is as follows.
10194 =over
10196 =item C<atomic>
10198 When this option is specified, the AST generator will make
10199 sure that a given domains space only appears in a single
10200 loop at the specified level.
10202 For example, for the schedule tree
10204         domain: "{ a[i] : 0 <= i < 10; b[i] : 0 <= i < 10 }"
10205         child:
10206           schedule: "[{ a[i] -> [i]; b[i] -> [i+1] }]"
10207           options: "{ atomic[x] }"
10209 the following AST will be generated
10211         for (int c0 = 0; c0 <= 10; c0 += 1) {
10212           if (c0 >= 1)
10213             b(c0 - 1);
10214           if (c0 <= 9)
10215             a(c0);
10216         }
10218 On the other hand, for the schedule tree
10220         domain: "{ a[i] : 0 <= i < 10; b[i] : 0 <= i < 10 }"
10221         child:
10222           schedule: "[{ a[i] -> [i]; b[i] -> [i+1] }]"
10223           options: "{ separate[x] }"
10225 the following AST will be generated
10227         {
10228           a(0);
10229           for (int c0 = 1; c0 <= 9; c0 += 1) {
10230             b(c0 - 1);
10231             a(c0);
10232           }
10233           b(9);
10234         }
10236 If neither C<atomic> nor C<separate> is specified, then the AST generator
10237 may produce either of these two results or some intermediate form.
10239 =item C<separate>
10241 When this option is specified, the AST generator will
10242 split the domain of the specified schedule dimension
10243 into pieces with a fixed set of statements for which
10244 instances need to be executed by the iterations in
10245 the schedule domain part.  This option tends to avoid
10246 the generation of guards inside the corresponding loops.
10247 See also the C<atomic> option.
10249 =item C<unroll>
10251 When this option is specified, the AST generator will
10252 I<completely> unroll the corresponding schedule dimension.
10253 It is the responsibility of the user to ensure that such
10254 unrolling is possible.
10255 To obtain a partial unrolling, the user should apply an additional
10256 strip-mining to the schedule and fully unroll the inner schedule
10257 dimension.
10259 =back
10261 The C<isolate> option is a bit more involved.  It allows the user
10262 to isolate a range of schedule dimension values from smaller and
10263 greater values.  Additionally, the user may specify a different
10264 atomic/separate/unroll choice for the isolated part and the remaining
10265 parts.  The typical use case of the C<isolate> option is to isolate
10266 full tiles from partial tiles.
10267 The part that needs to be isolated may depend on outer schedule dimensions.
10268 The option therefore needs to be able to reference those outer schedule
10269 dimensions.  In particular, the space of the C<isolate> option is that
10270 of a wrapped map with as domain the flat product of all outer band nodes
10271 and as range the space of the current band node.
10272 The atomic/separate/unroll choice for the isolated part is determined
10273 by an option that lives in an unnamed wrapped space with as domain
10274 a zero-dimensional C<isolate> space and as range the regular
10275 C<atomic>, C<separate> or C<unroll> space.
10276 This option may also be set directly using
10277 C<isl_schedule_node_band_member_set_isolate_ast_loop_type>.
10278 The atomic/separate/unroll choice for the remaining part is determined
10279 by the regular C<atomic>, C<separate> or C<unroll> option.
10280 Since the C<isolate> option references outer schedule dimensions,
10281 its use in a band node causes any tree containing the node
10282 to be considered anchored.
10284 As an example, consider the isolation of full tiles from partial tiles
10285 in a tiling of a triangular domain.  The original schedule is as follows.
10287         domain: "{ A[i,j] : 0 <= i,j and i + j <= 100 }"
10288         child:
10289           schedule: "[{ A[i,j] -> [floor(i/10)] }, \
10290                 { A[i,j] -> [floor(j/10)] }, \
10291                 { A[i,j] -> [i] }, { A[i,j] -> [j] }]"
10293 The output is
10295         for (int c0 = 0; c0 <= 10; c0 += 1)
10296           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
10297             for (int c2 = 10 * c0;
10298                  c2 <= min(10 * c0 + 9, -10 * c1 + 100); c2 += 1)
10299               for (int c3 = 10 * c1;
10300                    c3 <= min(10 * c1 + 9, -c2 + 100); c3 += 1)
10301                 A(c2, c3);
10303 Isolating the full tiles, we have the following input
10305         domain: "{ A[i,j] : 0 <= i,j and i + j <= 100 }"
10306         child:
10307           schedule: "[{ A[i,j] -> [floor(i/10)] }, \
10308                 { A[i,j] -> [floor(j/10)] }, \
10309                 { A[i,j] -> [i] }, { A[i,j] -> [j] }]"
10310           options: "{ isolate[[] -> [a,b,c,d]] : 0 <= 10a,10b and \
10311                 10a+9+10b+9 <= 100 }"
10313 and output
10315         {
10316           for (int c0 = 0; c0 <= 8; c0 += 1) {
10317             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
10318               for (int c2 = 10 * c0;
10319                    c2 <= 10 * c0 + 9; c2 += 1)
10320                 for (int c3 = 10 * c1;
10321                      c3 <= 10 * c1 + 9; c3 += 1)
10322                   A(c2, c3);
10323             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
10324               for (int c2 = 10 * c0;
10325                    c2 <= min(10 * c0 + 9, -10 * c1 + 100); c2 += 1)
10326                 for (int c3 = 10 * c1;
10327                      c3 <= min(10 * c1 + 9, -c2 + 100); c3 += 1)
10328                   A(c2, c3);
10329           }
10330           for (int c0 = 9; c0 <= 10; c0 += 1)
10331             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
10332               for (int c2 = 10 * c0;
10333                    c2 <= min(10 * c0 + 9, -10 * c1 + 100); c2 += 1)
10334                 for (int c3 = 10 * c1;
10335                      c3 <= min(10 * c1 + 9, -c2 + 100); c3 += 1)
10336                   A(c2, c3);
10337         }
10339 We may then additionally unroll the innermost loop of the isolated part
10341         domain: "{ A[i,j] : 0 <= i,j and i + j <= 100 }"
10342         child:
10343           schedule: "[{ A[i,j] -> [floor(i/10)] }, \
10344                 { A[i,j] -> [floor(j/10)] }, \
10345                 { A[i,j] -> [i] }, { A[i,j] -> [j] }]"
10346           options: "{ isolate[[] -> [a,b,c,d]] : 0 <= 10a,10b and \
10347                 10a+9+10b+9 <= 100; [isolate[] -> unroll[3]] }"
10349 to obtain
10351         {
10352           for (int c0 = 0; c0 <= 8; c0 += 1) {
10353             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
10354               for (int c2 = 10 * c0; c2 <= 10 * c0 + 9; c2 += 1) {
10355                 A(c2, 10 * c1);
10356                 A(c2, 10 * c1 + 1);
10357                 A(c2, 10 * c1 + 2);
10358                 A(c2, 10 * c1 + 3);
10359                 A(c2, 10 * c1 + 4);
10360                 A(c2, 10 * c1 + 5);
10361                 A(c2, 10 * c1 + 6);
10362                 A(c2, 10 * c1 + 7);
10363                 A(c2, 10 * c1 + 8);
10364                 A(c2, 10 * c1 + 9);
10365               }
10366             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
10367               for (int c2 = 10 * c0;
10368                    c2 <= min(10 * c0 + 9, -10 * c1 + 100); c2 += 1)
10369                 for (int c3 = 10 * c1;
10370                      c3 <= min(10 * c1 + 9, -c2 + 100); c3 += 1)
10371                   A(c2, c3);
10372           }
10373           for (int c0 = 9; c0 <= 10; c0 += 1)
10374             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
10375               for (int c2 = 10 * c0;
10376                    c2 <= min(10 * c0 + 9, -10 * c1 + 100); c2 += 1)
10377                 for (int c3 = 10 * c1;
10378                      c3 <= min(10 * c1 + 9, -c2 + 100); c3 += 1)
10379                   A(c2, c3);
10380         }
10383 =head3 AST Generation Options (Schedule Map)
10385 In case of AST construction using
10386 C<isl_ast_build_node_from_schedule_map>, the options
10387 that control how an AST is created from the individual schedule
10388 dimensions are stored in the C<isl_ast_build>.
10389 They can be set using the following function.
10391         #include <isl/ast_build.h>
10392         __isl_give isl_ast_build *
10393         isl_ast_build_set_options(
10394                 __isl_take isl_ast_build *control,
10395                 __isl_take isl_union_map *options);
10397 The options are encoded in an C<isl_union_map>.
10398 The domain of this union relation refers to the schedule domain,
10399 i.e., the range of the schedule passed
10400 to C<isl_ast_build_node_from_schedule_map>.
10401 In the case of nested AST generation (see L</"Nested AST Generation">),
10402 the domain of C<options> should refer to the extra piece of the schedule.
10403 That is, it should be equal to the range of the wrapped relation in the
10404 range of the schedule.
10405 The range of the options can consist of elements in one or more spaces,
10406 the names of which determine the effect of the option.
10407 The values of the range typically also refer to the schedule dimension
10408 to which the option applies.  In case of nested AST generation
10409 (see L</"Nested AST Generation">), these values refer to the position
10410 of the schedule dimension within the innermost AST generation.
10411 The constraints on the domain elements of
10412 the option should only refer to this dimension and earlier dimensions.
10413 We consider the following spaces.
10415 =over
10417 =item C<separation_class>
10419 B<This option has been deprecated.  Use the isolate option on
10420 schedule trees instead.>
10422 This space is a wrapped relation between two one dimensional spaces.
10423 The input space represents the schedule dimension to which the option
10424 applies and the output space represents the separation class.
10425 While constructing a loop corresponding to the specified schedule
10426 dimension(s), the AST generator will try to generate separate loops
10427 for domain elements that are assigned different classes.
10428 If only some of the elements are assigned a class, then those elements
10429 that are not assigned any class will be treated as belonging to a class
10430 that is separate from the explicitly assigned classes.
10431 The typical use case for this option is to separate full tiles from
10432 partial tiles.
10433 The other options, described below, are applied after the separation
10434 into classes.
10436 As an example, consider the separation into full and partial tiles
10437 of a tiling of a triangular domain.
10438 Take, for example, the domain
10440         { A[i,j] : 0 <= i,j and i + j <= 100 }
10442 and a tiling into tiles of 10 by 10.  The input to the AST generator
10443 is then the schedule
10445         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
10446                                                 i + j <= 100 }
10448 Without any options, the following AST is generated
10450         for (int c0 = 0; c0 <= 10; c0 += 1)
10451           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
10452             for (int c2 = 10 * c0;
10453                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
10454                  c2 += 1)
10455               for (int c3 = 10 * c1;
10456                    c3 <= min(10 * c1 + 9, -c2 + 100);
10457                    c3 += 1)
10458                 A(c2, c3);
10460 Separation into full and partial tiles can be obtained by assigning
10461 a class, say C<0>, to the full tiles.  The full tiles are represented by those
10462 values of the first and second schedule dimensions for which there are
10463 values of the third and fourth dimensions to cover an entire tile.
10464 That is, we need to specify the following option
10466         { [a,b,c,d] -> separation_class[[0]->[0]] :
10467                 exists b': 0 <= 10a,10b' and
10468                            10a+9+10b'+9 <= 100;
10469           [a,b,c,d] -> separation_class[[1]->[0]] :
10470                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
10472 which simplifies to
10474         { [a, b, c, d] -> separation_class[[1] -> [0]] :
10475                 a >= 0 and b >= 0 and b <= 8 - a;
10476           [a, b, c, d] -> separation_class[[0] -> [0]] :
10477                 a >= 0 and a <= 8 }
10479 With this option, the generated AST is as follows
10481         {
10482           for (int c0 = 0; c0 <= 8; c0 += 1) {
10483             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
10484               for (int c2 = 10 * c0;
10485                    c2 <= 10 * c0 + 9; c2 += 1)
10486                 for (int c3 = 10 * c1;
10487                      c3 <= 10 * c1 + 9; c3 += 1)
10488                   A(c2, c3);
10489             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
10490               for (int c2 = 10 * c0;
10491                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
10492                    c2 += 1)
10493                 for (int c3 = 10 * c1;
10494                      c3 <= min(-c2 + 100, 10 * c1 + 9);
10495                      c3 += 1)
10496                   A(c2, c3);
10497           }
10498           for (int c0 = 9; c0 <= 10; c0 += 1)
10499             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
10500               for (int c2 = 10 * c0;
10501                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
10502                    c2 += 1)
10503                 for (int c3 = 10 * c1;
10504                      c3 <= min(10 * c1 + 9, -c2 + 100);
10505                      c3 += 1)
10506                   A(c2, c3);
10507         }
10509 =item C<separate>
10511 This is a single-dimensional space representing the schedule dimension(s)
10512 to which ``separation'' should be applied.  Separation tries to split
10513 a loop into several pieces if this can avoid the generation of guards
10514 inside the loop.
10515 See also the C<atomic> option.
10517 =item C<atomic>
10519 This is a single-dimensional space representing the schedule dimension(s)
10520 for which the domains should be considered ``atomic''.  That is, the
10521 AST generator will make sure that any given domain space will only appear
10522 in a single loop at the specified level.
10524 Consider the following schedule
10526         { a[i] -> [i] : 0 <= i < 10;
10527           b[i] -> [i+1] : 0 <= i < 10 }
10529 If the following option is specified
10531         { [i] -> separate[x] }
10533 then the following AST will be generated
10535         {
10536           a(0);
10537           for (int c0 = 1; c0 <= 9; c0 += 1) {
10538             a(c0);
10539             b(c0 - 1);
10540           }
10541           b(9);
10542         }
10544 If, on the other hand, the following option is specified
10546         { [i] -> atomic[x] }
10548 then the following AST will be generated
10550         for (int c0 = 0; c0 <= 10; c0 += 1) {
10551           if (c0 <= 9)
10552             a(c0);
10553           if (c0 >= 1)
10554             b(c0 - 1);
10555         }
10557 If neither C<atomic> nor C<separate> is specified, then the AST generator
10558 may produce either of these two results or some intermediate form.
10560 =item C<unroll>
10562 This is a single-dimensional space representing the schedule dimension(s)
10563 that should be I<completely> unrolled.
10564 To obtain a partial unrolling, the user should apply an additional
10565 strip-mining to the schedule and fully unroll the inner loop.
10567 =back
10569 =head3 Fine-grained Control over AST Generation
10571 Besides specifying the constraints on the parameters,
10572 an C<isl_ast_build> object can be used to control
10573 various aspects of the AST generation process.
10574 In case of AST construction using
10575 C<isl_ast_build_node_from_schedule_map>,
10576 the most prominent way of control is through ``options'',
10577 as explained above.
10579 Additional control is available through the following functions.
10581         #include <isl/ast_build.h>
10582         __isl_give isl_ast_build *
10583         isl_ast_build_set_iterators(
10584                 __isl_take isl_ast_build *control,
10585                 __isl_take isl_id_list *iterators);
10587 The function C<isl_ast_build_set_iterators> allows the user to
10588 specify a list of iterator C<isl_id>s to be used as iterators.
10589 If the input schedule is injective, then
10590 the number of elements in this list should be as large as the dimension
10591 of the schedule space, but no direct correspondence should be assumed
10592 between dimensions and elements.
10593 If the input schedule is not injective, then an additional number
10594 of C<isl_id>s equal to the largest dimension of the input domains
10595 may be required.
10596 If the number of provided C<isl_id>s is insufficient, then additional
10597 names are automatically generated.
10599         #include <isl/ast_build.h>
10600         __isl_give isl_ast_build *
10601         isl_ast_build_set_create_leaf(
10602                 __isl_take isl_ast_build *control,
10603                 __isl_give isl_ast_node *(*fn)(
10604                         __isl_take isl_ast_build *build,
10605                         void *user), void *user);
10608 C<isl_ast_build_set_create_leaf> function allows for the
10609 specification of a callback that should be called whenever the AST
10610 generator arrives at an element of the schedule domain.
10611 The callback should return an AST node that should be inserted
10612 at the corresponding position of the AST.  The default action (when
10613 the callback is not set) is to continue generating parts of the AST to scan
10614 all the domain elements associated to the schedule domain element
10615 and to insert user nodes, ``calling'' the domain element, for each of them.
10616 The C<build> argument contains the current state of the C<isl_ast_build>.
10617 To ease nested AST generation (see L</"Nested AST Generation">),
10618 all control information that is
10619 specific to the current AST generation such as the options and
10620 the callbacks has been removed from this C<isl_ast_build>.
10621 The callback would typically return the result of a nested
10622 AST generation or a
10623 user defined node created using the following function.
10625         #include <isl/ast.h>
10626         __isl_give isl_ast_node *isl_ast_node_alloc_user(
10627                 __isl_take isl_ast_expr *expr);
10629         #include <isl/ast_build.h>
10630         __isl_give isl_ast_build *
10631         isl_ast_build_set_at_each_domain(
10632                 __isl_take isl_ast_build *build,
10633                 __isl_give isl_ast_node *(*fn)(
10634                         __isl_take isl_ast_node *node,
10635                         __isl_keep isl_ast_build *build,
10636                         void *user), void *user);
10637         __isl_give isl_ast_build *
10638         isl_ast_build_set_before_each_for(
10639                 __isl_take isl_ast_build *build,
10640                 __isl_give isl_id *(*fn)(
10641                         __isl_keep isl_ast_build *build,
10642                         void *user), void *user);
10643         __isl_give isl_ast_build *
10644         isl_ast_build_set_after_each_for(
10645                 __isl_take isl_ast_build *build,
10646                 __isl_give isl_ast_node *(*fn)(
10647                         __isl_take isl_ast_node *node,
10648                         __isl_keep isl_ast_build *build,
10649                         void *user), void *user);
10650         __isl_give isl_ast_build *
10651         isl_ast_build_set_before_each_mark(
10652                 __isl_take isl_ast_build *build,
10653                 isl_stat (*fn)(__isl_keep isl_id *mark,
10654                         __isl_keep isl_ast_build *build,
10655                         void *user), void *user);
10656         __isl_give isl_ast_build *
10657         isl_ast_build_set_after_each_mark(
10658                 __isl_take isl_ast_build *build,
10659                 __isl_give isl_ast_node *(*fn)(
10660                         __isl_take isl_ast_node *node,
10661                         __isl_keep isl_ast_build *build,
10662                         void *user), void *user);
10664 The callback set by C<isl_ast_build_set_at_each_domain> will
10665 be called for each domain AST node.
10666 The callbacks set by C<isl_ast_build_set_before_each_for>
10667 and C<isl_ast_build_set_after_each_for> will be called
10668 for each for AST node.  The first will be called in depth-first
10669 pre-order, while the second will be called in depth-first post-order.
10670 Since C<isl_ast_build_set_before_each_for> is called before the for
10671 node is actually constructed, it is only passed an C<isl_ast_build>.
10672 The returned C<isl_id> will be added as an annotation (using
10673 C<isl_ast_node_set_annotation>) to the constructed for node.
10674 In particular, if the user has also specified an C<after_each_for>
10675 callback, then the annotation can be retrieved from the node passed to
10676 that callback using C<isl_ast_node_get_annotation>.
10677 The callbacks set by C<isl_ast_build_set_before_each_mark>
10678 and C<isl_ast_build_set_after_each_mark> will be called for each
10679 mark AST node that is created, i.e., for each mark schedule node
10680 in the input schedule tree.  The first will be called in depth-first
10681 pre-order, while the second will be called in depth-first post-order.
10682 Since the callback set by C<isl_ast_build_set_before_each_mark>
10683 is called before the mark AST node is actually constructed, it is passed
10684 the identifier of the mark node.
10685 All callbacks should C<NULL> (or -1) on failure.
10686 The given C<isl_ast_build> can be used to create new
10687 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
10688 or C<isl_ast_build_call_from_pw_multi_aff>.
10690 =head3 Nested AST Generation
10692 C<isl> allows the user to create an AST within the context
10693 of another AST.  These nested ASTs are created using the
10694 same C<isl_ast_build_node_from_schedule_map> function that is used to create
10695 the outer AST.  The C<build> argument should be an C<isl_ast_build>
10696 passed to a callback set by
10697 C<isl_ast_build_set_create_leaf>.
10698 The space of the range of the C<schedule> argument should refer
10699 to this build.  In particular, the space should be a wrapped
10700 relation and the domain of this wrapped relation should be the
10701 same as that of the range of the schedule returned by
10702 C<isl_ast_build_get_schedule> below.
10703 In practice, the new schedule is typically
10704 created by calling C<isl_union_map_range_product> on the old schedule
10705 and some extra piece of the schedule.
10706 The space of the schedule domain is also available from
10707 the C<isl_ast_build>.
10709         #include <isl/ast_build.h>
10710         __isl_give isl_union_map *isl_ast_build_get_schedule(
10711                 __isl_keep isl_ast_build *build);
10712         __isl_give isl_space *isl_ast_build_get_schedule_space(
10713                 __isl_keep isl_ast_build *build);
10714         __isl_give isl_ast_build *isl_ast_build_restrict(
10715                 __isl_take isl_ast_build *build,
10716                 __isl_take isl_set *set);
10718 The C<isl_ast_build_get_schedule> function returns a (partial)
10719 schedule for the domains elements for which part of the AST still needs to
10720 be generated in the current build.
10721 In particular, the domain elements are mapped to those iterations of the loops
10722 enclosing the current point of the AST generation inside which
10723 the domain elements are executed.
10724 No direct correspondence between
10725 the input schedule and this schedule should be assumed.
10726 The space obtained from C<isl_ast_build_get_schedule_space> can be used
10727 to create a set for C<isl_ast_build_restrict> to intersect
10728 with the current build.  In particular, the set passed to
10729 C<isl_ast_build_restrict> can have additional parameters.
10730 The ids of the set dimensions in the space returned by
10731 C<isl_ast_build_get_schedule_space> correspond to the
10732 iterators of the already generated loops.
10733 The user should not rely on the ids of the output dimensions
10734 of the relations in the union relation returned by
10735 C<isl_ast_build_get_schedule> having any particular value.
10737 =head1 Applications
10739 Although C<isl> is mainly meant to be used as a library,
10740 it also contains some basic applications that use some
10741 of the functionality of C<isl>.
10742 For applications that take one or more polytopes or polyhedra
10743 as input, this input may be specified in either the L<isl format>
10744 or the L<PolyLib format>.
10746 =head2 C<isl_polyhedron_sample>
10748 C<isl_polyhedron_sample> takes a polyhedron as input and prints
10749 an integer element of the polyhedron, if there is any.
10750 The first column in the output is the denominator and is always
10751 equal to 1.  If the polyhedron contains no integer points,
10752 then a vector of length zero is printed.
10754 =head2 C<isl_pip>
10756 C<isl_pip> takes the same input as the C<example> program
10757 from the C<piplib> distribution, i.e., a set of constraints
10758 on the parameters, a line containing only -1 and finally a set
10759 of constraints on a parametric polyhedron.
10760 The coefficients of the parameters appear in the last columns
10761 (but before the final constant column).
10762 The output is the lexicographic minimum of the parametric polyhedron.
10763 As C<isl> currently does not have its own output format, the output
10764 is just a dump of the internal state.
10766 =head2 C<isl_polyhedron_minimize>
10768 C<isl_polyhedron_minimize> computes the minimum of some linear
10769 or affine objective function over the integer points in a polyhedron.
10770 If an affine objective function
10771 is given, then the constant should appear in the last column.
10773 =head2 C<isl_polytope_scan>
10775 Given a polytope, C<isl_polytope_scan> prints
10776 all integer points in the polytope.
10778 =head2 C<isl_codegen>
10780 Given either a schedule tree or a sequence consisting of
10781 a schedule map, a context set and an options relation,
10782 C<isl_codegen> prints out an AST that scans the domain elements
10783 of the schedule in the order of their image(s) taking into account
10784 the constraints in the context set.
10786 =head2 C<isl_schedule>
10788 Given an C<isl_schedule_constraints> object as input,
10789 C<isl_schedule> prints out a schedule that satisfies the given
10790 constraints.