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)
173 The source of C<isl> can be obtained either as a tarball
174 or from the git repository. Both are available from
175 L<http://freshmeat.net/projects/isl/>.
176 The installation process depends on how you obtained
179 =head2 Installation from the git repository
183 =item 1 Clone or update the repository
185 The first time the source is obtained, you need to clone
188 git clone git://repo.or.cz/isl.git
190 To obtain updates, you need to pull in the latest changes
194 =item 2 Generate C<configure>
200 After performing the above steps, continue
201 with the L<Common installation instructions>.
203 =head2 Common installation instructions
207 =item 1 Obtain C<GMP>
209 Building C<isl> requires C<GMP>, including its headers files.
210 Your distribution may not provide these header files by default
211 and you may need to install a package called C<gmp-devel> or something
212 similar. Alternatively, C<GMP> can be built from
213 source, available from L<http://gmplib.org/>.
217 C<isl> uses the standard C<autoconf> C<configure> script.
222 optionally followed by some configure options.
223 A complete list of options can be obtained by running
227 Below we discuss some of the more common options.
229 C<isl> can optionally use C<piplib>, but no
230 C<piplib> functionality is currently used by default.
231 The C<--with-piplib> option can
232 be used to specify which C<piplib>
233 library to use, either an installed version (C<system>),
234 an externally built version (C<build>)
235 or no version (C<no>). The option C<build> is mostly useful
236 in C<configure> scripts of larger projects that bundle both C<isl>
243 Installation prefix for C<isl>
245 =item C<--with-gmp-prefix>
247 Installation prefix for C<GMP> (architecture-independent files).
249 =item C<--with-gmp-exec-prefix>
251 Installation prefix for C<GMP> (architecture-dependent files).
253 =item C<--with-piplib>
255 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
257 =item C<--with-piplib-prefix>
259 Installation prefix for C<system> C<piplib> (architecture-independent files).
261 =item C<--with-piplib-exec-prefix>
263 Installation prefix for C<system> C<piplib> (architecture-dependent files).
265 =item C<--with-piplib-builddir>
267 Location where C<build> C<piplib> was built.
275 =item 4 Install (optional)
283 =head2 Initialization
285 All manipulations of integer sets and relations occur within
286 the context of an C<isl_ctx>.
287 A given C<isl_ctx> can only be used within a single thread.
288 All arguments of a function are required to have been allocated
289 within the same context.
290 There are currently no functions available for moving an object
291 from one C<isl_ctx> to another C<isl_ctx>. This means that
292 there is currently no way of safely moving an object from one
293 thread to another, unless the whole C<isl_ctx> is moved.
295 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
296 freed using C<isl_ctx_free>.
297 All objects allocated within an C<isl_ctx> should be freed
298 before the C<isl_ctx> itself is freed.
300 isl_ctx *isl_ctx_alloc();
301 void isl_ctx_free(isl_ctx *ctx);
305 All operations on integers, mainly the coefficients
306 of the constraints describing the sets and relations,
307 are performed in exact integer arithmetic using C<GMP>.
308 However, to allow future versions of C<isl> to optionally
309 support fixed integer arithmetic, all calls to C<GMP>
310 are wrapped inside C<isl> specific macros.
311 The basic type is C<isl_int> and the operations below
312 are available on this type.
313 The meanings of these operations are essentially the same
314 as their C<GMP> C<mpz_> counterparts.
315 As always with C<GMP> types, C<isl_int>s need to be
316 initialized with C<isl_int_init> before they can be used
317 and they need to be released with C<isl_int_clear>
319 The user should not assume that an C<isl_int> is represented
320 as a C<mpz_t>, but should instead explicitly convert between
321 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
322 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
326 =item isl_int_init(i)
328 =item isl_int_clear(i)
330 =item isl_int_set(r,i)
332 =item isl_int_set_si(r,i)
334 =item isl_int_set_gmp(r,g)
336 =item isl_int_get_gmp(i,g)
338 =item isl_int_abs(r,i)
340 =item isl_int_neg(r,i)
342 =item isl_int_swap(i,j)
344 =item isl_int_swap_or_set(i,j)
346 =item isl_int_add_ui(r,i,j)
348 =item isl_int_sub_ui(r,i,j)
350 =item isl_int_add(r,i,j)
352 =item isl_int_sub(r,i,j)
354 =item isl_int_mul(r,i,j)
356 =item isl_int_mul_ui(r,i,j)
358 =item isl_int_addmul(r,i,j)
360 =item isl_int_submul(r,i,j)
362 =item isl_int_gcd(r,i,j)
364 =item isl_int_lcm(r,i,j)
366 =item isl_int_divexact(r,i,j)
368 =item isl_int_cdiv_q(r,i,j)
370 =item isl_int_fdiv_q(r,i,j)
372 =item isl_int_fdiv_r(r,i,j)
374 =item isl_int_fdiv_q_ui(r,i,j)
376 =item isl_int_read(r,s)
378 =item isl_int_print(out,i,width)
382 =item isl_int_cmp(i,j)
384 =item isl_int_cmp_si(i,si)
386 =item isl_int_eq(i,j)
388 =item isl_int_ne(i,j)
390 =item isl_int_lt(i,j)
392 =item isl_int_le(i,j)
394 =item isl_int_gt(i,j)
396 =item isl_int_ge(i,j)
398 =item isl_int_abs_eq(i,j)
400 =item isl_int_abs_ne(i,j)
402 =item isl_int_abs_lt(i,j)
404 =item isl_int_abs_gt(i,j)
406 =item isl_int_abs_ge(i,j)
408 =item isl_int_is_zero(i)
410 =item isl_int_is_one(i)
412 =item isl_int_is_negone(i)
414 =item isl_int_is_pos(i)
416 =item isl_int_is_neg(i)
418 =item isl_int_is_nonpos(i)
420 =item isl_int_is_nonneg(i)
422 =item isl_int_is_divisible_by(i,j)
426 =head2 Sets and Relations
428 C<isl> uses six types of objects for representing sets and relations,
429 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
430 C<isl_union_set> and C<isl_union_map>.
431 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
432 can be described as a conjunction of affine constraints, while
433 C<isl_set> and C<isl_map> represent unions of
434 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
435 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
436 to live in the same space. C<isl_union_set>s and C<isl_union_map>s
437 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
438 where spaces are considered different if they have a different number
439 of dimensions and/or different names (see L<"Spaces">).
440 The difference between sets and relations (maps) is that sets have
441 one set of variables, while relations have two sets of variables,
442 input variables and output variables.
444 =head2 Memory Management
446 Since a high-level operation on sets and/or relations usually involves
447 several substeps and since the user is usually not interested in
448 the intermediate results, most functions that return a new object
449 will also release all the objects passed as arguments.
450 If the user still wants to use one or more of these arguments
451 after the function call, she should pass along a copy of the
452 object rather than the object itself.
453 The user is then responsible for making sure that the original
454 object gets used somewhere else or is explicitly freed.
456 The arguments and return values of all documented functions are
457 annotated to make clear which arguments are released and which
458 arguments are preserved. In particular, the following annotations
465 C<__isl_give> means that a new object is returned.
466 The user should make sure that the returned pointer is
467 used exactly once as a value for an C<__isl_take> argument.
468 In between, it can be used as a value for as many
469 C<__isl_keep> arguments as the user likes.
470 There is one exception, and that is the case where the
471 pointer returned is C<NULL>. Is this case, the user
472 is free to use it as an C<__isl_take> argument or not.
476 C<__isl_take> means that the object the argument points to
477 is taken over by the function and may no longer be used
478 by the user as an argument to any other function.
479 The pointer value must be one returned by a function
480 returning an C<__isl_give> pointer.
481 If the user passes in a C<NULL> value, then this will
482 be treated as an error in the sense that the function will
483 not perform its usual operation. However, it will still
484 make sure that all the other C<__isl_take> arguments
489 C<__isl_keep> means that the function will only use the object
490 temporarily. After the function has finished, the user
491 can still use it as an argument to other functions.
492 A C<NULL> value will be treated in the same way as
493 a C<NULL> value for an C<__isl_take> argument.
497 =head2 Error Handling
499 C<isl> supports different ways to react in case a runtime error is triggered.
500 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
501 with two maps that have incompatible spaces. There are three possible ways
502 to react on error: to warn, to continue or to abort.
504 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
505 the last error in the corresponding C<isl_ctx> and the function in which the
506 error was triggered returns C<NULL>. An error does not corrupt internal state,
507 such that isl can continue to be used. C<isl> also provides functions to
508 read the last error and to reset the memory that stores the last error. The
509 last error is only stored for information purposes. Its presence does not
510 change the behavior of C<isl>. Hence, resetting an error is not required to
511 continue to use isl, but only to observe new errors.
514 enum isl_error isl_ctx_last_error(isl_ctx *ctx);
515 void isl_ctx_reset_error(isl_ctx *ctx);
517 Another option is to continue on error. This is similar to warn on error mode,
518 except that C<isl> does not print any warning. This allows a program to
519 implement its own error reporting.
521 The last option is to directly abort the execution of the program from within
522 the isl library. This makes it obviously impossible to recover from an error,
523 but it allows to directly spot the error location. By aborting on error,
524 debuggers break at the location the error occurred and can provide a stack
525 trace. Other tools that automatically provide stack traces on abort or that do
526 not want to continue execution after an error was triggered may also prefer to
529 The on error behavior of isl can be specified by calling
530 C<isl_options_set_on_error> or by setting the command line option
531 C<--isl-on-error>. Valid arguments for the function call are
532 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
533 choices for the command line option are C<warn>, C<continue> and C<abort>.
534 It is also possible to query the current error mode.
536 #include <isl/options.h>
537 int isl_options_set_on_error(isl_ctx *ctx, int val);
538 int isl_options_get_on_error(isl_ctx *ctx);
542 Identifiers are used to identify both individual dimensions
543 and tuples of dimensions. They consist of a name and an optional
544 pointer. Identifiers with the same name but different pointer values
545 are considered to be distinct.
546 Identifiers can be constructed, copied, freed, inspected and printed
547 using the following functions.
550 __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
551 __isl_keep const char *name, void *user);
552 __isl_give isl_id *isl_id_copy(isl_id *id);
553 void *isl_id_free(__isl_take isl_id *id);
555 isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
556 void *isl_id_get_user(__isl_keep isl_id *id);
557 __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
559 __isl_give isl_printer *isl_printer_print_id(
560 __isl_take isl_printer *p, __isl_keep isl_id *id);
562 Note that C<isl_id_get_name> returns a pointer to some internal
563 data structure, so the result can only be used while the
564 corresponding C<isl_id> is alive.
568 Whenever a new set, relation or similiar object is created from scratch,
569 the space in which it lives needs to be specified using an C<isl_space>.
570 Each space involves zero or more parameters and zero, one or two
571 tuples of set or input/output dimensions. The parameters and dimensions
572 are identified by an C<isl_dim_type> and a position.
573 The type C<isl_dim_param> refers to parameters,
574 the type C<isl_dim_set> refers to set dimensions (for spaces
575 with a single tuple of dimensions) and the types C<isl_dim_in>
576 and C<isl_dim_out> refer to input and output dimensions
577 (for spaces with two tuples of dimensions).
578 Local spaces (see L</"Local Spaces">) also contain dimensions
579 of type C<isl_dim_div>.
580 Note that parameters are only identified by their position within
581 a given object. Across different objects, parameters are (usually)
582 identified by their names or identifiers. Only unnamed parameters
583 are identified by their positions across objects. The use of unnamed
584 parameters is discouraged.
586 #include <isl/space.h>
587 __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
588 unsigned nparam, unsigned n_in, unsigned n_out);
589 __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
591 __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
592 unsigned nparam, unsigned dim);
593 __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
594 void isl_space_free(__isl_take isl_space *space);
595 unsigned isl_space_dim(__isl_keep isl_space *space,
596 enum isl_dim_type type);
598 The space used for creating a parameter domain
599 needs to be created using C<isl_space_params_alloc>.
600 For other sets, the space
601 needs to be created using C<isl_space_set_alloc>, while
602 for a relation, the space
603 needs to be created using C<isl_space_alloc>.
604 C<isl_space_dim> can be used
605 to find out the number of dimensions of each type in
606 a space, where type may be
607 C<isl_dim_param>, C<isl_dim_in> (only for relations),
608 C<isl_dim_out> (only for relations), C<isl_dim_set>
609 (only for sets) or C<isl_dim_all>.
611 To check whether a given space is that of a set or a map
612 or whether it is a parameter space, use these functions:
614 #include <isl/space.h>
615 int isl_space_is_params(__isl_keep isl_space *space);
616 int isl_space_is_set(__isl_keep isl_space *space);
618 It is often useful to create objects that live in the
619 same space as some other object. This can be accomplished
620 by creating the new objects
621 (see L<Creating New Sets and Relations> or
622 L<Creating New (Piecewise) Quasipolynomials>) based on the space
623 of the original object.
626 __isl_give isl_space *isl_basic_set_get_space(
627 __isl_keep isl_basic_set *bset);
628 __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
630 #include <isl/union_set.h>
631 __isl_give isl_space *isl_union_set_get_space(
632 __isl_keep isl_union_set *uset);
635 __isl_give isl_space *isl_basic_map_get_space(
636 __isl_keep isl_basic_map *bmap);
637 __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
639 #include <isl/union_map.h>
640 __isl_give isl_space *isl_union_map_get_space(
641 __isl_keep isl_union_map *umap);
643 #include <isl/constraint.h>
644 __isl_give isl_space *isl_constraint_get_space(
645 __isl_keep isl_constraint *constraint);
647 #include <isl/polynomial.h>
648 __isl_give isl_space *isl_qpolynomial_get_domain_space(
649 __isl_keep isl_qpolynomial *qp);
650 __isl_give isl_space *isl_qpolynomial_get_space(
651 __isl_keep isl_qpolynomial *qp);
652 __isl_give isl_space *isl_qpolynomial_fold_get_space(
653 __isl_keep isl_qpolynomial_fold *fold);
654 __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
655 __isl_keep isl_pw_qpolynomial *pwqp);
656 __isl_give isl_space *isl_pw_qpolynomial_get_space(
657 __isl_keep isl_pw_qpolynomial *pwqp);
658 __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
659 __isl_keep isl_pw_qpolynomial_fold *pwf);
660 __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
661 __isl_keep isl_pw_qpolynomial_fold *pwf);
662 __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
663 __isl_keep isl_union_pw_qpolynomial *upwqp);
664 __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
665 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
668 __isl_give isl_space *isl_aff_get_domain_space(
669 __isl_keep isl_aff *aff);
670 __isl_give isl_space *isl_aff_get_space(
671 __isl_keep isl_aff *aff);
672 __isl_give isl_space *isl_pw_aff_get_domain_space(
673 __isl_keep isl_pw_aff *pwaff);
674 __isl_give isl_space *isl_pw_aff_get_space(
675 __isl_keep isl_pw_aff *pwaff);
676 __isl_give isl_space *isl_multi_aff_get_space(
677 __isl_keep isl_multi_aff *maff);
678 __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
679 __isl_keep isl_pw_multi_aff *pma);
680 __isl_give isl_space *isl_pw_multi_aff_get_space(
681 __isl_keep isl_pw_multi_aff *pma);
682 __isl_give isl_space *isl_union_pw_multi_aff_get_space(
683 __isl_keep isl_union_pw_multi_aff *upma);
685 #include <isl/point.h>
686 __isl_give isl_space *isl_point_get_space(
687 __isl_keep isl_point *pnt);
689 The identifiers or names of the individual dimensions may be set or read off
690 using the following functions.
692 #include <isl/space.h>
693 __isl_give isl_space *isl_space_set_dim_id(
694 __isl_take isl_space *space,
695 enum isl_dim_type type, unsigned pos,
696 __isl_take isl_id *id);
697 int isl_space_has_dim_id(__isl_keep isl_space *space,
698 enum isl_dim_type type, unsigned pos);
699 __isl_give isl_id *isl_space_get_dim_id(
700 __isl_keep isl_space *space,
701 enum isl_dim_type type, unsigned pos);
702 __isl_give isl_space *isl_space_set_dim_name(
703 __isl_take isl_space *space,
704 enum isl_dim_type type, unsigned pos,
705 __isl_keep const char *name);
706 int isl_space_has_dim_name(__isl_keep isl_space *space,
707 enum isl_dim_type type, unsigned pos);
708 __isl_keep const char *isl_space_get_dim_name(
709 __isl_keep isl_space *space,
710 enum isl_dim_type type, unsigned pos);
712 Note that C<isl_space_get_name> returns a pointer to some internal
713 data structure, so the result can only be used while the
714 corresponding C<isl_space> is alive.
715 Also note that every function that operates on two sets or relations
716 requires that both arguments have the same parameters. This also
717 means that if one of the arguments has named parameters, then the
718 other needs to have named parameters too and the names need to match.
719 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
720 arguments may have different parameters (as long as they are named),
721 in which case the result will have as parameters the union of the parameters of
724 Given the identifier or name of a dimension (typically a parameter),
725 its position can be obtained from the following function.
727 #include <isl/space.h>
728 int isl_space_find_dim_by_id(__isl_keep isl_space *space,
729 enum isl_dim_type type, __isl_keep isl_id *id);
730 int isl_space_find_dim_by_name(__isl_keep isl_space *space,
731 enum isl_dim_type type, const char *name);
733 The identifiers or names of entire spaces may be set or read off
734 using the following functions.
736 #include <isl/space.h>
737 __isl_give isl_space *isl_space_set_tuple_id(
738 __isl_take isl_space *space,
739 enum isl_dim_type type, __isl_take isl_id *id);
740 __isl_give isl_space *isl_space_reset_tuple_id(
741 __isl_take isl_space *space, enum isl_dim_type type);
742 int isl_space_has_tuple_id(__isl_keep isl_space *space,
743 enum isl_dim_type type);
744 __isl_give isl_id *isl_space_get_tuple_id(
745 __isl_keep isl_space *space, enum isl_dim_type type);
746 __isl_give isl_space *isl_space_set_tuple_name(
747 __isl_take isl_space *space,
748 enum isl_dim_type type, const char *s);
749 int isl_space_has_tuple_name(__isl_keep isl_space *space,
750 enum isl_dim_type type);
751 const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
752 enum isl_dim_type type);
754 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
755 or C<isl_dim_set>. As with C<isl_space_get_name>,
756 the C<isl_space_get_tuple_name> function returns a pointer to some internal
758 Binary operations require the corresponding spaces of their arguments
759 to have the same name.
761 Spaces can be nested. In particular, the domain of a set or
762 the domain or range of a relation can be a nested relation.
763 The following functions can be used to construct and deconstruct
766 #include <isl/space.h>
767 int isl_space_is_wrapping(__isl_keep isl_space *space);
768 __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
769 __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
771 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
772 be the space of a set, while that of
773 C<isl_space_wrap> should be the space of a relation.
774 Conversely, the output of C<isl_space_unwrap> is the space
775 of a relation, while that of C<isl_space_wrap> is the space of a set.
777 Spaces can be created from other spaces
778 using the following functions.
780 __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
781 __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
782 __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
783 __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
784 __isl_give isl_space *isl_space_params(
785 __isl_take isl_space *space);
786 __isl_give isl_space *isl_space_set_from_params(
787 __isl_take isl_space *space);
788 __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
789 __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
790 __isl_take isl_space *right);
791 __isl_give isl_space *isl_space_align_params(
792 __isl_take isl_space *space1, __isl_take isl_space *space2)
793 __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
794 enum isl_dim_type type, unsigned pos, unsigned n);
795 __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
796 enum isl_dim_type type, unsigned n);
797 __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
798 enum isl_dim_type type, unsigned first, unsigned n);
799 __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
800 enum isl_dim_type dst_type, unsigned dst_pos,
801 enum isl_dim_type src_type, unsigned src_pos,
803 __isl_give isl_space *isl_space_map_from_set(
804 __isl_take isl_space *space);
805 __isl_give isl_space *isl_space_map_from_domain_and_range(
806 __isl_take isl_space *domain,
807 __isl_take isl_space *range);
808 __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
809 __isl_give isl_space *isl_space_curry(
810 __isl_take isl_space *space);
812 Note that if dimensions are added or removed from a space, then
813 the name and the internal structure are lost.
817 A local space is essentially a space with
818 zero or more existentially quantified variables.
819 The local space of a (constraint of a) basic set or relation can be obtained
820 using the following functions.
822 #include <isl/constraint.h>
823 __isl_give isl_local_space *isl_constraint_get_local_space(
824 __isl_keep isl_constraint *constraint);
827 __isl_give isl_local_space *isl_basic_set_get_local_space(
828 __isl_keep isl_basic_set *bset);
831 __isl_give isl_local_space *isl_basic_map_get_local_space(
832 __isl_keep isl_basic_map *bmap);
834 A new local space can be created from a space using
836 #include <isl/local_space.h>
837 __isl_give isl_local_space *isl_local_space_from_space(
838 __isl_take isl_space *space);
840 They can be inspected, modified, copied and freed using the following functions.
842 #include <isl/local_space.h>
843 isl_ctx *isl_local_space_get_ctx(
844 __isl_keep isl_local_space *ls);
845 int isl_local_space_is_set(__isl_keep isl_local_space *ls);
846 int isl_local_space_dim(__isl_keep isl_local_space *ls,
847 enum isl_dim_type type);
848 int isl_local_space_has_dim_id(
849 __isl_keep isl_local_space *ls,
850 enum isl_dim_type type, unsigned pos);
851 __isl_give isl_id *isl_local_space_get_dim_id(
852 __isl_keep isl_local_space *ls,
853 enum isl_dim_type type, unsigned pos);
854 int isl_local_space_has_dim_name(
855 __isl_keep isl_local_space *ls,
856 enum isl_dim_type type, unsigned pos)
857 const char *isl_local_space_get_dim_name(
858 __isl_keep isl_local_space *ls,
859 enum isl_dim_type type, unsigned pos);
860 __isl_give isl_local_space *isl_local_space_set_dim_name(
861 __isl_take isl_local_space *ls,
862 enum isl_dim_type type, unsigned pos, const char *s);
863 __isl_give isl_local_space *isl_local_space_set_dim_id(
864 __isl_take isl_local_space *ls,
865 enum isl_dim_type type, unsigned pos,
866 __isl_take isl_id *id);
867 __isl_give isl_space *isl_local_space_get_space(
868 __isl_keep isl_local_space *ls);
869 __isl_give isl_aff *isl_local_space_get_div(
870 __isl_keep isl_local_space *ls, int pos);
871 __isl_give isl_local_space *isl_local_space_copy(
872 __isl_keep isl_local_space *ls);
873 void *isl_local_space_free(__isl_take isl_local_space *ls);
875 Two local spaces can be compared using
877 int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
878 __isl_keep isl_local_space *ls2);
880 Local spaces can be created from other local spaces
881 using the following functions.
883 __isl_give isl_local_space *isl_local_space_domain(
884 __isl_take isl_local_space *ls);
885 __isl_give isl_local_space *isl_local_space_range(
886 __isl_take isl_local_space *ls);
887 __isl_give isl_local_space *isl_local_space_from_domain(
888 __isl_take isl_local_space *ls);
889 __isl_give isl_local_space *isl_local_space_intersect(
890 __isl_take isl_local_space *ls1,
891 __isl_take isl_local_space *ls2);
892 __isl_give isl_local_space *isl_local_space_add_dims(
893 __isl_take isl_local_space *ls,
894 enum isl_dim_type type, unsigned n);
895 __isl_give isl_local_space *isl_local_space_insert_dims(
896 __isl_take isl_local_space *ls,
897 enum isl_dim_type type, unsigned first, unsigned n);
898 __isl_give isl_local_space *isl_local_space_drop_dims(
899 __isl_take isl_local_space *ls,
900 enum isl_dim_type type, unsigned first, unsigned n);
902 =head2 Input and Output
904 C<isl> supports its own input/output format, which is similar
905 to the C<Omega> format, but also supports the C<PolyLib> format
910 The C<isl> format is similar to that of C<Omega>, but has a different
911 syntax for describing the parameters and allows for the definition
912 of an existentially quantified variable as the integer division
913 of an affine expression.
914 For example, the set of integers C<i> between C<0> and C<n>
915 such that C<i % 10 <= 6> can be described as
917 [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
920 A set or relation can have several disjuncts, separated
921 by the keyword C<or>. Each disjunct is either a conjunction
922 of constraints or a projection (C<exists>) of a conjunction
923 of constraints. The constraints are separated by the keyword
926 =head3 C<PolyLib> format
928 If the represented set is a union, then the first line
929 contains a single number representing the number of disjuncts.
930 Otherwise, a line containing the number C<1> is optional.
932 Each disjunct is represented by a matrix of constraints.
933 The first line contains two numbers representing
934 the number of rows and columns,
935 where the number of rows is equal to the number of constraints
936 and the number of columns is equal to two plus the number of variables.
937 The following lines contain the actual rows of the constraint matrix.
938 In each row, the first column indicates whether the constraint
939 is an equality (C<0>) or inequality (C<1>). The final column
940 corresponds to the constant term.
942 If the set is parametric, then the coefficients of the parameters
943 appear in the last columns before the constant column.
944 The coefficients of any existentially quantified variables appear
945 between those of the set variables and those of the parameters.
947 =head3 Extended C<PolyLib> format
949 The extended C<PolyLib> format is nearly identical to the
950 C<PolyLib> format. The only difference is that the line
951 containing the number of rows and columns of a constraint matrix
952 also contains four additional numbers:
953 the number of output dimensions, the number of input dimensions,
954 the number of local dimensions (i.e., the number of existentially
955 quantified variables) and the number of parameters.
956 For sets, the number of ``output'' dimensions is equal
957 to the number of set dimensions, while the number of ``input''
963 __isl_give isl_basic_set *isl_basic_set_read_from_file(
964 isl_ctx *ctx, FILE *input);
965 __isl_give isl_basic_set *isl_basic_set_read_from_str(
966 isl_ctx *ctx, const char *str);
967 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
969 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
973 __isl_give isl_basic_map *isl_basic_map_read_from_file(
974 isl_ctx *ctx, FILE *input);
975 __isl_give isl_basic_map *isl_basic_map_read_from_str(
976 isl_ctx *ctx, const char *str);
977 __isl_give isl_map *isl_map_read_from_file(
978 isl_ctx *ctx, FILE *input);
979 __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
982 #include <isl/union_set.h>
983 __isl_give isl_union_set *isl_union_set_read_from_file(
984 isl_ctx *ctx, FILE *input);
985 __isl_give isl_union_set *isl_union_set_read_from_str(
986 isl_ctx *ctx, const char *str);
988 #include <isl/union_map.h>
989 __isl_give isl_union_map *isl_union_map_read_from_file(
990 isl_ctx *ctx, FILE *input);
991 __isl_give isl_union_map *isl_union_map_read_from_str(
992 isl_ctx *ctx, const char *str);
994 The input format is autodetected and may be either the C<PolyLib> format
995 or the C<isl> format.
999 Before anything can be printed, an C<isl_printer> needs to
1002 __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1004 __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1005 void isl_printer_free(__isl_take isl_printer *printer);
1006 __isl_give char *isl_printer_get_str(
1007 __isl_keep isl_printer *printer);
1009 The printer can be inspected using the following functions.
1011 FILE *isl_printer_get_file(
1012 __isl_keep isl_printer *printer);
1013 int isl_printer_get_output_format(
1014 __isl_keep isl_printer *p);
1016 The behavior of the printer can be modified in various ways
1018 __isl_give isl_printer *isl_printer_set_output_format(
1019 __isl_take isl_printer *p, int output_format);
1020 __isl_give isl_printer *isl_printer_set_indent(
1021 __isl_take isl_printer *p, int indent);
1022 __isl_give isl_printer *isl_printer_indent(
1023 __isl_take isl_printer *p, int indent);
1024 __isl_give isl_printer *isl_printer_set_prefix(
1025 __isl_take isl_printer *p, const char *prefix);
1026 __isl_give isl_printer *isl_printer_set_suffix(
1027 __isl_take isl_printer *p, const char *suffix);
1029 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1030 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1031 and defaults to C<ISL_FORMAT_ISL>.
1032 Each line in the output is indented by C<indent> (set by
1033 C<isl_printer_set_indent>) spaces
1034 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1035 In the C<PolyLib> format output,
1036 the coefficients of the existentially quantified variables
1037 appear between those of the set variables and those
1039 The function C<isl_printer_indent> increases the indentation
1040 by the specified amount (which may be negative).
1042 To actually print something, use
1044 #include <isl/printer.h>
1045 __isl_give isl_printer *isl_printer_print_double(
1046 __isl_take isl_printer *p, double d);
1048 #include <isl/set.h>
1049 __isl_give isl_printer *isl_printer_print_basic_set(
1050 __isl_take isl_printer *printer,
1051 __isl_keep isl_basic_set *bset);
1052 __isl_give isl_printer *isl_printer_print_set(
1053 __isl_take isl_printer *printer,
1054 __isl_keep isl_set *set);
1056 #include <isl/map.h>
1057 __isl_give isl_printer *isl_printer_print_basic_map(
1058 __isl_take isl_printer *printer,
1059 __isl_keep isl_basic_map *bmap);
1060 __isl_give isl_printer *isl_printer_print_map(
1061 __isl_take isl_printer *printer,
1062 __isl_keep isl_map *map);
1064 #include <isl/union_set.h>
1065 __isl_give isl_printer *isl_printer_print_union_set(
1066 __isl_take isl_printer *p,
1067 __isl_keep isl_union_set *uset);
1069 #include <isl/union_map.h>
1070 __isl_give isl_printer *isl_printer_print_union_map(
1071 __isl_take isl_printer *p,
1072 __isl_keep isl_union_map *umap);
1074 When called on a file printer, the following function flushes
1075 the file. When called on a string printer, the buffer is cleared.
1077 __isl_give isl_printer *isl_printer_flush(
1078 __isl_take isl_printer *p);
1080 =head2 Creating New Sets and Relations
1082 C<isl> has functions for creating some standard sets and relations.
1086 =item * Empty sets and relations
1088 __isl_give isl_basic_set *isl_basic_set_empty(
1089 __isl_take isl_space *space);
1090 __isl_give isl_basic_map *isl_basic_map_empty(
1091 __isl_take isl_space *space);
1092 __isl_give isl_set *isl_set_empty(
1093 __isl_take isl_space *space);
1094 __isl_give isl_map *isl_map_empty(
1095 __isl_take isl_space *space);
1096 __isl_give isl_union_set *isl_union_set_empty(
1097 __isl_take isl_space *space);
1098 __isl_give isl_union_map *isl_union_map_empty(
1099 __isl_take isl_space *space);
1101 For C<isl_union_set>s and C<isl_union_map>s, the space
1102 is only used to specify the parameters.
1104 =item * Universe sets and relations
1106 __isl_give isl_basic_set *isl_basic_set_universe(
1107 __isl_take isl_space *space);
1108 __isl_give isl_basic_map *isl_basic_map_universe(
1109 __isl_take isl_space *space);
1110 __isl_give isl_set *isl_set_universe(
1111 __isl_take isl_space *space);
1112 __isl_give isl_map *isl_map_universe(
1113 __isl_take isl_space *space);
1114 __isl_give isl_union_set *isl_union_set_universe(
1115 __isl_take isl_union_set *uset);
1116 __isl_give isl_union_map *isl_union_map_universe(
1117 __isl_take isl_union_map *umap);
1119 The sets and relations constructed by the functions above
1120 contain all integer values, while those constructed by the
1121 functions below only contain non-negative values.
1123 __isl_give isl_basic_set *isl_basic_set_nat_universe(
1124 __isl_take isl_space *space);
1125 __isl_give isl_basic_map *isl_basic_map_nat_universe(
1126 __isl_take isl_space *space);
1127 __isl_give isl_set *isl_set_nat_universe(
1128 __isl_take isl_space *space);
1129 __isl_give isl_map *isl_map_nat_universe(
1130 __isl_take isl_space *space);
1132 =item * Identity relations
1134 __isl_give isl_basic_map *isl_basic_map_identity(
1135 __isl_take isl_space *space);
1136 __isl_give isl_map *isl_map_identity(
1137 __isl_take isl_space *space);
1139 The number of input and output dimensions in C<space> needs
1142 =item * Lexicographic order
1144 __isl_give isl_map *isl_map_lex_lt(
1145 __isl_take isl_space *set_space);
1146 __isl_give isl_map *isl_map_lex_le(
1147 __isl_take isl_space *set_space);
1148 __isl_give isl_map *isl_map_lex_gt(
1149 __isl_take isl_space *set_space);
1150 __isl_give isl_map *isl_map_lex_ge(
1151 __isl_take isl_space *set_space);
1152 __isl_give isl_map *isl_map_lex_lt_first(
1153 __isl_take isl_space *space, unsigned n);
1154 __isl_give isl_map *isl_map_lex_le_first(
1155 __isl_take isl_space *space, unsigned n);
1156 __isl_give isl_map *isl_map_lex_gt_first(
1157 __isl_take isl_space *space, unsigned n);
1158 __isl_give isl_map *isl_map_lex_ge_first(
1159 __isl_take isl_space *space, unsigned n);
1161 The first four functions take a space for a B<set>
1162 and return relations that express that the elements in the domain
1163 are lexicographically less
1164 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1165 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1166 than the elements in the range.
1167 The last four functions take a space for a map
1168 and return relations that express that the first C<n> dimensions
1169 in the domain are lexicographically less
1170 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1171 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1172 than the first C<n> dimensions in the range.
1176 A basic set or relation can be converted to a set or relation
1177 using the following functions.
1179 __isl_give isl_set *isl_set_from_basic_set(
1180 __isl_take isl_basic_set *bset);
1181 __isl_give isl_map *isl_map_from_basic_map(
1182 __isl_take isl_basic_map *bmap);
1184 Sets and relations can be converted to union sets and relations
1185 using the following functions.
1187 __isl_give isl_union_map *isl_union_map_from_map(
1188 __isl_take isl_map *map);
1189 __isl_give isl_union_set *isl_union_set_from_set(
1190 __isl_take isl_set *set);
1192 The inverse conversions below can only be used if the input
1193 union set or relation is known to contain elements in exactly one
1196 __isl_give isl_set *isl_set_from_union_set(
1197 __isl_take isl_union_set *uset);
1198 __isl_give isl_map *isl_map_from_union_map(
1199 __isl_take isl_union_map *umap);
1201 A zero-dimensional set can be constructed on a given parameter domain
1202 using the following function.
1204 __isl_give isl_set *isl_set_from_params(
1205 __isl_take isl_set *set);
1207 Sets and relations can be copied and freed again using the following
1210 __isl_give isl_basic_set *isl_basic_set_copy(
1211 __isl_keep isl_basic_set *bset);
1212 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1213 __isl_give isl_union_set *isl_union_set_copy(
1214 __isl_keep isl_union_set *uset);
1215 __isl_give isl_basic_map *isl_basic_map_copy(
1216 __isl_keep isl_basic_map *bmap);
1217 __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1218 __isl_give isl_union_map *isl_union_map_copy(
1219 __isl_keep isl_union_map *umap);
1220 void isl_basic_set_free(__isl_take isl_basic_set *bset);
1221 void isl_set_free(__isl_take isl_set *set);
1222 void *isl_union_set_free(__isl_take isl_union_set *uset);
1223 void isl_basic_map_free(__isl_take isl_basic_map *bmap);
1224 void isl_map_free(__isl_take isl_map *map);
1225 void *isl_union_map_free(__isl_take isl_union_map *umap);
1227 Other sets and relations can be constructed by starting
1228 from a universe set or relation, adding equality and/or
1229 inequality constraints and then projecting out the
1230 existentially quantified variables, if any.
1231 Constraints can be constructed, manipulated and
1232 added to (or removed from) (basic) sets and relations
1233 using the following functions.
1235 #include <isl/constraint.h>
1236 __isl_give isl_constraint *isl_equality_alloc(
1237 __isl_take isl_local_space *ls);
1238 __isl_give isl_constraint *isl_inequality_alloc(
1239 __isl_take isl_local_space *ls);
1240 __isl_give isl_constraint *isl_constraint_set_constant(
1241 __isl_take isl_constraint *constraint, isl_int v);
1242 __isl_give isl_constraint *isl_constraint_set_constant_si(
1243 __isl_take isl_constraint *constraint, int v);
1244 __isl_give isl_constraint *isl_constraint_set_coefficient(
1245 __isl_take isl_constraint *constraint,
1246 enum isl_dim_type type, int pos, isl_int v);
1247 __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1248 __isl_take isl_constraint *constraint,
1249 enum isl_dim_type type, int pos, int v);
1250 __isl_give isl_basic_map *isl_basic_map_add_constraint(
1251 __isl_take isl_basic_map *bmap,
1252 __isl_take isl_constraint *constraint);
1253 __isl_give isl_basic_set *isl_basic_set_add_constraint(
1254 __isl_take isl_basic_set *bset,
1255 __isl_take isl_constraint *constraint);
1256 __isl_give isl_map *isl_map_add_constraint(
1257 __isl_take isl_map *map,
1258 __isl_take isl_constraint *constraint);
1259 __isl_give isl_set *isl_set_add_constraint(
1260 __isl_take isl_set *set,
1261 __isl_take isl_constraint *constraint);
1262 __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1263 __isl_take isl_basic_set *bset,
1264 __isl_take isl_constraint *constraint);
1266 For example, to create a set containing the even integers
1267 between 10 and 42, you would use the following code.
1270 isl_local_space *ls;
1272 isl_basic_set *bset;
1274 space = isl_space_set_alloc(ctx, 0, 2);
1275 bset = isl_basic_set_universe(isl_space_copy(space));
1276 ls = isl_local_space_from_space(space);
1278 c = isl_equality_alloc(isl_local_space_copy(ls));
1279 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1280 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1281 bset = isl_basic_set_add_constraint(bset, c);
1283 c = isl_inequality_alloc(isl_local_space_copy(ls));
1284 c = isl_constraint_set_constant_si(c, -10);
1285 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1286 bset = isl_basic_set_add_constraint(bset, c);
1288 c = isl_inequality_alloc(ls);
1289 c = isl_constraint_set_constant_si(c, 42);
1290 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1291 bset = isl_basic_set_add_constraint(bset, c);
1293 bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1297 isl_basic_set *bset;
1298 bset = isl_basic_set_read_from_str(ctx,
1299 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1301 A basic set or relation can also be constructed from two matrices
1302 describing the equalities and the inequalities.
1304 __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1305 __isl_take isl_space *space,
1306 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1307 enum isl_dim_type c1,
1308 enum isl_dim_type c2, enum isl_dim_type c3,
1309 enum isl_dim_type c4);
1310 __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1311 __isl_take isl_space *space,
1312 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1313 enum isl_dim_type c1,
1314 enum isl_dim_type c2, enum isl_dim_type c3,
1315 enum isl_dim_type c4, enum isl_dim_type c5);
1317 The C<isl_dim_type> arguments indicate the order in which
1318 different kinds of variables appear in the input matrices
1319 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1320 C<isl_dim_set> and C<isl_dim_div> for sets and
1321 of C<isl_dim_cst>, C<isl_dim_param>,
1322 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1324 A (basic or union) set or relation can also be constructed from a
1325 (union) (piecewise) (multiple) affine expression
1326 or a list of affine expressions
1327 (See L<"Piecewise Quasi Affine Expressions"> and
1328 L<"Piecewise Multiple Quasi Affine Expressions">).
1330 __isl_give isl_basic_map *isl_basic_map_from_aff(
1331 __isl_take isl_aff *aff);
1332 __isl_give isl_map *isl_map_from_aff(
1333 __isl_take isl_aff *aff);
1334 __isl_give isl_set *isl_set_from_pw_aff(
1335 __isl_take isl_pw_aff *pwaff);
1336 __isl_give isl_map *isl_map_from_pw_aff(
1337 __isl_take isl_pw_aff *pwaff);
1338 __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1339 __isl_take isl_space *domain_space,
1340 __isl_take isl_aff_list *list);
1341 __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1342 __isl_take isl_multi_aff *maff)
1343 __isl_give isl_map *isl_map_from_multi_aff(
1344 __isl_take isl_multi_aff *maff)
1345 __isl_give isl_set *isl_set_from_pw_multi_aff(
1346 __isl_take isl_pw_multi_aff *pma);
1347 __isl_give isl_map *isl_map_from_pw_multi_aff(
1348 __isl_take isl_pw_multi_aff *pma);
1349 __isl_give isl_union_map *
1350 isl_union_map_from_union_pw_multi_aff(
1351 __isl_take isl_union_pw_multi_aff *upma);
1353 The C<domain_dim> argument describes the domain of the resulting
1354 basic relation. It is required because the C<list> may consist
1355 of zero affine expressions.
1357 =head2 Inspecting Sets and Relations
1359 Usually, the user should not have to care about the actual constraints
1360 of the sets and maps, but should instead apply the abstract operations
1361 explained in the following sections.
1362 Occasionally, however, it may be required to inspect the individual
1363 coefficients of the constraints. This section explains how to do so.
1364 In these cases, it may also be useful to have C<isl> compute
1365 an explicit representation of the existentially quantified variables.
1367 __isl_give isl_set *isl_set_compute_divs(
1368 __isl_take isl_set *set);
1369 __isl_give isl_map *isl_map_compute_divs(
1370 __isl_take isl_map *map);
1371 __isl_give isl_union_set *isl_union_set_compute_divs(
1372 __isl_take isl_union_set *uset);
1373 __isl_give isl_union_map *isl_union_map_compute_divs(
1374 __isl_take isl_union_map *umap);
1376 This explicit representation defines the existentially quantified
1377 variables as integer divisions of the other variables, possibly
1378 including earlier existentially quantified variables.
1379 An explicitly represented existentially quantified variable therefore
1380 has a unique value when the values of the other variables are known.
1381 If, furthermore, the same existentials, i.e., existentials
1382 with the same explicit representations, should appear in the
1383 same order in each of the disjuncts of a set or map, then the user should call
1384 either of the following functions.
1386 __isl_give isl_set *isl_set_align_divs(
1387 __isl_take isl_set *set);
1388 __isl_give isl_map *isl_map_align_divs(
1389 __isl_take isl_map *map);
1391 Alternatively, the existentially quantified variables can be removed
1392 using the following functions, which compute an overapproximation.
1394 __isl_give isl_basic_set *isl_basic_set_remove_divs(
1395 __isl_take isl_basic_set *bset);
1396 __isl_give isl_basic_map *isl_basic_map_remove_divs(
1397 __isl_take isl_basic_map *bmap);
1398 __isl_give isl_set *isl_set_remove_divs(
1399 __isl_take isl_set *set);
1400 __isl_give isl_map *isl_map_remove_divs(
1401 __isl_take isl_map *map);
1403 To iterate over all the sets or maps in a union set or map, use
1405 int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1406 int (*fn)(__isl_take isl_set *set, void *user),
1408 int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1409 int (*fn)(__isl_take isl_map *map, void *user),
1412 The number of sets or maps in a union set or map can be obtained
1415 int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1416 int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1418 To extract the set or map in a given space from a union, use
1420 __isl_give isl_set *isl_union_set_extract_set(
1421 __isl_keep isl_union_set *uset,
1422 __isl_take isl_space *space);
1423 __isl_give isl_map *isl_union_map_extract_map(
1424 __isl_keep isl_union_map *umap,
1425 __isl_take isl_space *space);
1427 To iterate over all the basic sets or maps in a set or map, use
1429 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1430 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1432 int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1433 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1436 The callback function C<fn> should return 0 if successful and
1437 -1 if an error occurs. In the latter case, or if any other error
1438 occurs, the above functions will return -1.
1440 It should be noted that C<isl> does not guarantee that
1441 the basic sets or maps passed to C<fn> are disjoint.
1442 If this is required, then the user should call one of
1443 the following functions first.
1445 __isl_give isl_set *isl_set_make_disjoint(
1446 __isl_take isl_set *set);
1447 __isl_give isl_map *isl_map_make_disjoint(
1448 __isl_take isl_map *map);
1450 The number of basic sets in a set can be obtained
1453 int isl_set_n_basic_set(__isl_keep isl_set *set);
1455 To iterate over the constraints of a basic set or map, use
1457 #include <isl/constraint.h>
1459 int isl_basic_set_n_constraint(
1460 __isl_keep isl_basic_set *bset);
1461 int isl_basic_set_foreach_constraint(
1462 __isl_keep isl_basic_set *bset,
1463 int (*fn)(__isl_take isl_constraint *c, void *user),
1465 int isl_basic_map_foreach_constraint(
1466 __isl_keep isl_basic_map *bmap,
1467 int (*fn)(__isl_take isl_constraint *c, void *user),
1469 void *isl_constraint_free(__isl_take isl_constraint *c);
1471 Again, the callback function C<fn> should return 0 if successful and
1472 -1 if an error occurs. In the latter case, or if any other error
1473 occurs, the above functions will return -1.
1474 The constraint C<c> represents either an equality or an inequality.
1475 Use the following function to find out whether a constraint
1476 represents an equality. If not, it represents an inequality.
1478 int isl_constraint_is_equality(
1479 __isl_keep isl_constraint *constraint);
1481 The coefficients of the constraints can be inspected using
1482 the following functions.
1484 int isl_constraint_is_lower_bound(
1485 __isl_keep isl_constraint *constraint,
1486 enum isl_dim_type type, unsigned pos);
1487 int isl_constraint_is_upper_bound(
1488 __isl_keep isl_constraint *constraint,
1489 enum isl_dim_type type, unsigned pos);
1490 void isl_constraint_get_constant(
1491 __isl_keep isl_constraint *constraint, isl_int *v);
1492 void isl_constraint_get_coefficient(
1493 __isl_keep isl_constraint *constraint,
1494 enum isl_dim_type type, int pos, isl_int *v);
1495 int isl_constraint_involves_dims(
1496 __isl_keep isl_constraint *constraint,
1497 enum isl_dim_type type, unsigned first, unsigned n);
1499 The explicit representations of the existentially quantified
1500 variables can be inspected using the following function.
1501 Note that the user is only allowed to use this function
1502 if the inspected set or map is the result of a call
1503 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1504 The existentially quantified variable is equal to the floor
1505 of the returned affine expression. The affine expression
1506 itself can be inspected using the functions in
1507 L<"Piecewise Quasi Affine Expressions">.
1509 __isl_give isl_aff *isl_constraint_get_div(
1510 __isl_keep isl_constraint *constraint, int pos);
1512 To obtain the constraints of a basic set or map in matrix
1513 form, use the following functions.
1515 __isl_give isl_mat *isl_basic_set_equalities_matrix(
1516 __isl_keep isl_basic_set *bset,
1517 enum isl_dim_type c1, enum isl_dim_type c2,
1518 enum isl_dim_type c3, enum isl_dim_type c4);
1519 __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1520 __isl_keep isl_basic_set *bset,
1521 enum isl_dim_type c1, enum isl_dim_type c2,
1522 enum isl_dim_type c3, enum isl_dim_type c4);
1523 __isl_give isl_mat *isl_basic_map_equalities_matrix(
1524 __isl_keep isl_basic_map *bmap,
1525 enum isl_dim_type c1,
1526 enum isl_dim_type c2, enum isl_dim_type c3,
1527 enum isl_dim_type c4, enum isl_dim_type c5);
1528 __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1529 __isl_keep isl_basic_map *bmap,
1530 enum isl_dim_type c1,
1531 enum isl_dim_type c2, enum isl_dim_type c3,
1532 enum isl_dim_type c4, enum isl_dim_type c5);
1534 The C<isl_dim_type> arguments dictate the order in which
1535 different kinds of variables appear in the resulting matrix
1536 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1537 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1539 The number of parameters, input, output or set dimensions can
1540 be obtained using the following functions.
1542 unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1543 enum isl_dim_type type);
1544 unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1545 enum isl_dim_type type);
1546 unsigned isl_set_dim(__isl_keep isl_set *set,
1547 enum isl_dim_type type);
1548 unsigned isl_map_dim(__isl_keep isl_map *map,
1549 enum isl_dim_type type);
1551 To check whether the description of a set or relation depends
1552 on one or more given dimensions, it is not necessary to iterate over all
1553 constraints. Instead the following functions can be used.
1555 int isl_basic_set_involves_dims(
1556 __isl_keep isl_basic_set *bset,
1557 enum isl_dim_type type, unsigned first, unsigned n);
1558 int isl_set_involves_dims(__isl_keep isl_set *set,
1559 enum isl_dim_type type, unsigned first, unsigned n);
1560 int isl_basic_map_involves_dims(
1561 __isl_keep isl_basic_map *bmap,
1562 enum isl_dim_type type, unsigned first, unsigned n);
1563 int isl_map_involves_dims(__isl_keep isl_map *map,
1564 enum isl_dim_type type, unsigned first, unsigned n);
1566 Similarly, the following functions can be used to check whether
1567 a given dimension is involved in any lower or upper bound.
1569 int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1570 enum isl_dim_type type, unsigned pos);
1571 int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1572 enum isl_dim_type type, unsigned pos);
1574 The identifiers or names of the domain and range spaces of a set
1575 or relation can be read off or set using the following functions.
1577 __isl_give isl_set *isl_set_set_tuple_id(
1578 __isl_take isl_set *set, __isl_take isl_id *id);
1579 __isl_give isl_set *isl_set_reset_tuple_id(
1580 __isl_take isl_set *set);
1581 int isl_set_has_tuple_id(__isl_keep isl_set *set);
1582 __isl_give isl_id *isl_set_get_tuple_id(
1583 __isl_keep isl_set *set);
1584 __isl_give isl_map *isl_map_set_tuple_id(
1585 __isl_take isl_map *map, enum isl_dim_type type,
1586 __isl_take isl_id *id);
1587 __isl_give isl_map *isl_map_reset_tuple_id(
1588 __isl_take isl_map *map, enum isl_dim_type type);
1589 int isl_map_has_tuple_id(__isl_keep isl_map *map,
1590 enum isl_dim_type type);
1591 __isl_give isl_id *isl_map_get_tuple_id(
1592 __isl_keep isl_map *map, enum isl_dim_type type);
1594 const char *isl_basic_set_get_tuple_name(
1595 __isl_keep isl_basic_set *bset);
1596 __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1597 __isl_take isl_basic_set *set, const char *s);
1598 int isl_set_has_tuple_name(__isl_keep isl_set *set);
1599 const char *isl_set_get_tuple_name(
1600 __isl_keep isl_set *set);
1601 const char *isl_basic_map_get_tuple_name(
1602 __isl_keep isl_basic_map *bmap,
1603 enum isl_dim_type type);
1604 __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1605 __isl_take isl_basic_map *bmap,
1606 enum isl_dim_type type, const char *s);
1607 const char *isl_map_get_tuple_name(
1608 __isl_keep isl_map *map,
1609 enum isl_dim_type type);
1611 As with C<isl_space_get_tuple_name>, the value returned points to
1612 an internal data structure.
1613 The identifiers, positions or names of individual dimensions can be
1614 read off using the following functions.
1616 __isl_give isl_id *isl_basic_set_get_dim_id(
1617 __isl_keep isl_basic_set *bset,
1618 enum isl_dim_type type, unsigned pos);
1619 __isl_give isl_set *isl_set_set_dim_id(
1620 __isl_take isl_set *set, enum isl_dim_type type,
1621 unsigned pos, __isl_take isl_id *id);
1622 int isl_set_has_dim_id(__isl_keep isl_set *set,
1623 enum isl_dim_type type, unsigned pos);
1624 __isl_give isl_id *isl_set_get_dim_id(
1625 __isl_keep isl_set *set, enum isl_dim_type type,
1627 int isl_basic_map_has_dim_id(
1628 __isl_keep isl_basic_map *bmap,
1629 enum isl_dim_type type, unsigned pos);
1630 __isl_give isl_map *isl_map_set_dim_id(
1631 __isl_take isl_map *map, enum isl_dim_type type,
1632 unsigned pos, __isl_take isl_id *id);
1633 int isl_map_has_dim_id(__isl_keep isl_map *map,
1634 enum isl_dim_type type, unsigned pos);
1635 __isl_give isl_id *isl_map_get_dim_id(
1636 __isl_keep isl_map *map, enum isl_dim_type type,
1639 int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1640 enum isl_dim_type type, __isl_keep isl_id *id);
1641 int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1642 enum isl_dim_type type, __isl_keep isl_id *id);
1643 int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1644 enum isl_dim_type type, const char *name);
1645 int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1646 enum isl_dim_type type, const char *name);
1648 const char *isl_constraint_get_dim_name(
1649 __isl_keep isl_constraint *constraint,
1650 enum isl_dim_type type, unsigned pos);
1651 const char *isl_basic_set_get_dim_name(
1652 __isl_keep isl_basic_set *bset,
1653 enum isl_dim_type type, unsigned pos);
1654 int isl_set_has_dim_name(__isl_keep isl_set *set,
1655 enum isl_dim_type type, unsigned pos);
1656 const char *isl_set_get_dim_name(
1657 __isl_keep isl_set *set,
1658 enum isl_dim_type type, unsigned pos);
1659 const char *isl_basic_map_get_dim_name(
1660 __isl_keep isl_basic_map *bmap,
1661 enum isl_dim_type type, unsigned pos);
1662 int isl_map_has_dim_name(__isl_keep isl_map *map,
1663 enum isl_dim_type type, unsigned pos);
1664 const char *isl_map_get_dim_name(
1665 __isl_keep isl_map *map,
1666 enum isl_dim_type type, unsigned pos);
1668 These functions are mostly useful to obtain the identifiers, positions
1669 or names of the parameters. Identifiers of individual dimensions are
1670 essentially only useful for printing. They are ignored by all other
1671 operations and may not be preserved across those operations.
1675 =head3 Unary Properties
1681 The following functions test whether the given set or relation
1682 contains any integer points. The ``plain'' variants do not perform
1683 any computations, but simply check if the given set or relation
1684 is already known to be empty.
1686 int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1687 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1688 int isl_set_plain_is_empty(__isl_keep isl_set *set);
1689 int isl_set_is_empty(__isl_keep isl_set *set);
1690 int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1691 int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1692 int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1693 int isl_map_plain_is_empty(__isl_keep isl_map *map);
1694 int isl_map_is_empty(__isl_keep isl_map *map);
1695 int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1697 =item * Universality
1699 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1700 int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1701 int isl_set_plain_is_universe(__isl_keep isl_set *set);
1703 =item * Single-valuedness
1705 int isl_basic_map_is_single_valued(
1706 __isl_keep isl_basic_map *bmap);
1707 int isl_map_plain_is_single_valued(
1708 __isl_keep isl_map *map);
1709 int isl_map_is_single_valued(__isl_keep isl_map *map);
1710 int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1714 int isl_map_plain_is_injective(__isl_keep isl_map *map);
1715 int isl_map_is_injective(__isl_keep isl_map *map);
1716 int isl_union_map_plain_is_injective(
1717 __isl_keep isl_union_map *umap);
1718 int isl_union_map_is_injective(
1719 __isl_keep isl_union_map *umap);
1723 int isl_map_is_bijective(__isl_keep isl_map *map);
1724 int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1728 int isl_basic_map_plain_is_fixed(
1729 __isl_keep isl_basic_map *bmap,
1730 enum isl_dim_type type, unsigned pos,
1732 int isl_set_plain_is_fixed(__isl_keep isl_set *set,
1733 enum isl_dim_type type, unsigned pos,
1735 int isl_map_plain_is_fixed(__isl_keep isl_map *map,
1736 enum isl_dim_type type, unsigned pos,
1739 Check if the relation obviously lies on a hyperplane where the given dimension
1740 has a fixed value and if so, return that value in C<*val>.
1744 To check whether a set is a parameter domain, use this function:
1746 int isl_set_is_params(__isl_keep isl_set *set);
1747 int isl_union_set_is_params(
1748 __isl_keep isl_union_set *uset);
1752 The following functions check whether the domain of the given
1753 (basic) set is a wrapped relation.
1755 int isl_basic_set_is_wrapping(
1756 __isl_keep isl_basic_set *bset);
1757 int isl_set_is_wrapping(__isl_keep isl_set *set);
1759 =item * Internal Product
1761 int isl_basic_map_can_zip(
1762 __isl_keep isl_basic_map *bmap);
1763 int isl_map_can_zip(__isl_keep isl_map *map);
1765 Check whether the product of domain and range of the given relation
1767 i.e., whether both domain and range are nested relations.
1771 int isl_basic_map_can_curry(
1772 __isl_keep isl_basic_map *bmap);
1773 int isl_map_can_curry(__isl_keep isl_map *map);
1775 Check whether the domain of the (basic) relation is a wrapped relation.
1779 =head3 Binary Properties
1785 int isl_set_plain_is_equal(__isl_keep isl_set *set1,
1786 __isl_keep isl_set *set2);
1787 int isl_set_is_equal(__isl_keep isl_set *set1,
1788 __isl_keep isl_set *set2);
1789 int isl_union_set_is_equal(
1790 __isl_keep isl_union_set *uset1,
1791 __isl_keep isl_union_set *uset2);
1792 int isl_basic_map_is_equal(
1793 __isl_keep isl_basic_map *bmap1,
1794 __isl_keep isl_basic_map *bmap2);
1795 int isl_map_is_equal(__isl_keep isl_map *map1,
1796 __isl_keep isl_map *map2);
1797 int isl_map_plain_is_equal(__isl_keep isl_map *map1,
1798 __isl_keep isl_map *map2);
1799 int isl_union_map_is_equal(
1800 __isl_keep isl_union_map *umap1,
1801 __isl_keep isl_union_map *umap2);
1803 =item * Disjointness
1805 int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
1806 __isl_keep isl_set *set2);
1810 int isl_basic_set_is_subset(
1811 __isl_keep isl_basic_set *bset1,
1812 __isl_keep isl_basic_set *bset2);
1813 int isl_set_is_subset(__isl_keep isl_set *set1,
1814 __isl_keep isl_set *set2);
1815 int isl_set_is_strict_subset(
1816 __isl_keep isl_set *set1,
1817 __isl_keep isl_set *set2);
1818 int isl_union_set_is_subset(
1819 __isl_keep isl_union_set *uset1,
1820 __isl_keep isl_union_set *uset2);
1821 int isl_union_set_is_strict_subset(
1822 __isl_keep isl_union_set *uset1,
1823 __isl_keep isl_union_set *uset2);
1824 int isl_basic_map_is_subset(
1825 __isl_keep isl_basic_map *bmap1,
1826 __isl_keep isl_basic_map *bmap2);
1827 int isl_basic_map_is_strict_subset(
1828 __isl_keep isl_basic_map *bmap1,
1829 __isl_keep isl_basic_map *bmap2);
1830 int isl_map_is_subset(
1831 __isl_keep isl_map *map1,
1832 __isl_keep isl_map *map2);
1833 int isl_map_is_strict_subset(
1834 __isl_keep isl_map *map1,
1835 __isl_keep isl_map *map2);
1836 int isl_union_map_is_subset(
1837 __isl_keep isl_union_map *umap1,
1838 __isl_keep isl_union_map *umap2);
1839 int isl_union_map_is_strict_subset(
1840 __isl_keep isl_union_map *umap1,
1841 __isl_keep isl_union_map *umap2);
1843 Check whether the first argument is a (strict) subset of the
1848 =head2 Unary Operations
1854 __isl_give isl_set *isl_set_complement(
1855 __isl_take isl_set *set);
1856 __isl_give isl_map *isl_map_complement(
1857 __isl_take isl_map *map);
1861 __isl_give isl_basic_map *isl_basic_map_reverse(
1862 __isl_take isl_basic_map *bmap);
1863 __isl_give isl_map *isl_map_reverse(
1864 __isl_take isl_map *map);
1865 __isl_give isl_union_map *isl_union_map_reverse(
1866 __isl_take isl_union_map *umap);
1870 __isl_give isl_basic_set *isl_basic_set_project_out(
1871 __isl_take isl_basic_set *bset,
1872 enum isl_dim_type type, unsigned first, unsigned n);
1873 __isl_give isl_basic_map *isl_basic_map_project_out(
1874 __isl_take isl_basic_map *bmap,
1875 enum isl_dim_type type, unsigned first, unsigned n);
1876 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
1877 enum isl_dim_type type, unsigned first, unsigned n);
1878 __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
1879 enum isl_dim_type type, unsigned first, unsigned n);
1880 __isl_give isl_basic_set *isl_basic_set_params(
1881 __isl_take isl_basic_set *bset);
1882 __isl_give isl_basic_set *isl_basic_map_domain(
1883 __isl_take isl_basic_map *bmap);
1884 __isl_give isl_basic_set *isl_basic_map_range(
1885 __isl_take isl_basic_map *bmap);
1886 __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
1887 __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
1888 __isl_give isl_set *isl_map_domain(
1889 __isl_take isl_map *bmap);
1890 __isl_give isl_set *isl_map_range(
1891 __isl_take isl_map *map);
1892 __isl_give isl_set *isl_union_set_params(
1893 __isl_take isl_union_set *uset);
1894 __isl_give isl_set *isl_union_map_params(
1895 __isl_take isl_union_map *umap);
1896 __isl_give isl_union_set *isl_union_map_domain(
1897 __isl_take isl_union_map *umap);
1898 __isl_give isl_union_set *isl_union_map_range(
1899 __isl_take isl_union_map *umap);
1901 __isl_give isl_basic_map *isl_basic_map_domain_map(
1902 __isl_take isl_basic_map *bmap);
1903 __isl_give isl_basic_map *isl_basic_map_range_map(
1904 __isl_take isl_basic_map *bmap);
1905 __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
1906 __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
1907 __isl_give isl_union_map *isl_union_map_domain_map(
1908 __isl_take isl_union_map *umap);
1909 __isl_give isl_union_map *isl_union_map_range_map(
1910 __isl_take isl_union_map *umap);
1912 The functions above construct a (basic, regular or union) relation
1913 that maps (a wrapped version of) the input relation to its domain or range.
1917 __isl_give isl_set *isl_set_eliminate(
1918 __isl_take isl_set *set, enum isl_dim_type type,
1919 unsigned first, unsigned n);
1920 __isl_give isl_basic_map *isl_basic_map_eliminate(
1921 __isl_take isl_basic_map *bmap,
1922 enum isl_dim_type type,
1923 unsigned first, unsigned n);
1924 __isl_give isl_map *isl_map_eliminate(
1925 __isl_take isl_map *map, enum isl_dim_type type,
1926 unsigned first, unsigned n);
1928 Eliminate the coefficients for the given dimensions from the constraints,
1929 without removing the dimensions.
1933 __isl_give isl_basic_set *isl_basic_set_fix(
1934 __isl_take isl_basic_set *bset,
1935 enum isl_dim_type type, unsigned pos,
1937 __isl_give isl_basic_set *isl_basic_set_fix_si(
1938 __isl_take isl_basic_set *bset,
1939 enum isl_dim_type type, unsigned pos, int value);
1940 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
1941 enum isl_dim_type type, unsigned pos,
1943 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
1944 enum isl_dim_type type, unsigned pos, int value);
1945 __isl_give isl_basic_map *isl_basic_map_fix_si(
1946 __isl_take isl_basic_map *bmap,
1947 enum isl_dim_type type, unsigned pos, int value);
1948 __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
1949 enum isl_dim_type type, unsigned pos, int value);
1951 Intersect the set or relation with the hyperplane where the given
1952 dimension has the fixed given value.
1954 __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
1955 __isl_take isl_basic_map *bmap,
1956 enum isl_dim_type type, unsigned pos, int value);
1957 __isl_give isl_set *isl_set_lower_bound(
1958 __isl_take isl_set *set,
1959 enum isl_dim_type type, unsigned pos,
1961 __isl_give isl_set *isl_set_lower_bound_si(
1962 __isl_take isl_set *set,
1963 enum isl_dim_type type, unsigned pos, int value);
1964 __isl_give isl_map *isl_map_lower_bound_si(
1965 __isl_take isl_map *map,
1966 enum isl_dim_type type, unsigned pos, int value);
1967 __isl_give isl_set *isl_set_upper_bound(
1968 __isl_take isl_set *set,
1969 enum isl_dim_type type, unsigned pos,
1971 __isl_give isl_set *isl_set_upper_bound_si(
1972 __isl_take isl_set *set,
1973 enum isl_dim_type type, unsigned pos, int value);
1974 __isl_give isl_map *isl_map_upper_bound_si(
1975 __isl_take isl_map *map,
1976 enum isl_dim_type type, unsigned pos, int value);
1978 Intersect the set or relation with the half-space where the given
1979 dimension has a value bounded by the fixed given value.
1981 __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
1982 enum isl_dim_type type1, int pos1,
1983 enum isl_dim_type type2, int pos2);
1984 __isl_give isl_basic_map *isl_basic_map_equate(
1985 __isl_take isl_basic_map *bmap,
1986 enum isl_dim_type type1, int pos1,
1987 enum isl_dim_type type2, int pos2);
1988 __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
1989 enum isl_dim_type type1, int pos1,
1990 enum isl_dim_type type2, int pos2);
1992 Intersect the set or relation with the hyperplane where the given
1993 dimensions are equal to each other.
1995 __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
1996 enum isl_dim_type type1, int pos1,
1997 enum isl_dim_type type2, int pos2);
1999 Intersect the relation with the hyperplane where the given
2000 dimensions have opposite values.
2002 __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2003 enum isl_dim_type type1, int pos1,
2004 enum isl_dim_type type2, int pos2);
2005 __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2006 enum isl_dim_type type1, int pos1,
2007 enum isl_dim_type type2, int pos2);
2009 Intersect the relation with the half-space where the given
2010 dimensions satisfy the given ordering.
2014 __isl_give isl_map *isl_set_identity(
2015 __isl_take isl_set *set);
2016 __isl_give isl_union_map *isl_union_set_identity(
2017 __isl_take isl_union_set *uset);
2019 Construct an identity relation on the given (union) set.
2023 __isl_give isl_basic_set *isl_basic_map_deltas(
2024 __isl_take isl_basic_map *bmap);
2025 __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2026 __isl_give isl_union_set *isl_union_map_deltas(
2027 __isl_take isl_union_map *umap);
2029 These functions return a (basic) set containing the differences
2030 between image elements and corresponding domain elements in the input.
2032 __isl_give isl_basic_map *isl_basic_map_deltas_map(
2033 __isl_take isl_basic_map *bmap);
2034 __isl_give isl_map *isl_map_deltas_map(
2035 __isl_take isl_map *map);
2036 __isl_give isl_union_map *isl_union_map_deltas_map(
2037 __isl_take isl_union_map *umap);
2039 The functions above construct a (basic, regular or union) relation
2040 that maps (a wrapped version of) the input relation to its delta set.
2044 Simplify the representation of a set or relation by trying
2045 to combine pairs of basic sets or relations into a single
2046 basic set or relation.
2048 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2049 __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2050 __isl_give isl_union_set *isl_union_set_coalesce(
2051 __isl_take isl_union_set *uset);
2052 __isl_give isl_union_map *isl_union_map_coalesce(
2053 __isl_take isl_union_map *umap);
2055 One of the methods for combining pairs of basic sets or relations
2056 can result in coefficients that are much larger than those that appear
2057 in the constraints of the input. By default, the coefficients are
2058 not allowed to grow larger, but this can be changed by unsetting
2059 the following option.
2061 int isl_options_set_coalesce_bounded_wrapping(
2062 isl_ctx *ctx, int val);
2063 int isl_options_get_coalesce_bounded_wrapping(
2066 =item * Detecting equalities
2068 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2069 __isl_take isl_basic_set *bset);
2070 __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2071 __isl_take isl_basic_map *bmap);
2072 __isl_give isl_set *isl_set_detect_equalities(
2073 __isl_take isl_set *set);
2074 __isl_give isl_map *isl_map_detect_equalities(
2075 __isl_take isl_map *map);
2076 __isl_give isl_union_set *isl_union_set_detect_equalities(
2077 __isl_take isl_union_set *uset);
2078 __isl_give isl_union_map *isl_union_map_detect_equalities(
2079 __isl_take isl_union_map *umap);
2081 Simplify the representation of a set or relation by detecting implicit
2084 =item * Removing redundant constraints
2086 __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2087 __isl_take isl_basic_set *bset);
2088 __isl_give isl_set *isl_set_remove_redundancies(
2089 __isl_take isl_set *set);
2090 __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2091 __isl_take isl_basic_map *bmap);
2092 __isl_give isl_map *isl_map_remove_redundancies(
2093 __isl_take isl_map *map);
2097 __isl_give isl_basic_set *isl_set_convex_hull(
2098 __isl_take isl_set *set);
2099 __isl_give isl_basic_map *isl_map_convex_hull(
2100 __isl_take isl_map *map);
2102 If the input set or relation has any existentially quantified
2103 variables, then the result of these operations is currently undefined.
2107 __isl_give isl_basic_set *isl_set_simple_hull(
2108 __isl_take isl_set *set);
2109 __isl_give isl_basic_map *isl_map_simple_hull(
2110 __isl_take isl_map *map);
2111 __isl_give isl_union_map *isl_union_map_simple_hull(
2112 __isl_take isl_union_map *umap);
2114 These functions compute a single basic set or relation
2115 that contains the whole input set or relation.
2116 In particular, the output is described by translates
2117 of the constraints describing the basic sets or relations in the input.
2121 (See \autoref{s:simple hull}.)
2127 __isl_give isl_basic_set *isl_basic_set_affine_hull(
2128 __isl_take isl_basic_set *bset);
2129 __isl_give isl_basic_set *isl_set_affine_hull(
2130 __isl_take isl_set *set);
2131 __isl_give isl_union_set *isl_union_set_affine_hull(
2132 __isl_take isl_union_set *uset);
2133 __isl_give isl_basic_map *isl_basic_map_affine_hull(
2134 __isl_take isl_basic_map *bmap);
2135 __isl_give isl_basic_map *isl_map_affine_hull(
2136 __isl_take isl_map *map);
2137 __isl_give isl_union_map *isl_union_map_affine_hull(
2138 __isl_take isl_union_map *umap);
2140 In case of union sets and relations, the affine hull is computed
2143 =item * Polyhedral hull
2145 __isl_give isl_basic_set *isl_set_polyhedral_hull(
2146 __isl_take isl_set *set);
2147 __isl_give isl_basic_map *isl_map_polyhedral_hull(
2148 __isl_take isl_map *map);
2149 __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2150 __isl_take isl_union_set *uset);
2151 __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2152 __isl_take isl_union_map *umap);
2154 These functions compute a single basic set or relation
2155 not involving any existentially quantified variables
2156 that contains the whole input set or relation.
2157 In case of union sets and relations, the polyhedral hull is computed
2162 __isl_give isl_basic_set *isl_basic_set_sample(
2163 __isl_take isl_basic_set *bset);
2164 __isl_give isl_basic_set *isl_set_sample(
2165 __isl_take isl_set *set);
2166 __isl_give isl_basic_map *isl_basic_map_sample(
2167 __isl_take isl_basic_map *bmap);
2168 __isl_give isl_basic_map *isl_map_sample(
2169 __isl_take isl_map *map);
2171 If the input (basic) set or relation is non-empty, then return
2172 a singleton subset of the input. Otherwise, return an empty set.
2174 =item * Optimization
2176 #include <isl/ilp.h>
2177 enum isl_lp_result isl_basic_set_max(
2178 __isl_keep isl_basic_set *bset,
2179 __isl_keep isl_aff *obj, isl_int *opt)
2180 enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2181 __isl_keep isl_aff *obj, isl_int *opt);
2182 enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2183 __isl_keep isl_aff *obj, isl_int *opt);
2185 Compute the minimum or maximum of the integer affine expression C<obj>
2186 over the points in C<set>, returning the result in C<opt>.
2187 The return value may be one of C<isl_lp_error>,
2188 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2190 =item * Parametric optimization
2192 __isl_give isl_pw_aff *isl_set_dim_min(
2193 __isl_take isl_set *set, int pos);
2194 __isl_give isl_pw_aff *isl_set_dim_max(
2195 __isl_take isl_set *set, int pos);
2196 __isl_give isl_pw_aff *isl_map_dim_max(
2197 __isl_take isl_map *map, int pos);
2199 Compute the minimum or maximum of the given set or output dimension
2200 as a function of the parameters (and input dimensions), but independently
2201 of the other set or output dimensions.
2202 For lexicographic optimization, see L<"Lexicographic Optimization">.
2206 The following functions compute either the set of (rational) coefficient
2207 values of valid constraints for the given set or the set of (rational)
2208 values satisfying the constraints with coefficients from the given set.
2209 Internally, these two sets of functions perform essentially the
2210 same operations, except that the set of coefficients is assumed to
2211 be a cone, while the set of values may be any polyhedron.
2212 The current implementation is based on the Farkas lemma and
2213 Fourier-Motzkin elimination, but this may change or be made optional
2214 in future. In particular, future implementations may use different
2215 dualization algorithms or skip the elimination step.
2217 __isl_give isl_basic_set *isl_basic_set_coefficients(
2218 __isl_take isl_basic_set *bset);
2219 __isl_give isl_basic_set *isl_set_coefficients(
2220 __isl_take isl_set *set);
2221 __isl_give isl_union_set *isl_union_set_coefficients(
2222 __isl_take isl_union_set *bset);
2223 __isl_give isl_basic_set *isl_basic_set_solutions(
2224 __isl_take isl_basic_set *bset);
2225 __isl_give isl_basic_set *isl_set_solutions(
2226 __isl_take isl_set *set);
2227 __isl_give isl_union_set *isl_union_set_solutions(
2228 __isl_take isl_union_set *bset);
2232 __isl_give isl_map *isl_map_fixed_power(
2233 __isl_take isl_map *map, isl_int exp);
2234 __isl_give isl_union_map *isl_union_map_fixed_power(
2235 __isl_take isl_union_map *umap, isl_int exp);
2237 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2238 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2239 of C<map> is computed.
2241 __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2243 __isl_give isl_union_map *isl_union_map_power(
2244 __isl_take isl_union_map *umap, int *exact);
2246 Compute a parametric representation for all positive powers I<k> of C<map>.
2247 The result maps I<k> to a nested relation corresponding to the
2248 I<k>th power of C<map>.
2249 The result may be an overapproximation. If the result is known to be exact,
2250 then C<*exact> is set to C<1>.
2252 =item * Transitive closure
2254 __isl_give isl_map *isl_map_transitive_closure(
2255 __isl_take isl_map *map, int *exact);
2256 __isl_give isl_union_map *isl_union_map_transitive_closure(
2257 __isl_take isl_union_map *umap, int *exact);
2259 Compute the transitive closure of C<map>.
2260 The result may be an overapproximation. If the result is known to be exact,
2261 then C<*exact> is set to C<1>.
2263 =item * Reaching path lengths
2265 __isl_give isl_map *isl_map_reaching_path_lengths(
2266 __isl_take isl_map *map, int *exact);
2268 Compute a relation that maps each element in the range of C<map>
2269 to the lengths of all paths composed of edges in C<map> that
2270 end up in the given element.
2271 The result may be an overapproximation. If the result is known to be exact,
2272 then C<*exact> is set to C<1>.
2273 To compute the I<maximal> path length, the resulting relation
2274 should be postprocessed by C<isl_map_lexmax>.
2275 In particular, if the input relation is a dependence relation
2276 (mapping sources to sinks), then the maximal path length corresponds
2277 to the free schedule.
2278 Note, however, that C<isl_map_lexmax> expects the maximum to be
2279 finite, so if the path lengths are unbounded (possibly due to
2280 the overapproximation), then you will get an error message.
2284 __isl_give isl_basic_set *isl_basic_map_wrap(
2285 __isl_take isl_basic_map *bmap);
2286 __isl_give isl_set *isl_map_wrap(
2287 __isl_take isl_map *map);
2288 __isl_give isl_union_set *isl_union_map_wrap(
2289 __isl_take isl_union_map *umap);
2290 __isl_give isl_basic_map *isl_basic_set_unwrap(
2291 __isl_take isl_basic_set *bset);
2292 __isl_give isl_map *isl_set_unwrap(
2293 __isl_take isl_set *set);
2294 __isl_give isl_union_map *isl_union_set_unwrap(
2295 __isl_take isl_union_set *uset);
2299 Remove any internal structure of domain (and range) of the given
2300 set or relation. If there is any such internal structure in the input,
2301 then the name of the space is also removed.
2303 __isl_give isl_basic_set *isl_basic_set_flatten(
2304 __isl_take isl_basic_set *bset);
2305 __isl_give isl_set *isl_set_flatten(
2306 __isl_take isl_set *set);
2307 __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2308 __isl_take isl_basic_map *bmap);
2309 __isl_give isl_basic_map *isl_basic_map_flatten_range(
2310 __isl_take isl_basic_map *bmap);
2311 __isl_give isl_map *isl_map_flatten_range(
2312 __isl_take isl_map *map);
2313 __isl_give isl_map *isl_map_flatten_domain(
2314 __isl_take isl_map *map);
2315 __isl_give isl_basic_map *isl_basic_map_flatten(
2316 __isl_take isl_basic_map *bmap);
2317 __isl_give isl_map *isl_map_flatten(
2318 __isl_take isl_map *map);
2320 __isl_give isl_map *isl_set_flatten_map(
2321 __isl_take isl_set *set);
2323 The function above constructs a relation
2324 that maps the input set to a flattened version of the set.
2328 Lift the input set to a space with extra dimensions corresponding
2329 to the existentially quantified variables in the input.
2330 In particular, the result lives in a wrapped map where the domain
2331 is the original space and the range corresponds to the original
2332 existentially quantified variables.
2334 __isl_give isl_basic_set *isl_basic_set_lift(
2335 __isl_take isl_basic_set *bset);
2336 __isl_give isl_set *isl_set_lift(
2337 __isl_take isl_set *set);
2338 __isl_give isl_union_set *isl_union_set_lift(
2339 __isl_take isl_union_set *uset);
2341 Given a local space that contains the existentially quantified
2342 variables of a set, a basic relation that, when applied to
2343 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2344 can be constructed using the following function.
2346 #include <isl/local_space.h>
2347 __isl_give isl_basic_map *isl_local_space_lifting(
2348 __isl_take isl_local_space *ls);
2350 =item * Internal Product
2352 __isl_give isl_basic_map *isl_basic_map_zip(
2353 __isl_take isl_basic_map *bmap);
2354 __isl_give isl_map *isl_map_zip(
2355 __isl_take isl_map *map);
2356 __isl_give isl_union_map *isl_union_map_zip(
2357 __isl_take isl_union_map *umap);
2359 Given a relation with nested relations for domain and range,
2360 interchange the range of the domain with the domain of the range.
2364 __isl_give isl_basic_map *isl_basic_map_curry(
2365 __isl_take isl_basic_map *bmap);
2366 __isl_give isl_map *isl_map_curry(
2367 __isl_take isl_map *map);
2368 __isl_give isl_union_map *isl_union_map_curry(
2369 __isl_take isl_union_map *umap);
2371 Given a relation with a nested relation for domain,
2372 move the range of the nested relation out of the domain
2373 and use it as the domain of a nested relation in the range,
2374 with the original range as range of this nested relation.
2376 =item * Aligning parameters
2378 __isl_give isl_set *isl_set_align_params(
2379 __isl_take isl_set *set,
2380 __isl_take isl_space *model);
2381 __isl_give isl_map *isl_map_align_params(
2382 __isl_take isl_map *map,
2383 __isl_take isl_space *model);
2385 Change the order of the parameters of the given set or relation
2386 such that the first parameters match those of C<model>.
2387 This may involve the introduction of extra parameters.
2388 All parameters need to be named.
2390 =item * Dimension manipulation
2392 __isl_give isl_set *isl_set_add_dims(
2393 __isl_take isl_set *set,
2394 enum isl_dim_type type, unsigned n);
2395 __isl_give isl_map *isl_map_add_dims(
2396 __isl_take isl_map *map,
2397 enum isl_dim_type type, unsigned n);
2398 __isl_give isl_set *isl_set_insert_dims(
2399 __isl_take isl_set *set,
2400 enum isl_dim_type type, unsigned pos, unsigned n);
2401 __isl_give isl_map *isl_map_insert_dims(
2402 __isl_take isl_map *map,
2403 enum isl_dim_type type, unsigned pos, unsigned n);
2404 __isl_give isl_basic_set *isl_basic_set_move_dims(
2405 __isl_take isl_basic_set *bset,
2406 enum isl_dim_type dst_type, unsigned dst_pos,
2407 enum isl_dim_type src_type, unsigned src_pos,
2409 __isl_give isl_basic_map *isl_basic_map_move_dims(
2410 __isl_take isl_basic_map *bmap,
2411 enum isl_dim_type dst_type, unsigned dst_pos,
2412 enum isl_dim_type src_type, unsigned src_pos,
2414 __isl_give isl_set *isl_set_move_dims(
2415 __isl_take isl_set *set,
2416 enum isl_dim_type dst_type, unsigned dst_pos,
2417 enum isl_dim_type src_type, unsigned src_pos,
2419 __isl_give isl_map *isl_map_move_dims(
2420 __isl_take isl_map *map,
2421 enum isl_dim_type dst_type, unsigned dst_pos,
2422 enum isl_dim_type src_type, unsigned src_pos,
2425 It is usually not advisable to directly change the (input or output)
2426 space of a set or a relation as this removes the name and the internal
2427 structure of the space. However, the above functions can be useful
2428 to add new parameters, assuming
2429 C<isl_set_align_params> and C<isl_map_align_params>
2434 =head2 Binary Operations
2436 The two arguments of a binary operation not only need to live
2437 in the same C<isl_ctx>, they currently also need to have
2438 the same (number of) parameters.
2440 =head3 Basic Operations
2444 =item * Intersection
2446 __isl_give isl_basic_set *isl_basic_set_intersect_params(
2447 __isl_take isl_basic_set *bset1,
2448 __isl_take isl_basic_set *bset2);
2449 __isl_give isl_basic_set *isl_basic_set_intersect(
2450 __isl_take isl_basic_set *bset1,
2451 __isl_take isl_basic_set *bset2);
2452 __isl_give isl_set *isl_set_intersect_params(
2453 __isl_take isl_set *set,
2454 __isl_take isl_set *params);
2455 __isl_give isl_set *isl_set_intersect(
2456 __isl_take isl_set *set1,
2457 __isl_take isl_set *set2);
2458 __isl_give isl_union_set *isl_union_set_intersect_params(
2459 __isl_take isl_union_set *uset,
2460 __isl_take isl_set *set);
2461 __isl_give isl_union_map *isl_union_map_intersect_params(
2462 __isl_take isl_union_map *umap,
2463 __isl_take isl_set *set);
2464 __isl_give isl_union_set *isl_union_set_intersect(
2465 __isl_take isl_union_set *uset1,
2466 __isl_take isl_union_set *uset2);
2467 __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2468 __isl_take isl_basic_map *bmap,
2469 __isl_take isl_basic_set *bset);
2470 __isl_give isl_basic_map *isl_basic_map_intersect_range(
2471 __isl_take isl_basic_map *bmap,
2472 __isl_take isl_basic_set *bset);
2473 __isl_give isl_basic_map *isl_basic_map_intersect(
2474 __isl_take isl_basic_map *bmap1,
2475 __isl_take isl_basic_map *bmap2);
2476 __isl_give isl_map *isl_map_intersect_params(
2477 __isl_take isl_map *map,
2478 __isl_take isl_set *params);
2479 __isl_give isl_map *isl_map_intersect_domain(
2480 __isl_take isl_map *map,
2481 __isl_take isl_set *set);
2482 __isl_give isl_map *isl_map_intersect_range(
2483 __isl_take isl_map *map,
2484 __isl_take isl_set *set);
2485 __isl_give isl_map *isl_map_intersect(
2486 __isl_take isl_map *map1,
2487 __isl_take isl_map *map2);
2488 __isl_give isl_union_map *isl_union_map_intersect_domain(
2489 __isl_take isl_union_map *umap,
2490 __isl_take isl_union_set *uset);
2491 __isl_give isl_union_map *isl_union_map_intersect_range(
2492 __isl_take isl_union_map *umap,
2493 __isl_take isl_union_set *uset);
2494 __isl_give isl_union_map *isl_union_map_intersect(
2495 __isl_take isl_union_map *umap1,
2496 __isl_take isl_union_map *umap2);
2498 The second argument to the C<_params> functions needs to be
2499 a parametric (basic) set. For the other functions, a parametric set
2500 for either argument is only allowed if the other argument is
2501 a parametric set as well.
2505 __isl_give isl_set *isl_basic_set_union(
2506 __isl_take isl_basic_set *bset1,
2507 __isl_take isl_basic_set *bset2);
2508 __isl_give isl_map *isl_basic_map_union(
2509 __isl_take isl_basic_map *bmap1,
2510 __isl_take isl_basic_map *bmap2);
2511 __isl_give isl_set *isl_set_union(
2512 __isl_take isl_set *set1,
2513 __isl_take isl_set *set2);
2514 __isl_give isl_map *isl_map_union(
2515 __isl_take isl_map *map1,
2516 __isl_take isl_map *map2);
2517 __isl_give isl_union_set *isl_union_set_union(
2518 __isl_take isl_union_set *uset1,
2519 __isl_take isl_union_set *uset2);
2520 __isl_give isl_union_map *isl_union_map_union(
2521 __isl_take isl_union_map *umap1,
2522 __isl_take isl_union_map *umap2);
2524 =item * Set difference
2526 __isl_give isl_set *isl_set_subtract(
2527 __isl_take isl_set *set1,
2528 __isl_take isl_set *set2);
2529 __isl_give isl_map *isl_map_subtract(
2530 __isl_take isl_map *map1,
2531 __isl_take isl_map *map2);
2532 __isl_give isl_map *isl_map_subtract_domain(
2533 __isl_take isl_map *map,
2534 __isl_take isl_set *dom);
2535 __isl_give isl_map *isl_map_subtract_range(
2536 __isl_take isl_map *map,
2537 __isl_take isl_set *dom);
2538 __isl_give isl_union_set *isl_union_set_subtract(
2539 __isl_take isl_union_set *uset1,
2540 __isl_take isl_union_set *uset2);
2541 __isl_give isl_union_map *isl_union_map_subtract(
2542 __isl_take isl_union_map *umap1,
2543 __isl_take isl_union_map *umap2);
2547 __isl_give isl_basic_set *isl_basic_set_apply(
2548 __isl_take isl_basic_set *bset,
2549 __isl_take isl_basic_map *bmap);
2550 __isl_give isl_set *isl_set_apply(
2551 __isl_take isl_set *set,
2552 __isl_take isl_map *map);
2553 __isl_give isl_union_set *isl_union_set_apply(
2554 __isl_take isl_union_set *uset,
2555 __isl_take isl_union_map *umap);
2556 __isl_give isl_basic_map *isl_basic_map_apply_domain(
2557 __isl_take isl_basic_map *bmap1,
2558 __isl_take isl_basic_map *bmap2);
2559 __isl_give isl_basic_map *isl_basic_map_apply_range(
2560 __isl_take isl_basic_map *bmap1,
2561 __isl_take isl_basic_map *bmap2);
2562 __isl_give isl_map *isl_map_apply_domain(
2563 __isl_take isl_map *map1,
2564 __isl_take isl_map *map2);
2565 __isl_give isl_union_map *isl_union_map_apply_domain(
2566 __isl_take isl_union_map *umap1,
2567 __isl_take isl_union_map *umap2);
2568 __isl_give isl_map *isl_map_apply_range(
2569 __isl_take isl_map *map1,
2570 __isl_take isl_map *map2);
2571 __isl_give isl_union_map *isl_union_map_apply_range(
2572 __isl_take isl_union_map *umap1,
2573 __isl_take isl_union_map *umap2);
2575 =item * Cartesian Product
2577 __isl_give isl_set *isl_set_product(
2578 __isl_take isl_set *set1,
2579 __isl_take isl_set *set2);
2580 __isl_give isl_union_set *isl_union_set_product(
2581 __isl_take isl_union_set *uset1,
2582 __isl_take isl_union_set *uset2);
2583 __isl_give isl_basic_map *isl_basic_map_domain_product(
2584 __isl_take isl_basic_map *bmap1,
2585 __isl_take isl_basic_map *bmap2);
2586 __isl_give isl_basic_map *isl_basic_map_range_product(
2587 __isl_take isl_basic_map *bmap1,
2588 __isl_take isl_basic_map *bmap2);
2589 __isl_give isl_map *isl_map_domain_product(
2590 __isl_take isl_map *map1,
2591 __isl_take isl_map *map2);
2592 __isl_give isl_map *isl_map_range_product(
2593 __isl_take isl_map *map1,
2594 __isl_take isl_map *map2);
2595 __isl_give isl_union_map *isl_union_map_range_product(
2596 __isl_take isl_union_map *umap1,
2597 __isl_take isl_union_map *umap2);
2598 __isl_give isl_map *isl_map_product(
2599 __isl_take isl_map *map1,
2600 __isl_take isl_map *map2);
2601 __isl_give isl_union_map *isl_union_map_product(
2602 __isl_take isl_union_map *umap1,
2603 __isl_take isl_union_map *umap2);
2605 The above functions compute the cross product of the given
2606 sets or relations. The domains and ranges of the results
2607 are wrapped maps between domains and ranges of the inputs.
2608 To obtain a ``flat'' product, use the following functions
2611 __isl_give isl_basic_set *isl_basic_set_flat_product(
2612 __isl_take isl_basic_set *bset1,
2613 __isl_take isl_basic_set *bset2);
2614 __isl_give isl_set *isl_set_flat_product(
2615 __isl_take isl_set *set1,
2616 __isl_take isl_set *set2);
2617 __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2618 __isl_take isl_basic_map *bmap1,
2619 __isl_take isl_basic_map *bmap2);
2620 __isl_give isl_map *isl_map_flat_domain_product(
2621 __isl_take isl_map *map1,
2622 __isl_take isl_map *map2);
2623 __isl_give isl_map *isl_map_flat_range_product(
2624 __isl_take isl_map *map1,
2625 __isl_take isl_map *map2);
2626 __isl_give isl_union_map *isl_union_map_flat_range_product(
2627 __isl_take isl_union_map *umap1,
2628 __isl_take isl_union_map *umap2);
2629 __isl_give isl_basic_map *isl_basic_map_flat_product(
2630 __isl_take isl_basic_map *bmap1,
2631 __isl_take isl_basic_map *bmap2);
2632 __isl_give isl_map *isl_map_flat_product(
2633 __isl_take isl_map *map1,
2634 __isl_take isl_map *map2);
2636 =item * Simplification
2638 __isl_give isl_basic_set *isl_basic_set_gist(
2639 __isl_take isl_basic_set *bset,
2640 __isl_take isl_basic_set *context);
2641 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2642 __isl_take isl_set *context);
2643 __isl_give isl_set *isl_set_gist_params(
2644 __isl_take isl_set *set,
2645 __isl_take isl_set *context);
2646 __isl_give isl_union_set *isl_union_set_gist(
2647 __isl_take isl_union_set *uset,
2648 __isl_take isl_union_set *context);
2649 __isl_give isl_union_set *isl_union_set_gist_params(
2650 __isl_take isl_union_set *uset,
2651 __isl_take isl_set *set);
2652 __isl_give isl_basic_map *isl_basic_map_gist(
2653 __isl_take isl_basic_map *bmap,
2654 __isl_take isl_basic_map *context);
2655 __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2656 __isl_take isl_map *context);
2657 __isl_give isl_map *isl_map_gist_params(
2658 __isl_take isl_map *map,
2659 __isl_take isl_set *context);
2660 __isl_give isl_map *isl_map_gist_domain(
2661 __isl_take isl_map *map,
2662 __isl_take isl_set *context);
2663 __isl_give isl_map *isl_map_gist_range(
2664 __isl_take isl_map *map,
2665 __isl_take isl_set *context);
2666 __isl_give isl_union_map *isl_union_map_gist(
2667 __isl_take isl_union_map *umap,
2668 __isl_take isl_union_map *context);
2669 __isl_give isl_union_map *isl_union_map_gist_params(
2670 __isl_take isl_union_map *umap,
2671 __isl_take isl_set *set);
2672 __isl_give isl_union_map *isl_union_map_gist_domain(
2673 __isl_take isl_union_map *umap,
2674 __isl_take isl_union_set *uset);
2675 __isl_give isl_union_map *isl_union_map_gist_range(
2676 __isl_take isl_union_map *umap,
2677 __isl_take isl_union_set *uset);
2679 The gist operation returns a set or relation that has the
2680 same intersection with the context as the input set or relation.
2681 Any implicit equality in the intersection is made explicit in the result,
2682 while all inequalities that are redundant with respect to the intersection
2684 In case of union sets and relations, the gist operation is performed
2689 =head3 Lexicographic Optimization
2691 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2692 the following functions
2693 compute a set that contains the lexicographic minimum or maximum
2694 of the elements in C<set> (or C<bset>) for those values of the parameters
2695 that satisfy C<dom>.
2696 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2697 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2699 In other words, the union of the parameter values
2700 for which the result is non-empty and of C<*empty>
2703 __isl_give isl_set *isl_basic_set_partial_lexmin(
2704 __isl_take isl_basic_set *bset,
2705 __isl_take isl_basic_set *dom,
2706 __isl_give isl_set **empty);
2707 __isl_give isl_set *isl_basic_set_partial_lexmax(
2708 __isl_take isl_basic_set *bset,
2709 __isl_take isl_basic_set *dom,
2710 __isl_give isl_set **empty);
2711 __isl_give isl_set *isl_set_partial_lexmin(
2712 __isl_take isl_set *set, __isl_take isl_set *dom,
2713 __isl_give isl_set **empty);
2714 __isl_give isl_set *isl_set_partial_lexmax(
2715 __isl_take isl_set *set, __isl_take isl_set *dom,
2716 __isl_give isl_set **empty);
2718 Given a (basic) set C<set> (or C<bset>), the following functions simply
2719 return a set containing the lexicographic minimum or maximum
2720 of the elements in C<set> (or C<bset>).
2721 In case of union sets, the optimum is computed per space.
2723 __isl_give isl_set *isl_basic_set_lexmin(
2724 __isl_take isl_basic_set *bset);
2725 __isl_give isl_set *isl_basic_set_lexmax(
2726 __isl_take isl_basic_set *bset);
2727 __isl_give isl_set *isl_set_lexmin(
2728 __isl_take isl_set *set);
2729 __isl_give isl_set *isl_set_lexmax(
2730 __isl_take isl_set *set);
2731 __isl_give isl_union_set *isl_union_set_lexmin(
2732 __isl_take isl_union_set *uset);
2733 __isl_give isl_union_set *isl_union_set_lexmax(
2734 __isl_take isl_union_set *uset);
2736 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2737 the following functions
2738 compute a relation that maps each element of C<dom>
2739 to the single lexicographic minimum or maximum
2740 of the elements that are associated to that same
2741 element in C<map> (or C<bmap>).
2742 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2743 that contains the elements in C<dom> that do not map
2744 to any elements in C<map> (or C<bmap>).
2745 In other words, the union of the domain of the result and of C<*empty>
2748 __isl_give isl_map *isl_basic_map_partial_lexmax(
2749 __isl_take isl_basic_map *bmap,
2750 __isl_take isl_basic_set *dom,
2751 __isl_give isl_set **empty);
2752 __isl_give isl_map *isl_basic_map_partial_lexmin(
2753 __isl_take isl_basic_map *bmap,
2754 __isl_take isl_basic_set *dom,
2755 __isl_give isl_set **empty);
2756 __isl_give isl_map *isl_map_partial_lexmax(
2757 __isl_take isl_map *map, __isl_take isl_set *dom,
2758 __isl_give isl_set **empty);
2759 __isl_give isl_map *isl_map_partial_lexmin(
2760 __isl_take isl_map *map, __isl_take isl_set *dom,
2761 __isl_give isl_set **empty);
2763 Given a (basic) map C<map> (or C<bmap>), the following functions simply
2764 return a map mapping each element in the domain of
2765 C<map> (or C<bmap>) to the lexicographic minimum or maximum
2766 of all elements associated to that element.
2767 In case of union relations, the optimum is computed per space.
2769 __isl_give isl_map *isl_basic_map_lexmin(
2770 __isl_take isl_basic_map *bmap);
2771 __isl_give isl_map *isl_basic_map_lexmax(
2772 __isl_take isl_basic_map *bmap);
2773 __isl_give isl_map *isl_map_lexmin(
2774 __isl_take isl_map *map);
2775 __isl_give isl_map *isl_map_lexmax(
2776 __isl_take isl_map *map);
2777 __isl_give isl_union_map *isl_union_map_lexmin(
2778 __isl_take isl_union_map *umap);
2779 __isl_give isl_union_map *isl_union_map_lexmax(
2780 __isl_take isl_union_map *umap);
2782 The following functions return their result in the form of
2783 a piecewise multi-affine expression
2784 (See L<"Piecewise Multiple Quasi Affine Expressions">),
2785 but are otherwise equivalent to the corresponding functions
2786 returning a basic set or relation.
2788 __isl_give isl_pw_multi_aff *
2789 isl_basic_map_lexmin_pw_multi_aff(
2790 __isl_take isl_basic_map *bmap);
2791 __isl_give isl_pw_multi_aff *
2792 isl_basic_set_partial_lexmin_pw_multi_aff(
2793 __isl_take isl_basic_set *bset,
2794 __isl_take isl_basic_set *dom,
2795 __isl_give isl_set **empty);
2796 __isl_give isl_pw_multi_aff *
2797 isl_basic_set_partial_lexmax_pw_multi_aff(
2798 __isl_take isl_basic_set *bset,
2799 __isl_take isl_basic_set *dom,
2800 __isl_give isl_set **empty);
2801 __isl_give isl_pw_multi_aff *
2802 isl_basic_map_partial_lexmin_pw_multi_aff(
2803 __isl_take isl_basic_map *bmap,
2804 __isl_take isl_basic_set *dom,
2805 __isl_give isl_set **empty);
2806 __isl_give isl_pw_multi_aff *
2807 isl_basic_map_partial_lexmax_pw_multi_aff(
2808 __isl_take isl_basic_map *bmap,
2809 __isl_take isl_basic_set *dom,
2810 __isl_give isl_set **empty);
2814 Lists are defined over several element types, including
2815 C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_basic_set> and C<isl_set>.
2816 Here we take lists of C<isl_set>s as an example.
2817 Lists can be created, copied, modified and freed using the following functions.
2819 #include <isl/list.h>
2820 __isl_give isl_set_list *isl_set_list_from_set(
2821 __isl_take isl_set *el);
2822 __isl_give isl_set_list *isl_set_list_alloc(
2823 isl_ctx *ctx, int n);
2824 __isl_give isl_set_list *isl_set_list_copy(
2825 __isl_keep isl_set_list *list);
2826 __isl_give isl_set_list *isl_set_list_add(
2827 __isl_take isl_set_list *list,
2828 __isl_take isl_set *el);
2829 __isl_give isl_set_list *isl_set_list_set_set(
2830 __isl_take isl_set_list *list, int index,
2831 __isl_take isl_set *set);
2832 __isl_give isl_set_list *isl_set_list_concat(
2833 __isl_take isl_set_list *list1,
2834 __isl_take isl_set_list *list2);
2835 void *isl_set_list_free(__isl_take isl_set_list *list);
2837 C<isl_set_list_alloc> creates an empty list with a capacity for
2838 C<n> elements. C<isl_set_list_from_set> creates a list with a single
2841 Lists can be inspected using the following functions.
2843 #include <isl/list.h>
2844 isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
2845 int isl_set_list_n_set(__isl_keep isl_set_list *list);
2846 __isl_give isl_set *isl_set_list_get_set(
2847 __isl_keep isl_set_list *list, int index);
2848 int isl_set_list_foreach(__isl_keep isl_set_list *list,
2849 int (*fn)(__isl_take isl_set *el, void *user),
2852 Lists can be printed using
2854 #include <isl/list.h>
2855 __isl_give isl_printer *isl_printer_print_set_list(
2856 __isl_take isl_printer *p,
2857 __isl_keep isl_set_list *list);
2861 Vectors can be created, copied and freed using the following functions.
2863 #include <isl/vec.h>
2864 __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
2866 __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
2867 void isl_vec_free(__isl_take isl_vec *vec);
2869 Note that the elements of a newly created vector may have arbitrary values.
2870 The elements can be changed and inspected using the following functions.
2872 isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
2873 int isl_vec_size(__isl_keep isl_vec *vec);
2874 int isl_vec_get_element(__isl_keep isl_vec *vec,
2875 int pos, isl_int *v);
2876 __isl_give isl_vec *isl_vec_set_element(
2877 __isl_take isl_vec *vec, int pos, isl_int v);
2878 __isl_give isl_vec *isl_vec_set_element_si(
2879 __isl_take isl_vec *vec, int pos, int v);
2880 __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
2882 __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
2885 C<isl_vec_get_element> will return a negative value if anything went wrong.
2886 In that case, the value of C<*v> is undefined.
2890 Matrices can be created, copied and freed using the following functions.
2892 #include <isl/mat.h>
2893 __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
2894 unsigned n_row, unsigned n_col);
2895 __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
2896 void isl_mat_free(__isl_take isl_mat *mat);
2898 Note that the elements of a newly created matrix may have arbitrary values.
2899 The elements can be changed and inspected using the following functions.
2901 isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
2902 int isl_mat_rows(__isl_keep isl_mat *mat);
2903 int isl_mat_cols(__isl_keep isl_mat *mat);
2904 int isl_mat_get_element(__isl_keep isl_mat *mat,
2905 int row, int col, isl_int *v);
2906 __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
2907 int row, int col, isl_int v);
2908 __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
2909 int row, int col, int v);
2911 C<isl_mat_get_element> will return a negative value if anything went wrong.
2912 In that case, the value of C<*v> is undefined.
2914 The following function can be used to compute the (right) inverse
2915 of a matrix, i.e., a matrix such that the product of the original
2916 and the inverse (in that order) is a multiple of the identity matrix.
2917 The input matrix is assumed to be of full row-rank.
2919 __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
2921 The following function can be used to compute the (right) kernel
2922 (or null space) of a matrix, i.e., a matrix such that the product of
2923 the original and the kernel (in that order) is the zero matrix.
2925 __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
2927 =head2 Piecewise Quasi Affine Expressions
2929 The zero quasi affine expression on a given domain can be created using
2931 __isl_give isl_aff *isl_aff_zero_on_domain(
2932 __isl_take isl_local_space *ls);
2934 Note that the space in which the resulting object lives is a map space
2935 with the given space as domain and a one-dimensional range.
2937 An empty piecewise quasi affine expression (one with no cells)
2938 or a piecewise quasi affine expression with a single cell can
2939 be created using the following functions.
2941 #include <isl/aff.h>
2942 __isl_give isl_pw_aff *isl_pw_aff_empty(
2943 __isl_take isl_space *space);
2944 __isl_give isl_pw_aff *isl_pw_aff_alloc(
2945 __isl_take isl_set *set, __isl_take isl_aff *aff);
2946 __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2947 __isl_take isl_aff *aff);
2949 A piecewise quasi affine expression that is equal to 1 on a set
2950 and 0 outside the set can be created using the following function.
2952 #include <isl/aff.h>
2953 __isl_give isl_pw_aff *isl_set_indicator_function(
2954 __isl_take isl_set *set);
2956 Quasi affine expressions can be copied and freed using
2958 #include <isl/aff.h>
2959 __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
2960 void *isl_aff_free(__isl_take isl_aff *aff);
2962 __isl_give isl_pw_aff *isl_pw_aff_copy(
2963 __isl_keep isl_pw_aff *pwaff);
2964 void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
2966 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2967 using the following function. The constraint is required to have
2968 a non-zero coefficient for the specified dimension.
2970 #include <isl/constraint.h>
2971 __isl_give isl_aff *isl_constraint_get_bound(
2972 __isl_keep isl_constraint *constraint,
2973 enum isl_dim_type type, int pos);
2975 The entire affine expression of the constraint can also be extracted
2976 using the following function.
2978 #include <isl/constraint.h>
2979 __isl_give isl_aff *isl_constraint_get_aff(
2980 __isl_keep isl_constraint *constraint);
2982 Conversely, an equality constraint equating
2983 the affine expression to zero or an inequality constraint enforcing
2984 the affine expression to be non-negative, can be constructed using
2986 __isl_give isl_constraint *isl_equality_from_aff(
2987 __isl_take isl_aff *aff);
2988 __isl_give isl_constraint *isl_inequality_from_aff(
2989 __isl_take isl_aff *aff);
2991 The expression can be inspected using
2993 #include <isl/aff.h>
2994 isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
2995 int isl_aff_dim(__isl_keep isl_aff *aff,
2996 enum isl_dim_type type);
2997 __isl_give isl_local_space *isl_aff_get_domain_local_space(
2998 __isl_keep isl_aff *aff);
2999 __isl_give isl_local_space *isl_aff_get_local_space(
3000 __isl_keep isl_aff *aff);
3001 const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3002 enum isl_dim_type type, unsigned pos);
3003 const char *isl_pw_aff_get_dim_name(
3004 __isl_keep isl_pw_aff *pa,
3005 enum isl_dim_type type, unsigned pos);
3006 int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3007 enum isl_dim_type type, unsigned pos);
3008 __isl_give isl_id *isl_pw_aff_get_dim_id(
3009 __isl_keep isl_pw_aff *pa,
3010 enum isl_dim_type type, unsigned pos);
3011 __isl_give isl_id *isl_pw_aff_get_tuple_id(
3012 __isl_keep isl_pw_aff *pa,
3013 enum isl_dim_type type);
3014 int isl_aff_get_constant(__isl_keep isl_aff *aff,
3016 int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3017 enum isl_dim_type type, int pos, isl_int *v);
3018 int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3020 __isl_give isl_aff *isl_aff_get_div(
3021 __isl_keep isl_aff *aff, int pos);
3023 int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3024 int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3025 int (*fn)(__isl_take isl_set *set,
3026 __isl_take isl_aff *aff,
3027 void *user), void *user);
3029 int isl_aff_is_cst(__isl_keep isl_aff *aff);
3030 int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3032 int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3033 enum isl_dim_type type, unsigned first, unsigned n);
3034 int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3035 enum isl_dim_type type, unsigned first, unsigned n);
3037 isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3038 unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3039 enum isl_dim_type type);
3040 int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3042 It can be modified using
3044 #include <isl/aff.h>
3045 __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3046 __isl_take isl_pw_aff *pwaff,
3047 enum isl_dim_type type, __isl_take isl_id *id);
3048 __isl_give isl_aff *isl_aff_set_dim_name(
3049 __isl_take isl_aff *aff, enum isl_dim_type type,
3050 unsigned pos, const char *s);
3051 __isl_give isl_aff *isl_aff_set_dim_id(
3052 __isl_take isl_aff *aff, enum isl_dim_type type,
3053 unsigned pos, __isl_take isl_id *id);
3054 __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3055 __isl_take isl_pw_aff *pma,
3056 enum isl_dim_type type, unsigned pos,
3057 __isl_take isl_id *id);
3058 __isl_give isl_aff *isl_aff_set_constant(
3059 __isl_take isl_aff *aff, isl_int v);
3060 __isl_give isl_aff *isl_aff_set_constant_si(
3061 __isl_take isl_aff *aff, int v);
3062 __isl_give isl_aff *isl_aff_set_coefficient(
3063 __isl_take isl_aff *aff,
3064 enum isl_dim_type type, int pos, isl_int v);
3065 __isl_give isl_aff *isl_aff_set_coefficient_si(
3066 __isl_take isl_aff *aff,
3067 enum isl_dim_type type, int pos, int v);
3068 __isl_give isl_aff *isl_aff_set_denominator(
3069 __isl_take isl_aff *aff, isl_int v);
3071 __isl_give isl_aff *isl_aff_add_constant(
3072 __isl_take isl_aff *aff, isl_int v);
3073 __isl_give isl_aff *isl_aff_add_constant_si(
3074 __isl_take isl_aff *aff, int v);
3075 __isl_give isl_aff *isl_aff_add_constant_num(
3076 __isl_take isl_aff *aff, isl_int v);
3077 __isl_give isl_aff *isl_aff_add_constant_num_si(
3078 __isl_take isl_aff *aff, int v);
3079 __isl_give isl_aff *isl_aff_add_coefficient(
3080 __isl_take isl_aff *aff,
3081 enum isl_dim_type type, int pos, isl_int v);
3082 __isl_give isl_aff *isl_aff_add_coefficient_si(
3083 __isl_take isl_aff *aff,
3084 enum isl_dim_type type, int pos, int v);
3086 __isl_give isl_aff *isl_aff_insert_dims(
3087 __isl_take isl_aff *aff,
3088 enum isl_dim_type type, unsigned first, unsigned n);
3089 __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3090 __isl_take isl_pw_aff *pwaff,
3091 enum isl_dim_type type, unsigned first, unsigned n);
3092 __isl_give isl_aff *isl_aff_add_dims(
3093 __isl_take isl_aff *aff,
3094 enum isl_dim_type type, unsigned n);
3095 __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3096 __isl_take isl_pw_aff *pwaff,
3097 enum isl_dim_type type, unsigned n);
3098 __isl_give isl_aff *isl_aff_drop_dims(
3099 __isl_take isl_aff *aff,
3100 enum isl_dim_type type, unsigned first, unsigned n);
3101 __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3102 __isl_take isl_pw_aff *pwaff,
3103 enum isl_dim_type type, unsigned first, unsigned n);
3105 Note that the C<set_constant> and C<set_coefficient> functions
3106 set the I<numerator> of the constant or coefficient, while
3107 C<add_constant> and C<add_coefficient> add an integer value to
3108 the possibly rational constant or coefficient.
3109 The C<add_constant_num> functions add an integer value to
3112 To check whether an affine expressions is obviously zero
3113 or obviously equal to some other affine expression, use
3115 #include <isl/aff.h>
3116 int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3117 int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3118 __isl_keep isl_aff *aff2);
3119 int isl_pw_aff_plain_is_equal(
3120 __isl_keep isl_pw_aff *pwaff1,
3121 __isl_keep isl_pw_aff *pwaff2);
3125 #include <isl/aff.h>
3126 __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3127 __isl_take isl_aff *aff2);
3128 __isl_give isl_pw_aff *isl_pw_aff_add(
3129 __isl_take isl_pw_aff *pwaff1,
3130 __isl_take isl_pw_aff *pwaff2);
3131 __isl_give isl_pw_aff *isl_pw_aff_min(
3132 __isl_take isl_pw_aff *pwaff1,
3133 __isl_take isl_pw_aff *pwaff2);
3134 __isl_give isl_pw_aff *isl_pw_aff_max(
3135 __isl_take isl_pw_aff *pwaff1,
3136 __isl_take isl_pw_aff *pwaff2);
3137 __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3138 __isl_take isl_aff *aff2);
3139 __isl_give isl_pw_aff *isl_pw_aff_sub(
3140 __isl_take isl_pw_aff *pwaff1,
3141 __isl_take isl_pw_aff *pwaff2);
3142 __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3143 __isl_give isl_pw_aff *isl_pw_aff_neg(
3144 __isl_take isl_pw_aff *pwaff);
3145 __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3146 __isl_give isl_pw_aff *isl_pw_aff_ceil(
3147 __isl_take isl_pw_aff *pwaff);
3148 __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3149 __isl_give isl_pw_aff *isl_pw_aff_floor(
3150 __isl_take isl_pw_aff *pwaff);
3151 __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3153 __isl_give isl_pw_aff *isl_pw_aff_mod(
3154 __isl_take isl_pw_aff *pwaff, isl_int mod);
3155 __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3157 __isl_give isl_pw_aff *isl_pw_aff_scale(
3158 __isl_take isl_pw_aff *pwaff, isl_int f);
3159 __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3161 __isl_give isl_aff *isl_aff_scale_down_ui(
3162 __isl_take isl_aff *aff, unsigned f);
3163 __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3164 __isl_take isl_pw_aff *pwaff, isl_int f);
3166 __isl_give isl_pw_aff *isl_pw_aff_list_min(
3167 __isl_take isl_pw_aff_list *list);
3168 __isl_give isl_pw_aff *isl_pw_aff_list_max(
3169 __isl_take isl_pw_aff_list *list);
3171 __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3172 __isl_take isl_pw_aff *pwqp);
3174 __isl_give isl_aff *isl_aff_align_params(
3175 __isl_take isl_aff *aff,
3176 __isl_take isl_space *model);
3177 __isl_give isl_pw_aff *isl_pw_aff_align_params(
3178 __isl_take isl_pw_aff *pwaff,
3179 __isl_take isl_space *model);
3181 __isl_give isl_aff *isl_aff_project_domain_on_params(
3182 __isl_take isl_aff *aff);
3184 __isl_give isl_aff *isl_aff_gist_params(
3185 __isl_take isl_aff *aff,
3186 __isl_take isl_set *context);
3187 __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3188 __isl_take isl_set *context);
3189 __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3190 __isl_take isl_pw_aff *pwaff,
3191 __isl_take isl_set *context);
3192 __isl_give isl_pw_aff *isl_pw_aff_gist(
3193 __isl_take isl_pw_aff *pwaff,
3194 __isl_take isl_set *context);
3196 __isl_give isl_set *isl_pw_aff_domain(
3197 __isl_take isl_pw_aff *pwaff);
3198 __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3199 __isl_take isl_pw_aff *pa,
3200 __isl_take isl_set *set);
3201 __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3202 __isl_take isl_pw_aff *pa,
3203 __isl_take isl_set *set);
3205 __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3206 __isl_take isl_aff *aff2);
3207 __isl_give isl_pw_aff *isl_pw_aff_mul(
3208 __isl_take isl_pw_aff *pwaff1,
3209 __isl_take isl_pw_aff *pwaff2);
3211 When multiplying two affine expressions, at least one of the two needs
3214 #include <isl/aff.h>
3215 __isl_give isl_basic_set *isl_aff_neg_basic_set(
3216 __isl_take isl_aff *aff);
3217 __isl_give isl_basic_set *isl_aff_le_basic_set(
3218 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3219 __isl_give isl_basic_set *isl_aff_ge_basic_set(
3220 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3221 __isl_give isl_set *isl_pw_aff_eq_set(
3222 __isl_take isl_pw_aff *pwaff1,
3223 __isl_take isl_pw_aff *pwaff2);
3224 __isl_give isl_set *isl_pw_aff_ne_set(
3225 __isl_take isl_pw_aff *pwaff1,
3226 __isl_take isl_pw_aff *pwaff2);
3227 __isl_give isl_set *isl_pw_aff_le_set(
3228 __isl_take isl_pw_aff *pwaff1,
3229 __isl_take isl_pw_aff *pwaff2);
3230 __isl_give isl_set *isl_pw_aff_lt_set(
3231 __isl_take isl_pw_aff *pwaff1,
3232 __isl_take isl_pw_aff *pwaff2);
3233 __isl_give isl_set *isl_pw_aff_ge_set(
3234 __isl_take isl_pw_aff *pwaff1,
3235 __isl_take isl_pw_aff *pwaff2);
3236 __isl_give isl_set *isl_pw_aff_gt_set(
3237 __isl_take isl_pw_aff *pwaff1,
3238 __isl_take isl_pw_aff *pwaff2);
3240 __isl_give isl_set *isl_pw_aff_list_eq_set(
3241 __isl_take isl_pw_aff_list *list1,
3242 __isl_take isl_pw_aff_list *list2);
3243 __isl_give isl_set *isl_pw_aff_list_ne_set(
3244 __isl_take isl_pw_aff_list *list1,
3245 __isl_take isl_pw_aff_list *list2);
3246 __isl_give isl_set *isl_pw_aff_list_le_set(
3247 __isl_take isl_pw_aff_list *list1,
3248 __isl_take isl_pw_aff_list *list2);
3249 __isl_give isl_set *isl_pw_aff_list_lt_set(
3250 __isl_take isl_pw_aff_list *list1,
3251 __isl_take isl_pw_aff_list *list2);
3252 __isl_give isl_set *isl_pw_aff_list_ge_set(
3253 __isl_take isl_pw_aff_list *list1,
3254 __isl_take isl_pw_aff_list *list2);
3255 __isl_give isl_set *isl_pw_aff_list_gt_set(
3256 __isl_take isl_pw_aff_list *list1,
3257 __isl_take isl_pw_aff_list *list2);
3259 The function C<isl_aff_neg_basic_set> returns a basic set
3260 containing those elements in the domain space
3261 of C<aff> where C<aff> is negative.
3262 The function C<isl_aff_ge_basic_set> returns a basic set
3263 containing those elements in the shared space
3264 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3265 The function C<isl_pw_aff_ge_set> returns a set
3266 containing those elements in the shared domain
3267 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3268 The functions operating on C<isl_pw_aff_list> apply the corresponding
3269 C<isl_pw_aff> function to each pair of elements in the two lists.
3271 #include <isl/aff.h>
3272 __isl_give isl_set *isl_pw_aff_nonneg_set(
3273 __isl_take isl_pw_aff *pwaff);
3274 __isl_give isl_set *isl_pw_aff_zero_set(
3275 __isl_take isl_pw_aff *pwaff);
3276 __isl_give isl_set *isl_pw_aff_non_zero_set(
3277 __isl_take isl_pw_aff *pwaff);
3279 The function C<isl_pw_aff_nonneg_set> returns a set
3280 containing those elements in the domain
3281 of C<pwaff> where C<pwaff> is non-negative.
3283 #include <isl/aff.h>
3284 __isl_give isl_pw_aff *isl_pw_aff_cond(
3285 __isl_take isl_pw_aff *cond,
3286 __isl_take isl_pw_aff *pwaff_true,
3287 __isl_take isl_pw_aff *pwaff_false);
3289 The function C<isl_pw_aff_cond> performs a conditional operator
3290 and returns an expression that is equal to C<pwaff_true>
3291 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3292 where C<cond> is zero.
3294 #include <isl/aff.h>
3295 __isl_give isl_pw_aff *isl_pw_aff_union_min(
3296 __isl_take isl_pw_aff *pwaff1,
3297 __isl_take isl_pw_aff *pwaff2);
3298 __isl_give isl_pw_aff *isl_pw_aff_union_max(
3299 __isl_take isl_pw_aff *pwaff1,
3300 __isl_take isl_pw_aff *pwaff2);
3301 __isl_give isl_pw_aff *isl_pw_aff_union_add(
3302 __isl_take isl_pw_aff *pwaff1,
3303 __isl_take isl_pw_aff *pwaff2);
3305 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3306 expression with a domain that is the union of those of C<pwaff1> and
3307 C<pwaff2> and such that on each cell, the quasi-affine expression is
3308 the maximum of those of C<pwaff1> and C<pwaff2>. If only one of
3309 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3310 associated expression is the defined one.
3312 An expression can be read from input using
3314 #include <isl/aff.h>
3315 __isl_give isl_aff *isl_aff_read_from_str(
3316 isl_ctx *ctx, const char *str);
3317 __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3318 isl_ctx *ctx, const char *str);
3320 An expression can be printed using
3322 #include <isl/aff.h>
3323 __isl_give isl_printer *isl_printer_print_aff(
3324 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3326 __isl_give isl_printer *isl_printer_print_pw_aff(
3327 __isl_take isl_printer *p,
3328 __isl_keep isl_pw_aff *pwaff);
3330 =head2 Piecewise Multiple Quasi Affine Expressions
3332 An C<isl_multi_aff> object represents a sequence of
3333 zero or more affine expressions, all defined on the same domain space.
3335 An C<isl_multi_aff> can be constructed from a C<isl_aff_list> using the
3338 #include <isl/aff.h>
3339 __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3340 __isl_take isl_space *space,
3341 __isl_take isl_aff_list *list);
3343 An empty piecewise multiple quasi affine expression (one with no cells),
3344 the zero piecewise multiple quasi affine expression (with value zero
3345 for each output dimension),
3346 a piecewise multiple quasi affine expression with a single cell (with
3347 either a universe or a specified domain) or
3348 a zero-dimensional piecewise multiple quasi affine expression
3350 can be created using the following functions.
3352 #include <isl/aff.h>
3353 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3354 __isl_take isl_space *space);
3355 __isl_give isl_multi_aff *isl_multi_aff_zero(
3356 __isl_take isl_space *space);
3357 __isl_give isl_pw_multi_aff *
3358 isl_pw_multi_aff_from_multi_aff(
3359 __isl_take isl_multi_aff *ma);
3360 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3361 __isl_take isl_set *set,
3362 __isl_take isl_multi_aff *maff);
3363 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3364 __isl_take isl_set *set);
3366 __isl_give isl_union_pw_multi_aff *
3367 isl_union_pw_multi_aff_empty(
3368 __isl_take isl_space *space);
3369 __isl_give isl_union_pw_multi_aff *
3370 isl_union_pw_multi_aff_add_pw_multi_aff(
3371 __isl_take isl_union_pw_multi_aff *upma,
3372 __isl_take isl_pw_multi_aff *pma);
3373 __isl_give isl_union_pw_multi_aff *
3374 isl_union_pw_multi_aff_from_domain(
3375 __isl_take isl_union_set *uset);
3377 A piecewise multiple quasi affine expression can also be initialized
3378 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3379 and the C<isl_map> is single-valued.
3381 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3382 __isl_take isl_set *set);
3383 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3384 __isl_take isl_map *map);
3386 Multiple quasi affine expressions can be copied and freed using
3388 #include <isl/aff.h>
3389 __isl_give isl_multi_aff *isl_multi_aff_copy(
3390 __isl_keep isl_multi_aff *maff);
3391 void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3393 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3394 __isl_keep isl_pw_multi_aff *pma);
3395 void *isl_pw_multi_aff_free(
3396 __isl_take isl_pw_multi_aff *pma);
3398 __isl_give isl_union_pw_multi_aff *
3399 isl_union_pw_multi_aff_copy(
3400 __isl_keep isl_union_pw_multi_aff *upma);
3401 void *isl_union_pw_multi_aff_free(
3402 __isl_take isl_union_pw_multi_aff *upma);
3404 The expression can be inspected using
3406 #include <isl/aff.h>
3407 isl_ctx *isl_multi_aff_get_ctx(
3408 __isl_keep isl_multi_aff *maff);
3409 isl_ctx *isl_pw_multi_aff_get_ctx(
3410 __isl_keep isl_pw_multi_aff *pma);
3411 isl_ctx *isl_union_pw_multi_aff_get_ctx(
3412 __isl_keep isl_union_pw_multi_aff *upma);
3413 unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3414 enum isl_dim_type type);
3415 unsigned isl_pw_multi_aff_dim(
3416 __isl_keep isl_pw_multi_aff *pma,
3417 enum isl_dim_type type);
3418 __isl_give isl_aff *isl_multi_aff_get_aff(
3419 __isl_keep isl_multi_aff *multi, int pos);
3420 __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3421 __isl_keep isl_pw_multi_aff *pma, int pos);
3422 const char *isl_pw_multi_aff_get_dim_name(
3423 __isl_keep isl_pw_multi_aff *pma,
3424 enum isl_dim_type type, unsigned pos);
3425 __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3426 __isl_keep isl_pw_multi_aff *pma,
3427 enum isl_dim_type type, unsigned pos);
3428 const char *isl_multi_aff_get_tuple_name(
3429 __isl_keep isl_multi_aff *multi,
3430 enum isl_dim_type type);
3431 int isl_pw_multi_aff_has_tuple_name(
3432 __isl_keep isl_pw_multi_aff *pma,
3433 enum isl_dim_type type);
3434 const char *isl_pw_multi_aff_get_tuple_name(
3435 __isl_keep isl_pw_multi_aff *pma,
3436 enum isl_dim_type type);
3437 int isl_pw_multi_aff_has_tuple_id(
3438 __isl_keep isl_pw_multi_aff *pma,
3439 enum isl_dim_type type);
3440 __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3441 __isl_keep isl_pw_multi_aff *pma,
3442 enum isl_dim_type type);
3444 int isl_pw_multi_aff_foreach_piece(
3445 __isl_keep isl_pw_multi_aff *pma,
3446 int (*fn)(__isl_take isl_set *set,
3447 __isl_take isl_multi_aff *maff,
3448 void *user), void *user);
3450 int isl_union_pw_multi_aff_foreach_pw_multi_aff(
3451 __isl_keep isl_union_pw_multi_aff *upma,
3452 int (*fn)(__isl_take isl_pw_multi_aff *pma,
3453 void *user), void *user);
3455 It can be modified using
3457 #include <isl/aff.h>
3458 __isl_give isl_multi_aff *isl_multi_aff_set_aff(
3459 __isl_take isl_multi_aff *multi, int pos,
3460 __isl_take isl_aff *aff);
3461 __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3462 __isl_take isl_multi_aff *maff,
3463 enum isl_dim_type type, unsigned pos, const char *s);
3464 __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
3465 __isl_take isl_multi_aff *maff,
3466 enum isl_dim_type type, __isl_take isl_id *id);
3467 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3468 __isl_take isl_pw_multi_aff *pma,
3469 enum isl_dim_type type, __isl_take isl_id *id);
3471 __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
3472 __isl_take isl_multi_aff *maff,
3473 enum isl_dim_type type, unsigned first, unsigned n);
3475 To check whether two multiple affine expressions are
3476 obviously equal to each other, use
3478 int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3479 __isl_keep isl_multi_aff *maff2);
3480 int isl_pw_multi_aff_plain_is_equal(
3481 __isl_keep isl_pw_multi_aff *pma1,
3482 __isl_keep isl_pw_multi_aff *pma2);
3486 #include <isl/aff.h>
3487 __isl_give isl_multi_aff *isl_multi_aff_add(
3488 __isl_take isl_multi_aff *maff1,
3489 __isl_take isl_multi_aff *maff2);
3490 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3491 __isl_take isl_pw_multi_aff *pma1,
3492 __isl_take isl_pw_multi_aff *pma2);
3493 __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
3494 __isl_take isl_union_pw_multi_aff *upma1,
3495 __isl_take isl_union_pw_multi_aff *upma2);
3496 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3497 __isl_take isl_pw_multi_aff *pma1,
3498 __isl_take isl_pw_multi_aff *pma2);
3499 __isl_give isl_multi_aff *isl_multi_aff_scale(
3500 __isl_take isl_multi_aff *maff,
3502 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
3503 __isl_take isl_pw_multi_aff *pma,
3504 __isl_take isl_set *set);
3505 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3506 __isl_take isl_pw_multi_aff *pma,
3507 __isl_take isl_set *set);
3508 __isl_give isl_multi_aff *isl_multi_aff_lift(
3509 __isl_take isl_multi_aff *maff,
3510 __isl_give isl_local_space **ls);
3511 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
3512 __isl_take isl_pw_multi_aff *pma);
3513 __isl_give isl_multi_aff *isl_multi_aff_gist_params(
3514 __isl_take isl_multi_aff *maff,
3515 __isl_take isl_set *context);
3516 __isl_give isl_multi_aff *isl_multi_aff_gist(
3517 __isl_take isl_multi_aff *maff,
3518 __isl_take isl_set *context);
3519 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
3520 __isl_take isl_pw_multi_aff *pma,
3521 __isl_take isl_set *set);
3522 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
3523 __isl_take isl_pw_multi_aff *pma,
3524 __isl_take isl_set *set);
3525 __isl_give isl_set *isl_pw_multi_aff_domain(
3526 __isl_take isl_pw_multi_aff *pma);
3527 __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
3528 __isl_take isl_union_pw_multi_aff *upma);
3529 __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
3530 __isl_take isl_multi_aff *ma1,
3531 __isl_take isl_multi_aff *ma2);
3532 __isl_give isl_pw_multi_aff *
3533 isl_pw_multi_aff_flat_range_product(
3534 __isl_take isl_pw_multi_aff *pma1,
3535 __isl_take isl_pw_multi_aff *pma2);
3536 __isl_give isl_union_pw_multi_aff *
3537 isl_union_pw_multi_aff_flat_range_product(
3538 __isl_take isl_union_pw_multi_aff *upma1,
3539 __isl_take isl_union_pw_multi_aff *upma2);
3541 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
3542 then it is assigned the local space that lies at the basis of
3543 the lifting applied.
3545 An expression can be read from input using
3547 #include <isl/aff.h>
3548 __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3549 isl_ctx *ctx, const char *str);
3550 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3551 isl_ctx *ctx, const char *str);
3553 An expression can be printed using
3555 #include <isl/aff.h>
3556 __isl_give isl_printer *isl_printer_print_multi_aff(
3557 __isl_take isl_printer *p,
3558 __isl_keep isl_multi_aff *maff);
3559 __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3560 __isl_take isl_printer *p,
3561 __isl_keep isl_pw_multi_aff *pma);
3562 __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
3563 __isl_take isl_printer *p,
3564 __isl_keep isl_union_pw_multi_aff *upma);
3568 Points are elements of a set. They can be used to construct
3569 simple sets (boxes) or they can be used to represent the
3570 individual elements of a set.
3571 The zero point (the origin) can be created using
3573 __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
3575 The coordinates of a point can be inspected, set and changed
3578 int isl_point_get_coordinate(__isl_keep isl_point *pnt,
3579 enum isl_dim_type type, int pos, isl_int *v);
3580 __isl_give isl_point *isl_point_set_coordinate(
3581 __isl_take isl_point *pnt,
3582 enum isl_dim_type type, int pos, isl_int v);
3584 __isl_give isl_point *isl_point_add_ui(
3585 __isl_take isl_point *pnt,
3586 enum isl_dim_type type, int pos, unsigned val);
3587 __isl_give isl_point *isl_point_sub_ui(
3588 __isl_take isl_point *pnt,
3589 enum isl_dim_type type, int pos, unsigned val);
3591 Other properties can be obtained using
3593 isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
3595 Points can be copied or freed using
3597 __isl_give isl_point *isl_point_copy(
3598 __isl_keep isl_point *pnt);
3599 void isl_point_free(__isl_take isl_point *pnt);
3601 A singleton set can be created from a point using
3603 __isl_give isl_basic_set *isl_basic_set_from_point(
3604 __isl_take isl_point *pnt);
3605 __isl_give isl_set *isl_set_from_point(
3606 __isl_take isl_point *pnt);
3608 and a box can be created from two opposite extremal points using
3610 __isl_give isl_basic_set *isl_basic_set_box_from_points(
3611 __isl_take isl_point *pnt1,
3612 __isl_take isl_point *pnt2);
3613 __isl_give isl_set *isl_set_box_from_points(
3614 __isl_take isl_point *pnt1,
3615 __isl_take isl_point *pnt2);
3617 All elements of a B<bounded> (union) set can be enumerated using
3618 the following functions.
3620 int isl_set_foreach_point(__isl_keep isl_set *set,
3621 int (*fn)(__isl_take isl_point *pnt, void *user),
3623 int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
3624 int (*fn)(__isl_take isl_point *pnt, void *user),
3627 The function C<fn> is called for each integer point in
3628 C<set> with as second argument the last argument of
3629 the C<isl_set_foreach_point> call. The function C<fn>
3630 should return C<0> on success and C<-1> on failure.
3631 In the latter case, C<isl_set_foreach_point> will stop
3632 enumerating and return C<-1> as well.
3633 If the enumeration is performed successfully and to completion,
3634 then C<isl_set_foreach_point> returns C<0>.
3636 To obtain a single point of a (basic) set, use
3638 __isl_give isl_point *isl_basic_set_sample_point(
3639 __isl_take isl_basic_set *bset);
3640 __isl_give isl_point *isl_set_sample_point(
3641 __isl_take isl_set *set);
3643 If C<set> does not contain any (integer) points, then the
3644 resulting point will be ``void'', a property that can be
3647 int isl_point_is_void(__isl_keep isl_point *pnt);
3649 =head2 Piecewise Quasipolynomials
3651 A piecewise quasipolynomial is a particular kind of function that maps
3652 a parametric point to a rational value.
3653 More specifically, a quasipolynomial is a polynomial expression in greatest
3654 integer parts of affine expressions of parameters and variables.
3655 A piecewise quasipolynomial is a subdivision of a given parametric
3656 domain into disjoint cells with a quasipolynomial associated to
3657 each cell. The value of the piecewise quasipolynomial at a given
3658 point is the value of the quasipolynomial associated to the cell
3659 that contains the point. Outside of the union of cells,
3660 the value is assumed to be zero.
3661 For example, the piecewise quasipolynomial
3663 [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
3665 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
3666 A given piecewise quasipolynomial has a fixed domain dimension.
3667 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
3668 defined over different domains.
3669 Piecewise quasipolynomials are mainly used by the C<barvinok>
3670 library for representing the number of elements in a parametric set or map.
3671 For example, the piecewise quasipolynomial above represents
3672 the number of points in the map
3674 [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
3676 =head3 Input and Output
3678 Piecewise quasipolynomials can be read from input using
3680 __isl_give isl_union_pw_qpolynomial *
3681 isl_union_pw_qpolynomial_read_from_str(
3682 isl_ctx *ctx, const char *str);
3684 Quasipolynomials and piecewise quasipolynomials can be printed
3685 using the following functions.
3687 __isl_give isl_printer *isl_printer_print_qpolynomial(
3688 __isl_take isl_printer *p,
3689 __isl_keep isl_qpolynomial *qp);
3691 __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3692 __isl_take isl_printer *p,
3693 __isl_keep isl_pw_qpolynomial *pwqp);
3695 __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3696 __isl_take isl_printer *p,
3697 __isl_keep isl_union_pw_qpolynomial *upwqp);
3699 The output format of the printer
3700 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3701 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
3703 In case of printing in C<ISL_FORMAT_C>, the user may want
3704 to set the names of all dimensions
3706 __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
3707 __isl_take isl_qpolynomial *qp,
3708 enum isl_dim_type type, unsigned pos,
3710 __isl_give isl_pw_qpolynomial *
3711 isl_pw_qpolynomial_set_dim_name(
3712 __isl_take isl_pw_qpolynomial *pwqp,
3713 enum isl_dim_type type, unsigned pos,
3716 =head3 Creating New (Piecewise) Quasipolynomials
3718 Some simple quasipolynomials can be created using the following functions.
3719 More complicated quasipolynomials can be created by applying
3720 operations such as addition and multiplication
3721 on the resulting quasipolynomials
3723 __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
3724 __isl_take isl_space *domain);
3725 __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
3726 __isl_take isl_space *domain);
3727 __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
3728 __isl_take isl_space *domain);
3729 __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
3730 __isl_take isl_space *domain);
3731 __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
3732 __isl_take isl_space *domain);
3733 __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
3734 __isl_take isl_space *domain,
3735 const isl_int n, const isl_int d);
3736 __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
3737 __isl_take isl_space *domain,
3738 enum isl_dim_type type, unsigned pos);
3739 __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
3740 __isl_take isl_aff *aff);
3742 Note that the space in which a quasipolynomial lives is a map space
3743 with a one-dimensional range. The C<domain> argument in some of
3744 the functions above corresponds to the domain of this map space.
3746 The zero piecewise quasipolynomial or a piecewise quasipolynomial
3747 with a single cell can be created using the following functions.
3748 Multiple of these single cell piecewise quasipolynomials can
3749 be combined to create more complicated piecewise quasipolynomials.
3751 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
3752 __isl_take isl_space *space);
3753 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
3754 __isl_take isl_set *set,
3755 __isl_take isl_qpolynomial *qp);
3756 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
3757 __isl_take isl_qpolynomial *qp);
3758 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
3759 __isl_take isl_pw_aff *pwaff);
3761 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
3762 __isl_take isl_space *space);
3763 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
3764 __isl_take isl_pw_qpolynomial *pwqp);
3765 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
3766 __isl_take isl_union_pw_qpolynomial *upwqp,
3767 __isl_take isl_pw_qpolynomial *pwqp);
3769 Quasipolynomials can be copied and freed again using the following
3772 __isl_give isl_qpolynomial *isl_qpolynomial_copy(
3773 __isl_keep isl_qpolynomial *qp);
3774 void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
3776 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
3777 __isl_keep isl_pw_qpolynomial *pwqp);
3778 void *isl_pw_qpolynomial_free(
3779 __isl_take isl_pw_qpolynomial *pwqp);
3781 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
3782 __isl_keep isl_union_pw_qpolynomial *upwqp);
3783 void *isl_union_pw_qpolynomial_free(
3784 __isl_take isl_union_pw_qpolynomial *upwqp);
3786 =head3 Inspecting (Piecewise) Quasipolynomials
3788 To iterate over all piecewise quasipolynomials in a union
3789 piecewise quasipolynomial, use the following function
3791 int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
3792 __isl_keep isl_union_pw_qpolynomial *upwqp,
3793 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
3796 To extract the piecewise quasipolynomial in a given space from a union, use
3798 __isl_give isl_pw_qpolynomial *
3799 isl_union_pw_qpolynomial_extract_pw_qpolynomial(
3800 __isl_keep isl_union_pw_qpolynomial *upwqp,
3801 __isl_take isl_space *space);
3803 To iterate over the cells in a piecewise quasipolynomial,
3804 use either of the following two functions
3806 int isl_pw_qpolynomial_foreach_piece(
3807 __isl_keep isl_pw_qpolynomial *pwqp,
3808 int (*fn)(__isl_take isl_set *set,
3809 __isl_take isl_qpolynomial *qp,
3810 void *user), void *user);
3811 int isl_pw_qpolynomial_foreach_lifted_piece(
3812 __isl_keep isl_pw_qpolynomial *pwqp,
3813 int (*fn)(__isl_take isl_set *set,
3814 __isl_take isl_qpolynomial *qp,
3815 void *user), void *user);
3817 As usual, the function C<fn> should return C<0> on success
3818 and C<-1> on failure. The difference between
3819 C<isl_pw_qpolynomial_foreach_piece> and
3820 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
3821 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
3822 compute unique representations for all existentially quantified
3823 variables and then turn these existentially quantified variables
3824 into extra set variables, adapting the associated quasipolynomial
3825 accordingly. This means that the C<set> passed to C<fn>
3826 will not have any existentially quantified variables, but that
3827 the dimensions of the sets may be different for different
3828 invocations of C<fn>.
3830 To iterate over all terms in a quasipolynomial,
3833 int isl_qpolynomial_foreach_term(
3834 __isl_keep isl_qpolynomial *qp,
3835 int (*fn)(__isl_take isl_term *term,
3836 void *user), void *user);
3838 The terms themselves can be inspected and freed using
3841 unsigned isl_term_dim(__isl_keep isl_term *term,
3842 enum isl_dim_type type);
3843 void isl_term_get_num(__isl_keep isl_term *term,
3845 void isl_term_get_den(__isl_keep isl_term *term,
3847 int isl_term_get_exp(__isl_keep isl_term *term,
3848 enum isl_dim_type type, unsigned pos);
3849 __isl_give isl_aff *isl_term_get_div(
3850 __isl_keep isl_term *term, unsigned pos);
3851 void isl_term_free(__isl_take isl_term *term);
3853 Each term is a product of parameters, set variables and
3854 integer divisions. The function C<isl_term_get_exp>
3855 returns the exponent of a given dimensions in the given term.
3856 The C<isl_int>s in the arguments of C<isl_term_get_num>
3857 and C<isl_term_get_den> need to have been initialized
3858 using C<isl_int_init> before calling these functions.
3860 =head3 Properties of (Piecewise) Quasipolynomials
3862 To check whether a quasipolynomial is actually a constant,
3863 use the following function.
3865 int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
3866 isl_int *n, isl_int *d);
3868 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
3869 then the numerator and denominator of the constant
3870 are returned in C<*n> and C<*d>, respectively.
3872 To check whether two union piecewise quasipolynomials are
3873 obviously equal, use
3875 int isl_union_pw_qpolynomial_plain_is_equal(
3876 __isl_keep isl_union_pw_qpolynomial *upwqp1,
3877 __isl_keep isl_union_pw_qpolynomial *upwqp2);
3879 =head3 Operations on (Piecewise) Quasipolynomials
3881 __isl_give isl_qpolynomial *isl_qpolynomial_scale(
3882 __isl_take isl_qpolynomial *qp, isl_int v);
3883 __isl_give isl_qpolynomial *isl_qpolynomial_neg(
3884 __isl_take isl_qpolynomial *qp);
3885 __isl_give isl_qpolynomial *isl_qpolynomial_add(
3886 __isl_take isl_qpolynomial *qp1,
3887 __isl_take isl_qpolynomial *qp2);
3888 __isl_give isl_qpolynomial *isl_qpolynomial_sub(
3889 __isl_take isl_qpolynomial *qp1,
3890 __isl_take isl_qpolynomial *qp2);
3891 __isl_give isl_qpolynomial *isl_qpolynomial_mul(
3892 __isl_take isl_qpolynomial *qp1,
3893 __isl_take isl_qpolynomial *qp2);
3894 __isl_give isl_qpolynomial *isl_qpolynomial_pow(
3895 __isl_take isl_qpolynomial *qp, unsigned exponent);
3897 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
3898 __isl_take isl_pw_qpolynomial *pwqp1,
3899 __isl_take isl_pw_qpolynomial *pwqp2);
3900 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
3901 __isl_take isl_pw_qpolynomial *pwqp1,
3902 __isl_take isl_pw_qpolynomial *pwqp2);
3903 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
3904 __isl_take isl_pw_qpolynomial *pwqp1,
3905 __isl_take isl_pw_qpolynomial *pwqp2);
3906 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
3907 __isl_take isl_pw_qpolynomial *pwqp);
3908 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
3909 __isl_take isl_pw_qpolynomial *pwqp1,
3910 __isl_take isl_pw_qpolynomial *pwqp2);
3911 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
3912 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
3914 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
3915 __isl_take isl_union_pw_qpolynomial *upwqp1,
3916 __isl_take isl_union_pw_qpolynomial *upwqp2);
3917 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
3918 __isl_take isl_union_pw_qpolynomial *upwqp1,
3919 __isl_take isl_union_pw_qpolynomial *upwqp2);
3920 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
3921 __isl_take isl_union_pw_qpolynomial *upwqp1,
3922 __isl_take isl_union_pw_qpolynomial *upwqp2);
3924 __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
3925 __isl_take isl_pw_qpolynomial *pwqp,
3926 __isl_take isl_point *pnt);
3928 __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
3929 __isl_take isl_union_pw_qpolynomial *upwqp,
3930 __isl_take isl_point *pnt);
3932 __isl_give isl_set *isl_pw_qpolynomial_domain(
3933 __isl_take isl_pw_qpolynomial *pwqp);
3934 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
3935 __isl_take isl_pw_qpolynomial *pwpq,
3936 __isl_take isl_set *set);
3937 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
3938 __isl_take isl_pw_qpolynomial *pwpq,
3939 __isl_take isl_set *set);
3941 __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
3942 __isl_take isl_union_pw_qpolynomial *upwqp);
3943 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
3944 __isl_take isl_union_pw_qpolynomial *upwpq,
3945 __isl_take isl_union_set *uset);
3946 __isl_give isl_union_pw_qpolynomial *
3947 isl_union_pw_qpolynomial_intersect_params(
3948 __isl_take isl_union_pw_qpolynomial *upwpq,
3949 __isl_take isl_set *set);
3951 __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
3952 __isl_take isl_qpolynomial *qp,
3953 __isl_take isl_space *model);
3955 __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
3956 __isl_take isl_qpolynomial *qp);
3957 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
3958 __isl_take isl_pw_qpolynomial *pwqp);
3960 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
3961 __isl_take isl_union_pw_qpolynomial *upwqp);
3963 __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
3964 __isl_take isl_qpolynomial *qp,
3965 __isl_take isl_set *context);
3966 __isl_give isl_qpolynomial *isl_qpolynomial_gist(
3967 __isl_take isl_qpolynomial *qp,
3968 __isl_take isl_set *context);
3970 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
3971 __isl_take isl_pw_qpolynomial *pwqp,
3972 __isl_take isl_set *context);
3973 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
3974 __isl_take isl_pw_qpolynomial *pwqp,
3975 __isl_take isl_set *context);
3977 __isl_give isl_union_pw_qpolynomial *
3978 isl_union_pw_qpolynomial_gist_params(
3979 __isl_take isl_union_pw_qpolynomial *upwqp,
3980 __isl_take isl_set *context);
3981 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
3982 __isl_take isl_union_pw_qpolynomial *upwqp,
3983 __isl_take isl_union_set *context);
3985 The gist operation applies the gist operation to each of
3986 the cells in the domain of the input piecewise quasipolynomial.
3987 The context is also exploited
3988 to simplify the quasipolynomials associated to each cell.
3990 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
3991 __isl_take isl_pw_qpolynomial *pwqp, int sign);
3992 __isl_give isl_union_pw_qpolynomial *
3993 isl_union_pw_qpolynomial_to_polynomial(
3994 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
3996 Approximate each quasipolynomial by a polynomial. If C<sign> is positive,
3997 the polynomial will be an overapproximation. If C<sign> is negative,
3998 it will be an underapproximation. If C<sign> is zero, the approximation
3999 will lie somewhere in between.
4001 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4003 A piecewise quasipolynomial reduction is a piecewise
4004 reduction (or fold) of quasipolynomials.
4005 In particular, the reduction can be maximum or a minimum.
4006 The objects are mainly used to represent the result of
4007 an upper or lower bound on a quasipolynomial over its domain,
4008 i.e., as the result of the following function.
4010 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4011 __isl_take isl_pw_qpolynomial *pwqp,
4012 enum isl_fold type, int *tight);
4014 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4015 __isl_take isl_union_pw_qpolynomial *upwqp,
4016 enum isl_fold type, int *tight);
4018 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4019 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4020 is the returned bound is known be tight, i.e., for each value
4021 of the parameters there is at least
4022 one element in the domain that reaches the bound.
4023 If the domain of C<pwqp> is not wrapping, then the bound is computed
4024 over all elements in that domain and the result has a purely parametric
4025 domain. If the domain of C<pwqp> is wrapping, then the bound is
4026 computed over the range of the wrapped relation. The domain of the
4027 wrapped relation becomes the domain of the result.
4029 A (piecewise) quasipolynomial reduction can be copied or freed using the
4030 following functions.
4032 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4033 __isl_keep isl_qpolynomial_fold *fold);
4034 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4035 __isl_keep isl_pw_qpolynomial_fold *pwf);
4036 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4037 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4038 void isl_qpolynomial_fold_free(
4039 __isl_take isl_qpolynomial_fold *fold);
4040 void *isl_pw_qpolynomial_fold_free(
4041 __isl_take isl_pw_qpolynomial_fold *pwf);
4042 void *isl_union_pw_qpolynomial_fold_free(
4043 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4045 =head3 Printing Piecewise Quasipolynomial Reductions
4047 Piecewise quasipolynomial reductions can be printed
4048 using the following function.
4050 __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4051 __isl_take isl_printer *p,
4052 __isl_keep isl_pw_qpolynomial_fold *pwf);
4053 __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4054 __isl_take isl_printer *p,
4055 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4057 For C<isl_printer_print_pw_qpolynomial_fold>,
4058 output format of the printer
4059 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4060 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4061 output format of the printer
4062 needs to be set to C<ISL_FORMAT_ISL>.
4063 In case of printing in C<ISL_FORMAT_C>, the user may want
4064 to set the names of all dimensions
4066 __isl_give isl_pw_qpolynomial_fold *
4067 isl_pw_qpolynomial_fold_set_dim_name(
4068 __isl_take isl_pw_qpolynomial_fold *pwf,
4069 enum isl_dim_type type, unsigned pos,
4072 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4074 To iterate over all piecewise quasipolynomial reductions in a union
4075 piecewise quasipolynomial reduction, use the following function
4077 int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4078 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4079 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4080 void *user), void *user);
4082 To iterate over the cells in a piecewise quasipolynomial reduction,
4083 use either of the following two functions
4085 int isl_pw_qpolynomial_fold_foreach_piece(
4086 __isl_keep isl_pw_qpolynomial_fold *pwf,
4087 int (*fn)(__isl_take isl_set *set,
4088 __isl_take isl_qpolynomial_fold *fold,
4089 void *user), void *user);
4090 int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4091 __isl_keep isl_pw_qpolynomial_fold *pwf,
4092 int (*fn)(__isl_take isl_set *set,
4093 __isl_take isl_qpolynomial_fold *fold,
4094 void *user), void *user);
4096 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4097 of the difference between these two functions.
4099 To iterate over all quasipolynomials in a reduction, use
4101 int isl_qpolynomial_fold_foreach_qpolynomial(
4102 __isl_keep isl_qpolynomial_fold *fold,
4103 int (*fn)(__isl_take isl_qpolynomial *qp,
4104 void *user), void *user);
4106 =head3 Properties of Piecewise Quasipolynomial Reductions
4108 To check whether two union piecewise quasipolynomial reductions are
4109 obviously equal, use
4111 int isl_union_pw_qpolynomial_fold_plain_is_equal(
4112 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4113 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4115 =head3 Operations on Piecewise Quasipolynomial Reductions
4117 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4118 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4120 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4121 __isl_take isl_pw_qpolynomial_fold *pwf1,
4122 __isl_take isl_pw_qpolynomial_fold *pwf2);
4124 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4125 __isl_take isl_pw_qpolynomial_fold *pwf1,
4126 __isl_take isl_pw_qpolynomial_fold *pwf2);
4128 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4129 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4130 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4132 __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4133 __isl_take isl_pw_qpolynomial_fold *pwf,
4134 __isl_take isl_point *pnt);
4136 __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4137 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4138 __isl_take isl_point *pnt);
4140 __isl_give isl_pw_qpolynomial_fold *
4141 isl_pw_qpolynomial_fold_intersect_params(
4142 __isl_take isl_pw_qpolynomial_fold *pwf,
4143 __isl_take isl_set *set);
4145 __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4146 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4147 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4148 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4149 __isl_take isl_union_set *uset);
4150 __isl_give isl_union_pw_qpolynomial_fold *
4151 isl_union_pw_qpolynomial_fold_intersect_params(
4152 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4153 __isl_take isl_set *set);
4155 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4156 __isl_take isl_pw_qpolynomial_fold *pwf);
4158 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4159 __isl_take isl_pw_qpolynomial_fold *pwf);
4161 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4162 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4164 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4165 __isl_take isl_qpolynomial_fold *fold,
4166 __isl_take isl_set *context);
4167 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4168 __isl_take isl_qpolynomial_fold *fold,
4169 __isl_take isl_set *context);
4171 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4172 __isl_take isl_pw_qpolynomial_fold *pwf,
4173 __isl_take isl_set *context);
4174 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4175 __isl_take isl_pw_qpolynomial_fold *pwf,
4176 __isl_take isl_set *context);
4178 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4179 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4180 __isl_take isl_union_set *context);
4181 __isl_give isl_union_pw_qpolynomial_fold *
4182 isl_union_pw_qpolynomial_fold_gist_params(
4183 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4184 __isl_take isl_set *context);
4186 The gist operation applies the gist operation to each of
4187 the cells in the domain of the input piecewise quasipolynomial reduction.
4188 In future, the operation will also exploit the context
4189 to simplify the quasipolynomial reductions associated to each cell.
4191 __isl_give isl_pw_qpolynomial_fold *
4192 isl_set_apply_pw_qpolynomial_fold(
4193 __isl_take isl_set *set,
4194 __isl_take isl_pw_qpolynomial_fold *pwf,
4196 __isl_give isl_pw_qpolynomial_fold *
4197 isl_map_apply_pw_qpolynomial_fold(
4198 __isl_take isl_map *map,
4199 __isl_take isl_pw_qpolynomial_fold *pwf,
4201 __isl_give isl_union_pw_qpolynomial_fold *
4202 isl_union_set_apply_union_pw_qpolynomial_fold(
4203 __isl_take isl_union_set *uset,
4204 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4206 __isl_give isl_union_pw_qpolynomial_fold *
4207 isl_union_map_apply_union_pw_qpolynomial_fold(
4208 __isl_take isl_union_map *umap,
4209 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4212 The functions taking a map
4213 compose the given map with the given piecewise quasipolynomial reduction.
4214 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
4215 over all elements in the intersection of the range of the map
4216 and the domain of the piecewise quasipolynomial reduction
4217 as a function of an element in the domain of the map.
4218 The functions taking a set compute a bound over all elements in the
4219 intersection of the set and the domain of the
4220 piecewise quasipolynomial reduction.
4222 =head2 Dependence Analysis
4224 C<isl> contains specialized functionality for performing
4225 array dataflow analysis. That is, given a I<sink> access relation
4226 and a collection of possible I<source> access relations,
4227 C<isl> can compute relations that describe
4228 for each iteration of the sink access, which iteration
4229 of which of the source access relations was the last
4230 to access the same data element before the given iteration
4232 The resulting dependence relations map source iterations
4233 to the corresponding sink iterations.
4234 To compute standard flow dependences, the sink should be
4235 a read, while the sources should be writes.
4236 If any of the source accesses are marked as being I<may>
4237 accesses, then there will be a dependence from the last
4238 I<must> access B<and> from any I<may> access that follows
4239 this last I<must> access.
4240 In particular, if I<all> sources are I<may> accesses,
4241 then memory based dependence analysis is performed.
4242 If, on the other hand, all sources are I<must> accesses,
4243 then value based dependence analysis is performed.
4245 #include <isl/flow.h>
4247 typedef int (*isl_access_level_before)(void *first, void *second);
4249 __isl_give isl_access_info *isl_access_info_alloc(
4250 __isl_take isl_map *sink,
4251 void *sink_user, isl_access_level_before fn,
4253 __isl_give isl_access_info *isl_access_info_add_source(
4254 __isl_take isl_access_info *acc,
4255 __isl_take isl_map *source, int must,
4257 void *isl_access_info_free(__isl_take isl_access_info *acc);
4259 __isl_give isl_flow *isl_access_info_compute_flow(
4260 __isl_take isl_access_info *acc);
4262 int isl_flow_foreach(__isl_keep isl_flow *deps,
4263 int (*fn)(__isl_take isl_map *dep, int must,
4264 void *dep_user, void *user),
4266 __isl_give isl_map *isl_flow_get_no_source(
4267 __isl_keep isl_flow *deps, int must);
4268 void isl_flow_free(__isl_take isl_flow *deps);
4270 The function C<isl_access_info_compute_flow> performs the actual
4271 dependence analysis. The other functions are used to construct
4272 the input for this function or to read off the output.
4274 The input is collected in an C<isl_access_info>, which can
4275 be created through a call to C<isl_access_info_alloc>.
4276 The arguments to this functions are the sink access relation
4277 C<sink>, a token C<sink_user> used to identify the sink
4278 access to the user, a callback function for specifying the
4279 relative order of source and sink accesses, and the number
4280 of source access relations that will be added.
4281 The callback function has type C<int (*)(void *first, void *second)>.
4282 The function is called with two user supplied tokens identifying
4283 either a source or the sink and it should return the shared nesting
4284 level and the relative order of the two accesses.
4285 In particular, let I<n> be the number of loops shared by
4286 the two accesses. If C<first> precedes C<second> textually,
4287 then the function should return I<2 * n + 1>; otherwise,
4288 it should return I<2 * n>.
4289 The sources can be added to the C<isl_access_info> by performing
4290 (at most) C<max_source> calls to C<isl_access_info_add_source>.
4291 C<must> indicates whether the source is a I<must> access
4292 or a I<may> access. Note that a multi-valued access relation
4293 should only be marked I<must> if every iteration in the domain
4294 of the relation accesses I<all> elements in its image.
4295 The C<source_user> token is again used to identify
4296 the source access. The range of the source access relation
4297 C<source> should have the same dimension as the range
4298 of the sink access relation.
4299 The C<isl_access_info_free> function should usually not be
4300 called explicitly, because it is called implicitly by
4301 C<isl_access_info_compute_flow>.
4303 The result of the dependence analysis is collected in an
4304 C<isl_flow>. There may be elements of
4305 the sink access for which no preceding source access could be
4306 found or for which all preceding sources are I<may> accesses.
4307 The relations containing these elements can be obtained through
4308 calls to C<isl_flow_get_no_source>, the first with C<must> set
4309 and the second with C<must> unset.
4310 In the case of standard flow dependence analysis,
4311 with the sink a read and the sources I<must> writes,
4312 the first relation corresponds to the reads from uninitialized
4313 array elements and the second relation is empty.
4314 The actual flow dependences can be extracted using
4315 C<isl_flow_foreach>. This function will call the user-specified
4316 callback function C<fn> for each B<non-empty> dependence between
4317 a source and the sink. The callback function is called
4318 with four arguments, the actual flow dependence relation
4319 mapping source iterations to sink iterations, a boolean that
4320 indicates whether it is a I<must> or I<may> dependence, a token
4321 identifying the source and an additional C<void *> with value
4322 equal to the third argument of the C<isl_flow_foreach> call.
4323 A dependence is marked I<must> if it originates from a I<must>
4324 source and if it is not followed by any I<may> sources.
4326 After finishing with an C<isl_flow>, the user should call
4327 C<isl_flow_free> to free all associated memory.
4329 A higher-level interface to dependence analysis is provided
4330 by the following function.
4332 #include <isl/flow.h>
4334 int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
4335 __isl_take isl_union_map *must_source,
4336 __isl_take isl_union_map *may_source,
4337 __isl_take isl_union_map *schedule,
4338 __isl_give isl_union_map **must_dep,
4339 __isl_give isl_union_map **may_dep,
4340 __isl_give isl_union_map **must_no_source,
4341 __isl_give isl_union_map **may_no_source);
4343 The arrays are identified by the tuple names of the ranges
4344 of the accesses. The iteration domains by the tuple names
4345 of the domains of the accesses and of the schedule.
4346 The relative order of the iteration domains is given by the
4347 schedule. The relations returned through C<must_no_source>
4348 and C<may_no_source> are subsets of C<sink>.
4349 Any of C<must_dep>, C<may_dep>, C<must_no_source>
4350 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
4351 any of the other arguments is treated as an error.
4353 =head3 Interaction with Dependence Analysis
4355 During the dependence analysis, we frequently need to perform
4356 the following operation. Given a relation between sink iterations
4357 and potential source iterations from a particular source domain,
4358 what is the last potential source iteration corresponding to each
4359 sink iteration. It can sometimes be convenient to adjust
4360 the set of potential source iterations before or after each such operation.
4361 The prototypical example is fuzzy array dataflow analysis,
4362 where we need to analyze if, based on data-dependent constraints,
4363 the sink iteration can ever be executed without one or more of
4364 the corresponding potential source iterations being executed.
4365 If so, we can introduce extra parameters and select an unknown
4366 but fixed source iteration from the potential source iterations.
4367 To be able to perform such manipulations, C<isl> provides the following
4370 #include <isl/flow.h>
4372 typedef __isl_give isl_restriction *(*isl_access_restrict)(
4373 __isl_keep isl_map *source_map,
4374 __isl_keep isl_set *sink, void *source_user,
4376 __isl_give isl_access_info *isl_access_info_set_restrict(
4377 __isl_take isl_access_info *acc,
4378 isl_access_restrict fn, void *user);
4380 The function C<isl_access_info_set_restrict> should be called
4381 before calling C<isl_access_info_compute_flow> and registers a callback function
4382 that will be called any time C<isl> is about to compute the last
4383 potential source. The first argument is the (reverse) proto-dependence,
4384 mapping sink iterations to potential source iterations.
4385 The second argument represents the sink iterations for which
4386 we want to compute the last source iteration.
4387 The third argument is the token corresponding to the source
4388 and the final argument is the token passed to C<isl_access_info_set_restrict>.
4389 The callback is expected to return a restriction on either the input or
4390 the output of the operation computing the last potential source.
4391 If the input needs to be restricted then restrictions are needed
4392 for both the source and the sink iterations. The sink iterations
4393 and the potential source iterations will be intersected with these sets.
4394 If the output needs to be restricted then only a restriction on the source
4395 iterations is required.
4396 If any error occurs, the callback should return C<NULL>.
4397 An C<isl_restriction> object can be created, freed and inspected
4398 using the following functions.
4400 #include <isl/flow.h>
4402 __isl_give isl_restriction *isl_restriction_input(
4403 __isl_take isl_set *source_restr,
4404 __isl_take isl_set *sink_restr);
4405 __isl_give isl_restriction *isl_restriction_output(
4406 __isl_take isl_set *source_restr);
4407 __isl_give isl_restriction *isl_restriction_none(
4408 __isl_take isl_map *source_map);
4409 __isl_give isl_restriction *isl_restriction_empty(
4410 __isl_take isl_map *source_map);
4411 void *isl_restriction_free(
4412 __isl_take isl_restriction *restr);
4413 isl_ctx *isl_restriction_get_ctx(
4414 __isl_keep isl_restriction *restr);
4416 C<isl_restriction_none> and C<isl_restriction_empty> are special
4417 cases of C<isl_restriction_input>. C<isl_restriction_none>
4418 is essentially equivalent to
4420 isl_restriction_input(isl_set_universe(
4421 isl_space_range(isl_map_get_space(source_map))),
4423 isl_space_domain(isl_map_get_space(source_map))));
4425 whereas C<isl_restriction_empty> is essentially equivalent to
4427 isl_restriction_input(isl_set_empty(
4428 isl_space_range(isl_map_get_space(source_map))),
4430 isl_space_domain(isl_map_get_space(source_map))));
4434 B<The functionality described in this section is fairly new
4435 and may be subject to change.>
4437 The following function can be used to compute a schedule
4438 for a union of domains.
4439 By default, the algorithm used to construct the schedule is similar
4440 to that of C<Pluto>.
4441 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
4443 The generated schedule respects all C<validity> dependences.
4444 That is, all dependence distances over these dependences in the
4445 scheduled space are lexicographically positive.
4446 The default algorithm tries to minimize the dependence distances over
4447 C<proximity> dependences.
4448 Moreover, it tries to obtain sequences (bands) of schedule dimensions
4449 for groups of domains where the dependence distances have only
4450 non-negative values.
4451 When using Feautrier's algorithm, the C<proximity> dependence
4452 distances are only minimized during the extension to a
4453 full-dimensional schedule.
4455 #include <isl/schedule.h>
4456 __isl_give isl_schedule *isl_union_set_compute_schedule(
4457 __isl_take isl_union_set *domain,
4458 __isl_take isl_union_map *validity,
4459 __isl_take isl_union_map *proximity);
4460 void *isl_schedule_free(__isl_take isl_schedule *sched);
4462 A mapping from the domains to the scheduled space can be obtained
4463 from an C<isl_schedule> using the following function.
4465 __isl_give isl_union_map *isl_schedule_get_map(
4466 __isl_keep isl_schedule *sched);
4468 A representation of the schedule can be printed using
4470 __isl_give isl_printer *isl_printer_print_schedule(
4471 __isl_take isl_printer *p,
4472 __isl_keep isl_schedule *schedule);
4474 A representation of the schedule as a forest of bands can be obtained
4475 using the following function.
4477 __isl_give isl_band_list *isl_schedule_get_band_forest(
4478 __isl_keep isl_schedule *schedule);
4480 The individual bands can be visited in depth-first post-order
4481 using the following function.
4483 #include <isl/schedule.h>
4484 int isl_schedule_foreach_band(
4485 __isl_keep isl_schedule *sched,
4486 int (*fn)(__isl_keep isl_band *band, void *user),
4489 The list can be manipulated as explained in L<"Lists">.
4490 The bands inside the list can be copied and freed using the following
4493 #include <isl/band.h>
4494 __isl_give isl_band *isl_band_copy(
4495 __isl_keep isl_band *band);
4496 void *isl_band_free(__isl_take isl_band *band);
4498 Each band contains zero or more scheduling dimensions.
4499 These are referred to as the members of the band.
4500 The section of the schedule that corresponds to the band is
4501 referred to as the partial schedule of the band.
4502 For those nodes that participate in a band, the outer scheduling
4503 dimensions form the prefix schedule, while the inner scheduling
4504 dimensions form the suffix schedule.
4505 That is, if we take a cut of the band forest, then the union of
4506 the concatenations of the prefix, partial and suffix schedules of
4507 each band in the cut is equal to the entire schedule (modulo
4508 some possible padding at the end with zero scheduling dimensions).
4509 The properties of a band can be inspected using the following functions.
4511 #include <isl/band.h>
4512 isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
4514 int isl_band_has_children(__isl_keep isl_band *band);
4515 __isl_give isl_band_list *isl_band_get_children(
4516 __isl_keep isl_band *band);
4518 __isl_give isl_union_map *isl_band_get_prefix_schedule(
4519 __isl_keep isl_band *band);
4520 __isl_give isl_union_map *isl_band_get_partial_schedule(
4521 __isl_keep isl_band *band);
4522 __isl_give isl_union_map *isl_band_get_suffix_schedule(
4523 __isl_keep isl_band *band);
4525 int isl_band_n_member(__isl_keep isl_band *band);
4526 int isl_band_member_is_zero_distance(
4527 __isl_keep isl_band *band, int pos);
4529 int isl_band_list_foreach_band(
4530 __isl_keep isl_band_list *list,
4531 int (*fn)(__isl_keep isl_band *band, void *user),
4534 Note that a scheduling dimension is considered to be ``zero
4535 distance'' if it does not carry any proximity dependences
4537 That is, if the dependence distances of the proximity
4538 dependences are all zero in that direction (for fixed
4539 iterations of outer bands).
4540 Like C<isl_schedule_foreach_band>,
4541 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
4542 in depth-first post-order.
4544 A band can be tiled using the following function.
4546 #include <isl/band.h>
4547 int isl_band_tile(__isl_keep isl_band *band,
4548 __isl_take isl_vec *sizes);
4550 int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
4552 int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
4554 The C<isl_band_tile> function tiles the band using the given tile sizes
4555 inside its schedule.
4556 A new child band is created to represent the point loops and it is
4557 inserted between the modified band and its children.
4558 The C<tile_scale_tile_loops> option specifies whether the tile
4559 loops iterators should be scaled by the tile sizes.
4561 A representation of the band can be printed using
4563 #include <isl/band.h>
4564 __isl_give isl_printer *isl_printer_print_band(
4565 __isl_take isl_printer *p,
4566 __isl_keep isl_band *band);
4570 #include <isl/schedule.h>
4571 int isl_options_set_schedule_max_coefficient(
4572 isl_ctx *ctx, int val);
4573 int isl_options_get_schedule_max_coefficient(
4575 int isl_options_set_schedule_max_constant_term(
4576 isl_ctx *ctx, int val);
4577 int isl_options_get_schedule_max_constant_term(
4579 int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
4580 int isl_options_get_schedule_fuse(isl_ctx *ctx);
4581 int isl_options_set_schedule_maximize_band_depth(
4582 isl_ctx *ctx, int val);
4583 int isl_options_get_schedule_maximize_band_depth(
4585 int isl_options_set_schedule_outer_zero_distance(
4586 isl_ctx *ctx, int val);
4587 int isl_options_get_schedule_outer_zero_distance(
4589 int isl_options_set_schedule_split_scaled(
4590 isl_ctx *ctx, int val);
4591 int isl_options_get_schedule_split_scaled(
4593 int isl_options_set_schedule_algorithm(
4594 isl_ctx *ctx, int val);
4595 int isl_options_get_schedule_algorithm(
4597 int isl_options_set_schedule_separate_components(
4598 isl_ctx *ctx, int val);
4599 int isl_options_get_schedule_separate_components(
4604 =item * schedule_max_coefficient
4606 This option enforces that the coefficients for variable and parameter
4607 dimensions in the calculated schedule are not larger than the specified value.
4608 This option can significantly increase the speed of the scheduling calculation
4609 and may also prevent fusing of unrelated dimensions. A value of -1 means that
4610 this option does not introduce bounds on the variable or parameter
4613 =item * schedule_max_constant_term
4615 This option enforces that the constant coefficients in the calculated schedule
4616 are not larger than the maximal constant term. This option can significantly
4617 increase the speed of the scheduling calculation and may also prevent fusing of
4618 unrelated dimensions. A value of -1 means that this option does not introduce
4619 bounds on the constant coefficients.
4621 =item * schedule_fuse
4623 This option controls the level of fusion.
4624 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
4625 resulting schedule will be distributed as much as possible.
4626 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
4627 try to fuse loops in the resulting schedule.
4629 =item * schedule_maximize_band_depth
4631 If this option is set, we do not split bands at the point
4632 where we detect splitting is necessary. Instead, we
4633 backtrack and split bands as early as possible. This
4634 reduces the number of splits and maximizes the width of
4635 the bands. Wider bands give more possibilities for tiling.
4636 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
4637 then bands will be split as early as possible, even if there is no need.
4638 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
4640 =item * schedule_outer_zero_distance
4642 If this option is set, then we try to construct schedules
4643 where the outermost scheduling dimension in each band
4644 results in a zero dependence distance over the proximity
4647 =item * schedule_split_scaled
4649 If this option is set, then we try to construct schedules in which the
4650 constant term is split off from the linear part if the linear parts of
4651 the scheduling rows for all nodes in the graphs have a common non-trivial
4653 The constant term is then placed in a separate band and the linear
4656 =item * schedule_algorithm
4658 Selects the scheduling algorithm to be used.
4659 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
4660 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
4662 =item * schedule_separate_components
4664 If at any point the dependence graph contains any (weakly connected) components,
4665 then these components are scheduled separately.
4666 If this option is not set, then some iterations of the domains
4667 in these components may be scheduled together.
4668 If this option is set, then the components are given consecutive
4673 =head2 Parametric Vertex Enumeration
4675 The parametric vertex enumeration described in this section
4676 is mainly intended to be used internally and by the C<barvinok>
4679 #include <isl/vertices.h>
4680 __isl_give isl_vertices *isl_basic_set_compute_vertices(
4681 __isl_keep isl_basic_set *bset);
4683 The function C<isl_basic_set_compute_vertices> performs the
4684 actual computation of the parametric vertices and the chamber
4685 decomposition and store the result in an C<isl_vertices> object.
4686 This information can be queried by either iterating over all
4687 the vertices or iterating over all the chambers or cells
4688 and then iterating over all vertices that are active on the chamber.
4690 int isl_vertices_foreach_vertex(
4691 __isl_keep isl_vertices *vertices,
4692 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4695 int isl_vertices_foreach_cell(
4696 __isl_keep isl_vertices *vertices,
4697 int (*fn)(__isl_take isl_cell *cell, void *user),
4699 int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
4700 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4703 Other operations that can be performed on an C<isl_vertices> object are
4706 isl_ctx *isl_vertices_get_ctx(
4707 __isl_keep isl_vertices *vertices);
4708 int isl_vertices_get_n_vertices(
4709 __isl_keep isl_vertices *vertices);
4710 void isl_vertices_free(__isl_take isl_vertices *vertices);
4712 Vertices can be inspected and destroyed using the following functions.
4714 isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
4715 int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
4716 __isl_give isl_basic_set *isl_vertex_get_domain(
4717 __isl_keep isl_vertex *vertex);
4718 __isl_give isl_basic_set *isl_vertex_get_expr(
4719 __isl_keep isl_vertex *vertex);
4720 void isl_vertex_free(__isl_take isl_vertex *vertex);
4722 C<isl_vertex_get_expr> returns a singleton parametric set describing
4723 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4725 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4726 B<rational> basic sets, so they should mainly be used for inspection
4727 and should not be mixed with integer sets.
4729 Chambers can be inspected and destroyed using the following functions.
4731 isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4732 __isl_give isl_basic_set *isl_cell_get_domain(
4733 __isl_keep isl_cell *cell);
4734 void isl_cell_free(__isl_take isl_cell *cell);
4738 Although C<isl> is mainly meant to be used as a library,
4739 it also contains some basic applications that use some
4740 of the functionality of C<isl>.
4741 The input may be specified in either the L<isl format>
4742 or the L<PolyLib format>.
4744 =head2 C<isl_polyhedron_sample>
4746 C<isl_polyhedron_sample> takes a polyhedron as input and prints
4747 an integer element of the polyhedron, if there is any.
4748 The first column in the output is the denominator and is always
4749 equal to 1. If the polyhedron contains no integer points,
4750 then a vector of length zero is printed.
4754 C<isl_pip> takes the same input as the C<example> program
4755 from the C<piplib> distribution, i.e., a set of constraints
4756 on the parameters, a line containing only -1 and finally a set
4757 of constraints on a parametric polyhedron.
4758 The coefficients of the parameters appear in the last columns
4759 (but before the final constant column).
4760 The output is the lexicographic minimum of the parametric polyhedron.
4761 As C<isl> currently does not have its own output format, the output
4762 is just a dump of the internal state.
4764 =head2 C<isl_polyhedron_minimize>
4766 C<isl_polyhedron_minimize> computes the minimum of some linear
4767 or affine objective function over the integer points in a polyhedron.
4768 If an affine objective function
4769 is given, then the constant should appear in the last column.
4771 =head2 C<isl_polytope_scan>
4773 Given a polytope, C<isl_polytope_scan> prints
4774 all integer points in the polytope.