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
9 The C<isl> library offers functionality that is similar
10 to that offered by the C<Omega> and C<Omega+> libraries,
11 but the underlying algorithms are in most cases completely different.
13 The library is by no means complete and some fairly basic
14 functionality is still missing.
15 Still, even in its current form, the library has been successfully
16 used as a backend polyhedral library for the polyhedral
17 scanner C<CLooG> and as part of an equivalence checker of
18 static affine programs.
19 For bug reports, feature requests and questions,
20 visit the the discussion group at
21 L<http://groups.google.com/group/isl-development>.
23 =head2 Backward Incompatible Changes
25 =head3 Changes since isl-0.02
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>.
38 =head3 Changes since isl-0.03
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>.
49 =head3 Changes since isl-0.04
53 =item * All header files have been renamed from C<isl_header.h>
58 =head3 Changes since isl-0.05
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.
81 =head3 Changes since isl-0.06
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.
95 =head3 Changes since isl-0.07
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
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
139 A call to C<isl_qpolynomial_div(div)> call be replaced by
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.
156 =head3 Changes since isl-0.09
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)
171 =head3 Changes since isl-0.10
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.
184 =head3 Changes since isl-0.12
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>.
201 C<isl> is released under the MIT license.
205 Permission is hereby granted, free of charge, to any person obtaining a copy of
206 this software and associated documentation files (the "Software"), to deal in
207 the Software without restriction, including without limitation the rights to
208 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
209 of the Software, and to permit persons to whom the Software is furnished to do
210 so, subject to the following conditions:
212 The above copyright notice and this permission notice shall be included in all
213 copies or substantial portions of the Software.
215 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
216 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
217 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
218 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
219 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
220 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
225 Note that C<isl> currently requires C<GMP>, which is released
226 under the GNU Lesser General Public License (LGPL). This means
227 that code linked against C<isl> is also linked against LGPL code.
231 The source of C<isl> can be obtained either as a tarball
232 or from the git repository. Both are available from
233 L<http://freshmeat.net/projects/isl/>.
234 The installation process depends on how you obtained
237 =head2 Installation from the git repository
241 =item 1 Clone or update the repository
243 The first time the source is obtained, you need to clone
246 git clone git://repo.or.cz/isl.git
248 To obtain updates, you need to pull in the latest changes
252 =item 2 Generate C<configure>
258 After performing the above steps, continue
259 with the L<Common installation instructions>.
261 =head2 Common installation instructions
265 =item 1 Obtain C<GMP>
267 Building C<isl> requires C<GMP>, including its headers files.
268 Your distribution may not provide these header files by default
269 and you may need to install a package called C<gmp-devel> or something
270 similar. Alternatively, C<GMP> can be built from
271 source, available from L<http://gmplib.org/>.
275 C<isl> uses the standard C<autoconf> C<configure> script.
280 optionally followed by some configure options.
281 A complete list of options can be obtained by running
285 Below we discuss some of the more common options.
291 Installation prefix for C<isl>
293 =item C<--with-gmp-prefix>
295 Installation prefix for C<GMP> (architecture-independent files).
297 =item C<--with-gmp-exec-prefix>
299 Installation prefix for C<GMP> (architecture-dependent files).
307 =item 4 Install (optional)
313 =head1 Integer Set Library
315 =head2 Initialization
317 All manipulations of integer sets and relations occur within
318 the context of an C<isl_ctx>.
319 A given C<isl_ctx> can only be used within a single thread.
320 All arguments of a function are required to have been allocated
321 within the same context.
322 There are currently no functions available for moving an object
323 from one C<isl_ctx> to another C<isl_ctx>. This means that
324 there is currently no way of safely moving an object from one
325 thread to another, unless the whole C<isl_ctx> is moved.
327 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
328 freed using C<isl_ctx_free>.
329 All objects allocated within an C<isl_ctx> should be freed
330 before the C<isl_ctx> itself is freed.
332 isl_ctx *isl_ctx_alloc();
333 void isl_ctx_free(isl_ctx *ctx);
337 An C<isl_val> represents an integer value, a rational value
338 or one of three special values, infinity, negative infinity and NaN.
339 Some predefined values can be created using the following functions.
342 __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
343 __isl_give isl_val *isl_val_one(isl_ctx *ctx);
344 __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
345 __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
346 __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
348 Specific integer values can be created using the following functions.
351 __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
353 __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
355 __isl_give isl_val *isl_val_int_from_chunks(isl_ctx *ctx,
356 size_t n, size_t size, const void *chunks);
358 The function C<isl_val_int_from_chunks> constructs an C<isl_val>
359 from the C<n> I<digits>, each consisting of C<size> bytes, stored at C<chunks>.
360 The least significant digit is assumed to be stored first.
362 Value objects can be copied and freed using the following functions.
365 __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
366 void *isl_val_free(__isl_take isl_val *v);
368 They can be inspected using the following functions.
371 isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
372 long isl_val_get_num_si(__isl_keep isl_val *v);
373 long isl_val_get_den_si(__isl_keep isl_val *v);
374 double isl_val_get_d(__isl_keep isl_val *v);
375 size_t isl_val_n_abs_num_chunks(__isl_keep isl_val *v,
377 int isl_val_get_abs_num_chunks(__isl_keep isl_val *v,
378 size_t size, void *chunks);
380 C<isl_val_n_abs_num_chunks> returns the number of I<digits>
381 of C<size> bytes needed to store the absolute value of the
383 C<isl_val_get_abs_num_chunks> stores these digits at C<chunks>,
384 which is assumed to have been preallocated by the caller.
385 The least significant digit is stored first.
386 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si>,
387 C<isl_val_get_d>, C<isl_val_n_abs_num_chunks>
388 and C<isl_val_get_abs_num_chunks> can only be applied to rational values.
390 An C<isl_val> can be modified using the following function.
393 __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
396 The following unary properties are defined on C<isl_val>s.
399 int isl_val_sgn(__isl_keep isl_val *v);
400 int isl_val_is_zero(__isl_keep isl_val *v);
401 int isl_val_is_one(__isl_keep isl_val *v);
402 int isl_val_is_negone(__isl_keep isl_val *v);
403 int isl_val_is_nonneg(__isl_keep isl_val *v);
404 int isl_val_is_nonpos(__isl_keep isl_val *v);
405 int isl_val_is_pos(__isl_keep isl_val *v);
406 int isl_val_is_neg(__isl_keep isl_val *v);
407 int isl_val_is_int(__isl_keep isl_val *v);
408 int isl_val_is_rat(__isl_keep isl_val *v);
409 int isl_val_is_nan(__isl_keep isl_val *v);
410 int isl_val_is_infty(__isl_keep isl_val *v);
411 int isl_val_is_neginfty(__isl_keep isl_val *v);
413 Note that the sign of NaN is undefined.
415 The following binary properties are defined on pairs of C<isl_val>s.
418 int isl_val_lt(__isl_keep isl_val *v1,
419 __isl_keep isl_val *v2);
420 int isl_val_le(__isl_keep isl_val *v1,
421 __isl_keep isl_val *v2);
422 int isl_val_gt(__isl_keep isl_val *v1,
423 __isl_keep isl_val *v2);
424 int isl_val_ge(__isl_keep isl_val *v1,
425 __isl_keep isl_val *v2);
426 int isl_val_eq(__isl_keep isl_val *v1,
427 __isl_keep isl_val *v2);
428 int isl_val_ne(__isl_keep isl_val *v1,
429 __isl_keep isl_val *v2);
431 For integer C<isl_val>s we additionally have the following binary property.
434 int isl_val_is_divisible_by(__isl_keep isl_val *v1,
435 __isl_keep isl_val *v2);
437 An C<isl_val> can also be compared to an integer using the following
438 function. The result is undefined for NaN.
441 int isl_val_cmp_si(__isl_keep isl_val *v, long i);
443 The following unary operations are available on C<isl_val>s.
446 __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
447 __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
448 __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
449 __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
450 __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
452 The following binary operations are available on C<isl_val>s.
455 __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
456 __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
457 __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
458 __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
459 __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
460 __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
461 __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
462 __isl_take isl_val *v2);
463 __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
464 __isl_take isl_val *v2);
465 __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
466 __isl_take isl_val *v2);
467 __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
469 __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
470 __isl_take isl_val *v2);
471 __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
473 __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
474 __isl_take isl_val *v2);
475 __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
477 __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
478 __isl_take isl_val *v2);
480 On integer values, we additionally have the following operations.
483 __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
484 __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
485 __isl_take isl_val *v2);
486 __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
487 __isl_take isl_val *v2);
488 __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
489 __isl_take isl_val *v2, __isl_give isl_val **x,
490 __isl_give isl_val **y);
492 The function C<isl_val_gcdext> returns the greatest common divisor g
493 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
494 that C<*x> * C<v1> + C<*y> * C<v2> = g.
496 A value can be read from input using
499 __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
502 A value can be printed using
505 __isl_give isl_printer *isl_printer_print_val(
506 __isl_take isl_printer *p, __isl_keep isl_val *v);
508 =head3 GMP specific functions
510 These functions are only available if C<isl> has been compiled with C<GMP>
513 Specific integer and rational values can be created from C<GMP> values using
514 the following functions.
516 #include <isl/val_gmp.h>
517 __isl_give isl_val *isl_val_int_from_gmp(isl_ctx *ctx,
519 __isl_give isl_val *isl_val_from_gmp(isl_ctx *ctx,
520 const mpz_t n, const mpz_t d);
522 The numerator and denominator of a rational value can be extracted as
523 C<GMP> values using the following functions.
525 #include <isl/val_gmp.h>
526 int isl_val_get_num_gmp(__isl_keep isl_val *v, mpz_t z);
527 int isl_val_get_den_gmp(__isl_keep isl_val *v, mpz_t z);
529 =head2 Sets and Relations
531 C<isl> uses six types of objects for representing sets and relations,
532 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
533 C<isl_union_set> and C<isl_union_map>.
534 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
535 can be described as a conjunction of affine constraints, while
536 C<isl_set> and C<isl_map> represent unions of
537 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
538 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
539 to live in the same space. C<isl_union_set>s and C<isl_union_map>s
540 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
541 where spaces are considered different if they have a different number
542 of dimensions and/or different names (see L<"Spaces">).
543 The difference between sets and relations (maps) is that sets have
544 one set of variables, while relations have two sets of variables,
545 input variables and output variables.
547 =head2 Memory Management
549 Since a high-level operation on sets and/or relations usually involves
550 several substeps and since the user is usually not interested in
551 the intermediate results, most functions that return a new object
552 will also release all the objects passed as arguments.
553 If the user still wants to use one or more of these arguments
554 after the function call, she should pass along a copy of the
555 object rather than the object itself.
556 The user is then responsible for making sure that the original
557 object gets used somewhere else or is explicitly freed.
559 The arguments and return values of all documented functions are
560 annotated to make clear which arguments are released and which
561 arguments are preserved. In particular, the following annotations
568 C<__isl_give> means that a new object is returned.
569 The user should make sure that the returned pointer is
570 used exactly once as a value for an C<__isl_take> argument.
571 In between, it can be used as a value for as many
572 C<__isl_keep> arguments as the user likes.
573 There is one exception, and that is the case where the
574 pointer returned is C<NULL>. Is this case, the user
575 is free to use it as an C<__isl_take> argument or not.
579 C<__isl_take> means that the object the argument points to
580 is taken over by the function and may no longer be used
581 by the user as an argument to any other function.
582 The pointer value must be one returned by a function
583 returning an C<__isl_give> pointer.
584 If the user passes in a C<NULL> value, then this will
585 be treated as an error in the sense that the function will
586 not perform its usual operation. However, it will still
587 make sure that all the other C<__isl_take> arguments
592 C<__isl_keep> means that the function will only use the object
593 temporarily. After the function has finished, the user
594 can still use it as an argument to other functions.
595 A C<NULL> value will be treated in the same way as
596 a C<NULL> value for an C<__isl_take> argument.
600 =head2 Error Handling
602 C<isl> supports different ways to react in case a runtime error is triggered.
603 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
604 with two maps that have incompatible spaces. There are three possible ways
605 to react on error: to warn, to continue or to abort.
607 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
608 the last error in the corresponding C<isl_ctx> and the function in which the
609 error was triggered returns C<NULL>. An error does not corrupt internal state,
610 such that isl can continue to be used. C<isl> also provides functions to
611 read the last error and to reset the memory that stores the last error. The
612 last error is only stored for information purposes. Its presence does not
613 change the behavior of C<isl>. Hence, resetting an error is not required to
614 continue to use isl, but only to observe new errors.
617 enum isl_error isl_ctx_last_error(isl_ctx *ctx);
618 void isl_ctx_reset_error(isl_ctx *ctx);
620 Another option is to continue on error. This is similar to warn on error mode,
621 except that C<isl> does not print any warning. This allows a program to
622 implement its own error reporting.
624 The last option is to directly abort the execution of the program from within
625 the isl library. This makes it obviously impossible to recover from an error,
626 but it allows to directly spot the error location. By aborting on error,
627 debuggers break at the location the error occurred and can provide a stack
628 trace. Other tools that automatically provide stack traces on abort or that do
629 not want to continue execution after an error was triggered may also prefer to
632 The on error behavior of isl can be specified by calling
633 C<isl_options_set_on_error> or by setting the command line option
634 C<--isl-on-error>. Valid arguments for the function call are
635 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
636 choices for the command line option are C<warn>, C<continue> and C<abort>.
637 It is also possible to query the current error mode.
639 #include <isl/options.h>
640 int isl_options_set_on_error(isl_ctx *ctx, int val);
641 int isl_options_get_on_error(isl_ctx *ctx);
645 Identifiers are used to identify both individual dimensions
646 and tuples of dimensions. They consist of an optional name and an optional
647 user pointer. The name and the user pointer cannot both be C<NULL>, however.
648 Identifiers with the same name but different pointer values
649 are considered to be distinct.
650 Similarly, identifiers with different names but the same pointer value
651 are also considered to be distinct.
652 Equal identifiers are represented using the same object.
653 Pairs of identifiers can therefore be tested for equality using the
655 Identifiers can be constructed, copied, freed, inspected and printed
656 using the following functions.
659 __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
660 __isl_keep const char *name, void *user);
661 __isl_give isl_id *isl_id_set_free_user(
662 __isl_take isl_id *id,
663 __isl_give void (*free_user)(void *user));
664 __isl_give isl_id *isl_id_copy(isl_id *id);
665 void *isl_id_free(__isl_take isl_id *id);
667 isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
668 void *isl_id_get_user(__isl_keep isl_id *id);
669 __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
671 __isl_give isl_printer *isl_printer_print_id(
672 __isl_take isl_printer *p, __isl_keep isl_id *id);
674 The callback set by C<isl_id_set_free_user> is called on the user
675 pointer when the last reference to the C<isl_id> is freed.
676 Note that C<isl_id_get_name> returns a pointer to some internal
677 data structure, so the result can only be used while the
678 corresponding C<isl_id> is alive.
682 Whenever a new set, relation or similiar object is created from scratch,
683 the space in which it lives needs to be specified using an C<isl_space>.
684 Each space involves zero or more parameters and zero, one or two
685 tuples of set or input/output dimensions. The parameters and dimensions
686 are identified by an C<isl_dim_type> and a position.
687 The type C<isl_dim_param> refers to parameters,
688 the type C<isl_dim_set> refers to set dimensions (for spaces
689 with a single tuple of dimensions) and the types C<isl_dim_in>
690 and C<isl_dim_out> refer to input and output dimensions
691 (for spaces with two tuples of dimensions).
692 Local spaces (see L</"Local Spaces">) also contain dimensions
693 of type C<isl_dim_div>.
694 Note that parameters are only identified by their position within
695 a given object. Across different objects, parameters are (usually)
696 identified by their names or identifiers. Only unnamed parameters
697 are identified by their positions across objects. The use of unnamed
698 parameters is discouraged.
700 #include <isl/space.h>
701 __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
702 unsigned nparam, unsigned n_in, unsigned n_out);
703 __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
705 __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
706 unsigned nparam, unsigned dim);
707 __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
708 void *isl_space_free(__isl_take isl_space *space);
709 unsigned isl_space_dim(__isl_keep isl_space *space,
710 enum isl_dim_type type);
712 The space used for creating a parameter domain
713 needs to be created using C<isl_space_params_alloc>.
714 For other sets, the space
715 needs to be created using C<isl_space_set_alloc>, while
716 for a relation, the space
717 needs to be created using C<isl_space_alloc>.
718 C<isl_space_dim> can be used
719 to find out the number of dimensions of each type in
720 a space, where type may be
721 C<isl_dim_param>, C<isl_dim_in> (only for relations),
722 C<isl_dim_out> (only for relations), C<isl_dim_set>
723 (only for sets) or C<isl_dim_all>.
725 To check whether a given space is that of a set or a map
726 or whether it is a parameter space, use these functions:
728 #include <isl/space.h>
729 int isl_space_is_params(__isl_keep isl_space *space);
730 int isl_space_is_set(__isl_keep isl_space *space);
731 int isl_space_is_map(__isl_keep isl_space *space);
733 Spaces can be compared using the following functions:
735 #include <isl/space.h>
736 int isl_space_is_equal(__isl_keep isl_space *space1,
737 __isl_keep isl_space *space2);
738 int isl_space_is_domain(__isl_keep isl_space *space1,
739 __isl_keep isl_space *space2);
740 int isl_space_is_range(__isl_keep isl_space *space1,
741 __isl_keep isl_space *space2);
743 C<isl_space_is_domain> checks whether the first argument is equal
744 to the domain of the second argument. This requires in particular that
745 the first argument is a set space and that the second argument
748 It is often useful to create objects that live in the
749 same space as some other object. This can be accomplished
750 by creating the new objects
751 (see L<Creating New Sets and Relations> or
752 L<Creating New (Piecewise) Quasipolynomials>) based on the space
753 of the original object.
756 __isl_give isl_space *isl_basic_set_get_space(
757 __isl_keep isl_basic_set *bset);
758 __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
760 #include <isl/union_set.h>
761 __isl_give isl_space *isl_union_set_get_space(
762 __isl_keep isl_union_set *uset);
765 __isl_give isl_space *isl_basic_map_get_space(
766 __isl_keep isl_basic_map *bmap);
767 __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
769 #include <isl/union_map.h>
770 __isl_give isl_space *isl_union_map_get_space(
771 __isl_keep isl_union_map *umap);
773 #include <isl/constraint.h>
774 __isl_give isl_space *isl_constraint_get_space(
775 __isl_keep isl_constraint *constraint);
777 #include <isl/polynomial.h>
778 __isl_give isl_space *isl_qpolynomial_get_domain_space(
779 __isl_keep isl_qpolynomial *qp);
780 __isl_give isl_space *isl_qpolynomial_get_space(
781 __isl_keep isl_qpolynomial *qp);
782 __isl_give isl_space *isl_qpolynomial_fold_get_space(
783 __isl_keep isl_qpolynomial_fold *fold);
784 __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
785 __isl_keep isl_pw_qpolynomial *pwqp);
786 __isl_give isl_space *isl_pw_qpolynomial_get_space(
787 __isl_keep isl_pw_qpolynomial *pwqp);
788 __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
789 __isl_keep isl_pw_qpolynomial_fold *pwf);
790 __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
791 __isl_keep isl_pw_qpolynomial_fold *pwf);
792 __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
793 __isl_keep isl_union_pw_qpolynomial *upwqp);
794 __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
795 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
798 __isl_give isl_space *isl_multi_val_get_space(
799 __isl_keep isl_multi_val *mv);
802 __isl_give isl_space *isl_aff_get_domain_space(
803 __isl_keep isl_aff *aff);
804 __isl_give isl_space *isl_aff_get_space(
805 __isl_keep isl_aff *aff);
806 __isl_give isl_space *isl_pw_aff_get_domain_space(
807 __isl_keep isl_pw_aff *pwaff);
808 __isl_give isl_space *isl_pw_aff_get_space(
809 __isl_keep isl_pw_aff *pwaff);
810 __isl_give isl_space *isl_multi_aff_get_domain_space(
811 __isl_keep isl_multi_aff *maff);
812 __isl_give isl_space *isl_multi_aff_get_space(
813 __isl_keep isl_multi_aff *maff);
814 __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
815 __isl_keep isl_pw_multi_aff *pma);
816 __isl_give isl_space *isl_pw_multi_aff_get_space(
817 __isl_keep isl_pw_multi_aff *pma);
818 __isl_give isl_space *isl_union_pw_multi_aff_get_space(
819 __isl_keep isl_union_pw_multi_aff *upma);
820 __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
821 __isl_keep isl_multi_pw_aff *mpa);
822 __isl_give isl_space *isl_multi_pw_aff_get_space(
823 __isl_keep isl_multi_pw_aff *mpa);
825 #include <isl/point.h>
826 __isl_give isl_space *isl_point_get_space(
827 __isl_keep isl_point *pnt);
829 The identifiers or names of the individual dimensions may be set or read off
830 using the following functions.
832 #include <isl/space.h>
833 __isl_give isl_space *isl_space_set_dim_id(
834 __isl_take isl_space *space,
835 enum isl_dim_type type, unsigned pos,
836 __isl_take isl_id *id);
837 int isl_space_has_dim_id(__isl_keep isl_space *space,
838 enum isl_dim_type type, unsigned pos);
839 __isl_give isl_id *isl_space_get_dim_id(
840 __isl_keep isl_space *space,
841 enum isl_dim_type type, unsigned pos);
842 __isl_give isl_space *isl_space_set_dim_name(
843 __isl_take isl_space *space,
844 enum isl_dim_type type, unsigned pos,
845 __isl_keep const char *name);
846 int isl_space_has_dim_name(__isl_keep isl_space *space,
847 enum isl_dim_type type, unsigned pos);
848 __isl_keep const char *isl_space_get_dim_name(
849 __isl_keep isl_space *space,
850 enum isl_dim_type type, unsigned pos);
852 Note that C<isl_space_get_name> returns a pointer to some internal
853 data structure, so the result can only be used while the
854 corresponding C<isl_space> is alive.
855 Also note that every function that operates on two sets or relations
856 requires that both arguments have the same parameters. This also
857 means that if one of the arguments has named parameters, then the
858 other needs to have named parameters too and the names need to match.
859 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
860 arguments may have different parameters (as long as they are named),
861 in which case the result will have as parameters the union of the parameters of
864 Given the identifier or name of a dimension (typically a parameter),
865 its position can be obtained from the following function.
867 #include <isl/space.h>
868 int isl_space_find_dim_by_id(__isl_keep isl_space *space,
869 enum isl_dim_type type, __isl_keep isl_id *id);
870 int isl_space_find_dim_by_name(__isl_keep isl_space *space,
871 enum isl_dim_type type, const char *name);
873 The identifiers or names of entire spaces may be set or read off
874 using the following functions.
876 #include <isl/space.h>
877 __isl_give isl_space *isl_space_set_tuple_id(
878 __isl_take isl_space *space,
879 enum isl_dim_type type, __isl_take isl_id *id);
880 __isl_give isl_space *isl_space_reset_tuple_id(
881 __isl_take isl_space *space, enum isl_dim_type type);
882 int isl_space_has_tuple_id(__isl_keep isl_space *space,
883 enum isl_dim_type type);
884 __isl_give isl_id *isl_space_get_tuple_id(
885 __isl_keep isl_space *space, enum isl_dim_type type);
886 __isl_give isl_space *isl_space_set_tuple_name(
887 __isl_take isl_space *space,
888 enum isl_dim_type type, const char *s);
889 int isl_space_has_tuple_name(__isl_keep isl_space *space,
890 enum isl_dim_type type);
891 const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
892 enum isl_dim_type type);
894 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
895 or C<isl_dim_set>. As with C<isl_space_get_name>,
896 the C<isl_space_get_tuple_name> function returns a pointer to some internal
898 Binary operations require the corresponding spaces of their arguments
899 to have the same name.
901 Spaces can be nested. In particular, the domain of a set or
902 the domain or range of a relation can be a nested relation.
903 The following functions can be used to construct and deconstruct
906 #include <isl/space.h>
907 int isl_space_is_wrapping(__isl_keep isl_space *space);
908 __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
909 __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
911 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
912 be the space of a set, while that of
913 C<isl_space_wrap> should be the space of a relation.
914 Conversely, the output of C<isl_space_unwrap> is the space
915 of a relation, while that of C<isl_space_wrap> is the space of a set.
917 Spaces can be created from other spaces
918 using the following functions.
920 __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
921 __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
922 __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
923 __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
924 __isl_give isl_space *isl_space_domain_map(
925 __isl_take isl_space *space);
926 __isl_give isl_space *isl_space_range_map(
927 __isl_take isl_space *space);
928 __isl_give isl_space *isl_space_params(
929 __isl_take isl_space *space);
930 __isl_give isl_space *isl_space_set_from_params(
931 __isl_take isl_space *space);
932 __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
933 __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
934 __isl_take isl_space *right);
935 __isl_give isl_space *isl_space_align_params(
936 __isl_take isl_space *space1, __isl_take isl_space *space2)
937 __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
938 enum isl_dim_type type, unsigned pos, unsigned n);
939 __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
940 enum isl_dim_type type, unsigned n);
941 __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
942 enum isl_dim_type type, unsigned first, unsigned n);
943 __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
944 enum isl_dim_type dst_type, unsigned dst_pos,
945 enum isl_dim_type src_type, unsigned src_pos,
947 __isl_give isl_space *isl_space_map_from_set(
948 __isl_take isl_space *space);
949 __isl_give isl_space *isl_space_map_from_domain_and_range(
950 __isl_take isl_space *domain,
951 __isl_take isl_space *range);
952 __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
953 __isl_give isl_space *isl_space_curry(
954 __isl_take isl_space *space);
955 __isl_give isl_space *isl_space_uncurry(
956 __isl_take isl_space *space);
958 Note that if dimensions are added or removed from a space, then
959 the name and the internal structure are lost.
963 A local space is essentially a space with
964 zero or more existentially quantified variables.
965 The local space of a (constraint of a) basic set or relation can be obtained
966 using the following functions.
968 #include <isl/constraint.h>
969 __isl_give isl_local_space *isl_constraint_get_local_space(
970 __isl_keep isl_constraint *constraint);
973 __isl_give isl_local_space *isl_basic_set_get_local_space(
974 __isl_keep isl_basic_set *bset);
977 __isl_give isl_local_space *isl_basic_map_get_local_space(
978 __isl_keep isl_basic_map *bmap);
980 A new local space can be created from a space using
982 #include <isl/local_space.h>
983 __isl_give isl_local_space *isl_local_space_from_space(
984 __isl_take isl_space *space);
986 They can be inspected, modified, copied and freed using the following functions.
988 #include <isl/local_space.h>
989 isl_ctx *isl_local_space_get_ctx(
990 __isl_keep isl_local_space *ls);
991 int isl_local_space_is_set(__isl_keep isl_local_space *ls);
992 int isl_local_space_dim(__isl_keep isl_local_space *ls,
993 enum isl_dim_type type);
994 int isl_local_space_has_dim_id(
995 __isl_keep isl_local_space *ls,
996 enum isl_dim_type type, unsigned pos);
997 __isl_give isl_id *isl_local_space_get_dim_id(
998 __isl_keep isl_local_space *ls,
999 enum isl_dim_type type, unsigned pos);
1000 int isl_local_space_has_dim_name(
1001 __isl_keep isl_local_space *ls,
1002 enum isl_dim_type type, unsigned pos)
1003 const char *isl_local_space_get_dim_name(
1004 __isl_keep isl_local_space *ls,
1005 enum isl_dim_type type, unsigned pos);
1006 __isl_give isl_local_space *isl_local_space_set_dim_name(
1007 __isl_take isl_local_space *ls,
1008 enum isl_dim_type type, unsigned pos, const char *s);
1009 __isl_give isl_local_space *isl_local_space_set_dim_id(
1010 __isl_take isl_local_space *ls,
1011 enum isl_dim_type type, unsigned pos,
1012 __isl_take isl_id *id);
1013 __isl_give isl_space *isl_local_space_get_space(
1014 __isl_keep isl_local_space *ls);
1015 __isl_give isl_aff *isl_local_space_get_div(
1016 __isl_keep isl_local_space *ls, int pos);
1017 __isl_give isl_local_space *isl_local_space_copy(
1018 __isl_keep isl_local_space *ls);
1019 void *isl_local_space_free(__isl_take isl_local_space *ls);
1021 Note that C<isl_local_space_get_div> can only be used on local spaces
1024 Two local spaces can be compared using
1026 int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
1027 __isl_keep isl_local_space *ls2);
1029 Local spaces can be created from other local spaces
1030 using the following functions.
1032 __isl_give isl_local_space *isl_local_space_domain(
1033 __isl_take isl_local_space *ls);
1034 __isl_give isl_local_space *isl_local_space_range(
1035 __isl_take isl_local_space *ls);
1036 __isl_give isl_local_space *isl_local_space_from_domain(
1037 __isl_take isl_local_space *ls);
1038 __isl_give isl_local_space *isl_local_space_intersect(
1039 __isl_take isl_local_space *ls1,
1040 __isl_take isl_local_space *ls2);
1041 __isl_give isl_local_space *isl_local_space_add_dims(
1042 __isl_take isl_local_space *ls,
1043 enum isl_dim_type type, unsigned n);
1044 __isl_give isl_local_space *isl_local_space_insert_dims(
1045 __isl_take isl_local_space *ls,
1046 enum isl_dim_type type, unsigned first, unsigned n);
1047 __isl_give isl_local_space *isl_local_space_drop_dims(
1048 __isl_take isl_local_space *ls,
1049 enum isl_dim_type type, unsigned first, unsigned n);
1051 =head2 Input and Output
1053 C<isl> supports its own input/output format, which is similar
1054 to the C<Omega> format, but also supports the C<PolyLib> format
1057 =head3 C<isl> format
1059 The C<isl> format is similar to that of C<Omega>, but has a different
1060 syntax for describing the parameters and allows for the definition
1061 of an existentially quantified variable as the integer division
1062 of an affine expression.
1063 For example, the set of integers C<i> between C<0> and C<n>
1064 such that C<i % 10 <= 6> can be described as
1066 [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
1069 A set or relation can have several disjuncts, separated
1070 by the keyword C<or>. Each disjunct is either a conjunction
1071 of constraints or a projection (C<exists>) of a conjunction
1072 of constraints. The constraints are separated by the keyword
1075 =head3 C<PolyLib> format
1077 If the represented set is a union, then the first line
1078 contains a single number representing the number of disjuncts.
1079 Otherwise, a line containing the number C<1> is optional.
1081 Each disjunct is represented by a matrix of constraints.
1082 The first line contains two numbers representing
1083 the number of rows and columns,
1084 where the number of rows is equal to the number of constraints
1085 and the number of columns is equal to two plus the number of variables.
1086 The following lines contain the actual rows of the constraint matrix.
1087 In each row, the first column indicates whether the constraint
1088 is an equality (C<0>) or inequality (C<1>). The final column
1089 corresponds to the constant term.
1091 If the set is parametric, then the coefficients of the parameters
1092 appear in the last columns before the constant column.
1093 The coefficients of any existentially quantified variables appear
1094 between those of the set variables and those of the parameters.
1096 =head3 Extended C<PolyLib> format
1098 The extended C<PolyLib> format is nearly identical to the
1099 C<PolyLib> format. The only difference is that the line
1100 containing the number of rows and columns of a constraint matrix
1101 also contains four additional numbers:
1102 the number of output dimensions, the number of input dimensions,
1103 the number of local dimensions (i.e., the number of existentially
1104 quantified variables) and the number of parameters.
1105 For sets, the number of ``output'' dimensions is equal
1106 to the number of set dimensions, while the number of ``input''
1111 #include <isl/set.h>
1112 __isl_give isl_basic_set *isl_basic_set_read_from_file(
1113 isl_ctx *ctx, FILE *input);
1114 __isl_give isl_basic_set *isl_basic_set_read_from_str(
1115 isl_ctx *ctx, const char *str);
1116 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
1118 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
1121 #include <isl/map.h>
1122 __isl_give isl_basic_map *isl_basic_map_read_from_file(
1123 isl_ctx *ctx, FILE *input);
1124 __isl_give isl_basic_map *isl_basic_map_read_from_str(
1125 isl_ctx *ctx, const char *str);
1126 __isl_give isl_map *isl_map_read_from_file(
1127 isl_ctx *ctx, FILE *input);
1128 __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
1131 #include <isl/union_set.h>
1132 __isl_give isl_union_set *isl_union_set_read_from_file(
1133 isl_ctx *ctx, FILE *input);
1134 __isl_give isl_union_set *isl_union_set_read_from_str(
1135 isl_ctx *ctx, const char *str);
1137 #include <isl/union_map.h>
1138 __isl_give isl_union_map *isl_union_map_read_from_file(
1139 isl_ctx *ctx, FILE *input);
1140 __isl_give isl_union_map *isl_union_map_read_from_str(
1141 isl_ctx *ctx, const char *str);
1143 The input format is autodetected and may be either the C<PolyLib> format
1144 or the C<isl> format.
1148 Before anything can be printed, an C<isl_printer> needs to
1151 __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1153 __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1154 void *isl_printer_free(__isl_take isl_printer *printer);
1155 __isl_give char *isl_printer_get_str(
1156 __isl_keep isl_printer *printer);
1158 The printer can be inspected using the following functions.
1160 FILE *isl_printer_get_file(
1161 __isl_keep isl_printer *printer);
1162 int isl_printer_get_output_format(
1163 __isl_keep isl_printer *p);
1165 The behavior of the printer can be modified in various ways
1167 __isl_give isl_printer *isl_printer_set_output_format(
1168 __isl_take isl_printer *p, int output_format);
1169 __isl_give isl_printer *isl_printer_set_indent(
1170 __isl_take isl_printer *p, int indent);
1171 __isl_give isl_printer *isl_printer_indent(
1172 __isl_take isl_printer *p, int indent);
1173 __isl_give isl_printer *isl_printer_set_prefix(
1174 __isl_take isl_printer *p, const char *prefix);
1175 __isl_give isl_printer *isl_printer_set_suffix(
1176 __isl_take isl_printer *p, const char *suffix);
1178 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1179 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1180 and defaults to C<ISL_FORMAT_ISL>.
1181 Each line in the output is indented by C<indent> (set by
1182 C<isl_printer_set_indent>) spaces
1183 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1184 In the C<PolyLib> format output,
1185 the coefficients of the existentially quantified variables
1186 appear between those of the set variables and those
1188 The function C<isl_printer_indent> increases the indentation
1189 by the specified amount (which may be negative).
1191 To actually print something, use
1193 #include <isl/printer.h>
1194 __isl_give isl_printer *isl_printer_print_double(
1195 __isl_take isl_printer *p, double d);
1197 #include <isl/set.h>
1198 __isl_give isl_printer *isl_printer_print_basic_set(
1199 __isl_take isl_printer *printer,
1200 __isl_keep isl_basic_set *bset);
1201 __isl_give isl_printer *isl_printer_print_set(
1202 __isl_take isl_printer *printer,
1203 __isl_keep isl_set *set);
1205 #include <isl/map.h>
1206 __isl_give isl_printer *isl_printer_print_basic_map(
1207 __isl_take isl_printer *printer,
1208 __isl_keep isl_basic_map *bmap);
1209 __isl_give isl_printer *isl_printer_print_map(
1210 __isl_take isl_printer *printer,
1211 __isl_keep isl_map *map);
1213 #include <isl/union_set.h>
1214 __isl_give isl_printer *isl_printer_print_union_set(
1215 __isl_take isl_printer *p,
1216 __isl_keep isl_union_set *uset);
1218 #include <isl/union_map.h>
1219 __isl_give isl_printer *isl_printer_print_union_map(
1220 __isl_take isl_printer *p,
1221 __isl_keep isl_union_map *umap);
1223 When called on a file printer, the following function flushes
1224 the file. When called on a string printer, the buffer is cleared.
1226 __isl_give isl_printer *isl_printer_flush(
1227 __isl_take isl_printer *p);
1229 =head2 Creating New Sets and Relations
1231 C<isl> has functions for creating some standard sets and relations.
1235 =item * Empty sets and relations
1237 __isl_give isl_basic_set *isl_basic_set_empty(
1238 __isl_take isl_space *space);
1239 __isl_give isl_basic_map *isl_basic_map_empty(
1240 __isl_take isl_space *space);
1241 __isl_give isl_set *isl_set_empty(
1242 __isl_take isl_space *space);
1243 __isl_give isl_map *isl_map_empty(
1244 __isl_take isl_space *space);
1245 __isl_give isl_union_set *isl_union_set_empty(
1246 __isl_take isl_space *space);
1247 __isl_give isl_union_map *isl_union_map_empty(
1248 __isl_take isl_space *space);
1250 For C<isl_union_set>s and C<isl_union_map>s, the space
1251 is only used to specify the parameters.
1253 =item * Universe sets and relations
1255 __isl_give isl_basic_set *isl_basic_set_universe(
1256 __isl_take isl_space *space);
1257 __isl_give isl_basic_map *isl_basic_map_universe(
1258 __isl_take isl_space *space);
1259 __isl_give isl_set *isl_set_universe(
1260 __isl_take isl_space *space);
1261 __isl_give isl_map *isl_map_universe(
1262 __isl_take isl_space *space);
1263 __isl_give isl_union_set *isl_union_set_universe(
1264 __isl_take isl_union_set *uset);
1265 __isl_give isl_union_map *isl_union_map_universe(
1266 __isl_take isl_union_map *umap);
1268 The sets and relations constructed by the functions above
1269 contain all integer values, while those constructed by the
1270 functions below only contain non-negative values.
1272 __isl_give isl_basic_set *isl_basic_set_nat_universe(
1273 __isl_take isl_space *space);
1274 __isl_give isl_basic_map *isl_basic_map_nat_universe(
1275 __isl_take isl_space *space);
1276 __isl_give isl_set *isl_set_nat_universe(
1277 __isl_take isl_space *space);
1278 __isl_give isl_map *isl_map_nat_universe(
1279 __isl_take isl_space *space);
1281 =item * Identity relations
1283 __isl_give isl_basic_map *isl_basic_map_identity(
1284 __isl_take isl_space *space);
1285 __isl_give isl_map *isl_map_identity(
1286 __isl_take isl_space *space);
1288 The number of input and output dimensions in C<space> needs
1291 =item * Lexicographic order
1293 __isl_give isl_map *isl_map_lex_lt(
1294 __isl_take isl_space *set_space);
1295 __isl_give isl_map *isl_map_lex_le(
1296 __isl_take isl_space *set_space);
1297 __isl_give isl_map *isl_map_lex_gt(
1298 __isl_take isl_space *set_space);
1299 __isl_give isl_map *isl_map_lex_ge(
1300 __isl_take isl_space *set_space);
1301 __isl_give isl_map *isl_map_lex_lt_first(
1302 __isl_take isl_space *space, unsigned n);
1303 __isl_give isl_map *isl_map_lex_le_first(
1304 __isl_take isl_space *space, unsigned n);
1305 __isl_give isl_map *isl_map_lex_gt_first(
1306 __isl_take isl_space *space, unsigned n);
1307 __isl_give isl_map *isl_map_lex_ge_first(
1308 __isl_take isl_space *space, unsigned n);
1310 The first four functions take a space for a B<set>
1311 and return relations that express that the elements in the domain
1312 are lexicographically less
1313 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1314 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1315 than the elements in the range.
1316 The last four functions take a space for a map
1317 and return relations that express that the first C<n> dimensions
1318 in the domain are lexicographically less
1319 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1320 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1321 than the first C<n> dimensions in the range.
1325 A basic set or relation can be converted to a set or relation
1326 using the following functions.
1328 __isl_give isl_set *isl_set_from_basic_set(
1329 __isl_take isl_basic_set *bset);
1330 __isl_give isl_map *isl_map_from_basic_map(
1331 __isl_take isl_basic_map *bmap);
1333 Sets and relations can be converted to union sets and relations
1334 using the following functions.
1336 __isl_give isl_union_set *isl_union_set_from_basic_set(
1337 __isl_take isl_basic_set *bset);
1338 __isl_give isl_union_map *isl_union_map_from_basic_map(
1339 __isl_take isl_basic_map *bmap);
1340 __isl_give isl_union_set *isl_union_set_from_set(
1341 __isl_take isl_set *set);
1342 __isl_give isl_union_map *isl_union_map_from_map(
1343 __isl_take isl_map *map);
1345 The inverse conversions below can only be used if the input
1346 union set or relation is known to contain elements in exactly one
1349 __isl_give isl_set *isl_set_from_union_set(
1350 __isl_take isl_union_set *uset);
1351 __isl_give isl_map *isl_map_from_union_map(
1352 __isl_take isl_union_map *umap);
1354 A zero-dimensional (basic) set can be constructed on a given parameter domain
1355 using the following function.
1357 __isl_give isl_basic_set *isl_basic_set_from_params(
1358 __isl_take isl_basic_set *bset);
1359 __isl_give isl_set *isl_set_from_params(
1360 __isl_take isl_set *set);
1362 Sets and relations can be copied and freed again using the following
1365 __isl_give isl_basic_set *isl_basic_set_copy(
1366 __isl_keep isl_basic_set *bset);
1367 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1368 __isl_give isl_union_set *isl_union_set_copy(
1369 __isl_keep isl_union_set *uset);
1370 __isl_give isl_basic_map *isl_basic_map_copy(
1371 __isl_keep isl_basic_map *bmap);
1372 __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1373 __isl_give isl_union_map *isl_union_map_copy(
1374 __isl_keep isl_union_map *umap);
1375 void *isl_basic_set_free(__isl_take isl_basic_set *bset);
1376 void *isl_set_free(__isl_take isl_set *set);
1377 void *isl_union_set_free(__isl_take isl_union_set *uset);
1378 void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
1379 void *isl_map_free(__isl_take isl_map *map);
1380 void *isl_union_map_free(__isl_take isl_union_map *umap);
1382 Other sets and relations can be constructed by starting
1383 from a universe set or relation, adding equality and/or
1384 inequality constraints and then projecting out the
1385 existentially quantified variables, if any.
1386 Constraints can be constructed, manipulated and
1387 added to (or removed from) (basic) sets and relations
1388 using the following functions.
1390 #include <isl/constraint.h>
1391 __isl_give isl_constraint *isl_equality_alloc(
1392 __isl_take isl_local_space *ls);
1393 __isl_give isl_constraint *isl_inequality_alloc(
1394 __isl_take isl_local_space *ls);
1395 __isl_give isl_constraint *isl_constraint_set_constant_si(
1396 __isl_take isl_constraint *constraint, int v);
1397 __isl_give isl_constraint *isl_constraint_set_constant_val(
1398 __isl_take isl_constraint *constraint,
1399 __isl_take isl_val *v);
1400 __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1401 __isl_take isl_constraint *constraint,
1402 enum isl_dim_type type, int pos, int v);
1403 __isl_give isl_constraint *
1404 isl_constraint_set_coefficient_val(
1405 __isl_take isl_constraint *constraint,
1406 enum isl_dim_type type, int pos, isl_val *v);
1407 __isl_give isl_basic_map *isl_basic_map_add_constraint(
1408 __isl_take isl_basic_map *bmap,
1409 __isl_take isl_constraint *constraint);
1410 __isl_give isl_basic_set *isl_basic_set_add_constraint(
1411 __isl_take isl_basic_set *bset,
1412 __isl_take isl_constraint *constraint);
1413 __isl_give isl_map *isl_map_add_constraint(
1414 __isl_take isl_map *map,
1415 __isl_take isl_constraint *constraint);
1416 __isl_give isl_set *isl_set_add_constraint(
1417 __isl_take isl_set *set,
1418 __isl_take isl_constraint *constraint);
1419 __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1420 __isl_take isl_basic_set *bset,
1421 __isl_take isl_constraint *constraint);
1423 For example, to create a set containing the even integers
1424 between 10 and 42, you would use the following code.
1427 isl_local_space *ls;
1429 isl_basic_set *bset;
1431 space = isl_space_set_alloc(ctx, 0, 2);
1432 bset = isl_basic_set_universe(isl_space_copy(space));
1433 ls = isl_local_space_from_space(space);
1435 c = isl_equality_alloc(isl_local_space_copy(ls));
1436 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1437 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1438 bset = isl_basic_set_add_constraint(bset, c);
1440 c = isl_inequality_alloc(isl_local_space_copy(ls));
1441 c = isl_constraint_set_constant_si(c, -10);
1442 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1443 bset = isl_basic_set_add_constraint(bset, c);
1445 c = isl_inequality_alloc(ls);
1446 c = isl_constraint_set_constant_si(c, 42);
1447 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1448 bset = isl_basic_set_add_constraint(bset, c);
1450 bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1454 isl_basic_set *bset;
1455 bset = isl_basic_set_read_from_str(ctx,
1456 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1458 A basic set or relation can also be constructed from two matrices
1459 describing the equalities and the inequalities.
1461 __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1462 __isl_take isl_space *space,
1463 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1464 enum isl_dim_type c1,
1465 enum isl_dim_type c2, enum isl_dim_type c3,
1466 enum isl_dim_type c4);
1467 __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1468 __isl_take isl_space *space,
1469 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1470 enum isl_dim_type c1,
1471 enum isl_dim_type c2, enum isl_dim_type c3,
1472 enum isl_dim_type c4, enum isl_dim_type c5);
1474 The C<isl_dim_type> arguments indicate the order in which
1475 different kinds of variables appear in the input matrices
1476 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1477 C<isl_dim_set> and C<isl_dim_div> for sets and
1478 of C<isl_dim_cst>, C<isl_dim_param>,
1479 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1481 A (basic or union) set or relation can also be constructed from a
1482 (union) (piecewise) (multiple) affine expression
1483 or a list of affine expressions
1484 (See L<"Piecewise Quasi Affine Expressions"> and
1485 L<"Piecewise Multiple Quasi Affine Expressions">).
1487 __isl_give isl_basic_map *isl_basic_map_from_aff(
1488 __isl_take isl_aff *aff);
1489 __isl_give isl_map *isl_map_from_aff(
1490 __isl_take isl_aff *aff);
1491 __isl_give isl_set *isl_set_from_pw_aff(
1492 __isl_take isl_pw_aff *pwaff);
1493 __isl_give isl_map *isl_map_from_pw_aff(
1494 __isl_take isl_pw_aff *pwaff);
1495 __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1496 __isl_take isl_space *domain_space,
1497 __isl_take isl_aff_list *list);
1498 __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1499 __isl_take isl_multi_aff *maff)
1500 __isl_give isl_map *isl_map_from_multi_aff(
1501 __isl_take isl_multi_aff *maff)
1502 __isl_give isl_set *isl_set_from_pw_multi_aff(
1503 __isl_take isl_pw_multi_aff *pma);
1504 __isl_give isl_map *isl_map_from_pw_multi_aff(
1505 __isl_take isl_pw_multi_aff *pma);
1506 __isl_give isl_union_map *
1507 isl_union_map_from_union_pw_multi_aff(
1508 __isl_take isl_union_pw_multi_aff *upma);
1510 The C<domain_dim> argument describes the domain of the resulting
1511 basic relation. It is required because the C<list> may consist
1512 of zero affine expressions.
1514 =head2 Inspecting Sets and Relations
1516 Usually, the user should not have to care about the actual constraints
1517 of the sets and maps, but should instead apply the abstract operations
1518 explained in the following sections.
1519 Occasionally, however, it may be required to inspect the individual
1520 coefficients of the constraints. This section explains how to do so.
1521 In these cases, it may also be useful to have C<isl> compute
1522 an explicit representation of the existentially quantified variables.
1524 __isl_give isl_set *isl_set_compute_divs(
1525 __isl_take isl_set *set);
1526 __isl_give isl_map *isl_map_compute_divs(
1527 __isl_take isl_map *map);
1528 __isl_give isl_union_set *isl_union_set_compute_divs(
1529 __isl_take isl_union_set *uset);
1530 __isl_give isl_union_map *isl_union_map_compute_divs(
1531 __isl_take isl_union_map *umap);
1533 This explicit representation defines the existentially quantified
1534 variables as integer divisions of the other variables, possibly
1535 including earlier existentially quantified variables.
1536 An explicitly represented existentially quantified variable therefore
1537 has a unique value when the values of the other variables are known.
1538 If, furthermore, the same existentials, i.e., existentials
1539 with the same explicit representations, should appear in the
1540 same order in each of the disjuncts of a set or map, then the user should call
1541 either of the following functions.
1543 __isl_give isl_set *isl_set_align_divs(
1544 __isl_take isl_set *set);
1545 __isl_give isl_map *isl_map_align_divs(
1546 __isl_take isl_map *map);
1548 Alternatively, the existentially quantified variables can be removed
1549 using the following functions, which compute an overapproximation.
1551 __isl_give isl_basic_set *isl_basic_set_remove_divs(
1552 __isl_take isl_basic_set *bset);
1553 __isl_give isl_basic_map *isl_basic_map_remove_divs(
1554 __isl_take isl_basic_map *bmap);
1555 __isl_give isl_set *isl_set_remove_divs(
1556 __isl_take isl_set *set);
1557 __isl_give isl_map *isl_map_remove_divs(
1558 __isl_take isl_map *map);
1560 It is also possible to only remove those divs that are defined
1561 in terms of a given range of dimensions or only those for which
1562 no explicit representation is known.
1564 __isl_give isl_basic_set *
1565 isl_basic_set_remove_divs_involving_dims(
1566 __isl_take isl_basic_set *bset,
1567 enum isl_dim_type type,
1568 unsigned first, unsigned n);
1569 __isl_give isl_basic_map *
1570 isl_basic_map_remove_divs_involving_dims(
1571 __isl_take isl_basic_map *bmap,
1572 enum isl_dim_type type,
1573 unsigned first, unsigned n);
1574 __isl_give isl_set *isl_set_remove_divs_involving_dims(
1575 __isl_take isl_set *set, enum isl_dim_type type,
1576 unsigned first, unsigned n);
1577 __isl_give isl_map *isl_map_remove_divs_involving_dims(
1578 __isl_take isl_map *map, enum isl_dim_type type,
1579 unsigned first, unsigned n);
1581 __isl_give isl_basic_set *
1582 isl_basic_set_remove_unknown_divs(
1583 __isl_take isl_basic_set *bset);
1584 __isl_give isl_set *isl_set_remove_unknown_divs(
1585 __isl_take isl_set *set);
1586 __isl_give isl_map *isl_map_remove_unknown_divs(
1587 __isl_take isl_map *map);
1589 To iterate over all the sets or maps in a union set or map, use
1591 int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1592 int (*fn)(__isl_take isl_set *set, void *user),
1594 int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1595 int (*fn)(__isl_take isl_map *map, void *user),
1598 The number of sets or maps in a union set or map can be obtained
1601 int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1602 int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1604 To extract the set or map in a given space from a union, use
1606 __isl_give isl_set *isl_union_set_extract_set(
1607 __isl_keep isl_union_set *uset,
1608 __isl_take isl_space *space);
1609 __isl_give isl_map *isl_union_map_extract_map(
1610 __isl_keep isl_union_map *umap,
1611 __isl_take isl_space *space);
1613 To iterate over all the basic sets or maps in a set or map, use
1615 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1616 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1618 int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1619 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1622 The callback function C<fn> should return 0 if successful and
1623 -1 if an error occurs. In the latter case, or if any other error
1624 occurs, the above functions will return -1.
1626 It should be noted that C<isl> does not guarantee that
1627 the basic sets or maps passed to C<fn> are disjoint.
1628 If this is required, then the user should call one of
1629 the following functions first.
1631 __isl_give isl_set *isl_set_make_disjoint(
1632 __isl_take isl_set *set);
1633 __isl_give isl_map *isl_map_make_disjoint(
1634 __isl_take isl_map *map);
1636 The number of basic sets in a set can be obtained
1639 int isl_set_n_basic_set(__isl_keep isl_set *set);
1641 To iterate over the constraints of a basic set or map, use
1643 #include <isl/constraint.h>
1645 int isl_basic_set_n_constraint(
1646 __isl_keep isl_basic_set *bset);
1647 int isl_basic_set_foreach_constraint(
1648 __isl_keep isl_basic_set *bset,
1649 int (*fn)(__isl_take isl_constraint *c, void *user),
1651 int isl_basic_map_foreach_constraint(
1652 __isl_keep isl_basic_map *bmap,
1653 int (*fn)(__isl_take isl_constraint *c, void *user),
1655 void *isl_constraint_free(__isl_take isl_constraint *c);
1657 Again, the callback function C<fn> should return 0 if successful and
1658 -1 if an error occurs. In the latter case, or if any other error
1659 occurs, the above functions will return -1.
1660 The constraint C<c> represents either an equality or an inequality.
1661 Use the following function to find out whether a constraint
1662 represents an equality. If not, it represents an inequality.
1664 int isl_constraint_is_equality(
1665 __isl_keep isl_constraint *constraint);
1667 The coefficients of the constraints can be inspected using
1668 the following functions.
1670 int isl_constraint_is_lower_bound(
1671 __isl_keep isl_constraint *constraint,
1672 enum isl_dim_type type, unsigned pos);
1673 int isl_constraint_is_upper_bound(
1674 __isl_keep isl_constraint *constraint,
1675 enum isl_dim_type type, unsigned pos);
1676 __isl_give isl_val *isl_constraint_get_constant_val(
1677 __isl_keep isl_constraint *constraint);
1678 __isl_give isl_val *isl_constraint_get_coefficient_val(
1679 __isl_keep isl_constraint *constraint,
1680 enum isl_dim_type type, int pos);
1681 int isl_constraint_involves_dims(
1682 __isl_keep isl_constraint *constraint,
1683 enum isl_dim_type type, unsigned first, unsigned n);
1685 The explicit representations of the existentially quantified
1686 variables can be inspected using the following function.
1687 Note that the user is only allowed to use this function
1688 if the inspected set or map is the result of a call
1689 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1690 The existentially quantified variable is equal to the floor
1691 of the returned affine expression. The affine expression
1692 itself can be inspected using the functions in
1693 L<"Piecewise Quasi Affine Expressions">.
1695 __isl_give isl_aff *isl_constraint_get_div(
1696 __isl_keep isl_constraint *constraint, int pos);
1698 To obtain the constraints of a basic set or map in matrix
1699 form, use the following functions.
1701 __isl_give isl_mat *isl_basic_set_equalities_matrix(
1702 __isl_keep isl_basic_set *bset,
1703 enum isl_dim_type c1, enum isl_dim_type c2,
1704 enum isl_dim_type c3, enum isl_dim_type c4);
1705 __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1706 __isl_keep isl_basic_set *bset,
1707 enum isl_dim_type c1, enum isl_dim_type c2,
1708 enum isl_dim_type c3, enum isl_dim_type c4);
1709 __isl_give isl_mat *isl_basic_map_equalities_matrix(
1710 __isl_keep isl_basic_map *bmap,
1711 enum isl_dim_type c1,
1712 enum isl_dim_type c2, enum isl_dim_type c3,
1713 enum isl_dim_type c4, enum isl_dim_type c5);
1714 __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1715 __isl_keep isl_basic_map *bmap,
1716 enum isl_dim_type c1,
1717 enum isl_dim_type c2, enum isl_dim_type c3,
1718 enum isl_dim_type c4, enum isl_dim_type c5);
1720 The C<isl_dim_type> arguments dictate the order in which
1721 different kinds of variables appear in the resulting matrix
1722 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1723 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1725 The number of parameters, input, output or set dimensions can
1726 be obtained using the following functions.
1728 unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1729 enum isl_dim_type type);
1730 unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1731 enum isl_dim_type type);
1732 unsigned isl_set_dim(__isl_keep isl_set *set,
1733 enum isl_dim_type type);
1734 unsigned isl_map_dim(__isl_keep isl_map *map,
1735 enum isl_dim_type type);
1737 To check whether the description of a set or relation depends
1738 on one or more given dimensions, it is not necessary to iterate over all
1739 constraints. Instead the following functions can be used.
1741 int isl_basic_set_involves_dims(
1742 __isl_keep isl_basic_set *bset,
1743 enum isl_dim_type type, unsigned first, unsigned n);
1744 int isl_set_involves_dims(__isl_keep isl_set *set,
1745 enum isl_dim_type type, unsigned first, unsigned n);
1746 int isl_basic_map_involves_dims(
1747 __isl_keep isl_basic_map *bmap,
1748 enum isl_dim_type type, unsigned first, unsigned n);
1749 int isl_map_involves_dims(__isl_keep isl_map *map,
1750 enum isl_dim_type type, unsigned first, unsigned n);
1752 Similarly, the following functions can be used to check whether
1753 a given dimension is involved in any lower or upper bound.
1755 int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1756 enum isl_dim_type type, unsigned pos);
1757 int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1758 enum isl_dim_type type, unsigned pos);
1760 Note that these functions return true even if there is a bound on
1761 the dimension on only some of the basic sets of C<set>.
1762 To check if they have a bound for all of the basic sets in C<set>,
1763 use the following functions instead.
1765 int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1766 enum isl_dim_type type, unsigned pos);
1767 int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1768 enum isl_dim_type type, unsigned pos);
1770 The identifiers or names of the domain and range spaces of a set
1771 or relation can be read off or set using the following functions.
1773 __isl_give isl_set *isl_set_set_tuple_id(
1774 __isl_take isl_set *set, __isl_take isl_id *id);
1775 __isl_give isl_set *isl_set_reset_tuple_id(
1776 __isl_take isl_set *set);
1777 int isl_set_has_tuple_id(__isl_keep isl_set *set);
1778 __isl_give isl_id *isl_set_get_tuple_id(
1779 __isl_keep isl_set *set);
1780 __isl_give isl_map *isl_map_set_tuple_id(
1781 __isl_take isl_map *map, enum isl_dim_type type,
1782 __isl_take isl_id *id);
1783 __isl_give isl_map *isl_map_reset_tuple_id(
1784 __isl_take isl_map *map, enum isl_dim_type type);
1785 int isl_map_has_tuple_id(__isl_keep isl_map *map,
1786 enum isl_dim_type type);
1787 __isl_give isl_id *isl_map_get_tuple_id(
1788 __isl_keep isl_map *map, enum isl_dim_type type);
1790 const char *isl_basic_set_get_tuple_name(
1791 __isl_keep isl_basic_set *bset);
1792 __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1793 __isl_take isl_basic_set *set, const char *s);
1794 int isl_set_has_tuple_name(__isl_keep isl_set *set);
1795 const char *isl_set_get_tuple_name(
1796 __isl_keep isl_set *set);
1797 const char *isl_basic_map_get_tuple_name(
1798 __isl_keep isl_basic_map *bmap,
1799 enum isl_dim_type type);
1800 __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1801 __isl_take isl_basic_map *bmap,
1802 enum isl_dim_type type, const char *s);
1803 int isl_map_has_tuple_name(__isl_keep isl_map *map,
1804 enum isl_dim_type type);
1805 const char *isl_map_get_tuple_name(
1806 __isl_keep isl_map *map,
1807 enum isl_dim_type type);
1809 As with C<isl_space_get_tuple_name>, the value returned points to
1810 an internal data structure.
1811 The identifiers, positions or names of individual dimensions can be
1812 read off using the following functions.
1814 __isl_give isl_id *isl_basic_set_get_dim_id(
1815 __isl_keep isl_basic_set *bset,
1816 enum isl_dim_type type, unsigned pos);
1817 __isl_give isl_set *isl_set_set_dim_id(
1818 __isl_take isl_set *set, enum isl_dim_type type,
1819 unsigned pos, __isl_take isl_id *id);
1820 int isl_set_has_dim_id(__isl_keep isl_set *set,
1821 enum isl_dim_type type, unsigned pos);
1822 __isl_give isl_id *isl_set_get_dim_id(
1823 __isl_keep isl_set *set, enum isl_dim_type type,
1825 int isl_basic_map_has_dim_id(
1826 __isl_keep isl_basic_map *bmap,
1827 enum isl_dim_type type, unsigned pos);
1828 __isl_give isl_map *isl_map_set_dim_id(
1829 __isl_take isl_map *map, enum isl_dim_type type,
1830 unsigned pos, __isl_take isl_id *id);
1831 int isl_map_has_dim_id(__isl_keep isl_map *map,
1832 enum isl_dim_type type, unsigned pos);
1833 __isl_give isl_id *isl_map_get_dim_id(
1834 __isl_keep isl_map *map, enum isl_dim_type type,
1837 int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1838 enum isl_dim_type type, __isl_keep isl_id *id);
1839 int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1840 enum isl_dim_type type, __isl_keep isl_id *id);
1841 int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1842 enum isl_dim_type type, const char *name);
1843 int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1844 enum isl_dim_type type, const char *name);
1846 const char *isl_constraint_get_dim_name(
1847 __isl_keep isl_constraint *constraint,
1848 enum isl_dim_type type, unsigned pos);
1849 const char *isl_basic_set_get_dim_name(
1850 __isl_keep isl_basic_set *bset,
1851 enum isl_dim_type type, unsigned pos);
1852 int isl_set_has_dim_name(__isl_keep isl_set *set,
1853 enum isl_dim_type type, unsigned pos);
1854 const char *isl_set_get_dim_name(
1855 __isl_keep isl_set *set,
1856 enum isl_dim_type type, unsigned pos);
1857 const char *isl_basic_map_get_dim_name(
1858 __isl_keep isl_basic_map *bmap,
1859 enum isl_dim_type type, unsigned pos);
1860 int isl_map_has_dim_name(__isl_keep isl_map *map,
1861 enum isl_dim_type type, unsigned pos);
1862 const char *isl_map_get_dim_name(
1863 __isl_keep isl_map *map,
1864 enum isl_dim_type type, unsigned pos);
1866 These functions are mostly useful to obtain the identifiers, positions
1867 or names of the parameters. Identifiers of individual dimensions are
1868 essentially only useful for printing. They are ignored by all other
1869 operations and may not be preserved across those operations.
1873 =head3 Unary Properties
1879 The following functions test whether the given set or relation
1880 contains any integer points. The ``plain'' variants do not perform
1881 any computations, but simply check if the given set or relation
1882 is already known to be empty.
1884 int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1885 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1886 int isl_set_plain_is_empty(__isl_keep isl_set *set);
1887 int isl_set_is_empty(__isl_keep isl_set *set);
1888 int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1889 int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1890 int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1891 int isl_map_plain_is_empty(__isl_keep isl_map *map);
1892 int isl_map_is_empty(__isl_keep isl_map *map);
1893 int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1895 =item * Universality
1897 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1898 int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1899 int isl_set_plain_is_universe(__isl_keep isl_set *set);
1901 =item * Single-valuedness
1903 int isl_basic_map_is_single_valued(
1904 __isl_keep isl_basic_map *bmap);
1905 int isl_map_plain_is_single_valued(
1906 __isl_keep isl_map *map);
1907 int isl_map_is_single_valued(__isl_keep isl_map *map);
1908 int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1912 int isl_map_plain_is_injective(__isl_keep isl_map *map);
1913 int isl_map_is_injective(__isl_keep isl_map *map);
1914 int isl_union_map_plain_is_injective(
1915 __isl_keep isl_union_map *umap);
1916 int isl_union_map_is_injective(
1917 __isl_keep isl_union_map *umap);
1921 int isl_map_is_bijective(__isl_keep isl_map *map);
1922 int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1926 __isl_give isl_val *
1927 isl_basic_map_plain_get_val_if_fixed(
1928 __isl_keep isl_basic_map *bmap,
1929 enum isl_dim_type type, unsigned pos);
1930 __isl_give isl_val *isl_set_plain_get_val_if_fixed(
1931 __isl_keep isl_set *set,
1932 enum isl_dim_type type, unsigned pos);
1933 __isl_give isl_val *isl_map_plain_get_val_if_fixed(
1934 __isl_keep isl_map *map,
1935 enum isl_dim_type type, unsigned pos);
1937 If the set or relation obviously lies on a hyperplane where the given dimension
1938 has a fixed value, then return that value.
1939 Otherwise return NaN.
1943 int isl_set_dim_residue_class_val(
1944 __isl_keep isl_set *set,
1945 int pos, __isl_give isl_val **modulo,
1946 __isl_give isl_val **residue);
1948 Check if the values of the given set dimension are equal to a fixed
1949 value modulo some integer value. If so, assign the modulo to C<*modulo>
1950 and the fixed value to C<*residue>. If the given dimension attains only
1951 a single value, then assign C<0> to C<*modulo> and the fixed value to
1953 If the dimension does not attain only a single value and if no modulo
1954 can be found then assign C<1> to C<*modulo> and C<1> to C<*residue>.
1958 To check whether a set is a parameter domain, use this function:
1960 int isl_set_is_params(__isl_keep isl_set *set);
1961 int isl_union_set_is_params(
1962 __isl_keep isl_union_set *uset);
1966 The following functions check whether the domain of the given
1967 (basic) set is a wrapped relation.
1969 int isl_basic_set_is_wrapping(
1970 __isl_keep isl_basic_set *bset);
1971 int isl_set_is_wrapping(__isl_keep isl_set *set);
1973 =item * Internal Product
1975 int isl_basic_map_can_zip(
1976 __isl_keep isl_basic_map *bmap);
1977 int isl_map_can_zip(__isl_keep isl_map *map);
1979 Check whether the product of domain and range of the given relation
1981 i.e., whether both domain and range are nested relations.
1985 int isl_basic_map_can_curry(
1986 __isl_keep isl_basic_map *bmap);
1987 int isl_map_can_curry(__isl_keep isl_map *map);
1989 Check whether the domain of the (basic) relation is a wrapped relation.
1991 int isl_basic_map_can_uncurry(
1992 __isl_keep isl_basic_map *bmap);
1993 int isl_map_can_uncurry(__isl_keep isl_map *map);
1995 Check whether the range of the (basic) relation is a wrapped relation.
1999 =head3 Binary Properties
2005 int isl_set_plain_is_equal(__isl_keep isl_set *set1,
2006 __isl_keep isl_set *set2);
2007 int isl_set_is_equal(__isl_keep isl_set *set1,
2008 __isl_keep isl_set *set2);
2009 int isl_union_set_is_equal(
2010 __isl_keep isl_union_set *uset1,
2011 __isl_keep isl_union_set *uset2);
2012 int isl_basic_map_is_equal(
2013 __isl_keep isl_basic_map *bmap1,
2014 __isl_keep isl_basic_map *bmap2);
2015 int isl_map_is_equal(__isl_keep isl_map *map1,
2016 __isl_keep isl_map *map2);
2017 int isl_map_plain_is_equal(__isl_keep isl_map *map1,
2018 __isl_keep isl_map *map2);
2019 int isl_union_map_is_equal(
2020 __isl_keep isl_union_map *umap1,
2021 __isl_keep isl_union_map *umap2);
2023 =item * Disjointness
2025 int isl_basic_set_is_disjoint(
2026 __isl_keep isl_basic_set *bset1,
2027 __isl_keep isl_basic_set *bset2);
2028 int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
2029 __isl_keep isl_set *set2);
2030 int isl_set_is_disjoint(__isl_keep isl_set *set1,
2031 __isl_keep isl_set *set2);
2032 int isl_basic_map_is_disjoint(
2033 __isl_keep isl_basic_map *bmap1,
2034 __isl_keep isl_basic_map *bmap2);
2035 int isl_map_is_disjoint(__isl_keep isl_map *map1,
2036 __isl_keep isl_map *map2);
2040 int isl_basic_set_is_subset(
2041 __isl_keep isl_basic_set *bset1,
2042 __isl_keep isl_basic_set *bset2);
2043 int isl_set_is_subset(__isl_keep isl_set *set1,
2044 __isl_keep isl_set *set2);
2045 int isl_set_is_strict_subset(
2046 __isl_keep isl_set *set1,
2047 __isl_keep isl_set *set2);
2048 int isl_union_set_is_subset(
2049 __isl_keep isl_union_set *uset1,
2050 __isl_keep isl_union_set *uset2);
2051 int isl_union_set_is_strict_subset(
2052 __isl_keep isl_union_set *uset1,
2053 __isl_keep isl_union_set *uset2);
2054 int isl_basic_map_is_subset(
2055 __isl_keep isl_basic_map *bmap1,
2056 __isl_keep isl_basic_map *bmap2);
2057 int isl_basic_map_is_strict_subset(
2058 __isl_keep isl_basic_map *bmap1,
2059 __isl_keep isl_basic_map *bmap2);
2060 int isl_map_is_subset(
2061 __isl_keep isl_map *map1,
2062 __isl_keep isl_map *map2);
2063 int isl_map_is_strict_subset(
2064 __isl_keep isl_map *map1,
2065 __isl_keep isl_map *map2);
2066 int isl_union_map_is_subset(
2067 __isl_keep isl_union_map *umap1,
2068 __isl_keep isl_union_map *umap2);
2069 int isl_union_map_is_strict_subset(
2070 __isl_keep isl_union_map *umap1,
2071 __isl_keep isl_union_map *umap2);
2073 Check whether the first argument is a (strict) subset of the
2078 int isl_set_plain_cmp(__isl_keep isl_set *set1,
2079 __isl_keep isl_set *set2);
2081 This function is useful for sorting C<isl_set>s.
2082 The order depends on the internal representation of the inputs.
2083 The order is fixed over different calls to the function (assuming
2084 the internal representation of the inputs has not changed), but may
2085 change over different versions of C<isl>.
2089 =head2 Unary Operations
2095 __isl_give isl_set *isl_set_complement(
2096 __isl_take isl_set *set);
2097 __isl_give isl_map *isl_map_complement(
2098 __isl_take isl_map *map);
2102 __isl_give isl_basic_map *isl_basic_map_reverse(
2103 __isl_take isl_basic_map *bmap);
2104 __isl_give isl_map *isl_map_reverse(
2105 __isl_take isl_map *map);
2106 __isl_give isl_union_map *isl_union_map_reverse(
2107 __isl_take isl_union_map *umap);
2111 __isl_give isl_basic_set *isl_basic_set_project_out(
2112 __isl_take isl_basic_set *bset,
2113 enum isl_dim_type type, unsigned first, unsigned n);
2114 __isl_give isl_basic_map *isl_basic_map_project_out(
2115 __isl_take isl_basic_map *bmap,
2116 enum isl_dim_type type, unsigned first, unsigned n);
2117 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2118 enum isl_dim_type type, unsigned first, unsigned n);
2119 __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2120 enum isl_dim_type type, unsigned first, unsigned n);
2121 __isl_give isl_basic_set *isl_basic_set_params(
2122 __isl_take isl_basic_set *bset);
2123 __isl_give isl_basic_set *isl_basic_map_domain(
2124 __isl_take isl_basic_map *bmap);
2125 __isl_give isl_basic_set *isl_basic_map_range(
2126 __isl_take isl_basic_map *bmap);
2127 __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2128 __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2129 __isl_give isl_set *isl_map_domain(
2130 __isl_take isl_map *bmap);
2131 __isl_give isl_set *isl_map_range(
2132 __isl_take isl_map *map);
2133 __isl_give isl_set *isl_union_set_params(
2134 __isl_take isl_union_set *uset);
2135 __isl_give isl_set *isl_union_map_params(
2136 __isl_take isl_union_map *umap);
2137 __isl_give isl_union_set *isl_union_map_domain(
2138 __isl_take isl_union_map *umap);
2139 __isl_give isl_union_set *isl_union_map_range(
2140 __isl_take isl_union_map *umap);
2142 __isl_give isl_basic_map *isl_basic_map_domain_map(
2143 __isl_take isl_basic_map *bmap);
2144 __isl_give isl_basic_map *isl_basic_map_range_map(
2145 __isl_take isl_basic_map *bmap);
2146 __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2147 __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2148 __isl_give isl_union_map *isl_union_map_domain_map(
2149 __isl_take isl_union_map *umap);
2150 __isl_give isl_union_map *isl_union_map_range_map(
2151 __isl_take isl_union_map *umap);
2153 The functions above construct a (basic, regular or union) relation
2154 that maps (a wrapped version of) the input relation to its domain or range.
2158 __isl_give isl_basic_set *isl_basic_set_eliminate(
2159 __isl_take isl_basic_set *bset,
2160 enum isl_dim_type type,
2161 unsigned first, unsigned n);
2162 __isl_give isl_set *isl_set_eliminate(
2163 __isl_take isl_set *set, enum isl_dim_type type,
2164 unsigned first, unsigned n);
2165 __isl_give isl_basic_map *isl_basic_map_eliminate(
2166 __isl_take isl_basic_map *bmap,
2167 enum isl_dim_type type,
2168 unsigned first, unsigned n);
2169 __isl_give isl_map *isl_map_eliminate(
2170 __isl_take isl_map *map, enum isl_dim_type type,
2171 unsigned first, unsigned n);
2173 Eliminate the coefficients for the given dimensions from the constraints,
2174 without removing the dimensions.
2178 __isl_give isl_basic_set *isl_basic_set_fix_si(
2179 __isl_take isl_basic_set *bset,
2180 enum isl_dim_type type, unsigned pos, int value);
2181 __isl_give isl_basic_set *isl_basic_set_fix_val(
2182 __isl_take isl_basic_set *bset,
2183 enum isl_dim_type type, unsigned pos,
2184 __isl_take isl_val *v);
2185 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2186 enum isl_dim_type type, unsigned pos, int value);
2187 __isl_give isl_set *isl_set_fix_val(
2188 __isl_take isl_set *set,
2189 enum isl_dim_type type, unsigned pos,
2190 __isl_take isl_val *v);
2191 __isl_give isl_basic_map *isl_basic_map_fix_si(
2192 __isl_take isl_basic_map *bmap,
2193 enum isl_dim_type type, unsigned pos, int value);
2194 __isl_give isl_basic_map *isl_basic_map_fix_val(
2195 __isl_take isl_basic_map *bmap,
2196 enum isl_dim_type type, unsigned pos,
2197 __isl_take isl_val *v);
2198 __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2199 enum isl_dim_type type, unsigned pos, int value);
2200 __isl_give isl_map *isl_map_fix_val(
2201 __isl_take isl_map *map,
2202 enum isl_dim_type type, unsigned pos,
2203 __isl_take isl_val *v);
2205 Intersect the set or relation with the hyperplane where the given
2206 dimension has the fixed given value.
2208 __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2209 __isl_take isl_basic_map *bmap,
2210 enum isl_dim_type type, unsigned pos, int value);
2211 __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2212 __isl_take isl_basic_map *bmap,
2213 enum isl_dim_type type, unsigned pos, int value);
2214 __isl_give isl_set *isl_set_lower_bound_si(
2215 __isl_take isl_set *set,
2216 enum isl_dim_type type, unsigned pos, int value);
2217 __isl_give isl_set *isl_set_lower_bound_val(
2218 __isl_take isl_set *set,
2219 enum isl_dim_type type, unsigned pos,
2220 __isl_take isl_val *value);
2221 __isl_give isl_map *isl_map_lower_bound_si(
2222 __isl_take isl_map *map,
2223 enum isl_dim_type type, unsigned pos, int value);
2224 __isl_give isl_set *isl_set_upper_bound_si(
2225 __isl_take isl_set *set,
2226 enum isl_dim_type type, unsigned pos, int value);
2227 __isl_give isl_set *isl_set_upper_bound_val(
2228 __isl_take isl_set *set,
2229 enum isl_dim_type type, unsigned pos,
2230 __isl_take isl_val *value);
2231 __isl_give isl_map *isl_map_upper_bound_si(
2232 __isl_take isl_map *map,
2233 enum isl_dim_type type, unsigned pos, int value);
2235 Intersect the set or relation with the half-space where the given
2236 dimension has a value bounded by the fixed given integer value.
2238 __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2239 enum isl_dim_type type1, int pos1,
2240 enum isl_dim_type type2, int pos2);
2241 __isl_give isl_basic_map *isl_basic_map_equate(
2242 __isl_take isl_basic_map *bmap,
2243 enum isl_dim_type type1, int pos1,
2244 enum isl_dim_type type2, int pos2);
2245 __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2246 enum isl_dim_type type1, int pos1,
2247 enum isl_dim_type type2, int pos2);
2249 Intersect the set or relation with the hyperplane where the given
2250 dimensions are equal to each other.
2252 __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
2253 enum isl_dim_type type1, int pos1,
2254 enum isl_dim_type type2, int pos2);
2256 Intersect the relation with the hyperplane where the given
2257 dimensions have opposite values.
2259 __isl_give isl_basic_map *isl_basic_map_order_ge(
2260 __isl_take isl_basic_map *bmap,
2261 enum isl_dim_type type1, int pos1,
2262 enum isl_dim_type type2, int pos2);
2263 __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2264 enum isl_dim_type type1, int pos1,
2265 enum isl_dim_type type2, int pos2);
2266 __isl_give isl_basic_map *isl_basic_map_order_gt(
2267 __isl_take isl_basic_map *bmap,
2268 enum isl_dim_type type1, int pos1,
2269 enum isl_dim_type type2, int pos2);
2270 __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2271 enum isl_dim_type type1, int pos1,
2272 enum isl_dim_type type2, int pos2);
2274 Intersect the relation with the half-space where the given
2275 dimensions satisfy the given ordering.
2279 __isl_give isl_map *isl_set_identity(
2280 __isl_take isl_set *set);
2281 __isl_give isl_union_map *isl_union_set_identity(
2282 __isl_take isl_union_set *uset);
2284 Construct an identity relation on the given (union) set.
2288 __isl_give isl_basic_set *isl_basic_map_deltas(
2289 __isl_take isl_basic_map *bmap);
2290 __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2291 __isl_give isl_union_set *isl_union_map_deltas(
2292 __isl_take isl_union_map *umap);
2294 These functions return a (basic) set containing the differences
2295 between image elements and corresponding domain elements in the input.
2297 __isl_give isl_basic_map *isl_basic_map_deltas_map(
2298 __isl_take isl_basic_map *bmap);
2299 __isl_give isl_map *isl_map_deltas_map(
2300 __isl_take isl_map *map);
2301 __isl_give isl_union_map *isl_union_map_deltas_map(
2302 __isl_take isl_union_map *umap);
2304 The functions above construct a (basic, regular or union) relation
2305 that maps (a wrapped version of) the input relation to its delta set.
2309 Simplify the representation of a set or relation by trying
2310 to combine pairs of basic sets or relations into a single
2311 basic set or relation.
2313 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2314 __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2315 __isl_give isl_union_set *isl_union_set_coalesce(
2316 __isl_take isl_union_set *uset);
2317 __isl_give isl_union_map *isl_union_map_coalesce(
2318 __isl_take isl_union_map *umap);
2320 One of the methods for combining pairs of basic sets or relations
2321 can result in coefficients that are much larger than those that appear
2322 in the constraints of the input. By default, the coefficients are
2323 not allowed to grow larger, but this can be changed by unsetting
2324 the following option.
2326 int isl_options_set_coalesce_bounded_wrapping(
2327 isl_ctx *ctx, int val);
2328 int isl_options_get_coalesce_bounded_wrapping(
2331 =item * Detecting equalities
2333 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2334 __isl_take isl_basic_set *bset);
2335 __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2336 __isl_take isl_basic_map *bmap);
2337 __isl_give isl_set *isl_set_detect_equalities(
2338 __isl_take isl_set *set);
2339 __isl_give isl_map *isl_map_detect_equalities(
2340 __isl_take isl_map *map);
2341 __isl_give isl_union_set *isl_union_set_detect_equalities(
2342 __isl_take isl_union_set *uset);
2343 __isl_give isl_union_map *isl_union_map_detect_equalities(
2344 __isl_take isl_union_map *umap);
2346 Simplify the representation of a set or relation by detecting implicit
2349 =item * Removing redundant constraints
2351 __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2352 __isl_take isl_basic_set *bset);
2353 __isl_give isl_set *isl_set_remove_redundancies(
2354 __isl_take isl_set *set);
2355 __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2356 __isl_take isl_basic_map *bmap);
2357 __isl_give isl_map *isl_map_remove_redundancies(
2358 __isl_take isl_map *map);
2362 __isl_give isl_basic_set *isl_set_convex_hull(
2363 __isl_take isl_set *set);
2364 __isl_give isl_basic_map *isl_map_convex_hull(
2365 __isl_take isl_map *map);
2367 If the input set or relation has any existentially quantified
2368 variables, then the result of these operations is currently undefined.
2372 __isl_give isl_basic_set *
2373 isl_set_unshifted_simple_hull(
2374 __isl_take isl_set *set);
2375 __isl_give isl_basic_map *
2376 isl_map_unshifted_simple_hull(
2377 __isl_take isl_map *map);
2378 __isl_give isl_basic_set *isl_set_simple_hull(
2379 __isl_take isl_set *set);
2380 __isl_give isl_basic_map *isl_map_simple_hull(
2381 __isl_take isl_map *map);
2382 __isl_give isl_union_map *isl_union_map_simple_hull(
2383 __isl_take isl_union_map *umap);
2385 These functions compute a single basic set or relation
2386 that contains the whole input set or relation.
2387 In particular, the output is described by translates
2388 of the constraints describing the basic sets or relations in the input.
2389 In case of C<isl_set_unshifted_simple_hull>, only the original
2390 constraints are used, without any translation.
2394 (See \autoref{s:simple hull}.)
2400 __isl_give isl_basic_set *isl_basic_set_affine_hull(
2401 __isl_take isl_basic_set *bset);
2402 __isl_give isl_basic_set *isl_set_affine_hull(
2403 __isl_take isl_set *set);
2404 __isl_give isl_union_set *isl_union_set_affine_hull(
2405 __isl_take isl_union_set *uset);
2406 __isl_give isl_basic_map *isl_basic_map_affine_hull(
2407 __isl_take isl_basic_map *bmap);
2408 __isl_give isl_basic_map *isl_map_affine_hull(
2409 __isl_take isl_map *map);
2410 __isl_give isl_union_map *isl_union_map_affine_hull(
2411 __isl_take isl_union_map *umap);
2413 In case of union sets and relations, the affine hull is computed
2416 =item * Polyhedral hull
2418 __isl_give isl_basic_set *isl_set_polyhedral_hull(
2419 __isl_take isl_set *set);
2420 __isl_give isl_basic_map *isl_map_polyhedral_hull(
2421 __isl_take isl_map *map);
2422 __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2423 __isl_take isl_union_set *uset);
2424 __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2425 __isl_take isl_union_map *umap);
2427 These functions compute a single basic set or relation
2428 not involving any existentially quantified variables
2429 that contains the whole input set or relation.
2430 In case of union sets and relations, the polyhedral hull is computed
2433 =item * Other approximations
2435 __isl_give isl_basic_set *
2436 isl_basic_set_drop_constraints_involving_dims(
2437 __isl_take isl_basic_set *bset,
2438 enum isl_dim_type type,
2439 unsigned first, unsigned n);
2440 __isl_give isl_basic_map *
2441 isl_basic_map_drop_constraints_involving_dims(
2442 __isl_take isl_basic_map *bmap,
2443 enum isl_dim_type type,
2444 unsigned first, unsigned n);
2445 __isl_give isl_basic_set *
2446 isl_basic_set_drop_constraints_not_involving_dims(
2447 __isl_take isl_basic_set *bset,
2448 enum isl_dim_type type,
2449 unsigned first, unsigned n);
2450 __isl_give isl_set *
2451 isl_set_drop_constraints_involving_dims(
2452 __isl_take isl_set *set,
2453 enum isl_dim_type type,
2454 unsigned first, unsigned n);
2455 __isl_give isl_map *
2456 isl_map_drop_constraints_involving_dims(
2457 __isl_take isl_map *map,
2458 enum isl_dim_type type,
2459 unsigned first, unsigned n);
2461 These functions drop any constraints (not) involving the specified dimensions.
2462 Note that the result depends on the representation of the input.
2466 __isl_give isl_basic_set *isl_basic_set_sample(
2467 __isl_take isl_basic_set *bset);
2468 __isl_give isl_basic_set *isl_set_sample(
2469 __isl_take isl_set *set);
2470 __isl_give isl_basic_map *isl_basic_map_sample(
2471 __isl_take isl_basic_map *bmap);
2472 __isl_give isl_basic_map *isl_map_sample(
2473 __isl_take isl_map *map);
2475 If the input (basic) set or relation is non-empty, then return
2476 a singleton subset of the input. Otherwise, return an empty set.
2478 =item * Optimization
2480 #include <isl/ilp.h>
2481 __isl_give isl_val *isl_basic_set_max_val(
2482 __isl_keep isl_basic_set *bset,
2483 __isl_keep isl_aff *obj);
2484 __isl_give isl_val *isl_set_min_val(
2485 __isl_keep isl_set *set,
2486 __isl_keep isl_aff *obj);
2487 __isl_give isl_val *isl_set_max_val(
2488 __isl_keep isl_set *set,
2489 __isl_keep isl_aff *obj);
2491 Compute the minimum or maximum of the integer affine expression C<obj>
2492 over the points in C<set>, returning the result in C<opt>.
2493 The result is C<NULL> in case of an error, the optimal value in case
2494 there is one, negative infinity or infinity if the problem is unbounded and
2495 NaN if the problem is empty.
2497 =item * Parametric optimization
2499 __isl_give isl_pw_aff *isl_set_dim_min(
2500 __isl_take isl_set *set, int pos);
2501 __isl_give isl_pw_aff *isl_set_dim_max(
2502 __isl_take isl_set *set, int pos);
2503 __isl_give isl_pw_aff *isl_map_dim_max(
2504 __isl_take isl_map *map, int pos);
2506 Compute the minimum or maximum of the given set or output dimension
2507 as a function of the parameters (and input dimensions), but independently
2508 of the other set or output dimensions.
2509 For lexicographic optimization, see L<"Lexicographic Optimization">.
2513 The following functions compute either the set of (rational) coefficient
2514 values of valid constraints for the given set or the set of (rational)
2515 values satisfying the constraints with coefficients from the given set.
2516 Internally, these two sets of functions perform essentially the
2517 same operations, except that the set of coefficients is assumed to
2518 be a cone, while the set of values may be any polyhedron.
2519 The current implementation is based on the Farkas lemma and
2520 Fourier-Motzkin elimination, but this may change or be made optional
2521 in future. In particular, future implementations may use different
2522 dualization algorithms or skip the elimination step.
2524 __isl_give isl_basic_set *isl_basic_set_coefficients(
2525 __isl_take isl_basic_set *bset);
2526 __isl_give isl_basic_set *isl_set_coefficients(
2527 __isl_take isl_set *set);
2528 __isl_give isl_union_set *isl_union_set_coefficients(
2529 __isl_take isl_union_set *bset);
2530 __isl_give isl_basic_set *isl_basic_set_solutions(
2531 __isl_take isl_basic_set *bset);
2532 __isl_give isl_basic_set *isl_set_solutions(
2533 __isl_take isl_set *set);
2534 __isl_give isl_union_set *isl_union_set_solutions(
2535 __isl_take isl_union_set *bset);
2539 __isl_give isl_map *isl_map_fixed_power_val(
2540 __isl_take isl_map *map,
2541 __isl_take isl_val *exp);
2542 __isl_give isl_union_map *
2543 isl_union_map_fixed_power_val(
2544 __isl_take isl_union_map *umap,
2545 __isl_take isl_val *exp);
2547 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2548 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2549 of C<map> is computed.
2551 __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2553 __isl_give isl_union_map *isl_union_map_power(
2554 __isl_take isl_union_map *umap, int *exact);
2556 Compute a parametric representation for all positive powers I<k> of C<map>.
2557 The result maps I<k> to a nested relation corresponding to the
2558 I<k>th power of C<map>.
2559 The result may be an overapproximation. If the result is known to be exact,
2560 then C<*exact> is set to C<1>.
2562 =item * Transitive closure
2564 __isl_give isl_map *isl_map_transitive_closure(
2565 __isl_take isl_map *map, int *exact);
2566 __isl_give isl_union_map *isl_union_map_transitive_closure(
2567 __isl_take isl_union_map *umap, int *exact);
2569 Compute the transitive closure of C<map>.
2570 The result may be an overapproximation. If the result is known to be exact,
2571 then C<*exact> is set to C<1>.
2573 =item * Reaching path lengths
2575 __isl_give isl_map *isl_map_reaching_path_lengths(
2576 __isl_take isl_map *map, int *exact);
2578 Compute a relation that maps each element in the range of C<map>
2579 to the lengths of all paths composed of edges in C<map> that
2580 end up in the given element.
2581 The result may be an overapproximation. If the result is known to be exact,
2582 then C<*exact> is set to C<1>.
2583 To compute the I<maximal> path length, the resulting relation
2584 should be postprocessed by C<isl_map_lexmax>.
2585 In particular, if the input relation is a dependence relation
2586 (mapping sources to sinks), then the maximal path length corresponds
2587 to the free schedule.
2588 Note, however, that C<isl_map_lexmax> expects the maximum to be
2589 finite, so if the path lengths are unbounded (possibly due to
2590 the overapproximation), then you will get an error message.
2594 __isl_give isl_basic_set *isl_basic_map_wrap(
2595 __isl_take isl_basic_map *bmap);
2596 __isl_give isl_set *isl_map_wrap(
2597 __isl_take isl_map *map);
2598 __isl_give isl_union_set *isl_union_map_wrap(
2599 __isl_take isl_union_map *umap);
2600 __isl_give isl_basic_map *isl_basic_set_unwrap(
2601 __isl_take isl_basic_set *bset);
2602 __isl_give isl_map *isl_set_unwrap(
2603 __isl_take isl_set *set);
2604 __isl_give isl_union_map *isl_union_set_unwrap(
2605 __isl_take isl_union_set *uset);
2609 Remove any internal structure of domain (and range) of the given
2610 set or relation. If there is any such internal structure in the input,
2611 then the name of the space is also removed.
2613 __isl_give isl_basic_set *isl_basic_set_flatten(
2614 __isl_take isl_basic_set *bset);
2615 __isl_give isl_set *isl_set_flatten(
2616 __isl_take isl_set *set);
2617 __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2618 __isl_take isl_basic_map *bmap);
2619 __isl_give isl_basic_map *isl_basic_map_flatten_range(
2620 __isl_take isl_basic_map *bmap);
2621 __isl_give isl_map *isl_map_flatten_range(
2622 __isl_take isl_map *map);
2623 __isl_give isl_map *isl_map_flatten_domain(
2624 __isl_take isl_map *map);
2625 __isl_give isl_basic_map *isl_basic_map_flatten(
2626 __isl_take isl_basic_map *bmap);
2627 __isl_give isl_map *isl_map_flatten(
2628 __isl_take isl_map *map);
2630 __isl_give isl_map *isl_set_flatten_map(
2631 __isl_take isl_set *set);
2633 The function above constructs a relation
2634 that maps the input set to a flattened version of the set.
2638 Lift the input set to a space with extra dimensions corresponding
2639 to the existentially quantified variables in the input.
2640 In particular, the result lives in a wrapped map where the domain
2641 is the original space and the range corresponds to the original
2642 existentially quantified variables.
2644 __isl_give isl_basic_set *isl_basic_set_lift(
2645 __isl_take isl_basic_set *bset);
2646 __isl_give isl_set *isl_set_lift(
2647 __isl_take isl_set *set);
2648 __isl_give isl_union_set *isl_union_set_lift(
2649 __isl_take isl_union_set *uset);
2651 Given a local space that contains the existentially quantified
2652 variables of a set, a basic relation that, when applied to
2653 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2654 can be constructed using the following function.
2656 #include <isl/local_space.h>
2657 __isl_give isl_basic_map *isl_local_space_lifting(
2658 __isl_take isl_local_space *ls);
2660 =item * Internal Product
2662 __isl_give isl_basic_map *isl_basic_map_zip(
2663 __isl_take isl_basic_map *bmap);
2664 __isl_give isl_map *isl_map_zip(
2665 __isl_take isl_map *map);
2666 __isl_give isl_union_map *isl_union_map_zip(
2667 __isl_take isl_union_map *umap);
2669 Given a relation with nested relations for domain and range,
2670 interchange the range of the domain with the domain of the range.
2674 __isl_give isl_basic_map *isl_basic_map_curry(
2675 __isl_take isl_basic_map *bmap);
2676 __isl_give isl_basic_map *isl_basic_map_uncurry(
2677 __isl_take isl_basic_map *bmap);
2678 __isl_give isl_map *isl_map_curry(
2679 __isl_take isl_map *map);
2680 __isl_give isl_map *isl_map_uncurry(
2681 __isl_take isl_map *map);
2682 __isl_give isl_union_map *isl_union_map_curry(
2683 __isl_take isl_union_map *umap);
2684 __isl_give isl_union_map *isl_union_map_uncurry(
2685 __isl_take isl_union_map *umap);
2687 Given a relation with a nested relation for domain,
2688 the C<curry> functions
2689 move the range of the nested relation out of the domain
2690 and use it as the domain of a nested relation in the range,
2691 with the original range as range of this nested relation.
2692 The C<uncurry> functions perform the inverse operation.
2694 =item * Aligning parameters
2696 __isl_give isl_basic_set *isl_basic_set_align_params(
2697 __isl_take isl_basic_set *bset,
2698 __isl_take isl_space *model);
2699 __isl_give isl_set *isl_set_align_params(
2700 __isl_take isl_set *set,
2701 __isl_take isl_space *model);
2702 __isl_give isl_basic_map *isl_basic_map_align_params(
2703 __isl_take isl_basic_map *bmap,
2704 __isl_take isl_space *model);
2705 __isl_give isl_map *isl_map_align_params(
2706 __isl_take isl_map *map,
2707 __isl_take isl_space *model);
2709 Change the order of the parameters of the given set or relation
2710 such that the first parameters match those of C<model>.
2711 This may involve the introduction of extra parameters.
2712 All parameters need to be named.
2714 =item * Dimension manipulation
2716 __isl_give isl_basic_set *isl_basic_set_add_dims(
2717 __isl_take isl_basic_set *bset,
2718 enum isl_dim_type type, unsigned n);
2719 __isl_give isl_set *isl_set_add_dims(
2720 __isl_take isl_set *set,
2721 enum isl_dim_type type, unsigned n);
2722 __isl_give isl_map *isl_map_add_dims(
2723 __isl_take isl_map *map,
2724 enum isl_dim_type type, unsigned n);
2725 __isl_give isl_basic_set *isl_basic_set_insert_dims(
2726 __isl_take isl_basic_set *bset,
2727 enum isl_dim_type type, unsigned pos,
2729 __isl_give isl_basic_map *isl_basic_map_insert_dims(
2730 __isl_take isl_basic_map *bmap,
2731 enum isl_dim_type type, unsigned pos,
2733 __isl_give isl_set *isl_set_insert_dims(
2734 __isl_take isl_set *set,
2735 enum isl_dim_type type, unsigned pos, unsigned n);
2736 __isl_give isl_map *isl_map_insert_dims(
2737 __isl_take isl_map *map,
2738 enum isl_dim_type type, unsigned pos, unsigned n);
2739 __isl_give isl_basic_set *isl_basic_set_move_dims(
2740 __isl_take isl_basic_set *bset,
2741 enum isl_dim_type dst_type, unsigned dst_pos,
2742 enum isl_dim_type src_type, unsigned src_pos,
2744 __isl_give isl_basic_map *isl_basic_map_move_dims(
2745 __isl_take isl_basic_map *bmap,
2746 enum isl_dim_type dst_type, unsigned dst_pos,
2747 enum isl_dim_type src_type, unsigned src_pos,
2749 __isl_give isl_set *isl_set_move_dims(
2750 __isl_take isl_set *set,
2751 enum isl_dim_type dst_type, unsigned dst_pos,
2752 enum isl_dim_type src_type, unsigned src_pos,
2754 __isl_give isl_map *isl_map_move_dims(
2755 __isl_take isl_map *map,
2756 enum isl_dim_type dst_type, unsigned dst_pos,
2757 enum isl_dim_type src_type, unsigned src_pos,
2760 It is usually not advisable to directly change the (input or output)
2761 space of a set or a relation as this removes the name and the internal
2762 structure of the space. However, the above functions can be useful
2763 to add new parameters, assuming
2764 C<isl_set_align_params> and C<isl_map_align_params>
2769 =head2 Binary Operations
2771 The two arguments of a binary operation not only need to live
2772 in the same C<isl_ctx>, they currently also need to have
2773 the same (number of) parameters.
2775 =head3 Basic Operations
2779 =item * Intersection
2781 __isl_give isl_basic_set *isl_basic_set_intersect_params(
2782 __isl_take isl_basic_set *bset1,
2783 __isl_take isl_basic_set *bset2);
2784 __isl_give isl_basic_set *isl_basic_set_intersect(
2785 __isl_take isl_basic_set *bset1,
2786 __isl_take isl_basic_set *bset2);
2787 __isl_give isl_set *isl_set_intersect_params(
2788 __isl_take isl_set *set,
2789 __isl_take isl_set *params);
2790 __isl_give isl_set *isl_set_intersect(
2791 __isl_take isl_set *set1,
2792 __isl_take isl_set *set2);
2793 __isl_give isl_union_set *isl_union_set_intersect_params(
2794 __isl_take isl_union_set *uset,
2795 __isl_take isl_set *set);
2796 __isl_give isl_union_map *isl_union_map_intersect_params(
2797 __isl_take isl_union_map *umap,
2798 __isl_take isl_set *set);
2799 __isl_give isl_union_set *isl_union_set_intersect(
2800 __isl_take isl_union_set *uset1,
2801 __isl_take isl_union_set *uset2);
2802 __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2803 __isl_take isl_basic_map *bmap,
2804 __isl_take isl_basic_set *bset);
2805 __isl_give isl_basic_map *isl_basic_map_intersect_range(
2806 __isl_take isl_basic_map *bmap,
2807 __isl_take isl_basic_set *bset);
2808 __isl_give isl_basic_map *isl_basic_map_intersect(
2809 __isl_take isl_basic_map *bmap1,
2810 __isl_take isl_basic_map *bmap2);
2811 __isl_give isl_map *isl_map_intersect_params(
2812 __isl_take isl_map *map,
2813 __isl_take isl_set *params);
2814 __isl_give isl_map *isl_map_intersect_domain(
2815 __isl_take isl_map *map,
2816 __isl_take isl_set *set);
2817 __isl_give isl_map *isl_map_intersect_range(
2818 __isl_take isl_map *map,
2819 __isl_take isl_set *set);
2820 __isl_give isl_map *isl_map_intersect(
2821 __isl_take isl_map *map1,
2822 __isl_take isl_map *map2);
2823 __isl_give isl_union_map *isl_union_map_intersect_domain(
2824 __isl_take isl_union_map *umap,
2825 __isl_take isl_union_set *uset);
2826 __isl_give isl_union_map *isl_union_map_intersect_range(
2827 __isl_take isl_union_map *umap,
2828 __isl_take isl_union_set *uset);
2829 __isl_give isl_union_map *isl_union_map_intersect(
2830 __isl_take isl_union_map *umap1,
2831 __isl_take isl_union_map *umap2);
2833 The second argument to the C<_params> functions needs to be
2834 a parametric (basic) set. For the other functions, a parametric set
2835 for either argument is only allowed if the other argument is
2836 a parametric set as well.
2840 __isl_give isl_set *isl_basic_set_union(
2841 __isl_take isl_basic_set *bset1,
2842 __isl_take isl_basic_set *bset2);
2843 __isl_give isl_map *isl_basic_map_union(
2844 __isl_take isl_basic_map *bmap1,
2845 __isl_take isl_basic_map *bmap2);
2846 __isl_give isl_set *isl_set_union(
2847 __isl_take isl_set *set1,
2848 __isl_take isl_set *set2);
2849 __isl_give isl_map *isl_map_union(
2850 __isl_take isl_map *map1,
2851 __isl_take isl_map *map2);
2852 __isl_give isl_union_set *isl_union_set_union(
2853 __isl_take isl_union_set *uset1,
2854 __isl_take isl_union_set *uset2);
2855 __isl_give isl_union_map *isl_union_map_union(
2856 __isl_take isl_union_map *umap1,
2857 __isl_take isl_union_map *umap2);
2859 =item * Set difference
2861 __isl_give isl_set *isl_set_subtract(
2862 __isl_take isl_set *set1,
2863 __isl_take isl_set *set2);
2864 __isl_give isl_map *isl_map_subtract(
2865 __isl_take isl_map *map1,
2866 __isl_take isl_map *map2);
2867 __isl_give isl_map *isl_map_subtract_domain(
2868 __isl_take isl_map *map,
2869 __isl_take isl_set *dom);
2870 __isl_give isl_map *isl_map_subtract_range(
2871 __isl_take isl_map *map,
2872 __isl_take isl_set *dom);
2873 __isl_give isl_union_set *isl_union_set_subtract(
2874 __isl_take isl_union_set *uset1,
2875 __isl_take isl_union_set *uset2);
2876 __isl_give isl_union_map *isl_union_map_subtract(
2877 __isl_take isl_union_map *umap1,
2878 __isl_take isl_union_map *umap2);
2879 __isl_give isl_union_map *isl_union_map_subtract_domain(
2880 __isl_take isl_union_map *umap,
2881 __isl_take isl_union_set *dom);
2882 __isl_give isl_union_map *isl_union_map_subtract_range(
2883 __isl_take isl_union_map *umap,
2884 __isl_take isl_union_set *dom);
2888 __isl_give isl_basic_set *isl_basic_set_apply(
2889 __isl_take isl_basic_set *bset,
2890 __isl_take isl_basic_map *bmap);
2891 __isl_give isl_set *isl_set_apply(
2892 __isl_take isl_set *set,
2893 __isl_take isl_map *map);
2894 __isl_give isl_union_set *isl_union_set_apply(
2895 __isl_take isl_union_set *uset,
2896 __isl_take isl_union_map *umap);
2897 __isl_give isl_basic_map *isl_basic_map_apply_domain(
2898 __isl_take isl_basic_map *bmap1,
2899 __isl_take isl_basic_map *bmap2);
2900 __isl_give isl_basic_map *isl_basic_map_apply_range(
2901 __isl_take isl_basic_map *bmap1,
2902 __isl_take isl_basic_map *bmap2);
2903 __isl_give isl_map *isl_map_apply_domain(
2904 __isl_take isl_map *map1,
2905 __isl_take isl_map *map2);
2906 __isl_give isl_union_map *isl_union_map_apply_domain(
2907 __isl_take isl_union_map *umap1,
2908 __isl_take isl_union_map *umap2);
2909 __isl_give isl_map *isl_map_apply_range(
2910 __isl_take isl_map *map1,
2911 __isl_take isl_map *map2);
2912 __isl_give isl_union_map *isl_union_map_apply_range(
2913 __isl_take isl_union_map *umap1,
2914 __isl_take isl_union_map *umap2);
2918 __isl_give isl_basic_set *
2919 isl_basic_set_preimage_multi_aff(
2920 __isl_take isl_basic_set *bset,
2921 __isl_take isl_multi_aff *ma);
2922 __isl_give isl_set *isl_set_preimage_multi_aff(
2923 __isl_take isl_set *set,
2924 __isl_take isl_multi_aff *ma);
2925 __isl_give isl_set *isl_set_preimage_pw_multi_aff(
2926 __isl_take isl_set *set,
2927 __isl_take isl_pw_multi_aff *pma);
2928 __isl_give isl_basic_map *
2929 isl_basic_map_preimage_domain_multi_aff(
2930 __isl_take isl_basic_map *bmap,
2931 __isl_take isl_multi_aff *ma);
2932 __isl_give isl_map *isl_map_preimage_domain_multi_aff(
2933 __isl_take isl_map *map,
2934 __isl_take isl_multi_aff *ma);
2935 __isl_give isl_union_map *
2936 isl_union_map_preimage_domain_multi_aff(
2937 __isl_take isl_union_map *umap,
2938 __isl_take isl_multi_aff *ma);
2939 __isl_give isl_basic_map *
2940 isl_basic_map_preimage_range_multi_aff(
2941 __isl_take isl_basic_map *bmap,
2942 __isl_take isl_multi_aff *ma);
2944 These functions compute the preimage of the given set or map domain/range under
2945 the given function. In other words, the expression is plugged
2946 into the set description or into the domain/range of the map.
2947 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
2948 L</"Piecewise Multiple Quasi Affine Expressions">.
2950 =item * Cartesian Product
2952 __isl_give isl_set *isl_set_product(
2953 __isl_take isl_set *set1,
2954 __isl_take isl_set *set2);
2955 __isl_give isl_union_set *isl_union_set_product(
2956 __isl_take isl_union_set *uset1,
2957 __isl_take isl_union_set *uset2);
2958 __isl_give isl_basic_map *isl_basic_map_domain_product(
2959 __isl_take isl_basic_map *bmap1,
2960 __isl_take isl_basic_map *bmap2);
2961 __isl_give isl_basic_map *isl_basic_map_range_product(
2962 __isl_take isl_basic_map *bmap1,
2963 __isl_take isl_basic_map *bmap2);
2964 __isl_give isl_basic_map *isl_basic_map_product(
2965 __isl_take isl_basic_map *bmap1,
2966 __isl_take isl_basic_map *bmap2);
2967 __isl_give isl_map *isl_map_domain_product(
2968 __isl_take isl_map *map1,
2969 __isl_take isl_map *map2);
2970 __isl_give isl_map *isl_map_range_product(
2971 __isl_take isl_map *map1,
2972 __isl_take isl_map *map2);
2973 __isl_give isl_union_map *isl_union_map_domain_product(
2974 __isl_take isl_union_map *umap1,
2975 __isl_take isl_union_map *umap2);
2976 __isl_give isl_union_map *isl_union_map_range_product(
2977 __isl_take isl_union_map *umap1,
2978 __isl_take isl_union_map *umap2);
2979 __isl_give isl_map *isl_map_product(
2980 __isl_take isl_map *map1,
2981 __isl_take isl_map *map2);
2982 __isl_give isl_union_map *isl_union_map_product(
2983 __isl_take isl_union_map *umap1,
2984 __isl_take isl_union_map *umap2);
2986 The above functions compute the cross product of the given
2987 sets or relations. The domains and ranges of the results
2988 are wrapped maps between domains and ranges of the inputs.
2989 To obtain a ``flat'' product, use the following functions
2992 __isl_give isl_basic_set *isl_basic_set_flat_product(
2993 __isl_take isl_basic_set *bset1,
2994 __isl_take isl_basic_set *bset2);
2995 __isl_give isl_set *isl_set_flat_product(
2996 __isl_take isl_set *set1,
2997 __isl_take isl_set *set2);
2998 __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2999 __isl_take isl_basic_map *bmap1,
3000 __isl_take isl_basic_map *bmap2);
3001 __isl_give isl_map *isl_map_flat_domain_product(
3002 __isl_take isl_map *map1,
3003 __isl_take isl_map *map2);
3004 __isl_give isl_map *isl_map_flat_range_product(
3005 __isl_take isl_map *map1,
3006 __isl_take isl_map *map2);
3007 __isl_give isl_union_map *isl_union_map_flat_range_product(
3008 __isl_take isl_union_map *umap1,
3009 __isl_take isl_union_map *umap2);
3010 __isl_give isl_basic_map *isl_basic_map_flat_product(
3011 __isl_take isl_basic_map *bmap1,
3012 __isl_take isl_basic_map *bmap2);
3013 __isl_give isl_map *isl_map_flat_product(
3014 __isl_take isl_map *map1,
3015 __isl_take isl_map *map2);
3017 =item * Simplification
3019 __isl_give isl_basic_set *isl_basic_set_gist(
3020 __isl_take isl_basic_set *bset,
3021 __isl_take isl_basic_set *context);
3022 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
3023 __isl_take isl_set *context);
3024 __isl_give isl_set *isl_set_gist_params(
3025 __isl_take isl_set *set,
3026 __isl_take isl_set *context);
3027 __isl_give isl_union_set *isl_union_set_gist(
3028 __isl_take isl_union_set *uset,
3029 __isl_take isl_union_set *context);
3030 __isl_give isl_union_set *isl_union_set_gist_params(
3031 __isl_take isl_union_set *uset,
3032 __isl_take isl_set *set);
3033 __isl_give isl_basic_map *isl_basic_map_gist(
3034 __isl_take isl_basic_map *bmap,
3035 __isl_take isl_basic_map *context);
3036 __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
3037 __isl_take isl_map *context);
3038 __isl_give isl_map *isl_map_gist_params(
3039 __isl_take isl_map *map,
3040 __isl_take isl_set *context);
3041 __isl_give isl_map *isl_map_gist_domain(
3042 __isl_take isl_map *map,
3043 __isl_take isl_set *context);
3044 __isl_give isl_map *isl_map_gist_range(
3045 __isl_take isl_map *map,
3046 __isl_take isl_set *context);
3047 __isl_give isl_union_map *isl_union_map_gist(
3048 __isl_take isl_union_map *umap,
3049 __isl_take isl_union_map *context);
3050 __isl_give isl_union_map *isl_union_map_gist_params(
3051 __isl_take isl_union_map *umap,
3052 __isl_take isl_set *set);
3053 __isl_give isl_union_map *isl_union_map_gist_domain(
3054 __isl_take isl_union_map *umap,
3055 __isl_take isl_union_set *uset);
3056 __isl_give isl_union_map *isl_union_map_gist_range(
3057 __isl_take isl_union_map *umap,
3058 __isl_take isl_union_set *uset);
3060 The gist operation returns a set or relation that has the
3061 same intersection with the context as the input set or relation.
3062 Any implicit equality in the intersection is made explicit in the result,
3063 while all inequalities that are redundant with respect to the intersection
3065 In case of union sets and relations, the gist operation is performed
3070 =head3 Lexicographic Optimization
3072 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
3073 the following functions
3074 compute a set that contains the lexicographic minimum or maximum
3075 of the elements in C<set> (or C<bset>) for those values of the parameters
3076 that satisfy C<dom>.
3077 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3078 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
3080 In other words, the union of the parameter values
3081 for which the result is non-empty and of C<*empty>
3084 __isl_give isl_set *isl_basic_set_partial_lexmin(
3085 __isl_take isl_basic_set *bset,
3086 __isl_take isl_basic_set *dom,
3087 __isl_give isl_set **empty);
3088 __isl_give isl_set *isl_basic_set_partial_lexmax(
3089 __isl_take isl_basic_set *bset,
3090 __isl_take isl_basic_set *dom,
3091 __isl_give isl_set **empty);
3092 __isl_give isl_set *isl_set_partial_lexmin(
3093 __isl_take isl_set *set, __isl_take isl_set *dom,
3094 __isl_give isl_set **empty);
3095 __isl_give isl_set *isl_set_partial_lexmax(
3096 __isl_take isl_set *set, __isl_take isl_set *dom,
3097 __isl_give isl_set **empty);
3099 Given a (basic) set C<set> (or C<bset>), the following functions simply
3100 return a set containing the lexicographic minimum or maximum
3101 of the elements in C<set> (or C<bset>).
3102 In case of union sets, the optimum is computed per space.
3104 __isl_give isl_set *isl_basic_set_lexmin(
3105 __isl_take isl_basic_set *bset);
3106 __isl_give isl_set *isl_basic_set_lexmax(
3107 __isl_take isl_basic_set *bset);
3108 __isl_give isl_set *isl_set_lexmin(
3109 __isl_take isl_set *set);
3110 __isl_give isl_set *isl_set_lexmax(
3111 __isl_take isl_set *set);
3112 __isl_give isl_union_set *isl_union_set_lexmin(
3113 __isl_take isl_union_set *uset);
3114 __isl_give isl_union_set *isl_union_set_lexmax(
3115 __isl_take isl_union_set *uset);
3117 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3118 the following functions
3119 compute a relation that maps each element of C<dom>
3120 to the single lexicographic minimum or maximum
3121 of the elements that are associated to that same
3122 element in C<map> (or C<bmap>).
3123 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3124 that contains the elements in C<dom> that do not map
3125 to any elements in C<map> (or C<bmap>).
3126 In other words, the union of the domain of the result and of C<*empty>
3129 __isl_give isl_map *isl_basic_map_partial_lexmax(
3130 __isl_take isl_basic_map *bmap,
3131 __isl_take isl_basic_set *dom,
3132 __isl_give isl_set **empty);
3133 __isl_give isl_map *isl_basic_map_partial_lexmin(
3134 __isl_take isl_basic_map *bmap,
3135 __isl_take isl_basic_set *dom,
3136 __isl_give isl_set **empty);
3137 __isl_give isl_map *isl_map_partial_lexmax(
3138 __isl_take isl_map *map, __isl_take isl_set *dom,
3139 __isl_give isl_set **empty);
3140 __isl_give isl_map *isl_map_partial_lexmin(
3141 __isl_take isl_map *map, __isl_take isl_set *dom,
3142 __isl_give isl_set **empty);
3144 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3145 return a map mapping each element in the domain of
3146 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3147 of all elements associated to that element.
3148 In case of union relations, the optimum is computed per space.
3150 __isl_give isl_map *isl_basic_map_lexmin(
3151 __isl_take isl_basic_map *bmap);
3152 __isl_give isl_map *isl_basic_map_lexmax(
3153 __isl_take isl_basic_map *bmap);
3154 __isl_give isl_map *isl_map_lexmin(
3155 __isl_take isl_map *map);
3156 __isl_give isl_map *isl_map_lexmax(
3157 __isl_take isl_map *map);
3158 __isl_give isl_union_map *isl_union_map_lexmin(
3159 __isl_take isl_union_map *umap);
3160 __isl_give isl_union_map *isl_union_map_lexmax(
3161 __isl_take isl_union_map *umap);
3163 The following functions return their result in the form of
3164 a piecewise multi-affine expression
3165 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3166 but are otherwise equivalent to the corresponding functions
3167 returning a basic set or relation.
3169 __isl_give isl_pw_multi_aff *
3170 isl_basic_map_lexmin_pw_multi_aff(
3171 __isl_take isl_basic_map *bmap);
3172 __isl_give isl_pw_multi_aff *
3173 isl_basic_set_partial_lexmin_pw_multi_aff(
3174 __isl_take isl_basic_set *bset,
3175 __isl_take isl_basic_set *dom,
3176 __isl_give isl_set **empty);
3177 __isl_give isl_pw_multi_aff *
3178 isl_basic_set_partial_lexmax_pw_multi_aff(
3179 __isl_take isl_basic_set *bset,
3180 __isl_take isl_basic_set *dom,
3181 __isl_give isl_set **empty);
3182 __isl_give isl_pw_multi_aff *
3183 isl_basic_map_partial_lexmin_pw_multi_aff(
3184 __isl_take isl_basic_map *bmap,
3185 __isl_take isl_basic_set *dom,
3186 __isl_give isl_set **empty);
3187 __isl_give isl_pw_multi_aff *
3188 isl_basic_map_partial_lexmax_pw_multi_aff(
3189 __isl_take isl_basic_map *bmap,
3190 __isl_take isl_basic_set *dom,
3191 __isl_give isl_set **empty);
3192 __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3193 __isl_take isl_set *set);
3194 __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3195 __isl_take isl_set *set);
3196 __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3197 __isl_take isl_map *map);
3198 __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3199 __isl_take isl_map *map);
3203 Lists are defined over several element types, including
3204 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3205 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3206 Here we take lists of C<isl_set>s as an example.
3207 Lists can be created, copied, modified and freed using the following functions.
3209 #include <isl/list.h>
3210 __isl_give isl_set_list *isl_set_list_from_set(
3211 __isl_take isl_set *el);
3212 __isl_give isl_set_list *isl_set_list_alloc(
3213 isl_ctx *ctx, int n);
3214 __isl_give isl_set_list *isl_set_list_copy(
3215 __isl_keep isl_set_list *list);
3216 __isl_give isl_set_list *isl_set_list_insert(
3217 __isl_take isl_set_list *list, unsigned pos,
3218 __isl_take isl_set *el);
3219 __isl_give isl_set_list *isl_set_list_add(
3220 __isl_take isl_set_list *list,
3221 __isl_take isl_set *el);
3222 __isl_give isl_set_list *isl_set_list_drop(
3223 __isl_take isl_set_list *list,
3224 unsigned first, unsigned n);
3225 __isl_give isl_set_list *isl_set_list_set_set(
3226 __isl_take isl_set_list *list, int index,
3227 __isl_take isl_set *set);
3228 __isl_give isl_set_list *isl_set_list_concat(
3229 __isl_take isl_set_list *list1,
3230 __isl_take isl_set_list *list2);
3231 __isl_give isl_set_list *isl_set_list_sort(
3232 __isl_take isl_set_list *list,
3233 int (*cmp)(__isl_keep isl_set *a,
3234 __isl_keep isl_set *b, void *user),
3236 void *isl_set_list_free(__isl_take isl_set_list *list);
3238 C<isl_set_list_alloc> creates an empty list with a capacity for
3239 C<n> elements. C<isl_set_list_from_set> creates a list with a single
3242 Lists can be inspected using the following functions.
3244 #include <isl/list.h>
3245 isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3246 int isl_set_list_n_set(__isl_keep isl_set_list *list);
3247 __isl_give isl_set *isl_set_list_get_set(
3248 __isl_keep isl_set_list *list, int index);
3249 int isl_set_list_foreach(__isl_keep isl_set_list *list,
3250 int (*fn)(__isl_take isl_set *el, void *user),
3252 int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3253 int (*follows)(__isl_keep isl_set *a,
3254 __isl_keep isl_set *b, void *user),
3256 int (*fn)(__isl_take isl_set *el, void *user),
3259 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3260 strongly connected components of the graph with as vertices the elements
3261 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3262 iff C<follows(a, b)> returns C<1>. The callbacks C<follows> and C<fn>
3263 should return C<-1> on error.
3265 Lists can be printed using
3267 #include <isl/list.h>
3268 __isl_give isl_printer *isl_printer_print_set_list(
3269 __isl_take isl_printer *p,
3270 __isl_keep isl_set_list *list);
3272 =head2 Multiple Values
3274 An C<isl_multi_val> object represents a sequence of zero or more values,
3275 living in a set space.
3277 An C<isl_multi_val> can be constructed from an C<isl_val_list>
3278 using the following function
3280 #include <isl/val.h>
3281 __isl_give isl_multi_val *isl_multi_val_from_val_list(
3282 __isl_take isl_space *space,
3283 __isl_take isl_val_list *list);
3285 The zero multiple value (with value zero for each set dimension)
3286 can be created using the following function.
3288 #include <isl/val.h>
3289 __isl_give isl_multi_val *isl_multi_val_zero(
3290 __isl_take isl_space *space);
3292 Multiple values can be copied and freed using
3294 #include <isl/val.h>
3295 __isl_give isl_multi_val *isl_multi_val_copy(
3296 __isl_keep isl_multi_val *mv);
3297 void *isl_multi_val_free(__isl_take isl_multi_val *mv);
3299 They can be inspected using
3301 #include <isl/val.h>
3302 isl_ctx *isl_multi_val_get_ctx(
3303 __isl_keep isl_multi_val *mv);
3304 unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
3305 enum isl_dim_type type);
3306 __isl_give isl_val *isl_multi_val_get_val(
3307 __isl_keep isl_multi_val *mv, int pos);
3308 int isl_multi_val_find_dim_by_id(
3309 __isl_keep isl_multi_val *mv,
3310 enum isl_dim_type type, __isl_keep isl_id *id);
3311 __isl_give isl_id *isl_multi_val_get_dim_id(
3312 __isl_keep isl_multi_val *mv,
3313 enum isl_dim_type type, unsigned pos);
3314 const char *isl_multi_val_get_tuple_name(
3315 __isl_keep isl_multi_val *mv,
3316 enum isl_dim_type type);
3317 int isl_multi_val_has_tuple_id(__isl_keep isl_multi_val *mv,
3318 enum isl_dim_type type);
3319 __isl_give isl_id *isl_multi_val_get_tuple_id(
3320 __isl_keep isl_multi_val *mv,
3321 enum isl_dim_type type);
3322 __isl_give isl_multi_val *isl_multi_val_reset_tuple_id(
3323 __isl_take isl_multi_val *mv,
3324 enum isl_dim_type type);
3326 They can be modified using
3328 #include <isl/val.h>
3329 __isl_give isl_multi_val *isl_multi_val_set_val(
3330 __isl_take isl_multi_val *mv, int pos,
3331 __isl_take isl_val *val);
3332 __isl_give isl_multi_val *isl_multi_val_set_dim_name(
3333 __isl_take isl_multi_val *mv,
3334 enum isl_dim_type type, unsigned pos, const char *s);
3335 __isl_give isl_multi_val *isl_multi_val_set_dim_id(
3336 __isl_take isl_multi_val *mv,
3337 enum isl_dim_type type, unsigned pos,
3338 __isl_take isl_id *id);
3339 __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
3340 __isl_take isl_multi_val *mv,
3341 enum isl_dim_type type, const char *s);
3342 __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
3343 __isl_take isl_multi_val *mv,
3344 enum isl_dim_type type, __isl_take isl_id *id);
3346 __isl_give isl_multi_val *isl_multi_val_insert_dims(
3347 __isl_take isl_multi_val *mv,
3348 enum isl_dim_type type, unsigned first, unsigned n);
3349 __isl_give isl_multi_val *isl_multi_val_add_dims(
3350 __isl_take isl_multi_val *mv,
3351 enum isl_dim_type type, unsigned n);
3352 __isl_give isl_multi_val *isl_multi_val_drop_dims(
3353 __isl_take isl_multi_val *mv,
3354 enum isl_dim_type type, unsigned first, unsigned n);
3358 #include <isl/val.h>
3359 __isl_give isl_multi_val *isl_multi_val_align_params(
3360 __isl_take isl_multi_val *mv,
3361 __isl_take isl_space *model);
3362 __isl_give isl_multi_val *isl_multi_val_from_range(
3363 __isl_take isl_multi_val *mv);
3364 __isl_give isl_multi_val *isl_multi_val_range_splice(
3365 __isl_take isl_multi_val *mv1, unsigned pos,
3366 __isl_take isl_multi_val *mv2);
3367 __isl_give isl_multi_val *isl_multi_val_range_product(
3368 __isl_take isl_multi_val *mv1,
3369 __isl_take isl_multi_val *mv2);
3370 __isl_give isl_multi_val *isl_multi_val_flat_range_product(
3371 __isl_take isl_multi_val *mv1,
3372 __isl_take isl_multi_aff *mv2);
3373 __isl_give isl_multi_val *isl_multi_val_product(
3374 __isl_take isl_multi_val *mv1,
3375 __isl_take isl_multi_val *mv2);
3376 __isl_give isl_multi_val *isl_multi_val_add_val(
3377 __isl_take isl_multi_val *mv,
3378 __isl_take isl_val *v);
3379 __isl_give isl_multi_val *isl_multi_val_mod_val(
3380 __isl_take isl_multi_val *mv,
3381 __isl_take isl_val *v);
3382 __isl_give isl_multi_val *isl_multi_val_scale_val(
3383 __isl_take isl_multi_val *mv,
3384 __isl_take isl_val *v);
3385 __isl_give isl_multi_val *isl_multi_val_scale_multi_val(
3386 __isl_take isl_multi_val *mv1,
3387 __isl_take isl_multi_val *mv2);
3388 __isl_give isl_multi_val *
3389 isl_multi_val_scale_down_multi_val(
3390 __isl_take isl_multi_val *mv1,
3391 __isl_take isl_multi_val *mv2);
3393 A multiple value can be printed using
3395 __isl_give isl_printer *isl_printer_print_multi_val(
3396 __isl_take isl_printer *p,
3397 __isl_keep isl_multi_val *mv);
3401 Vectors can be created, copied and freed using the following functions.
3403 #include <isl/vec.h>
3404 __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3406 __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3407 void *isl_vec_free(__isl_take isl_vec *vec);
3409 Note that the elements of a newly created vector may have arbitrary values.
3410 The elements can be changed and inspected using the following functions.
3412 isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3413 int isl_vec_size(__isl_keep isl_vec *vec);
3414 __isl_give isl_val *isl_vec_get_element_val(
3415 __isl_keep isl_vec *vec, int pos);
3416 __isl_give isl_vec *isl_vec_set_element_si(
3417 __isl_take isl_vec *vec, int pos, int v);
3418 __isl_give isl_vec *isl_vec_set_element_val(
3419 __isl_take isl_vec *vec, int pos,
3420 __isl_take isl_val *v);
3421 __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3423 __isl_give isl_vec *isl_vec_set_val(
3424 __isl_take isl_vec *vec, __isl_take isl_val *v);
3425 int isl_vec_cmp_element(__isl_keep isl_vec *vec1,
3426 __isl_keep isl_vec *vec2, int pos);
3428 C<isl_vec_get_element> will return a negative value if anything went wrong.
3429 In that case, the value of C<*v> is undefined.
3431 The following function can be used to concatenate two vectors.
3433 __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3434 __isl_take isl_vec *vec2);
3438 Matrices can be created, copied and freed using the following functions.
3440 #include <isl/mat.h>
3441 __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3442 unsigned n_row, unsigned n_col);
3443 __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3444 void *isl_mat_free(__isl_take isl_mat *mat);
3446 Note that the elements of a newly created matrix may have arbitrary values.
3447 The elements can be changed and inspected using the following functions.
3449 isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3450 int isl_mat_rows(__isl_keep isl_mat *mat);
3451 int isl_mat_cols(__isl_keep isl_mat *mat);
3452 __isl_give isl_val *isl_mat_get_element_val(
3453 __isl_keep isl_mat *mat, int row, int col);
3454 __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3455 int row, int col, int v);
3456 __isl_give isl_mat *isl_mat_set_element_val(
3457 __isl_take isl_mat *mat, int row, int col,
3458 __isl_take isl_val *v);
3460 C<isl_mat_get_element> will return a negative value if anything went wrong.
3461 In that case, the value of C<*v> is undefined.
3463 The following function can be used to compute the (right) inverse
3464 of a matrix, i.e., a matrix such that the product of the original
3465 and the inverse (in that order) is a multiple of the identity matrix.
3466 The input matrix is assumed to be of full row-rank.
3468 __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3470 The following function can be used to compute the (right) kernel
3471 (or null space) of a matrix, i.e., a matrix such that the product of
3472 the original and the kernel (in that order) is the zero matrix.
3474 __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3476 =head2 Piecewise Quasi Affine Expressions
3478 The zero quasi affine expression or the quasi affine expression
3479 that is equal to a given value or
3480 a specified dimension on a given domain can be created using
3482 __isl_give isl_aff *isl_aff_zero_on_domain(
3483 __isl_take isl_local_space *ls);
3484 __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3485 __isl_take isl_local_space *ls);
3486 __isl_give isl_aff *isl_aff_val_on_domain(
3487 __isl_take isl_local_space *ls,
3488 __isl_take isl_val *val);
3489 __isl_give isl_aff *isl_aff_var_on_domain(
3490 __isl_take isl_local_space *ls,
3491 enum isl_dim_type type, unsigned pos);
3492 __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3493 __isl_take isl_local_space *ls,
3494 enum isl_dim_type type, unsigned pos);
3496 Note that the space in which the resulting objects live is a map space
3497 with the given space as domain and a one-dimensional range.
3499 An empty piecewise quasi affine expression (one with no cells)
3500 or a piecewise quasi affine expression with a single cell can
3501 be created using the following functions.
3503 #include <isl/aff.h>
3504 __isl_give isl_pw_aff *isl_pw_aff_empty(
3505 __isl_take isl_space *space);
3506 __isl_give isl_pw_aff *isl_pw_aff_alloc(
3507 __isl_take isl_set *set, __isl_take isl_aff *aff);
3508 __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3509 __isl_take isl_aff *aff);
3511 A piecewise quasi affine expression that is equal to 1 on a set
3512 and 0 outside the set can be created using the following function.
3514 #include <isl/aff.h>
3515 __isl_give isl_pw_aff *isl_set_indicator_function(
3516 __isl_take isl_set *set);
3518 Quasi affine expressions can be copied and freed using
3520 #include <isl/aff.h>
3521 __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3522 void *isl_aff_free(__isl_take isl_aff *aff);
3524 __isl_give isl_pw_aff *isl_pw_aff_copy(
3525 __isl_keep isl_pw_aff *pwaff);
3526 void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3528 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3529 using the following function. The constraint is required to have
3530 a non-zero coefficient for the specified dimension.
3532 #include <isl/constraint.h>
3533 __isl_give isl_aff *isl_constraint_get_bound(
3534 __isl_keep isl_constraint *constraint,
3535 enum isl_dim_type type, int pos);
3537 The entire affine expression of the constraint can also be extracted
3538 using the following function.
3540 #include <isl/constraint.h>
3541 __isl_give isl_aff *isl_constraint_get_aff(
3542 __isl_keep isl_constraint *constraint);
3544 Conversely, an equality constraint equating
3545 the affine expression to zero or an inequality constraint enforcing
3546 the affine expression to be non-negative, can be constructed using
3548 __isl_give isl_constraint *isl_equality_from_aff(
3549 __isl_take isl_aff *aff);
3550 __isl_give isl_constraint *isl_inequality_from_aff(
3551 __isl_take isl_aff *aff);
3553 The expression can be inspected using
3555 #include <isl/aff.h>
3556 isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3557 int isl_aff_dim(__isl_keep isl_aff *aff,
3558 enum isl_dim_type type);
3559 __isl_give isl_local_space *isl_aff_get_domain_local_space(
3560 __isl_keep isl_aff *aff);
3561 __isl_give isl_local_space *isl_aff_get_local_space(
3562 __isl_keep isl_aff *aff);
3563 const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3564 enum isl_dim_type type, unsigned pos);
3565 const char *isl_pw_aff_get_dim_name(
3566 __isl_keep isl_pw_aff *pa,
3567 enum isl_dim_type type, unsigned pos);
3568 int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3569 enum isl_dim_type type, unsigned pos);
3570 __isl_give isl_id *isl_pw_aff_get_dim_id(
3571 __isl_keep isl_pw_aff *pa,
3572 enum isl_dim_type type, unsigned pos);
3573 int isl_pw_aff_has_tuple_id(__isl_keep isl_pw_aff *pa,
3574 enum isl_dim_type type);
3575 __isl_give isl_id *isl_pw_aff_get_tuple_id(
3576 __isl_keep isl_pw_aff *pa,
3577 enum isl_dim_type type);
3578 __isl_give isl_val *isl_aff_get_constant_val(
3579 __isl_keep isl_aff *aff);
3580 __isl_give isl_val *isl_aff_get_coefficient_val(
3581 __isl_keep isl_aff *aff,
3582 enum isl_dim_type type, int pos);
3583 __isl_give isl_val *isl_aff_get_denominator_val(
3584 __isl_keep isl_aff *aff);
3585 __isl_give isl_aff *isl_aff_get_div(
3586 __isl_keep isl_aff *aff, int pos);
3588 int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3589 int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3590 int (*fn)(__isl_take isl_set *set,
3591 __isl_take isl_aff *aff,
3592 void *user), void *user);
3594 int isl_aff_is_cst(__isl_keep isl_aff *aff);
3595 int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3597 int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3598 enum isl_dim_type type, unsigned first, unsigned n);
3599 int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3600 enum isl_dim_type type, unsigned first, unsigned n);
3602 isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3603 unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3604 enum isl_dim_type type);
3605 int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3607 It can be modified using
3609 #include <isl/aff.h>
3610 __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3611 __isl_take isl_pw_aff *pwaff,
3612 enum isl_dim_type type, __isl_take isl_id *id);
3613 __isl_give isl_aff *isl_aff_set_dim_name(
3614 __isl_take isl_aff *aff, enum isl_dim_type type,
3615 unsigned pos, const char *s);
3616 __isl_give isl_aff *isl_aff_set_dim_id(
3617 __isl_take isl_aff *aff, enum isl_dim_type type,
3618 unsigned pos, __isl_take isl_id *id);
3619 __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3620 __isl_take isl_pw_aff *pma,
3621 enum isl_dim_type type, unsigned pos,
3622 __isl_take isl_id *id);
3623 __isl_give isl_aff *isl_aff_set_constant_si(
3624 __isl_take isl_aff *aff, int v);
3625 __isl_give isl_aff *isl_aff_set_constant_val(
3626 __isl_take isl_aff *aff, __isl_take isl_val *v);
3627 __isl_give isl_aff *isl_aff_set_coefficient_si(
3628 __isl_take isl_aff *aff,
3629 enum isl_dim_type type, int pos, int v);
3630 __isl_give isl_aff *isl_aff_set_coefficient_val(
3631 __isl_take isl_aff *aff,
3632 enum isl_dim_type type, int pos,
3633 __isl_take isl_val *v);
3635 __isl_give isl_aff *isl_aff_add_constant_si(
3636 __isl_take isl_aff *aff, int v);
3637 __isl_give isl_aff *isl_aff_add_constant_val(
3638 __isl_take isl_aff *aff, __isl_take isl_val *v);
3639 __isl_give isl_aff *isl_aff_add_constant_num_si(
3640 __isl_take isl_aff *aff, int v);
3641 __isl_give isl_aff *isl_aff_add_coefficient_si(
3642 __isl_take isl_aff *aff,
3643 enum isl_dim_type type, int pos, int v);
3644 __isl_give isl_aff *isl_aff_add_coefficient_val(
3645 __isl_take isl_aff *aff,
3646 enum isl_dim_type type, int pos,
3647 __isl_take isl_val *v);
3649 __isl_give isl_aff *isl_aff_insert_dims(
3650 __isl_take isl_aff *aff,
3651 enum isl_dim_type type, unsigned first, unsigned n);
3652 __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3653 __isl_take isl_pw_aff *pwaff,
3654 enum isl_dim_type type, unsigned first, unsigned n);
3655 __isl_give isl_aff *isl_aff_add_dims(
3656 __isl_take isl_aff *aff,
3657 enum isl_dim_type type, unsigned n);
3658 __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3659 __isl_take isl_pw_aff *pwaff,
3660 enum isl_dim_type type, unsigned n);
3661 __isl_give isl_aff *isl_aff_drop_dims(
3662 __isl_take isl_aff *aff,
3663 enum isl_dim_type type, unsigned first, unsigned n);
3664 __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3665 __isl_take isl_pw_aff *pwaff,
3666 enum isl_dim_type type, unsigned first, unsigned n);
3667 __isl_give isl_aff *isl_aff_move_dims(
3668 __isl_take isl_aff *aff,
3669 enum isl_dim_type dst_type, unsigned dst_pos,
3670 enum isl_dim_type src_type, unsigned src_pos,
3672 __isl_give isl_pw_aff *isl_pw_aff_move_dims(
3673 __isl_take isl_pw_aff *pa,
3674 enum isl_dim_type dst_type, unsigned dst_pos,
3675 enum isl_dim_type src_type, unsigned src_pos,
3678 Note that C<isl_aff_set_constant_si> and C<isl_aff_set_coefficient_si>
3679 set the I<numerator> of the constant or coefficient, while
3680 C<isl_aff_set_constant_val> and C<isl_aff_set_coefficient_val> set
3681 the constant or coefficient as a whole.
3682 The C<add_constant> and C<add_coefficient> functions add an integer
3683 or rational value to
3684 the possibly rational constant or coefficient.
3685 The C<add_constant_num> functions add an integer value to
3688 To check whether an affine expressions is obviously zero
3689 or obviously equal to some other affine expression, use
3691 #include <isl/aff.h>
3692 int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3693 int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3694 __isl_keep isl_aff *aff2);
3695 int isl_pw_aff_plain_is_equal(
3696 __isl_keep isl_pw_aff *pwaff1,
3697 __isl_keep isl_pw_aff *pwaff2);
3701 #include <isl/aff.h>
3702 __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3703 __isl_take isl_aff *aff2);
3704 __isl_give isl_pw_aff *isl_pw_aff_add(
3705 __isl_take isl_pw_aff *pwaff1,
3706 __isl_take isl_pw_aff *pwaff2);
3707 __isl_give isl_pw_aff *isl_pw_aff_min(
3708 __isl_take isl_pw_aff *pwaff1,
3709 __isl_take isl_pw_aff *pwaff2);
3710 __isl_give isl_pw_aff *isl_pw_aff_max(
3711 __isl_take isl_pw_aff *pwaff1,
3712 __isl_take isl_pw_aff *pwaff2);
3713 __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3714 __isl_take isl_aff *aff2);
3715 __isl_give isl_pw_aff *isl_pw_aff_sub(
3716 __isl_take isl_pw_aff *pwaff1,
3717 __isl_take isl_pw_aff *pwaff2);
3718 __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3719 __isl_give isl_pw_aff *isl_pw_aff_neg(
3720 __isl_take isl_pw_aff *pwaff);
3721 __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3722 __isl_give isl_pw_aff *isl_pw_aff_ceil(
3723 __isl_take isl_pw_aff *pwaff);
3724 __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3725 __isl_give isl_pw_aff *isl_pw_aff_floor(
3726 __isl_take isl_pw_aff *pwaff);
3727 __isl_give isl_aff *isl_aff_mod_val(__isl_take isl_aff *aff,
3728 __isl_take isl_val *mod);
3729 __isl_give isl_pw_aff *isl_pw_aff_mod_val(
3730 __isl_take isl_pw_aff *pa,
3731 __isl_take isl_val *mod);
3732 __isl_give isl_aff *isl_aff_scale_val(__isl_take isl_aff *aff,
3733 __isl_take isl_val *v);
3734 __isl_give isl_pw_aff *isl_pw_aff_scale_val(
3735 __isl_take isl_pw_aff *pa, __isl_take isl_val *v);
3736 __isl_give isl_aff *isl_aff_scale_down_ui(
3737 __isl_take isl_aff *aff, unsigned f);
3738 __isl_give isl_aff *isl_aff_scale_down_val(
3739 __isl_take isl_aff *aff, __isl_take isl_val *v);
3740 __isl_give isl_pw_aff *isl_pw_aff_scale_down_val(
3741 __isl_take isl_pw_aff *pa,
3742 __isl_take isl_val *f);
3744 __isl_give isl_pw_aff *isl_pw_aff_list_min(
3745 __isl_take isl_pw_aff_list *list);
3746 __isl_give isl_pw_aff *isl_pw_aff_list_max(
3747 __isl_take isl_pw_aff_list *list);
3749 __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3750 __isl_take isl_pw_aff *pwqp);
3752 __isl_give isl_aff *isl_aff_align_params(
3753 __isl_take isl_aff *aff,
3754 __isl_take isl_space *model);
3755 __isl_give isl_pw_aff *isl_pw_aff_align_params(
3756 __isl_take isl_pw_aff *pwaff,
3757 __isl_take isl_space *model);
3759 __isl_give isl_aff *isl_aff_project_domain_on_params(
3760 __isl_take isl_aff *aff);
3761 __isl_give isl_pw_aff *isl_pw_aff_from_range(
3762 __isl_take isl_pw_aff *pwa);
3764 __isl_give isl_aff *isl_aff_gist_params(
3765 __isl_take isl_aff *aff,
3766 __isl_take isl_set *context);
3767 __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3768 __isl_take isl_set *context);
3769 __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3770 __isl_take isl_pw_aff *pwaff,
3771 __isl_take isl_set *context);
3772 __isl_give isl_pw_aff *isl_pw_aff_gist(
3773 __isl_take isl_pw_aff *pwaff,
3774 __isl_take isl_set *context);
3776 __isl_give isl_set *isl_pw_aff_domain(
3777 __isl_take isl_pw_aff *pwaff);
3778 __isl_give isl_set *isl_pw_aff_params(
3779 __isl_take isl_pw_aff *pwa);
3780 __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3781 __isl_take isl_pw_aff *pa,
3782 __isl_take isl_set *set);
3783 __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3784 __isl_take isl_pw_aff *pa,
3785 __isl_take isl_set *set);
3787 __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3788 __isl_take isl_aff *aff2);
3789 __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3790 __isl_take isl_aff *aff2);
3791 __isl_give isl_pw_aff *isl_pw_aff_mul(
3792 __isl_take isl_pw_aff *pwaff1,
3793 __isl_take isl_pw_aff *pwaff2);
3794 __isl_give isl_pw_aff *isl_pw_aff_div(
3795 __isl_take isl_pw_aff *pa1,
3796 __isl_take isl_pw_aff *pa2);
3797 __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3798 __isl_take isl_pw_aff *pa1,
3799 __isl_take isl_pw_aff *pa2);
3800 __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3801 __isl_take isl_pw_aff *pa1,
3802 __isl_take isl_pw_aff *pa2);
3804 When multiplying two affine expressions, at least one of the two needs
3805 to be a constant. Similarly, when dividing an affine expression by another,
3806 the second expression needs to be a constant.
3807 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3808 rounding towards zero. C<isl_pw_aff_tdiv_r> computes the corresponding
3811 #include <isl/aff.h>
3812 __isl_give isl_aff *isl_aff_pullback_multi_aff(
3813 __isl_take isl_aff *aff,
3814 __isl_take isl_multi_aff *ma);
3815 __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3816 __isl_take isl_pw_aff *pa,
3817 __isl_take isl_multi_aff *ma);
3818 __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3819 __isl_take isl_pw_aff *pa,
3820 __isl_take isl_pw_multi_aff *pma);
3822 These functions precompose the input expression by the given
3823 C<isl_multi_aff> or C<isl_pw_multi_aff>. In other words,
3824 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3825 into the (piecewise) affine expression.
3826 Objects of type C<isl_multi_aff> are described in
3827 L</"Piecewise Multiple Quasi Affine Expressions">.
3829 #include <isl/aff.h>
3830 __isl_give isl_basic_set *isl_aff_zero_basic_set(
3831 __isl_take isl_aff *aff);
3832 __isl_give isl_basic_set *isl_aff_neg_basic_set(
3833 __isl_take isl_aff *aff);
3834 __isl_give isl_basic_set *isl_aff_le_basic_set(
3835 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3836 __isl_give isl_basic_set *isl_aff_ge_basic_set(
3837 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3838 __isl_give isl_set *isl_pw_aff_eq_set(
3839 __isl_take isl_pw_aff *pwaff1,
3840 __isl_take isl_pw_aff *pwaff2);
3841 __isl_give isl_set *isl_pw_aff_ne_set(
3842 __isl_take isl_pw_aff *pwaff1,
3843 __isl_take isl_pw_aff *pwaff2);
3844 __isl_give isl_set *isl_pw_aff_le_set(
3845 __isl_take isl_pw_aff *pwaff1,
3846 __isl_take isl_pw_aff *pwaff2);
3847 __isl_give isl_set *isl_pw_aff_lt_set(
3848 __isl_take isl_pw_aff *pwaff1,
3849 __isl_take isl_pw_aff *pwaff2);
3850 __isl_give isl_set *isl_pw_aff_ge_set(
3851 __isl_take isl_pw_aff *pwaff1,
3852 __isl_take isl_pw_aff *pwaff2);
3853 __isl_give isl_set *isl_pw_aff_gt_set(
3854 __isl_take isl_pw_aff *pwaff1,
3855 __isl_take isl_pw_aff *pwaff2);
3857 __isl_give isl_set *isl_pw_aff_list_eq_set(
3858 __isl_take isl_pw_aff_list *list1,
3859 __isl_take isl_pw_aff_list *list2);
3860 __isl_give isl_set *isl_pw_aff_list_ne_set(
3861 __isl_take isl_pw_aff_list *list1,
3862 __isl_take isl_pw_aff_list *list2);
3863 __isl_give isl_set *isl_pw_aff_list_le_set(
3864 __isl_take isl_pw_aff_list *list1,
3865 __isl_take isl_pw_aff_list *list2);
3866 __isl_give isl_set *isl_pw_aff_list_lt_set(
3867 __isl_take isl_pw_aff_list *list1,
3868 __isl_take isl_pw_aff_list *list2);
3869 __isl_give isl_set *isl_pw_aff_list_ge_set(
3870 __isl_take isl_pw_aff_list *list1,
3871 __isl_take isl_pw_aff_list *list2);
3872 __isl_give isl_set *isl_pw_aff_list_gt_set(
3873 __isl_take isl_pw_aff_list *list1,
3874 __isl_take isl_pw_aff_list *list2);
3876 The function C<isl_aff_neg_basic_set> returns a basic set
3877 containing those elements in the domain space
3878 of C<aff> where C<aff> is negative.
3879 The function C<isl_aff_ge_basic_set> returns a basic set
3880 containing those elements in the shared space
3881 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3882 The function C<isl_pw_aff_ge_set> returns a set
3883 containing those elements in the shared domain
3884 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3885 The functions operating on C<isl_pw_aff_list> apply the corresponding
3886 C<isl_pw_aff> function to each pair of elements in the two lists.
3888 #include <isl/aff.h>
3889 __isl_give isl_set *isl_pw_aff_nonneg_set(
3890 __isl_take isl_pw_aff *pwaff);
3891 __isl_give isl_set *isl_pw_aff_zero_set(
3892 __isl_take isl_pw_aff *pwaff);
3893 __isl_give isl_set *isl_pw_aff_non_zero_set(
3894 __isl_take isl_pw_aff *pwaff);
3896 The function C<isl_pw_aff_nonneg_set> returns a set
3897 containing those elements in the domain
3898 of C<pwaff> where C<pwaff> is non-negative.
3900 #include <isl/aff.h>
3901 __isl_give isl_pw_aff *isl_pw_aff_cond(
3902 __isl_take isl_pw_aff *cond,
3903 __isl_take isl_pw_aff *pwaff_true,
3904 __isl_take isl_pw_aff *pwaff_false);
3906 The function C<isl_pw_aff_cond> performs a conditional operator
3907 and returns an expression that is equal to C<pwaff_true>
3908 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3909 where C<cond> is zero.
3911 #include <isl/aff.h>
3912 __isl_give isl_pw_aff *isl_pw_aff_union_min(
3913 __isl_take isl_pw_aff *pwaff1,
3914 __isl_take isl_pw_aff *pwaff2);
3915 __isl_give isl_pw_aff *isl_pw_aff_union_max(
3916 __isl_take isl_pw_aff *pwaff1,
3917 __isl_take isl_pw_aff *pwaff2);
3918 __isl_give isl_pw_aff *isl_pw_aff_union_add(
3919 __isl_take isl_pw_aff *pwaff1,
3920 __isl_take isl_pw_aff *pwaff2);
3922 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3923 expression with a domain that is the union of those of C<pwaff1> and
3924 C<pwaff2> and such that on each cell, the quasi-affine expression is
3925 the maximum of those of C<pwaff1> and C<pwaff2>. If only one of
3926 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3927 associated expression is the defined one.
3929 An expression can be read from input using
3931 #include <isl/aff.h>
3932 __isl_give isl_aff *isl_aff_read_from_str(
3933 isl_ctx *ctx, const char *str);
3934 __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3935 isl_ctx *ctx, const char *str);
3937 An expression can be printed using
3939 #include <isl/aff.h>
3940 __isl_give isl_printer *isl_printer_print_aff(
3941 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3943 __isl_give isl_printer *isl_printer_print_pw_aff(
3944 __isl_take isl_printer *p,
3945 __isl_keep isl_pw_aff *pwaff);
3947 =head2 Piecewise Multiple Quasi Affine Expressions
3949 An C<isl_multi_aff> object represents a sequence of
3950 zero or more affine expressions, all defined on the same domain space.
3951 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
3952 zero or more piecewise affine expressions.
3954 An C<isl_multi_aff> can be constructed from a single
3955 C<isl_aff> or an C<isl_aff_list> using the
3956 following functions. Similarly for C<isl_multi_pw_aff>
3957 and C<isl_pw_multi_aff>.
3959 #include <isl/aff.h>
3960 __isl_give isl_multi_aff *isl_multi_aff_from_aff(
3961 __isl_take isl_aff *aff);
3962 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
3963 __isl_take isl_pw_aff *pa);
3964 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_pw_aff(
3965 __isl_take isl_pw_aff *pa);
3966 __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3967 __isl_take isl_space *space,
3968 __isl_take isl_aff_list *list);
3970 An C<isl_multi_pw_aff> can be converted to an C<isl_pw_multi_aff>
3971 using the following function. Note however that the domain
3972 of the result is the intersection of the domains of the input.
3974 #include <isl/aff.h>
3975 __isl_give isl_pw_multi_aff *
3976 isl_pw_multi_aff_from_multi_pw_aff(
3977 __isl_take isl_multi_pw_aff *mpa);
3979 An empty piecewise multiple quasi affine expression (one with no cells),
3980 the zero piecewise multiple quasi affine expression (with value zero
3981 for each output dimension),
3982 a piecewise multiple quasi affine expression with a single cell (with
3983 either a universe or a specified domain) or
3984 a zero-dimensional piecewise multiple quasi affine expression
3986 can be created using the following functions.
3988 #include <isl/aff.h>
3989 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3990 __isl_take isl_space *space);
3991 __isl_give isl_multi_aff *isl_multi_aff_zero(
3992 __isl_take isl_space *space);
3993 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_zero(
3994 __isl_take isl_space *space);
3995 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
3996 __isl_take isl_space *space);
3997 __isl_give isl_multi_aff *isl_multi_aff_identity(
3998 __isl_take isl_space *space);
3999 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
4000 __isl_take isl_space *space);
4001 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
4002 __isl_take isl_space *space);
4003 __isl_give isl_multi_aff *isl_multi_aff_domain_map(
4004 __isl_take isl_space *space);
4005 __isl_give isl_multi_aff *isl_multi_aff_range_map(
4006 __isl_take isl_space *space);
4007 __isl_give isl_multi_aff *isl_multi_aff_project_out_map(
4008 __isl_take isl_space *space,
4009 enum isl_dim_type type,
4010 unsigned first, unsigned n);
4011 __isl_give isl_pw_multi_aff *
4012 isl_pw_multi_aff_project_out_map(
4013 __isl_take isl_space *space,
4014 enum isl_dim_type type,
4015 unsigned first, unsigned n);
4016 __isl_give isl_pw_multi_aff *
4017 isl_pw_multi_aff_from_multi_aff(
4018 __isl_take isl_multi_aff *ma);
4019 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
4020 __isl_take isl_set *set,
4021 __isl_take isl_multi_aff *maff);
4022 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4023 __isl_take isl_set *set);
4025 __isl_give isl_union_pw_multi_aff *
4026 isl_union_pw_multi_aff_empty(
4027 __isl_take isl_space *space);
4028 __isl_give isl_union_pw_multi_aff *
4029 isl_union_pw_multi_aff_add_pw_multi_aff(
4030 __isl_take isl_union_pw_multi_aff *upma,
4031 __isl_take isl_pw_multi_aff *pma);
4032 __isl_give isl_union_pw_multi_aff *
4033 isl_union_pw_multi_aff_from_domain(
4034 __isl_take isl_union_set *uset);
4036 A piecewise multiple quasi affine expression can also be initialized
4037 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4038 and the C<isl_map> is single-valued.
4039 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
4040 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
4042 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4043 __isl_take isl_set *set);
4044 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4045 __isl_take isl_map *map);
4047 __isl_give isl_union_pw_multi_aff *
4048 isl_union_pw_multi_aff_from_union_set(
4049 __isl_take isl_union_set *uset);
4050 __isl_give isl_union_pw_multi_aff *
4051 isl_union_pw_multi_aff_from_union_map(
4052 __isl_take isl_union_map *umap);
4054 Multiple quasi affine expressions can be copied and freed using
4056 #include <isl/aff.h>
4057 __isl_give isl_multi_aff *isl_multi_aff_copy(
4058 __isl_keep isl_multi_aff *maff);
4059 void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
4061 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
4062 __isl_keep isl_pw_multi_aff *pma);
4063 void *isl_pw_multi_aff_free(
4064 __isl_take isl_pw_multi_aff *pma);
4066 __isl_give isl_union_pw_multi_aff *
4067 isl_union_pw_multi_aff_copy(
4068 __isl_keep isl_union_pw_multi_aff *upma);
4069 void *isl_union_pw_multi_aff_free(
4070 __isl_take isl_union_pw_multi_aff *upma);
4072 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
4073 __isl_keep isl_multi_pw_aff *mpa);
4074 void *isl_multi_pw_aff_free(
4075 __isl_take isl_multi_pw_aff *mpa);
4077 The expression can be inspected using
4079 #include <isl/aff.h>
4080 isl_ctx *isl_multi_aff_get_ctx(
4081 __isl_keep isl_multi_aff *maff);
4082 isl_ctx *isl_pw_multi_aff_get_ctx(
4083 __isl_keep isl_pw_multi_aff *pma);
4084 isl_ctx *isl_union_pw_multi_aff_get_ctx(
4085 __isl_keep isl_union_pw_multi_aff *upma);
4086 isl_ctx *isl_multi_pw_aff_get_ctx(
4087 __isl_keep isl_multi_pw_aff *mpa);
4088 unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
4089 enum isl_dim_type type);
4090 unsigned isl_pw_multi_aff_dim(
4091 __isl_keep isl_pw_multi_aff *pma,
4092 enum isl_dim_type type);
4093 unsigned isl_multi_pw_aff_dim(
4094 __isl_keep isl_multi_pw_aff *mpa,
4095 enum isl_dim_type type);
4096 __isl_give isl_aff *isl_multi_aff_get_aff(
4097 __isl_keep isl_multi_aff *multi, int pos);
4098 __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
4099 __isl_keep isl_pw_multi_aff *pma, int pos);
4100 __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
4101 __isl_keep isl_multi_pw_aff *mpa, int pos);
4102 int isl_multi_aff_find_dim_by_id(
4103 __isl_keep isl_multi_aff *ma,
4104 enum isl_dim_type type, __isl_keep isl_id *id);
4105 int isl_multi_pw_aff_find_dim_by_id(
4106 __isl_keep isl_multi_pw_aff *mpa,
4107 enum isl_dim_type type, __isl_keep isl_id *id);
4108 const char *isl_pw_multi_aff_get_dim_name(
4109 __isl_keep isl_pw_multi_aff *pma,
4110 enum isl_dim_type type, unsigned pos);
4111 __isl_give isl_id *isl_multi_aff_get_dim_id(
4112 __isl_keep isl_multi_aff *ma,
4113 enum isl_dim_type type, unsigned pos);
4114 __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
4115 __isl_keep isl_pw_multi_aff *pma,
4116 enum isl_dim_type type, unsigned pos);
4117 __isl_give isl_id *isl_multi_pw_aff_get_dim_id(
4118 __isl_keep isl_multi_pw_aff *mpa,
4119 enum isl_dim_type type, unsigned pos);
4120 const char *isl_multi_aff_get_tuple_name(
4121 __isl_keep isl_multi_aff *multi,
4122 enum isl_dim_type type);
4123 int isl_pw_multi_aff_has_tuple_name(
4124 __isl_keep isl_pw_multi_aff *pma,
4125 enum isl_dim_type type);
4126 const char *isl_pw_multi_aff_get_tuple_name(
4127 __isl_keep isl_pw_multi_aff *pma,
4128 enum isl_dim_type type);
4129 int isl_multi_aff_has_tuple_id(__isl_keep isl_multi_aff *ma,
4130 enum isl_dim_type type);
4131 int isl_pw_multi_aff_has_tuple_id(
4132 __isl_keep isl_pw_multi_aff *pma,
4133 enum isl_dim_type type);
4134 int isl_multi_pw_aff_has_tuple_id(
4135 __isl_keep isl_multi_pw_aff *mpa,
4136 enum isl_dim_type type);
4137 __isl_give isl_id *isl_multi_aff_get_tuple_id(
4138 __isl_keep isl_multi_aff *ma,
4139 enum isl_dim_type type);
4140 __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
4141 __isl_keep isl_pw_multi_aff *pma,
4142 enum isl_dim_type type);
4143 __isl_give isl_id *isl_multi_pw_aff_get_tuple_id(
4144 __isl_keep isl_multi_pw_aff *mpa,
4145 enum isl_dim_type type);
4146 __isl_give isl_multi_aff *isl_multi_aff_reset_tuple_id(
4147 __isl_take isl_multi_aff *ma,
4148 enum isl_dim_type type);
4149 __isl_give isl_multi_pw_aff *
4150 isl_multi_pw_aff_reset_tuple_id(
4151 __isl_take isl_multi_pw_aff *mpa,
4152 enum isl_dim_type type);
4154 int isl_pw_multi_aff_foreach_piece(
4155 __isl_keep isl_pw_multi_aff *pma,
4156 int (*fn)(__isl_take isl_set *set,
4157 __isl_take isl_multi_aff *maff,
4158 void *user), void *user);
4160 int isl_union_pw_multi_aff_foreach_pw_multi_aff(
4161 __isl_keep isl_union_pw_multi_aff *upma,
4162 int (*fn)(__isl_take isl_pw_multi_aff *pma,
4163 void *user), void *user);
4165 It can be modified using
4167 #include <isl/aff.h>
4168 __isl_give isl_multi_aff *isl_multi_aff_set_aff(
4169 __isl_take isl_multi_aff *multi, int pos,
4170 __isl_take isl_aff *aff);
4171 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
4172 __isl_take isl_pw_multi_aff *pma, unsigned pos,
4173 __isl_take isl_pw_aff *pa);
4174 __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
4175 __isl_take isl_multi_aff *maff,
4176 enum isl_dim_type type, unsigned pos, const char *s);
4177 __isl_give isl_multi_aff *isl_multi_aff_set_dim_id(
4178 __isl_take isl_multi_aff *maff,
4179 enum isl_dim_type type, unsigned pos,
4180 __isl_take isl_id *id);
4181 __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
4182 __isl_take isl_multi_aff *maff,
4183 enum isl_dim_type type, const char *s);
4184 __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
4185 __isl_take isl_multi_aff *maff,
4186 enum isl_dim_type type, __isl_take isl_id *id);
4187 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
4188 __isl_take isl_pw_multi_aff *pma,
4189 enum isl_dim_type type, __isl_take isl_id *id);
4191 __isl_give isl_multi_pw_aff *
4192 isl_multi_pw_aff_set_dim_name(
4193 __isl_take isl_multi_pw_aff *mpa,
4194 enum isl_dim_type type, unsigned pos, const char *s);
4195 __isl_give isl_multi_pw_aff *
4196 isl_multi_pw_aff_set_dim_id(
4197 __isl_take isl_multi_pw_aff *mpa,
4198 enum isl_dim_type type, unsigned pos,
4199 __isl_take isl_id *id);
4200 __isl_give isl_multi_pw_aff *
4201 isl_multi_pw_aff_set_tuple_name(
4202 __isl_take isl_multi_pw_aff *mpa,
4203 enum isl_dim_type type, const char *s);
4205 __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4206 __isl_take isl_multi_aff *ma,
4207 enum isl_dim_type type, unsigned first, unsigned n);
4208 __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4209 __isl_take isl_multi_aff *ma,
4210 enum isl_dim_type type, unsigned n);
4211 __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4212 __isl_take isl_multi_aff *maff,
4213 enum isl_dim_type type, unsigned first, unsigned n);
4214 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4215 __isl_take isl_pw_multi_aff *pma,
4216 enum isl_dim_type type, unsigned first, unsigned n);
4218 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4219 __isl_take isl_multi_pw_aff *mpa,
4220 enum isl_dim_type type, unsigned first, unsigned n);
4221 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4222 __isl_take isl_multi_pw_aff *mpa,
4223 enum isl_dim_type type, unsigned n);
4224 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_move_dims(
4225 __isl_take isl_multi_pw_aff *pma,
4226 enum isl_dim_type dst_type, unsigned dst_pos,
4227 enum isl_dim_type src_type, unsigned src_pos,
4230 To check whether two multiple affine expressions are
4231 obviously equal to each other, use
4233 int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
4234 __isl_keep isl_multi_aff *maff2);
4235 int isl_pw_multi_aff_plain_is_equal(
4236 __isl_keep isl_pw_multi_aff *pma1,
4237 __isl_keep isl_pw_multi_aff *pma2);
4238 int isl_multi_pw_aff_plain_is_equal(
4239 __isl_keep isl_multi_pw_aff *mpa1,
4240 __isl_keep isl_multi_pw_aff *mpa2);
4244 #include <isl/aff.h>
4245 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
4246 __isl_take isl_pw_multi_aff *pma1,
4247 __isl_take isl_pw_multi_aff *pma2);
4248 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
4249 __isl_take isl_pw_multi_aff *pma1,
4250 __isl_take isl_pw_multi_aff *pma2);
4251 __isl_give isl_multi_aff *isl_multi_aff_add(
4252 __isl_take isl_multi_aff *maff1,
4253 __isl_take isl_multi_aff *maff2);
4254 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
4255 __isl_take isl_pw_multi_aff *pma1,
4256 __isl_take isl_pw_multi_aff *pma2);
4257 __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
4258 __isl_take isl_union_pw_multi_aff *upma1,
4259 __isl_take isl_union_pw_multi_aff *upma2);
4260 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
4261 __isl_take isl_pw_multi_aff *pma1,
4262 __isl_take isl_pw_multi_aff *pma2);
4263 __isl_give isl_multi_aff *isl_multi_aff_sub(
4264 __isl_take isl_multi_aff *ma1,
4265 __isl_take isl_multi_aff *ma2);
4266 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
4267 __isl_take isl_pw_multi_aff *pma1,
4268 __isl_take isl_pw_multi_aff *pma2);
4269 __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
4270 __isl_take isl_union_pw_multi_aff *upma1,
4271 __isl_take isl_union_pw_multi_aff *upma2);
4273 C<isl_multi_aff_sub> subtracts the second argument from the first.
4275 __isl_give isl_multi_aff *isl_multi_aff_scale_val(
4276 __isl_take isl_multi_aff *ma,
4277 __isl_take isl_val *v);
4278 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_val(
4279 __isl_take isl_pw_multi_aff *pma,
4280 __isl_take isl_val *v);
4281 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_val(
4282 __isl_take isl_multi_pw_aff *mpa,
4283 __isl_take isl_val *v);
4284 __isl_give isl_multi_aff *isl_multi_aff_scale_multi_val(
4285 __isl_take isl_multi_aff *ma,
4286 __isl_take isl_multi_val *mv);
4287 __isl_give isl_pw_multi_aff *
4288 isl_pw_multi_aff_scale_multi_val(
4289 __isl_take isl_pw_multi_aff *pma,
4290 __isl_take isl_multi_val *mv);
4291 __isl_give isl_multi_pw_aff *
4292 isl_multi_pw_aff_scale_multi_val(
4293 __isl_take isl_multi_pw_aff *mpa,
4294 __isl_take isl_multi_val *mv);
4295 __isl_give isl_union_pw_multi_aff *
4296 isl_union_pw_multi_aff_scale_multi_val(
4297 __isl_take isl_union_pw_multi_aff *upma,
4298 __isl_take isl_multi_val *mv);
4299 __isl_give isl_multi_aff *
4300 isl_multi_aff_scale_down_multi_val(
4301 __isl_take isl_multi_aff *ma,
4302 __isl_take isl_multi_val *mv);
4303 __isl_give isl_multi_pw_aff *
4304 isl_multi_pw_aff_scale_down_multi_val(
4305 __isl_take isl_multi_pw_aff *mpa,
4306 __isl_take isl_multi_val *mv);
4308 C<isl_multi_aff_scale_multi_val> scales the elements of C<ma>
4309 by the corresponding elements of C<mv>.
4311 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_fix_si(
4312 __isl_take isl_pw_multi_aff *pma,
4313 enum isl_dim_type type, unsigned pos, int value);
4314 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
4315 __isl_take isl_pw_multi_aff *pma,
4316 __isl_take isl_set *set);
4317 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
4318 __isl_take isl_pw_multi_aff *pma,
4319 __isl_take isl_set *set);
4320 __isl_give isl_union_pw_multi_aff *
4321 isl_union_pw_multi_aff_intersect_domain(
4322 __isl_take isl_union_pw_multi_aff *upma,
4323 __isl_take isl_union_set *uset);
4324 __isl_give isl_multi_aff *isl_multi_aff_lift(
4325 __isl_take isl_multi_aff *maff,
4326 __isl_give isl_local_space **ls);
4327 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4328 __isl_take isl_pw_multi_aff *pma);
4329 __isl_give isl_multi_aff *isl_multi_aff_align_params(
4330 __isl_take isl_multi_aff *multi,
4331 __isl_take isl_space *model);
4332 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4333 __isl_take isl_pw_multi_aff *pma,
4334 __isl_take isl_space *model);
4335 __isl_give isl_pw_multi_aff *
4336 isl_pw_multi_aff_project_domain_on_params(
4337 __isl_take isl_pw_multi_aff *pma);
4338 __isl_give isl_multi_aff *isl_multi_aff_gist_params(
4339 __isl_take isl_multi_aff *maff,
4340 __isl_take isl_set *context);
4341 __isl_give isl_multi_aff *isl_multi_aff_gist(
4342 __isl_take isl_multi_aff *maff,
4343 __isl_take isl_set *context);
4344 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
4345 __isl_take isl_pw_multi_aff *pma,
4346 __isl_take isl_set *set);
4347 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
4348 __isl_take isl_pw_multi_aff *pma,
4349 __isl_take isl_set *set);
4350 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist_params(
4351 __isl_take isl_multi_pw_aff *mpa,
4352 __isl_take isl_set *set);
4353 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist(
4354 __isl_take isl_multi_pw_aff *mpa,
4355 __isl_take isl_set *set);
4356 __isl_give isl_multi_aff *isl_multi_aff_from_range(
4357 __isl_take isl_multi_aff *ma);
4358 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_range(
4359 __isl_take isl_multi_pw_aff *mpa);
4360 __isl_give isl_set *isl_pw_multi_aff_domain(
4361 __isl_take isl_pw_multi_aff *pma);
4362 __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4363 __isl_take isl_union_pw_multi_aff *upma);
4364 __isl_give isl_multi_aff *isl_multi_aff_range_splice(
4365 __isl_take isl_multi_aff *ma1, unsigned pos,
4366 __isl_take isl_multi_aff *ma2);
4367 __isl_give isl_multi_aff *isl_multi_aff_splice(
4368 __isl_take isl_multi_aff *ma1,
4369 unsigned in_pos, unsigned out_pos,
4370 __isl_take isl_multi_aff *ma2);
4371 __isl_give isl_multi_aff *isl_multi_aff_range_product(
4372 __isl_take isl_multi_aff *ma1,
4373 __isl_take isl_multi_aff *ma2);
4374 __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4375 __isl_take isl_multi_aff *ma1,
4376 __isl_take isl_multi_aff *ma2);
4377 __isl_give isl_multi_aff *isl_multi_aff_product(
4378 __isl_take isl_multi_aff *ma1,
4379 __isl_take isl_multi_aff *ma2);
4380 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_product(
4381 __isl_take isl_multi_pw_aff *mpa1,
4382 __isl_take isl_multi_pw_aff *mpa2);
4383 __isl_give isl_pw_multi_aff *
4384 isl_pw_multi_aff_range_product(
4385 __isl_take isl_pw_multi_aff *pma1,
4386 __isl_take isl_pw_multi_aff *pma2);
4387 __isl_give isl_pw_multi_aff *
4388 isl_pw_multi_aff_flat_range_product(
4389 __isl_take isl_pw_multi_aff *pma1,
4390 __isl_take isl_pw_multi_aff *pma2);
4391 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4392 __isl_take isl_pw_multi_aff *pma1,
4393 __isl_take isl_pw_multi_aff *pma2);
4394 __isl_give isl_union_pw_multi_aff *
4395 isl_union_pw_multi_aff_flat_range_product(
4396 __isl_take isl_union_pw_multi_aff *upma1,
4397 __isl_take isl_union_pw_multi_aff *upma2);
4398 __isl_give isl_multi_pw_aff *
4399 isl_multi_pw_aff_range_splice(
4400 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4401 __isl_take isl_multi_pw_aff *mpa2);
4402 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4403 __isl_take isl_multi_pw_aff *mpa1,
4404 unsigned in_pos, unsigned out_pos,
4405 __isl_take isl_multi_pw_aff *mpa2);
4406 __isl_give isl_multi_pw_aff *
4407 isl_multi_pw_aff_range_product(
4408 __isl_take isl_multi_pw_aff *mpa1,
4409 __isl_take isl_multi_pw_aff *mpa2);
4410 __isl_give isl_multi_pw_aff *
4411 isl_multi_pw_aff_flat_range_product(
4412 __isl_take isl_multi_pw_aff *mpa1,
4413 __isl_take isl_multi_pw_aff *mpa2);
4415 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4416 then it is assigned the local space that lies at the basis of
4417 the lifting applied.
4419 #include <isl/aff.h>
4420 __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4421 __isl_take isl_multi_aff *ma1,
4422 __isl_take isl_multi_aff *ma2);
4423 __isl_give isl_pw_multi_aff *
4424 isl_pw_multi_aff_pullback_multi_aff(
4425 __isl_take isl_pw_multi_aff *pma,
4426 __isl_take isl_multi_aff *ma);
4427 __isl_give isl_pw_multi_aff *
4428 isl_pw_multi_aff_pullback_pw_multi_aff(
4429 __isl_take isl_pw_multi_aff *pma1,
4430 __isl_take isl_pw_multi_aff *pma2);
4432 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4433 In other words, C<ma2> is plugged
4436 __isl_give isl_set *isl_multi_aff_lex_le_set(
4437 __isl_take isl_multi_aff *ma1,
4438 __isl_take isl_multi_aff *ma2);
4439 __isl_give isl_set *isl_multi_aff_lex_ge_set(
4440 __isl_take isl_multi_aff *ma1,
4441 __isl_take isl_multi_aff *ma2);
4443 The function C<isl_multi_aff_lex_le_set> returns a set
4444 containing those elements in the shared domain space
4445 where C<ma1> is lexicographically smaller than or
4448 An expression can be read from input using
4450 #include <isl/aff.h>
4451 __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4452 isl_ctx *ctx, const char *str);
4453 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4454 isl_ctx *ctx, const char *str);
4455 __isl_give isl_union_pw_multi_aff *
4456 isl_union_pw_multi_aff_read_from_str(
4457 isl_ctx *ctx, const char *str);
4459 An expression can be printed using
4461 #include <isl/aff.h>
4462 __isl_give isl_printer *isl_printer_print_multi_aff(
4463 __isl_take isl_printer *p,
4464 __isl_keep isl_multi_aff *maff);
4465 __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4466 __isl_take isl_printer *p,
4467 __isl_keep isl_pw_multi_aff *pma);
4468 __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4469 __isl_take isl_printer *p,
4470 __isl_keep isl_union_pw_multi_aff *upma);
4471 __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4472 __isl_take isl_printer *p,
4473 __isl_keep isl_multi_pw_aff *mpa);
4477 Points are elements of a set. They can be used to construct
4478 simple sets (boxes) or they can be used to represent the
4479 individual elements of a set.
4480 The zero point (the origin) can be created using
4482 __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4484 The coordinates of a point can be inspected, set and changed
4487 __isl_give isl_val *isl_point_get_coordinate_val(
4488 __isl_keep isl_point *pnt,
4489 enum isl_dim_type type, int pos);
4490 __isl_give isl_point *isl_point_set_coordinate_val(
4491 __isl_take isl_point *pnt,
4492 enum isl_dim_type type, int pos,
4493 __isl_take isl_val *v);
4495 __isl_give isl_point *isl_point_add_ui(
4496 __isl_take isl_point *pnt,
4497 enum isl_dim_type type, int pos, unsigned val);
4498 __isl_give isl_point *isl_point_sub_ui(
4499 __isl_take isl_point *pnt,
4500 enum isl_dim_type type, int pos, unsigned val);
4502 Other properties can be obtained using
4504 isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4506 Points can be copied or freed using
4508 __isl_give isl_point *isl_point_copy(
4509 __isl_keep isl_point *pnt);
4510 void isl_point_free(__isl_take isl_point *pnt);
4512 A singleton set can be created from a point using
4514 __isl_give isl_basic_set *isl_basic_set_from_point(
4515 __isl_take isl_point *pnt);
4516 __isl_give isl_set *isl_set_from_point(
4517 __isl_take isl_point *pnt);
4519 and a box can be created from two opposite extremal points using
4521 __isl_give isl_basic_set *isl_basic_set_box_from_points(
4522 __isl_take isl_point *pnt1,
4523 __isl_take isl_point *pnt2);
4524 __isl_give isl_set *isl_set_box_from_points(
4525 __isl_take isl_point *pnt1,
4526 __isl_take isl_point *pnt2);
4528 All elements of a B<bounded> (union) set can be enumerated using
4529 the following functions.
4531 int isl_set_foreach_point(__isl_keep isl_set *set,
4532 int (*fn)(__isl_take isl_point *pnt, void *user),
4534 int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4535 int (*fn)(__isl_take isl_point *pnt, void *user),
4538 The function C<fn> is called for each integer point in
4539 C<set> with as second argument the last argument of
4540 the C<isl_set_foreach_point> call. The function C<fn>
4541 should return C<0> on success and C<-1> on failure.
4542 In the latter case, C<isl_set_foreach_point> will stop
4543 enumerating and return C<-1> as well.
4544 If the enumeration is performed successfully and to completion,
4545 then C<isl_set_foreach_point> returns C<0>.
4547 To obtain a single point of a (basic) set, use
4549 __isl_give isl_point *isl_basic_set_sample_point(
4550 __isl_take isl_basic_set *bset);
4551 __isl_give isl_point *isl_set_sample_point(
4552 __isl_take isl_set *set);
4554 If C<set> does not contain any (integer) points, then the
4555 resulting point will be ``void'', a property that can be
4558 int isl_point_is_void(__isl_keep isl_point *pnt);
4560 =head2 Piecewise Quasipolynomials
4562 A piecewise quasipolynomial is a particular kind of function that maps
4563 a parametric point to a rational value.
4564 More specifically, a quasipolynomial is a polynomial expression in greatest
4565 integer parts of affine expressions of parameters and variables.
4566 A piecewise quasipolynomial is a subdivision of a given parametric
4567 domain into disjoint cells with a quasipolynomial associated to
4568 each cell. The value of the piecewise quasipolynomial at a given
4569 point is the value of the quasipolynomial associated to the cell
4570 that contains the point. Outside of the union of cells,
4571 the value is assumed to be zero.
4572 For example, the piecewise quasipolynomial
4574 [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4576 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4577 A given piecewise quasipolynomial has a fixed domain dimension.
4578 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4579 defined over different domains.
4580 Piecewise quasipolynomials are mainly used by the C<barvinok>
4581 library for representing the number of elements in a parametric set or map.
4582 For example, the piecewise quasipolynomial above represents
4583 the number of points in the map
4585 [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4587 =head3 Input and Output
4589 Piecewise quasipolynomials can be read from input using
4591 __isl_give isl_union_pw_qpolynomial *
4592 isl_union_pw_qpolynomial_read_from_str(
4593 isl_ctx *ctx, const char *str);
4595 Quasipolynomials and piecewise quasipolynomials can be printed
4596 using the following functions.
4598 __isl_give isl_printer *isl_printer_print_qpolynomial(
4599 __isl_take isl_printer *p,
4600 __isl_keep isl_qpolynomial *qp);
4602 __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4603 __isl_take isl_printer *p,
4604 __isl_keep isl_pw_qpolynomial *pwqp);
4606 __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4607 __isl_take isl_printer *p,
4608 __isl_keep isl_union_pw_qpolynomial *upwqp);
4610 The output format of the printer
4611 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4612 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4614 In case of printing in C<ISL_FORMAT_C>, the user may want
4615 to set the names of all dimensions
4617 __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4618 __isl_take isl_qpolynomial *qp,
4619 enum isl_dim_type type, unsigned pos,
4621 __isl_give isl_pw_qpolynomial *
4622 isl_pw_qpolynomial_set_dim_name(
4623 __isl_take isl_pw_qpolynomial *pwqp,
4624 enum isl_dim_type type, unsigned pos,
4627 =head3 Creating New (Piecewise) Quasipolynomials
4629 Some simple quasipolynomials can be created using the following functions.
4630 More complicated quasipolynomials can be created by applying
4631 operations such as addition and multiplication
4632 on the resulting quasipolynomials
4634 __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4635 __isl_take isl_space *domain);
4636 __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4637 __isl_take isl_space *domain);
4638 __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4639 __isl_take isl_space *domain);
4640 __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4641 __isl_take isl_space *domain);
4642 __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4643 __isl_take isl_space *domain);
4644 __isl_give isl_qpolynomial *isl_qpolynomial_val_on_domain(
4645 __isl_take isl_space *domain,
4646 __isl_take isl_val *val);
4647 __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4648 __isl_take isl_space *domain,
4649 enum isl_dim_type type, unsigned pos);
4650 __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4651 __isl_take isl_aff *aff);
4653 Note that the space in which a quasipolynomial lives is a map space
4654 with a one-dimensional range. The C<domain> argument in some of
4655 the functions above corresponds to the domain of this map space.
4657 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4658 with a single cell can be created using the following functions.
4659 Multiple of these single cell piecewise quasipolynomials can
4660 be combined to create more complicated piecewise quasipolynomials.
4662 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4663 __isl_take isl_space *space);
4664 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4665 __isl_take isl_set *set,
4666 __isl_take isl_qpolynomial *qp);
4667 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4668 __isl_take isl_qpolynomial *qp);
4669 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4670 __isl_take isl_pw_aff *pwaff);
4672 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4673 __isl_take isl_space *space);
4674 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4675 __isl_take isl_pw_qpolynomial *pwqp);
4676 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4677 __isl_take isl_union_pw_qpolynomial *upwqp,
4678 __isl_take isl_pw_qpolynomial *pwqp);
4680 Quasipolynomials can be copied and freed again using the following
4683 __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4684 __isl_keep isl_qpolynomial *qp);
4685 void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4687 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4688 __isl_keep isl_pw_qpolynomial *pwqp);
4689 void *isl_pw_qpolynomial_free(
4690 __isl_take isl_pw_qpolynomial *pwqp);
4692 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4693 __isl_keep isl_union_pw_qpolynomial *upwqp);
4694 void *isl_union_pw_qpolynomial_free(
4695 __isl_take isl_union_pw_qpolynomial *upwqp);
4697 =head3 Inspecting (Piecewise) Quasipolynomials
4699 To iterate over all piecewise quasipolynomials in a union
4700 piecewise quasipolynomial, use the following function
4702 int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4703 __isl_keep isl_union_pw_qpolynomial *upwqp,
4704 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4707 To extract the piecewise quasipolynomial in a given space from a union, use
4709 __isl_give isl_pw_qpolynomial *
4710 isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4711 __isl_keep isl_union_pw_qpolynomial *upwqp,
4712 __isl_take isl_space *space);
4714 To iterate over the cells in a piecewise quasipolynomial,
4715 use either of the following two functions
4717 int isl_pw_qpolynomial_foreach_piece(
4718 __isl_keep isl_pw_qpolynomial *pwqp,
4719 int (*fn)(__isl_take isl_set *set,
4720 __isl_take isl_qpolynomial *qp,
4721 void *user), void *user);
4722 int isl_pw_qpolynomial_foreach_lifted_piece(
4723 __isl_keep isl_pw_qpolynomial *pwqp,
4724 int (*fn)(__isl_take isl_set *set,
4725 __isl_take isl_qpolynomial *qp,
4726 void *user), void *user);
4728 As usual, the function C<fn> should return C<0> on success
4729 and C<-1> on failure. The difference between
4730 C<isl_pw_qpolynomial_foreach_piece> and
4731 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4732 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4733 compute unique representations for all existentially quantified
4734 variables and then turn these existentially quantified variables
4735 into extra set variables, adapting the associated quasipolynomial
4736 accordingly. This means that the C<set> passed to C<fn>
4737 will not have any existentially quantified variables, but that
4738 the dimensions of the sets may be different for different
4739 invocations of C<fn>.
4741 The constant term of a quasipolynomial can be extracted using
4743 __isl_give isl_val *isl_qpolynomial_get_constant_val(
4744 __isl_keep isl_qpolynomial *qp);
4746 To iterate over all terms in a quasipolynomial,
4749 int isl_qpolynomial_foreach_term(
4750 __isl_keep isl_qpolynomial *qp,
4751 int (*fn)(__isl_take isl_term *term,
4752 void *user), void *user);
4754 The terms themselves can be inspected and freed using
4757 unsigned isl_term_dim(__isl_keep isl_term *term,
4758 enum isl_dim_type type);
4759 __isl_give isl_val *isl_term_get_coefficient_val(
4760 __isl_keep isl_term *term);
4761 int isl_term_get_exp(__isl_keep isl_term *term,
4762 enum isl_dim_type type, unsigned pos);
4763 __isl_give isl_aff *isl_term_get_div(
4764 __isl_keep isl_term *term, unsigned pos);
4765 void isl_term_free(__isl_take isl_term *term);
4767 Each term is a product of parameters, set variables and
4768 integer divisions. The function C<isl_term_get_exp>
4769 returns the exponent of a given dimensions in the given term.
4771 =head3 Properties of (Piecewise) Quasipolynomials
4773 To check whether two union piecewise quasipolynomials are
4774 obviously equal, use
4776 int isl_union_pw_qpolynomial_plain_is_equal(
4777 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4778 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4780 =head3 Operations on (Piecewise) Quasipolynomials
4782 __isl_give isl_qpolynomial *isl_qpolynomial_scale_val(
4783 __isl_take isl_qpolynomial *qp,
4784 __isl_take isl_val *v);
4785 __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4786 __isl_take isl_qpolynomial *qp);
4787 __isl_give isl_qpolynomial *isl_qpolynomial_add(
4788 __isl_take isl_qpolynomial *qp1,
4789 __isl_take isl_qpolynomial *qp2);
4790 __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4791 __isl_take isl_qpolynomial *qp1,
4792 __isl_take isl_qpolynomial *qp2);
4793 __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4794 __isl_take isl_qpolynomial *qp1,
4795 __isl_take isl_qpolynomial *qp2);
4796 __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4797 __isl_take isl_qpolynomial *qp, unsigned exponent);
4799 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_fix_val(
4800 __isl_take isl_pw_qpolynomial *pwqp,
4801 enum isl_dim_type type, unsigned n,
4802 __isl_take isl_val *v);
4803 __isl_give isl_pw_qpolynomial *
4804 isl_pw_qpolynomial_scale_val(
4805 __isl_take isl_pw_qpolynomial *pwqp,
4806 __isl_take isl_val *v);
4807 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4808 __isl_take isl_pw_qpolynomial *pwqp1,
4809 __isl_take isl_pw_qpolynomial *pwqp2);
4810 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4811 __isl_take isl_pw_qpolynomial *pwqp1,
4812 __isl_take isl_pw_qpolynomial *pwqp2);
4813 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4814 __isl_take isl_pw_qpolynomial *pwqp1,
4815 __isl_take isl_pw_qpolynomial *pwqp2);
4816 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4817 __isl_take isl_pw_qpolynomial *pwqp);
4818 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4819 __isl_take isl_pw_qpolynomial *pwqp1,
4820 __isl_take isl_pw_qpolynomial *pwqp2);
4821 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4822 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4824 __isl_give isl_union_pw_qpolynomial *
4825 isl_union_pw_qpolynomial_scale_val(
4826 __isl_take isl_union_pw_qpolynomial *upwqp,
4827 __isl_take isl_val *v);
4828 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4829 __isl_take isl_union_pw_qpolynomial *upwqp1,
4830 __isl_take isl_union_pw_qpolynomial *upwqp2);
4831 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4832 __isl_take isl_union_pw_qpolynomial *upwqp1,
4833 __isl_take isl_union_pw_qpolynomial *upwqp2);
4834 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4835 __isl_take isl_union_pw_qpolynomial *upwqp1,
4836 __isl_take isl_union_pw_qpolynomial *upwqp2);
4838 __isl_give isl_val *isl_pw_qpolynomial_eval(
4839 __isl_take isl_pw_qpolynomial *pwqp,
4840 __isl_take isl_point *pnt);
4842 __isl_give isl_val *isl_union_pw_qpolynomial_eval(
4843 __isl_take isl_union_pw_qpolynomial *upwqp,
4844 __isl_take isl_point *pnt);
4846 __isl_give isl_set *isl_pw_qpolynomial_domain(
4847 __isl_take isl_pw_qpolynomial *pwqp);
4848 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4849 __isl_take isl_pw_qpolynomial *pwpq,
4850 __isl_take isl_set *set);
4851 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4852 __isl_take isl_pw_qpolynomial *pwpq,
4853 __isl_take isl_set *set);
4855 __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4856 __isl_take isl_union_pw_qpolynomial *upwqp);
4857 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4858 __isl_take isl_union_pw_qpolynomial *upwpq,
4859 __isl_take isl_union_set *uset);
4860 __isl_give isl_union_pw_qpolynomial *
4861 isl_union_pw_qpolynomial_intersect_params(
4862 __isl_take isl_union_pw_qpolynomial *upwpq,
4863 __isl_take isl_set *set);
4865 __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4866 __isl_take isl_qpolynomial *qp,
4867 __isl_take isl_space *model);
4869 __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4870 __isl_take isl_qpolynomial *qp);
4871 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4872 __isl_take isl_pw_qpolynomial *pwqp);
4874 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4875 __isl_take isl_union_pw_qpolynomial *upwqp);
4877 __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4878 __isl_take isl_qpolynomial *qp,
4879 __isl_take isl_set *context);
4880 __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4881 __isl_take isl_qpolynomial *qp,
4882 __isl_take isl_set *context);
4884 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4885 __isl_take isl_pw_qpolynomial *pwqp,
4886 __isl_take isl_set *context);
4887 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4888 __isl_take isl_pw_qpolynomial *pwqp,
4889 __isl_take isl_set *context);
4891 __isl_give isl_union_pw_qpolynomial *
4892 isl_union_pw_qpolynomial_gist_params(
4893 __isl_take isl_union_pw_qpolynomial *upwqp,
4894 __isl_take isl_set *context);
4895 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4896 __isl_take isl_union_pw_qpolynomial *upwqp,
4897 __isl_take isl_union_set *context);
4899 The gist operation applies the gist operation to each of
4900 the cells in the domain of the input piecewise quasipolynomial.
4901 The context is also exploited
4902 to simplify the quasipolynomials associated to each cell.
4904 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4905 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4906 __isl_give isl_union_pw_qpolynomial *
4907 isl_union_pw_qpolynomial_to_polynomial(
4908 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4910 Approximate each quasipolynomial by a polynomial. If C<sign> is positive,
4911 the polynomial will be an overapproximation. If C<sign> is negative,
4912 it will be an underapproximation. If C<sign> is zero, the approximation
4913 will lie somewhere in between.
4915 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4917 A piecewise quasipolynomial reduction is a piecewise
4918 reduction (or fold) of quasipolynomials.
4919 In particular, the reduction can be maximum or a minimum.
4920 The objects are mainly used to represent the result of
4921 an upper or lower bound on a quasipolynomial over its domain,
4922 i.e., as the result of the following function.
4924 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4925 __isl_take isl_pw_qpolynomial *pwqp,
4926 enum isl_fold type, int *tight);
4928 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4929 __isl_take isl_union_pw_qpolynomial *upwqp,
4930 enum isl_fold type, int *tight);
4932 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4933 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4934 is the returned bound is known be tight, i.e., for each value
4935 of the parameters there is at least
4936 one element in the domain that reaches the bound.
4937 If the domain of C<pwqp> is not wrapping, then the bound is computed
4938 over all elements in that domain and the result has a purely parametric
4939 domain. If the domain of C<pwqp> is wrapping, then the bound is
4940 computed over the range of the wrapped relation. The domain of the
4941 wrapped relation becomes the domain of the result.
4943 A (piecewise) quasipolynomial reduction can be copied or freed using the
4944 following functions.
4946 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4947 __isl_keep isl_qpolynomial_fold *fold);
4948 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4949 __isl_keep isl_pw_qpolynomial_fold *pwf);
4950 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4951 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4952 void isl_qpolynomial_fold_free(
4953 __isl_take isl_qpolynomial_fold *fold);
4954 void *isl_pw_qpolynomial_fold_free(
4955 __isl_take isl_pw_qpolynomial_fold *pwf);
4956 void *isl_union_pw_qpolynomial_fold_free(
4957 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4959 =head3 Printing Piecewise Quasipolynomial Reductions
4961 Piecewise quasipolynomial reductions can be printed
4962 using the following function.
4964 __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4965 __isl_take isl_printer *p,
4966 __isl_keep isl_pw_qpolynomial_fold *pwf);
4967 __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4968 __isl_take isl_printer *p,
4969 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4971 For C<isl_printer_print_pw_qpolynomial_fold>,
4972 output format of the printer
4973 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4974 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4975 output format of the printer
4976 needs to be set to C<ISL_FORMAT_ISL>.
4977 In case of printing in C<ISL_FORMAT_C>, the user may want
4978 to set the names of all dimensions
4980 __isl_give isl_pw_qpolynomial_fold *
4981 isl_pw_qpolynomial_fold_set_dim_name(
4982 __isl_take isl_pw_qpolynomial_fold *pwf,
4983 enum isl_dim_type type, unsigned pos,
4986 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4988 To iterate over all piecewise quasipolynomial reductions in a union
4989 piecewise quasipolynomial reduction, use the following function
4991 int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4992 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4993 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4994 void *user), void *user);
4996 To iterate over the cells in a piecewise quasipolynomial reduction,
4997 use either of the following two functions
4999 int isl_pw_qpolynomial_fold_foreach_piece(
5000 __isl_keep isl_pw_qpolynomial_fold *pwf,
5001 int (*fn)(__isl_take isl_set *set,
5002 __isl_take isl_qpolynomial_fold *fold,
5003 void *user), void *user);
5004 int isl_pw_qpolynomial_fold_foreach_lifted_piece(
5005 __isl_keep isl_pw_qpolynomial_fold *pwf,
5006 int (*fn)(__isl_take isl_set *set,
5007 __isl_take isl_qpolynomial_fold *fold,
5008 void *user), void *user);
5010 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
5011 of the difference between these two functions.
5013 To iterate over all quasipolynomials in a reduction, use
5015 int isl_qpolynomial_fold_foreach_qpolynomial(
5016 __isl_keep isl_qpolynomial_fold *fold,
5017 int (*fn)(__isl_take isl_qpolynomial *qp,
5018 void *user), void *user);
5020 =head3 Properties of Piecewise Quasipolynomial Reductions
5022 To check whether two union piecewise quasipolynomial reductions are
5023 obviously equal, use
5025 int isl_union_pw_qpolynomial_fold_plain_is_equal(
5026 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
5027 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
5029 =head3 Operations on Piecewise Quasipolynomial Reductions
5031 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale_val(
5032 __isl_take isl_qpolynomial_fold *fold,
5033 __isl_take isl_val *v);
5034 __isl_give isl_pw_qpolynomial_fold *
5035 isl_pw_qpolynomial_fold_scale_val(
5036 __isl_take isl_pw_qpolynomial_fold *pwf,
5037 __isl_take isl_val *v);
5038 __isl_give isl_union_pw_qpolynomial_fold *
5039 isl_union_pw_qpolynomial_fold_scale_val(
5040 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5041 __isl_take isl_val *v);
5043 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
5044 __isl_take isl_pw_qpolynomial_fold *pwf1,
5045 __isl_take isl_pw_qpolynomial_fold *pwf2);
5047 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
5048 __isl_take isl_pw_qpolynomial_fold *pwf1,
5049 __isl_take isl_pw_qpolynomial_fold *pwf2);
5051 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
5052 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
5053 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
5055 __isl_give isl_val *isl_pw_qpolynomial_fold_eval(
5056 __isl_take isl_pw_qpolynomial_fold *pwf,
5057 __isl_take isl_point *pnt);
5059 __isl_give isl_val *isl_union_pw_qpolynomial_fold_eval(
5060 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5061 __isl_take isl_point *pnt);
5063 __isl_give isl_pw_qpolynomial_fold *
5064 isl_pw_qpolynomial_fold_intersect_params(
5065 __isl_take isl_pw_qpolynomial_fold *pwf,
5066 __isl_take isl_set *set);
5068 __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
5069 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5070 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
5071 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5072 __isl_take isl_union_set *uset);
5073 __isl_give isl_union_pw_qpolynomial_fold *
5074 isl_union_pw_qpolynomial_fold_intersect_params(
5075 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5076 __isl_take isl_set *set);
5078 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
5079 __isl_take isl_pw_qpolynomial_fold *pwf);
5081 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
5082 __isl_take isl_pw_qpolynomial_fold *pwf);
5084 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
5085 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5087 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
5088 __isl_take isl_qpolynomial_fold *fold,
5089 __isl_take isl_set *context);
5090 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
5091 __isl_take isl_qpolynomial_fold *fold,
5092 __isl_take isl_set *context);
5094 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
5095 __isl_take isl_pw_qpolynomial_fold *pwf,
5096 __isl_take isl_set *context);
5097 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
5098 __isl_take isl_pw_qpolynomial_fold *pwf,
5099 __isl_take isl_set *context);
5101 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
5102 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5103 __isl_take isl_union_set *context);
5104 __isl_give isl_union_pw_qpolynomial_fold *
5105 isl_union_pw_qpolynomial_fold_gist_params(
5106 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5107 __isl_take isl_set *context);
5109 The gist operation applies the gist operation to each of
5110 the cells in the domain of the input piecewise quasipolynomial reduction.
5111 In future, the operation will also exploit the context
5112 to simplify the quasipolynomial reductions associated to each cell.
5114 __isl_give isl_pw_qpolynomial_fold *
5115 isl_set_apply_pw_qpolynomial_fold(
5116 __isl_take isl_set *set,
5117 __isl_take isl_pw_qpolynomial_fold *pwf,
5119 __isl_give isl_pw_qpolynomial_fold *
5120 isl_map_apply_pw_qpolynomial_fold(
5121 __isl_take isl_map *map,
5122 __isl_take isl_pw_qpolynomial_fold *pwf,
5124 __isl_give isl_union_pw_qpolynomial_fold *
5125 isl_union_set_apply_union_pw_qpolynomial_fold(
5126 __isl_take isl_union_set *uset,
5127 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5129 __isl_give isl_union_pw_qpolynomial_fold *
5130 isl_union_map_apply_union_pw_qpolynomial_fold(
5131 __isl_take isl_union_map *umap,
5132 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5135 The functions taking a map
5136 compose the given map with the given piecewise quasipolynomial reduction.
5137 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5138 over all elements in the intersection of the range of the map
5139 and the domain of the piecewise quasipolynomial reduction
5140 as a function of an element in the domain of the map.
5141 The functions taking a set compute a bound over all elements in the
5142 intersection of the set and the domain of the
5143 piecewise quasipolynomial reduction.
5145 =head2 Parametric Vertex Enumeration
5147 The parametric vertex enumeration described in this section
5148 is mainly intended to be used internally and by the C<barvinok>
5151 #include <isl/vertices.h>
5152 __isl_give isl_vertices *isl_basic_set_compute_vertices(
5153 __isl_keep isl_basic_set *bset);
5155 The function C<isl_basic_set_compute_vertices> performs the
5156 actual computation of the parametric vertices and the chamber
5157 decomposition and store the result in an C<isl_vertices> object.
5158 This information can be queried by either iterating over all
5159 the vertices or iterating over all the chambers or cells
5160 and then iterating over all vertices that are active on the chamber.
5162 int isl_vertices_foreach_vertex(
5163 __isl_keep isl_vertices *vertices,
5164 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5167 int isl_vertices_foreach_cell(
5168 __isl_keep isl_vertices *vertices,
5169 int (*fn)(__isl_take isl_cell *cell, void *user),
5171 int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
5172 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5175 Other operations that can be performed on an C<isl_vertices> object are
5178 isl_ctx *isl_vertices_get_ctx(
5179 __isl_keep isl_vertices *vertices);
5180 int isl_vertices_get_n_vertices(
5181 __isl_keep isl_vertices *vertices);
5182 void isl_vertices_free(__isl_take isl_vertices *vertices);
5184 Vertices can be inspected and destroyed using the following functions.
5186 isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5187 int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5188 __isl_give isl_basic_set *isl_vertex_get_domain(
5189 __isl_keep isl_vertex *vertex);
5190 __isl_give isl_basic_set *isl_vertex_get_expr(
5191 __isl_keep isl_vertex *vertex);
5192 void isl_vertex_free(__isl_take isl_vertex *vertex);
5194 C<isl_vertex_get_expr> returns a singleton parametric set describing
5195 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5197 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5198 B<rational> basic sets, so they should mainly be used for inspection
5199 and should not be mixed with integer sets.
5201 Chambers can be inspected and destroyed using the following functions.
5203 isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5204 __isl_give isl_basic_set *isl_cell_get_domain(
5205 __isl_keep isl_cell *cell);
5206 void isl_cell_free(__isl_take isl_cell *cell);
5208 =head1 Polyhedral Compilation Library
5210 This section collects functionality in C<isl> that has been specifically
5211 designed for use during polyhedral compilation.
5213 =head2 Dependence Analysis
5215 C<isl> contains specialized functionality for performing
5216 array dataflow analysis. That is, given a I<sink> access relation
5217 and a collection of possible I<source> access relations,
5218 C<isl> can compute relations that describe
5219 for each iteration of the sink access, which iteration
5220 of which of the source access relations was the last
5221 to access the same data element before the given iteration
5223 The resulting dependence relations map source iterations
5224 to the corresponding sink iterations.
5225 To compute standard flow dependences, the sink should be
5226 a read, while the sources should be writes.
5227 If any of the source accesses are marked as being I<may>
5228 accesses, then there will be a dependence from the last
5229 I<must> access B<and> from any I<may> access that follows
5230 this last I<must> access.
5231 In particular, if I<all> sources are I<may> accesses,
5232 then memory based dependence analysis is performed.
5233 If, on the other hand, all sources are I<must> accesses,
5234 then value based dependence analysis is performed.
5236 #include <isl/flow.h>
5238 typedef int (*isl_access_level_before)(void *first, void *second);
5240 __isl_give isl_access_info *isl_access_info_alloc(
5241 __isl_take isl_map *sink,
5242 void *sink_user, isl_access_level_before fn,
5244 __isl_give isl_access_info *isl_access_info_add_source(
5245 __isl_take isl_access_info *acc,
5246 __isl_take isl_map *source, int must,
5248 void *isl_access_info_free(__isl_take isl_access_info *acc);
5250 __isl_give isl_flow *isl_access_info_compute_flow(
5251 __isl_take isl_access_info *acc);
5253 int isl_flow_foreach(__isl_keep isl_flow *deps,
5254 int (*fn)(__isl_take isl_map *dep, int must,
5255 void *dep_user, void *user),
5257 __isl_give isl_map *isl_flow_get_no_source(
5258 __isl_keep isl_flow *deps, int must);
5259 void isl_flow_free(__isl_take isl_flow *deps);
5261 The function C<isl_access_info_compute_flow> performs the actual
5262 dependence analysis. The other functions are used to construct
5263 the input for this function or to read off the output.
5265 The input is collected in an C<isl_access_info>, which can
5266 be created through a call to C<isl_access_info_alloc>.
5267 The arguments to this functions are the sink access relation
5268 C<sink>, a token C<sink_user> used to identify the sink
5269 access to the user, a callback function for specifying the
5270 relative order of source and sink accesses, and the number
5271 of source access relations that will be added.
5272 The callback function has type C<int (*)(void *first, void *second)>.
5273 The function is called with two user supplied tokens identifying
5274 either a source or the sink and it should return the shared nesting
5275 level and the relative order of the two accesses.
5276 In particular, let I<n> be the number of loops shared by
5277 the two accesses. If C<first> precedes C<second> textually,
5278 then the function should return I<2 * n + 1>; otherwise,
5279 it should return I<2 * n>.
5280 The sources can be added to the C<isl_access_info> by performing
5281 (at most) C<max_source> calls to C<isl_access_info_add_source>.
5282 C<must> indicates whether the source is a I<must> access
5283 or a I<may> access. Note that a multi-valued access relation
5284 should only be marked I<must> if every iteration in the domain
5285 of the relation accesses I<all> elements in its image.
5286 The C<source_user> token is again used to identify
5287 the source access. The range of the source access relation
5288 C<source> should have the same dimension as the range
5289 of the sink access relation.
5290 The C<isl_access_info_free> function should usually not be
5291 called explicitly, because it is called implicitly by
5292 C<isl_access_info_compute_flow>.
5294 The result of the dependence analysis is collected in an
5295 C<isl_flow>. There may be elements of
5296 the sink access for which no preceding source access could be
5297 found or for which all preceding sources are I<may> accesses.
5298 The relations containing these elements can be obtained through
5299 calls to C<isl_flow_get_no_source>, the first with C<must> set
5300 and the second with C<must> unset.
5301 In the case of standard flow dependence analysis,
5302 with the sink a read and the sources I<must> writes,
5303 the first relation corresponds to the reads from uninitialized
5304 array elements and the second relation is empty.
5305 The actual flow dependences can be extracted using
5306 C<isl_flow_foreach>. This function will call the user-specified
5307 callback function C<fn> for each B<non-empty> dependence between
5308 a source and the sink. The callback function is called
5309 with four arguments, the actual flow dependence relation
5310 mapping source iterations to sink iterations, a boolean that
5311 indicates whether it is a I<must> or I<may> dependence, a token
5312 identifying the source and an additional C<void *> with value
5313 equal to the third argument of the C<isl_flow_foreach> call.
5314 A dependence is marked I<must> if it originates from a I<must>
5315 source and if it is not followed by any I<may> sources.
5317 After finishing with an C<isl_flow>, the user should call
5318 C<isl_flow_free> to free all associated memory.
5320 A higher-level interface to dependence analysis is provided
5321 by the following function.
5323 #include <isl/flow.h>
5325 int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
5326 __isl_take isl_union_map *must_source,
5327 __isl_take isl_union_map *may_source,
5328 __isl_take isl_union_map *schedule,
5329 __isl_give isl_union_map **must_dep,
5330 __isl_give isl_union_map **may_dep,
5331 __isl_give isl_union_map **must_no_source,
5332 __isl_give isl_union_map **may_no_source);
5334 The arrays are identified by the tuple names of the ranges
5335 of the accesses. The iteration domains by the tuple names
5336 of the domains of the accesses and of the schedule.
5337 The relative order of the iteration domains is given by the
5338 schedule. The relations returned through C<must_no_source>
5339 and C<may_no_source> are subsets of C<sink>.
5340 Any of C<must_dep>, C<may_dep>, C<must_no_source>
5341 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
5342 any of the other arguments is treated as an error.
5344 =head3 Interaction with Dependence Analysis
5346 During the dependence analysis, we frequently need to perform
5347 the following operation. Given a relation between sink iterations
5348 and potential source iterations from a particular source domain,
5349 what is the last potential source iteration corresponding to each
5350 sink iteration. It can sometimes be convenient to adjust
5351 the set of potential source iterations before or after each such operation.
5352 The prototypical example is fuzzy array dataflow analysis,
5353 where we need to analyze if, based on data-dependent constraints,
5354 the sink iteration can ever be executed without one or more of
5355 the corresponding potential source iterations being executed.
5356 If so, we can introduce extra parameters and select an unknown
5357 but fixed source iteration from the potential source iterations.
5358 To be able to perform such manipulations, C<isl> provides the following
5361 #include <isl/flow.h>
5363 typedef __isl_give isl_restriction *(*isl_access_restrict)(
5364 __isl_keep isl_map *source_map,
5365 __isl_keep isl_set *sink, void *source_user,
5367 __isl_give isl_access_info *isl_access_info_set_restrict(
5368 __isl_take isl_access_info *acc,
5369 isl_access_restrict fn, void *user);
5371 The function C<isl_access_info_set_restrict> should be called
5372 before calling C<isl_access_info_compute_flow> and registers a callback function
5373 that will be called any time C<isl> is about to compute the last
5374 potential source. The first argument is the (reverse) proto-dependence,
5375 mapping sink iterations to potential source iterations.
5376 The second argument represents the sink iterations for which
5377 we want to compute the last source iteration.
5378 The third argument is the token corresponding to the source
5379 and the final argument is the token passed to C<isl_access_info_set_restrict>.
5380 The callback is expected to return a restriction on either the input or
5381 the output of the operation computing the last potential source.
5382 If the input needs to be restricted then restrictions are needed
5383 for both the source and the sink iterations. The sink iterations
5384 and the potential source iterations will be intersected with these sets.
5385 If the output needs to be restricted then only a restriction on the source
5386 iterations is required.
5387 If any error occurs, the callback should return C<NULL>.
5388 An C<isl_restriction> object can be created, freed and inspected
5389 using the following functions.
5391 #include <isl/flow.h>
5393 __isl_give isl_restriction *isl_restriction_input(
5394 __isl_take isl_set *source_restr,
5395 __isl_take isl_set *sink_restr);
5396 __isl_give isl_restriction *isl_restriction_output(
5397 __isl_take isl_set *source_restr);
5398 __isl_give isl_restriction *isl_restriction_none(
5399 __isl_take isl_map *source_map);
5400 __isl_give isl_restriction *isl_restriction_empty(
5401 __isl_take isl_map *source_map);
5402 void *isl_restriction_free(
5403 __isl_take isl_restriction *restr);
5404 isl_ctx *isl_restriction_get_ctx(
5405 __isl_keep isl_restriction *restr);
5407 C<isl_restriction_none> and C<isl_restriction_empty> are special
5408 cases of C<isl_restriction_input>. C<isl_restriction_none>
5409 is essentially equivalent to
5411 isl_restriction_input(isl_set_universe(
5412 isl_space_range(isl_map_get_space(source_map))),
5414 isl_space_domain(isl_map_get_space(source_map))));
5416 whereas C<isl_restriction_empty> is essentially equivalent to
5418 isl_restriction_input(isl_set_empty(
5419 isl_space_range(isl_map_get_space(source_map))),
5421 isl_space_domain(isl_map_get_space(source_map))));
5425 B<The functionality described in this section is fairly new
5426 and may be subject to change.>
5428 The following function can be used to compute a schedule
5429 for a union of domains.
5430 By default, the algorithm used to construct the schedule is similar
5431 to that of C<Pluto>.
5432 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5434 The generated schedule respects all C<validity> dependences.
5435 That is, all dependence distances over these dependences in the
5436 scheduled space are lexicographically positive.
5437 The default algorithm tries to minimize the dependence distances over
5438 C<proximity> dependences.
5439 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5440 for groups of domains where the dependence distances have only
5441 non-negative values.
5442 When using Feautrier's algorithm, the C<proximity> dependence
5443 distances are only minimized during the extension to a
5444 full-dimensional schedule.
5446 #include <isl/schedule.h>
5447 __isl_give isl_schedule *isl_union_set_compute_schedule(
5448 __isl_take isl_union_set *domain,
5449 __isl_take isl_union_map *validity,
5450 __isl_take isl_union_map *proximity);
5451 void *isl_schedule_free(__isl_take isl_schedule *sched);
5453 A mapping from the domains to the scheduled space can be obtained
5454 from an C<isl_schedule> using the following function.
5456 __isl_give isl_union_map *isl_schedule_get_map(
5457 __isl_keep isl_schedule *sched);
5459 A representation of the schedule can be printed using
5461 __isl_give isl_printer *isl_printer_print_schedule(
5462 __isl_take isl_printer *p,
5463 __isl_keep isl_schedule *schedule);
5465 A representation of the schedule as a forest of bands can be obtained
5466 using the following function.
5468 __isl_give isl_band_list *isl_schedule_get_band_forest(
5469 __isl_keep isl_schedule *schedule);
5471 The individual bands can be visited in depth-first post-order
5472 using the following function.
5474 #include <isl/schedule.h>
5475 int isl_schedule_foreach_band(
5476 __isl_keep isl_schedule *sched,
5477 int (*fn)(__isl_keep isl_band *band, void *user),
5480 The list can be manipulated as explained in L<"Lists">.
5481 The bands inside the list can be copied and freed using the following
5484 #include <isl/band.h>
5485 __isl_give isl_band *isl_band_copy(
5486 __isl_keep isl_band *band);
5487 void *isl_band_free(__isl_take isl_band *band);
5489 Each band contains zero or more scheduling dimensions.
5490 These are referred to as the members of the band.
5491 The section of the schedule that corresponds to the band is
5492 referred to as the partial schedule of the band.
5493 For those nodes that participate in a band, the outer scheduling
5494 dimensions form the prefix schedule, while the inner scheduling
5495 dimensions form the suffix schedule.
5496 That is, if we take a cut of the band forest, then the union of
5497 the concatenations of the prefix, partial and suffix schedules of
5498 each band in the cut is equal to the entire schedule (modulo
5499 some possible padding at the end with zero scheduling dimensions).
5500 The properties of a band can be inspected using the following functions.
5502 #include <isl/band.h>
5503 isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5505 int isl_band_has_children(__isl_keep isl_band *band);
5506 __isl_give isl_band_list *isl_band_get_children(
5507 __isl_keep isl_band *band);
5509 __isl_give isl_union_map *isl_band_get_prefix_schedule(
5510 __isl_keep isl_band *band);
5511 __isl_give isl_union_map *isl_band_get_partial_schedule(
5512 __isl_keep isl_band *band);
5513 __isl_give isl_union_map *isl_band_get_suffix_schedule(
5514 __isl_keep isl_band *band);
5516 int isl_band_n_member(__isl_keep isl_band *band);
5517 int isl_band_member_is_zero_distance(
5518 __isl_keep isl_band *band, int pos);
5520 int isl_band_list_foreach_band(
5521 __isl_keep isl_band_list *list,
5522 int (*fn)(__isl_keep isl_band *band, void *user),
5525 Note that a scheduling dimension is considered to be ``zero
5526 distance'' if it does not carry any proximity dependences
5528 That is, if the dependence distances of the proximity
5529 dependences are all zero in that direction (for fixed
5530 iterations of outer bands).
5531 Like C<isl_schedule_foreach_band>,
5532 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5533 in depth-first post-order.
5535 A band can be tiled using the following function.
5537 #include <isl/band.h>
5538 int isl_band_tile(__isl_keep isl_band *band,
5539 __isl_take isl_vec *sizes);
5541 int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5543 int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5544 int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5546 int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5548 The C<isl_band_tile> function tiles the band using the given tile sizes
5549 inside its schedule.
5550 A new child band is created to represent the point loops and it is
5551 inserted between the modified band and its children.
5552 The C<tile_scale_tile_loops> option specifies whether the tile
5553 loops iterators should be scaled by the tile sizes.
5554 If the C<tile_shift_point_loops> option is set, then the point loops
5555 are shifted to start at zero.
5557 A band can be split into two nested bands using the following function.
5559 int isl_band_split(__isl_keep isl_band *band, int pos);
5561 The resulting outer band contains the first C<pos> dimensions of C<band>
5562 while the inner band contains the remaining dimensions.
5564 A representation of the band can be printed using
5566 #include <isl/band.h>
5567 __isl_give isl_printer *isl_printer_print_band(
5568 __isl_take isl_printer *p,
5569 __isl_keep isl_band *band);
5573 #include <isl/schedule.h>
5574 int isl_options_set_schedule_max_coefficient(
5575 isl_ctx *ctx, int val);
5576 int isl_options_get_schedule_max_coefficient(
5578 int isl_options_set_schedule_max_constant_term(
5579 isl_ctx *ctx, int val);
5580 int isl_options_get_schedule_max_constant_term(
5582 int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5583 int isl_options_get_schedule_fuse(isl_ctx *ctx);
5584 int isl_options_set_schedule_maximize_band_depth(
5585 isl_ctx *ctx, int val);
5586 int isl_options_get_schedule_maximize_band_depth(
5588 int isl_options_set_schedule_outer_zero_distance(
5589 isl_ctx *ctx, int val);
5590 int isl_options_get_schedule_outer_zero_distance(
5592 int isl_options_set_schedule_split_scaled(
5593 isl_ctx *ctx, int val);
5594 int isl_options_get_schedule_split_scaled(
5596 int isl_options_set_schedule_algorithm(
5597 isl_ctx *ctx, int val);
5598 int isl_options_get_schedule_algorithm(
5600 int isl_options_set_schedule_separate_components(
5601 isl_ctx *ctx, int val);
5602 int isl_options_get_schedule_separate_components(
5607 =item * schedule_max_coefficient
5609 This option enforces that the coefficients for variable and parameter
5610 dimensions in the calculated schedule are not larger than the specified value.
5611 This option can significantly increase the speed of the scheduling calculation
5612 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5613 this option does not introduce bounds on the variable or parameter
5616 =item * schedule_max_constant_term
5618 This option enforces that the constant coefficients in the calculated schedule
5619 are not larger than the maximal constant term. This option can significantly
5620 increase the speed of the scheduling calculation and may also prevent fusing of
5621 unrelated dimensions. A value of -1 means that this option does not introduce
5622 bounds on the constant coefficients.
5624 =item * schedule_fuse
5626 This option controls the level of fusion.
5627 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5628 resulting schedule will be distributed as much as possible.
5629 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5630 try to fuse loops in the resulting schedule.
5632 =item * schedule_maximize_band_depth
5634 If this option is set, we do not split bands at the point
5635 where we detect splitting is necessary. Instead, we
5636 backtrack and split bands as early as possible. This
5637 reduces the number of splits and maximizes the width of
5638 the bands. Wider bands give more possibilities for tiling.
5639 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5640 then bands will be split as early as possible, even if there is no need.
5641 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5643 =item * schedule_outer_zero_distance
5645 If this option is set, then we try to construct schedules
5646 where the outermost scheduling dimension in each band
5647 results in a zero dependence distance over the proximity
5650 =item * schedule_split_scaled
5652 If this option is set, then we try to construct schedules in which the
5653 constant term is split off from the linear part if the linear parts of
5654 the scheduling rows for all nodes in the graphs have a common non-trivial
5656 The constant term is then placed in a separate band and the linear
5659 =item * schedule_algorithm
5661 Selects the scheduling algorithm to be used.
5662 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5663 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5665 =item * schedule_separate_components
5667 If at any point the dependence graph contains any (weakly connected) components,
5668 then these components are scheduled separately.
5669 If this option is not set, then some iterations of the domains
5670 in these components may be scheduled together.
5671 If this option is set, then the components are given consecutive
5676 =head2 AST Generation
5678 This section describes the C<isl> functionality for generating
5679 ASTs that visit all the elements
5680 in a domain in an order specified by a schedule.
5681 In particular, given a C<isl_union_map>, an AST is generated
5682 that visits all the elements in the domain of the C<isl_union_map>
5683 according to the lexicographic order of the corresponding image
5684 element(s). If the range of the C<isl_union_map> consists of
5685 elements in more than one space, then each of these spaces is handled
5686 separately in an arbitrary order.
5687 It should be noted that the image elements only specify the I<order>
5688 in which the corresponding domain elements should be visited.
5689 No direct relation between the image elements and the loop iterators
5690 in the generated AST should be assumed.
5692 Each AST is generated within a build. The initial build
5693 simply specifies the constraints on the parameters (if any)
5694 and can be created, inspected, copied and freed using the following functions.
5696 #include <isl/ast_build.h>
5697 __isl_give isl_ast_build *isl_ast_build_from_context(
5698 __isl_take isl_set *set);
5699 isl_ctx *isl_ast_build_get_ctx(
5700 __isl_keep isl_ast_build *build);
5701 __isl_give isl_ast_build *isl_ast_build_copy(
5702 __isl_keep isl_ast_build *build);
5703 void *isl_ast_build_free(
5704 __isl_take isl_ast_build *build);
5706 The C<set> argument is usually a parameter set with zero or more parameters.
5707 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5708 and L</"Fine-grained Control over AST Generation">.
5709 Finally, the AST itself can be constructed using the following
5712 #include <isl/ast_build.h>
5713 __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5714 __isl_keep isl_ast_build *build,
5715 __isl_take isl_union_map *schedule);
5717 =head3 Inspecting the AST
5719 The basic properties of an AST node can be obtained as follows.
5721 #include <isl/ast.h>
5722 isl_ctx *isl_ast_node_get_ctx(
5723 __isl_keep isl_ast_node *node);
5724 enum isl_ast_node_type isl_ast_node_get_type(
5725 __isl_keep isl_ast_node *node);
5727 The type of an AST node is one of
5728 C<isl_ast_node_for>,
5730 C<isl_ast_node_block> or
5731 C<isl_ast_node_user>.
5732 An C<isl_ast_node_for> represents a for node.
5733 An C<isl_ast_node_if> represents an if node.
5734 An C<isl_ast_node_block> represents a compound node.
5735 An C<isl_ast_node_user> represents an expression statement.
5736 An expression statement typically corresponds to a domain element, i.e.,
5737 one of the elements that is visited by the AST.
5739 Each type of node has its own additional properties.
5741 #include <isl/ast.h>
5742 __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5743 __isl_keep isl_ast_node *node);
5744 __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5745 __isl_keep isl_ast_node *node);
5746 __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5747 __isl_keep isl_ast_node *node);
5748 __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5749 __isl_keep isl_ast_node *node);
5750 __isl_give isl_ast_node *isl_ast_node_for_get_body(
5751 __isl_keep isl_ast_node *node);
5752 int isl_ast_node_for_is_degenerate(
5753 __isl_keep isl_ast_node *node);
5755 An C<isl_ast_for> is considered degenerate if it is known to execute
5758 #include <isl/ast.h>
5759 __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5760 __isl_keep isl_ast_node *node);
5761 __isl_give isl_ast_node *isl_ast_node_if_get_then(
5762 __isl_keep isl_ast_node *node);
5763 int isl_ast_node_if_has_else(
5764 __isl_keep isl_ast_node *node);
5765 __isl_give isl_ast_node *isl_ast_node_if_get_else(
5766 __isl_keep isl_ast_node *node);
5768 __isl_give isl_ast_node_list *
5769 isl_ast_node_block_get_children(
5770 __isl_keep isl_ast_node *node);
5772 __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5773 __isl_keep isl_ast_node *node);
5775 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5776 the following functions.
5778 #include <isl/ast.h>
5779 isl_ctx *isl_ast_expr_get_ctx(
5780 __isl_keep isl_ast_expr *expr);
5781 enum isl_ast_expr_type isl_ast_expr_get_type(
5782 __isl_keep isl_ast_expr *expr);
5784 The type of an AST expression is one of
5786 C<isl_ast_expr_id> or
5787 C<isl_ast_expr_int>.
5788 An C<isl_ast_expr_op> represents the result of an operation.
5789 An C<isl_ast_expr_id> represents an identifier.
5790 An C<isl_ast_expr_int> represents an integer value.
5792 Each type of expression has its own additional properties.
5794 #include <isl/ast.h>
5795 enum isl_ast_op_type isl_ast_expr_get_op_type(
5796 __isl_keep isl_ast_expr *expr);
5797 int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5798 __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5799 __isl_keep isl_ast_expr *expr, int pos);
5800 int isl_ast_node_foreach_ast_op_type(
5801 __isl_keep isl_ast_node *node,
5802 int (*fn)(enum isl_ast_op_type type, void *user),
5805 C<isl_ast_expr_get_op_type> returns the type of the operation
5806 performed. C<isl_ast_expr_get_op_n_arg> returns the number of
5807 arguments. C<isl_ast_expr_get_op_arg> returns the specified
5809 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5810 C<isl_ast_op_type> that appears in C<node>.
5811 The operation type is one of the following.
5815 =item C<isl_ast_op_and>
5817 Logical I<and> of two arguments.
5818 Both arguments can be evaluated.
5820 =item C<isl_ast_op_and_then>
5822 Logical I<and> of two arguments.
5823 The second argument can only be evaluated if the first evaluates to true.
5825 =item C<isl_ast_op_or>
5827 Logical I<or> of two arguments.
5828 Both arguments can be evaluated.
5830 =item C<isl_ast_op_or_else>
5832 Logical I<or> of two arguments.
5833 The second argument can only be evaluated if the first evaluates to false.
5835 =item C<isl_ast_op_max>
5837 Maximum of two or more arguments.
5839 =item C<isl_ast_op_min>
5841 Minimum of two or more arguments.
5843 =item C<isl_ast_op_minus>
5847 =item C<isl_ast_op_add>
5849 Sum of two arguments.
5851 =item C<isl_ast_op_sub>
5853 Difference of two arguments.
5855 =item C<isl_ast_op_mul>
5857 Product of two arguments.
5859 =item C<isl_ast_op_div>
5861 Exact division. That is, the result is known to be an integer.
5863 =item C<isl_ast_op_fdiv_q>
5865 Result of integer division, rounded towards negative
5868 =item C<isl_ast_op_pdiv_q>
5870 Result of integer division, where dividend is known to be non-negative.
5872 =item C<isl_ast_op_pdiv_r>
5874 Remainder of integer division, where dividend is known to be non-negative.
5876 =item C<isl_ast_op_cond>
5878 Conditional operator defined on three arguments.
5879 If the first argument evaluates to true, then the result
5880 is equal to the second argument. Otherwise, the result
5881 is equal to the third argument.
5882 The second and third argument may only be evaluated if
5883 the first argument evaluates to true and false, respectively.
5884 Corresponds to C<a ? b : c> in C.
5886 =item C<isl_ast_op_select>
5888 Conditional operator defined on three arguments.
5889 If the first argument evaluates to true, then the result
5890 is equal to the second argument. Otherwise, the result
5891 is equal to the third argument.
5892 The second and third argument may be evaluated independently
5893 of the value of the first argument.
5894 Corresponds to C<a * b + (1 - a) * c> in C.
5896 =item C<isl_ast_op_eq>
5900 =item C<isl_ast_op_le>
5902 Less than or equal relation.
5904 =item C<isl_ast_op_lt>
5908 =item C<isl_ast_op_ge>
5910 Greater than or equal relation.
5912 =item C<isl_ast_op_gt>
5914 Greater than relation.
5916 =item C<isl_ast_op_call>
5919 The number of arguments of the C<isl_ast_expr> is one more than
5920 the number of arguments in the function call, the first argument
5921 representing the function being called.
5925 #include <isl/ast.h>
5926 __isl_give isl_id *isl_ast_expr_get_id(
5927 __isl_keep isl_ast_expr *expr);
5929 Return the identifier represented by the AST expression.
5931 #include <isl/ast.h>
5932 __isl_give isl_val *isl_ast_expr_get_val(
5933 __isl_keep isl_ast_expr *expr);
5935 Return the integer represented by the AST expression.
5937 =head3 Manipulating and printing the AST
5939 AST nodes can be copied and freed using the following functions.
5941 #include <isl/ast.h>
5942 __isl_give isl_ast_node *isl_ast_node_copy(
5943 __isl_keep isl_ast_node *node);
5944 void *isl_ast_node_free(__isl_take isl_ast_node *node);
5946 AST expressions can be copied and freed using the following functions.
5948 #include <isl/ast.h>
5949 __isl_give isl_ast_expr *isl_ast_expr_copy(
5950 __isl_keep isl_ast_expr *expr);
5951 void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5953 New AST expressions can be created either directly or within
5954 the context of an C<isl_ast_build>.
5956 #include <isl/ast.h>
5957 __isl_give isl_ast_expr *isl_ast_expr_from_val(
5958 __isl_take isl_val *v);
5959 __isl_give isl_ast_expr *isl_ast_expr_from_id(
5960 __isl_take isl_id *id);
5961 __isl_give isl_ast_expr *isl_ast_expr_neg(
5962 __isl_take isl_ast_expr *expr);
5963 __isl_give isl_ast_expr *isl_ast_expr_add(
5964 __isl_take isl_ast_expr *expr1,
5965 __isl_take isl_ast_expr *expr2);
5966 __isl_give isl_ast_expr *isl_ast_expr_sub(
5967 __isl_take isl_ast_expr *expr1,
5968 __isl_take isl_ast_expr *expr2);
5969 __isl_give isl_ast_expr *isl_ast_expr_mul(
5970 __isl_take isl_ast_expr *expr1,
5971 __isl_take isl_ast_expr *expr2);
5972 __isl_give isl_ast_expr *isl_ast_expr_div(
5973 __isl_take isl_ast_expr *expr1,
5974 __isl_take isl_ast_expr *expr2);
5975 __isl_give isl_ast_expr *isl_ast_expr_and(
5976 __isl_take isl_ast_expr *expr1,
5977 __isl_take isl_ast_expr *expr2)
5978 __isl_give isl_ast_expr *isl_ast_expr_or(
5979 __isl_take isl_ast_expr *expr1,
5980 __isl_take isl_ast_expr *expr2)
5982 #include <isl/ast_build.h>
5983 __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5984 __isl_keep isl_ast_build *build,
5985 __isl_take isl_pw_aff *pa);
5986 __isl_give isl_ast_expr *
5987 isl_ast_build_call_from_pw_multi_aff(
5988 __isl_keep isl_ast_build *build,
5989 __isl_take isl_pw_multi_aff *pma);
5991 The domains of C<pa> and C<pma> should correspond
5992 to the schedule space of C<build>.
5993 The tuple id of C<pma> is used as the function being called.
5995 User specified data can be attached to an C<isl_ast_node> and obtained
5996 from the same C<isl_ast_node> using the following functions.
5998 #include <isl/ast.h>
5999 __isl_give isl_ast_node *isl_ast_node_set_annotation(
6000 __isl_take isl_ast_node *node,
6001 __isl_take isl_id *annotation);
6002 __isl_give isl_id *isl_ast_node_get_annotation(
6003 __isl_keep isl_ast_node *node);
6005 Basic printing can be performed using the following functions.
6007 #include <isl/ast.h>
6008 __isl_give isl_printer *isl_printer_print_ast_expr(
6009 __isl_take isl_printer *p,
6010 __isl_keep isl_ast_expr *expr);
6011 __isl_give isl_printer *isl_printer_print_ast_node(
6012 __isl_take isl_printer *p,
6013 __isl_keep isl_ast_node *node);
6015 More advanced printing can be performed using the following functions.
6017 #include <isl/ast.h>
6018 __isl_give isl_printer *isl_ast_op_type_print_macro(
6019 enum isl_ast_op_type type,
6020 __isl_take isl_printer *p);
6021 __isl_give isl_printer *isl_ast_node_print_macros(
6022 __isl_keep isl_ast_node *node,
6023 __isl_take isl_printer *p);
6024 __isl_give isl_printer *isl_ast_node_print(
6025 __isl_keep isl_ast_node *node,
6026 __isl_take isl_printer *p,
6027 __isl_take isl_ast_print_options *options);
6028 __isl_give isl_printer *isl_ast_node_for_print(
6029 __isl_keep isl_ast_node *node,
6030 __isl_take isl_printer *p,
6031 __isl_take isl_ast_print_options *options);
6032 __isl_give isl_printer *isl_ast_node_if_print(
6033 __isl_keep isl_ast_node *node,
6034 __isl_take isl_printer *p,
6035 __isl_take isl_ast_print_options *options);
6037 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
6038 C<isl> may print out an AST that makes use of macros such
6039 as C<floord>, C<min> and C<max>.
6040 C<isl_ast_op_type_print_macro> prints out the macro
6041 corresponding to a specific C<isl_ast_op_type>.
6042 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
6043 for expressions where these macros would be used and prints
6044 out the required macro definitions.
6045 Essentially, C<isl_ast_node_print_macros> calls
6046 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
6047 as function argument.
6048 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
6049 C<isl_ast_node_if_print> print an C<isl_ast_node>
6050 in C<ISL_FORMAT_C>, but allow for some extra control
6051 through an C<isl_ast_print_options> object.
6052 This object can be created using the following functions.
6054 #include <isl/ast.h>
6055 __isl_give isl_ast_print_options *
6056 isl_ast_print_options_alloc(isl_ctx *ctx);
6057 __isl_give isl_ast_print_options *
6058 isl_ast_print_options_copy(
6059 __isl_keep isl_ast_print_options *options);
6060 void *isl_ast_print_options_free(
6061 __isl_take isl_ast_print_options *options);
6063 __isl_give isl_ast_print_options *
6064 isl_ast_print_options_set_print_user(
6065 __isl_take isl_ast_print_options *options,
6066 __isl_give isl_printer *(*print_user)(
6067 __isl_take isl_printer *p,
6068 __isl_take isl_ast_print_options *options,
6069 __isl_keep isl_ast_node *node, void *user),
6071 __isl_give isl_ast_print_options *
6072 isl_ast_print_options_set_print_for(
6073 __isl_take isl_ast_print_options *options,
6074 __isl_give isl_printer *(*print_for)(
6075 __isl_take isl_printer *p,
6076 __isl_take isl_ast_print_options *options,
6077 __isl_keep isl_ast_node *node, void *user),
6080 The callback set by C<isl_ast_print_options_set_print_user>
6081 is called whenever a node of type C<isl_ast_node_user> needs to
6083 The callback set by C<isl_ast_print_options_set_print_for>
6084 is called whenever a node of type C<isl_ast_node_for> needs to
6086 Note that C<isl_ast_node_for_print> will I<not> call the
6087 callback set by C<isl_ast_print_options_set_print_for> on the node
6088 on which C<isl_ast_node_for_print> is called, but only on nested
6089 nodes of type C<isl_ast_node_for>. It is therefore safe to
6090 call C<isl_ast_node_for_print> from within the callback set by
6091 C<isl_ast_print_options_set_print_for>.
6093 The following option determines the type to be used for iterators
6094 while printing the AST.
6096 int isl_options_set_ast_iterator_type(
6097 isl_ctx *ctx, const char *val);
6098 const char *isl_options_get_ast_iterator_type(
6103 #include <isl/ast_build.h>
6104 int isl_options_set_ast_build_atomic_upper_bound(
6105 isl_ctx *ctx, int val);
6106 int isl_options_get_ast_build_atomic_upper_bound(
6108 int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
6110 int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
6111 int isl_options_set_ast_build_exploit_nested_bounds(
6112 isl_ctx *ctx, int val);
6113 int isl_options_get_ast_build_exploit_nested_bounds(
6115 int isl_options_set_ast_build_group_coscheduled(
6116 isl_ctx *ctx, int val);
6117 int isl_options_get_ast_build_group_coscheduled(
6119 int isl_options_set_ast_build_scale_strides(
6120 isl_ctx *ctx, int val);
6121 int isl_options_get_ast_build_scale_strides(
6123 int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
6125 int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
6126 int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
6128 int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
6132 =item * ast_build_atomic_upper_bound
6134 Generate loop upper bounds that consist of the current loop iterator,
6135 an operator and an expression not involving the iterator.
6136 If this option is not set, then the current loop iterator may appear
6137 several times in the upper bound.
6138 For example, when this option is turned off, AST generation
6141 [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
6145 for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
6148 When the option is turned on, the following AST is generated
6150 for (int c0 = 0; c0 <= min(100, n); c0 += 1)
6153 =item * ast_build_prefer_pdiv
6155 If this option is turned off, then the AST generation will
6156 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
6157 operators, but no C<isl_ast_op_pdiv_q> or
6158 C<isl_ast_op_pdiv_r> operators.
6159 If this options is turned on, then C<isl> will try to convert
6160 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
6161 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
6163 =item * ast_build_exploit_nested_bounds
6165 Simplify conditions based on bounds of nested for loops.
6166 In particular, remove conditions that are implied by the fact
6167 that one or more nested loops have at least one iteration,
6168 meaning that the upper bound is at least as large as the lower bound.
6169 For example, when this option is turned off, AST generation
6172 [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
6178 for (int c0 = 0; c0 <= N; c0 += 1)
6179 for (int c1 = 0; c1 <= M; c1 += 1)
6182 When the option is turned on, the following AST is generated
6184 for (int c0 = 0; c0 <= N; c0 += 1)
6185 for (int c1 = 0; c1 <= M; c1 += 1)
6188 =item * ast_build_group_coscheduled
6190 If two domain elements are assigned the same schedule point, then
6191 they may be executed in any order and they may even appear in different
6192 loops. If this options is set, then the AST generator will make
6193 sure that coscheduled domain elements do not appear in separate parts
6194 of the AST. This is useful in case of nested AST generation
6195 if the outer AST generation is given only part of a schedule
6196 and the inner AST generation should handle the domains that are
6197 coscheduled by this initial part of the schedule together.
6198 For example if an AST is generated for a schedule
6200 { A[i] -> [0]; B[i] -> [0] }
6202 then the C<isl_ast_build_set_create_leaf> callback described
6203 below may get called twice, once for each domain.
6204 Setting this option ensures that the callback is only called once
6205 on both domains together.
6207 =item * ast_build_separation_bounds
6209 This option specifies which bounds to use during separation.
6210 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
6211 then all (possibly implicit) bounds on the current dimension will
6212 be used during separation.
6213 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
6214 then only those bounds that are explicitly available will
6215 be used during separation.
6217 =item * ast_build_scale_strides
6219 This option specifies whether the AST generator is allowed
6220 to scale down iterators of strided loops.
6222 =item * ast_build_allow_else
6224 This option specifies whether the AST generator is allowed
6225 to construct if statements with else branches.
6227 =item * ast_build_allow_or
6229 This option specifies whether the AST generator is allowed
6230 to construct if conditions with disjunctions.
6234 =head3 Fine-grained Control over AST Generation
6236 Besides specifying the constraints on the parameters,
6237 an C<isl_ast_build> object can be used to control
6238 various aspects of the AST generation process.
6239 The most prominent way of control is through ``options'',
6240 which can be set using the following function.
6242 #include <isl/ast_build.h>
6243 __isl_give isl_ast_build *
6244 isl_ast_build_set_options(
6245 __isl_take isl_ast_build *control,
6246 __isl_take isl_union_map *options);
6248 The options are encoded in an <isl_union_map>.
6249 The domain of this union relation refers to the schedule domain,
6250 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
6251 In the case of nested AST generation (see L</"Nested AST Generation">),
6252 the domain of C<options> should refer to the extra piece of the schedule.
6253 That is, it should be equal to the range of the wrapped relation in the
6254 range of the schedule.
6255 The range of the options can consist of elements in one or more spaces,
6256 the names of which determine the effect of the option.
6257 The values of the range typically also refer to the schedule dimension
6258 to which the option applies. In case of nested AST generation
6259 (see L</"Nested AST Generation">), these values refer to the position
6260 of the schedule dimension within the innermost AST generation.
6261 The constraints on the domain elements of
6262 the option should only refer to this dimension and earlier dimensions.
6263 We consider the following spaces.
6267 =item C<separation_class>
6269 This space is a wrapped relation between two one dimensional spaces.
6270 The input space represents the schedule dimension to which the option
6271 applies and the output space represents the separation class.
6272 While constructing a loop corresponding to the specified schedule
6273 dimension(s), the AST generator will try to generate separate loops
6274 for domain elements that are assigned different classes.
6275 If only some of the elements are assigned a class, then those elements
6276 that are not assigned any class will be treated as belonging to a class
6277 that is separate from the explicitly assigned classes.
6278 The typical use case for this option is to separate full tiles from
6280 The other options, described below, are applied after the separation
6283 As an example, consider the separation into full and partial tiles
6284 of a tiling of a triangular domain.
6285 Take, for example, the domain
6287 { A[i,j] : 0 <= i,j and i + j <= 100 }
6289 and a tiling into tiles of 10 by 10. The input to the AST generator
6290 is then the schedule
6292 { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
6295 Without any options, the following AST is generated
6297 for (int c0 = 0; c0 <= 10; c0 += 1)
6298 for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6299 for (int c2 = 10 * c0;
6300 c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6302 for (int c3 = 10 * c1;
6303 c3 <= min(10 * c1 + 9, -c2 + 100);
6307 Separation into full and partial tiles can be obtained by assigning
6308 a class, say C<0>, to the full tiles. The full tiles are represented by those
6309 values of the first and second schedule dimensions for which there are
6310 values of the third and fourth dimensions to cover an entire tile.
6311 That is, we need to specify the following option
6313 { [a,b,c,d] -> separation_class[[0]->[0]] :
6314 exists b': 0 <= 10a,10b' and
6315 10a+9+10b'+9 <= 100;
6316 [a,b,c,d] -> separation_class[[1]->[0]] :
6317 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
6321 { [a, b, c, d] -> separation_class[[1] -> [0]] :
6322 a >= 0 and b >= 0 and b <= 8 - a;
6323 [a, b, c, d] -> separation_class[[0] -> [0]] :
6326 With this option, the generated AST is as follows
6329 for (int c0 = 0; c0 <= 8; c0 += 1) {
6330 for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
6331 for (int c2 = 10 * c0;
6332 c2 <= 10 * c0 + 9; c2 += 1)
6333 for (int c3 = 10 * c1;
6334 c3 <= 10 * c1 + 9; c3 += 1)
6336 for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
6337 for (int c2 = 10 * c0;
6338 c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6340 for (int c3 = 10 * c1;
6341 c3 <= min(-c2 + 100, 10 * c1 + 9);
6345 for (int c0 = 9; c0 <= 10; c0 += 1)
6346 for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6347 for (int c2 = 10 * c0;
6348 c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6350 for (int c3 = 10 * c1;
6351 c3 <= min(10 * c1 + 9, -c2 + 100);
6358 This is a single-dimensional space representing the schedule dimension(s)
6359 to which ``separation'' should be applied. Separation tries to split
6360 a loop into several pieces if this can avoid the generation of guards
6362 See also the C<atomic> option.
6366 This is a single-dimensional space representing the schedule dimension(s)
6367 for which the domains should be considered ``atomic''. That is, the
6368 AST generator will make sure that any given domain space will only appear
6369 in a single loop at the specified level.
6371 Consider the following schedule
6373 { a[i] -> [i] : 0 <= i < 10;
6374 b[i] -> [i+1] : 0 <= i < 10 }
6376 If the following option is specified
6378 { [i] -> separate[x] }
6380 then the following AST will be generated
6384 for (int c0 = 1; c0 <= 9; c0 += 1) {
6391 If, on the other hand, the following option is specified
6393 { [i] -> atomic[x] }
6395 then the following AST will be generated
6397 for (int c0 = 0; c0 <= 10; c0 += 1) {
6404 If neither C<atomic> nor C<separate> is specified, then the AST generator
6405 may produce either of these two results or some intermediate form.
6409 This is a single-dimensional space representing the schedule dimension(s)
6410 that should be I<completely> unrolled.
6411 To obtain a partial unrolling, the user should apply an additional
6412 strip-mining to the schedule and fully unroll the inner loop.
6416 Additional control is available through the following functions.
6418 #include <isl/ast_build.h>
6419 __isl_give isl_ast_build *
6420 isl_ast_build_set_iterators(
6421 __isl_take isl_ast_build *control,
6422 __isl_take isl_id_list *iterators);
6424 The function C<isl_ast_build_set_iterators> allows the user to
6425 specify a list of iterator C<isl_id>s to be used as iterators.
6426 If the input schedule is injective, then
6427 the number of elements in this list should be as large as the dimension
6428 of the schedule space, but no direct correspondence should be assumed
6429 between dimensions and elements.
6430 If the input schedule is not injective, then an additional number
6431 of C<isl_id>s equal to the largest dimension of the input domains
6433 If the number of provided C<isl_id>s is insufficient, then additional
6434 names are automatically generated.
6436 #include <isl/ast_build.h>
6437 __isl_give isl_ast_build *
6438 isl_ast_build_set_create_leaf(
6439 __isl_take isl_ast_build *control,
6440 __isl_give isl_ast_node *(*fn)(
6441 __isl_take isl_ast_build *build,
6442 void *user), void *user);
6445 C<isl_ast_build_set_create_leaf> function allows for the
6446 specification of a callback that should be called whenever the AST
6447 generator arrives at an element of the schedule domain.
6448 The callback should return an AST node that should be inserted
6449 at the corresponding position of the AST. The default action (when
6450 the callback is not set) is to continue generating parts of the AST to scan
6451 all the domain elements associated to the schedule domain element
6452 and to insert user nodes, ``calling'' the domain element, for each of them.
6453 The C<build> argument contains the current state of the C<isl_ast_build>.
6454 To ease nested AST generation (see L</"Nested AST Generation">),
6455 all control information that is
6456 specific to the current AST generation such as the options and
6457 the callbacks has been removed from this C<isl_ast_build>.
6458 The callback would typically return the result of a nested
6460 user defined node created using the following function.
6462 #include <isl/ast.h>
6463 __isl_give isl_ast_node *isl_ast_node_alloc_user(
6464 __isl_take isl_ast_expr *expr);
6466 #include <isl/ast_build.h>
6467 __isl_give isl_ast_build *
6468 isl_ast_build_set_at_each_domain(
6469 __isl_take isl_ast_build *build,
6470 __isl_give isl_ast_node *(*fn)(
6471 __isl_take isl_ast_node *node,
6472 __isl_keep isl_ast_build *build,
6473 void *user), void *user);
6474 __isl_give isl_ast_build *
6475 isl_ast_build_set_before_each_for(
6476 __isl_take isl_ast_build *build,
6477 __isl_give isl_id *(*fn)(
6478 __isl_keep isl_ast_build *build,
6479 void *user), void *user);
6480 __isl_give isl_ast_build *
6481 isl_ast_build_set_after_each_for(
6482 __isl_take isl_ast_build *build,
6483 __isl_give isl_ast_node *(*fn)(
6484 __isl_take isl_ast_node *node,
6485 __isl_keep isl_ast_build *build,
6486 void *user), void *user);
6488 The callback set by C<isl_ast_build_set_at_each_domain> will
6489 be called for each domain AST node.
6490 The callbacks set by C<isl_ast_build_set_before_each_for>
6491 and C<isl_ast_build_set_after_each_for> will be called
6492 for each for AST node. The first will be called in depth-first
6493 pre-order, while the second will be called in depth-first post-order.
6494 Since C<isl_ast_build_set_before_each_for> is called before the for
6495 node is actually constructed, it is only passed an C<isl_ast_build>.
6496 The returned C<isl_id> will be added as an annotation (using
6497 C<isl_ast_node_set_annotation>) to the constructed for node.
6498 In particular, if the user has also specified an C<after_each_for>
6499 callback, then the annotation can be retrieved from the node passed to
6500 that callback using C<isl_ast_node_get_annotation>.
6501 All callbacks should C<NULL> on failure.
6502 The given C<isl_ast_build> can be used to create new
6503 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6504 or C<isl_ast_build_call_from_pw_multi_aff>.
6506 =head3 Nested AST Generation
6508 C<isl> allows the user to create an AST within the context
6509 of another AST. These nested ASTs are created using the
6510 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6511 outer AST. The C<build> argument should be an C<isl_ast_build>
6512 passed to a callback set by
6513 C<isl_ast_build_set_create_leaf>.
6514 The space of the range of the C<schedule> argument should refer
6515 to this build. In particular, the space should be a wrapped
6516 relation and the domain of this wrapped relation should be the
6517 same as that of the range of the schedule returned by
6518 C<isl_ast_build_get_schedule> below.
6519 In practice, the new schedule is typically
6520 created by calling C<isl_union_map_range_product> on the old schedule
6521 and some extra piece of the schedule.
6522 The space of the schedule domain is also available from
6523 the C<isl_ast_build>.
6525 #include <isl/ast_build.h>
6526 __isl_give isl_union_map *isl_ast_build_get_schedule(
6527 __isl_keep isl_ast_build *build);
6528 __isl_give isl_space *isl_ast_build_get_schedule_space(
6529 __isl_keep isl_ast_build *build);
6530 __isl_give isl_ast_build *isl_ast_build_restrict(
6531 __isl_take isl_ast_build *build,
6532 __isl_take isl_set *set);
6534 The C<isl_ast_build_get_schedule> function returns a (partial)
6535 schedule for the domains elements for which part of the AST still needs to
6536 be generated in the current build.
6537 In particular, the domain elements are mapped to those iterations of the loops
6538 enclosing the current point of the AST generation inside which
6539 the domain elements are executed.
6540 No direct correspondence between
6541 the input schedule and this schedule should be assumed.
6542 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6543 to create a set for C<isl_ast_build_restrict> to intersect
6544 with the current build. In particular, the set passed to
6545 C<isl_ast_build_restrict> can have additional parameters.
6546 The ids of the set dimensions in the space returned by
6547 C<isl_ast_build_get_schedule_space> correspond to the
6548 iterators of the already generated loops.
6549 The user should not rely on the ids of the output dimensions
6550 of the relations in the union relation returned by
6551 C<isl_ast_build_get_schedule> having any particular value.
6555 Although C<isl> is mainly meant to be used as a library,
6556 it also contains some basic applications that use some
6557 of the functionality of C<isl>.
6558 The input may be specified in either the L<isl format>
6559 or the L<PolyLib format>.
6561 =head2 C<isl_polyhedron_sample>
6563 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6564 an integer element of the polyhedron, if there is any.
6565 The first column in the output is the denominator and is always
6566 equal to 1. If the polyhedron contains no integer points,
6567 then a vector of length zero is printed.
6571 C<isl_pip> takes the same input as the C<example> program
6572 from the C<piplib> distribution, i.e., a set of constraints
6573 on the parameters, a line containing only -1 and finally a set
6574 of constraints on a parametric polyhedron.
6575 The coefficients of the parameters appear in the last columns
6576 (but before the final constant column).
6577 The output is the lexicographic minimum of the parametric polyhedron.
6578 As C<isl> currently does not have its own output format, the output
6579 is just a dump of the internal state.
6581 =head2 C<isl_polyhedron_minimize>
6583 C<isl_polyhedron_minimize> computes the minimum of some linear
6584 or affine objective function over the integer points in a polyhedron.
6585 If an affine objective function
6586 is given, then the constant should appear in the last column.
6588 =head2 C<isl_polytope_scan>
6590 Given a polytope, C<isl_polytope_scan> prints
6591 all integer points in the polytope.
6593 =head2 C<isl_codegen>
6595 Given a schedule, a context set and an options relation,
6596 C<isl_codegen> prints out an AST that scans the domain elements
6597 of the schedule in the order of their image(s) taking into account
6598 the constraints in the context set.