doc/user.pod

   1 =head1 Introduction
   2
   3 C<isl> is a thread-safe C library for manipulating
   4 sets and relations of integer points bounded by affine constraints.
   5 The descriptions of the sets and relations may involve
   6 both parameters and existentially quantified variables.
   7 All computations are performed in exact integer arithmetic
   8 using C<GMP>.
   9 The C<isl> library offers functionality that is similar
  10 to that offered by the C<Omega> and C<Omega+> libraries,
  11 but the underlying algorithms are in most cases completely different.
  12
  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
  20 =head1 Installation
  21
  22 The source of C<isl> can be obtained either as a tarball
  23 or from the git repository.  Both are available from
  24 L<http://freshmeat.net/projects/isl/>.
  25 The installation process depends on how you obtained
  26 the source.
  27
  28 =head2 Installation from the git repository
  29
  30 =over
  31
  32 =item 1 Clone or update the repository
  33
  34 The first time the source is obtained, you need to clone
  35 the repository.
  36
  37         git clone git://repo.or.cz/isl.git
  38
  39 To obtain updates, you need to pull in the latest changes
  40
  41         git pull
  42
  43 =item 2 Get submodule (optional)
  44
  45 C<isl> can optionally use the C<piplib> library and provides
  46 this library as a submodule.  If you want to use it, then
  47 after you have cloned C<isl>, you need to grab the submodules
  48
  49         git submodule init
  50         git submodule update
  51
  52 To obtain updates, you only need
  53
  54         git submodule update
  55
  56 Note that C<isl> currently does not use any C<piplib>
  57 functionality by default.
  58
  59 =item 3 Generate C<configure>
  60
  61         ./autogen.sh
  62
  63 =back
  64
  65 After performing the above steps, continue
  66 with the L<Common installation instructions>.
  67
  68 =head2 Common installation instructions
  69
  70 =over
  71
  72 =item 1 Obtain C<GMP>
  73
  74 Building C<isl> requires C<GMP>, including its headers files.
  75 Your distribution may not provide these header files by default
  76 and you may need to install a package called C<gmp-devel> or something
  77 similar.  Alternatively, C<GMP> can be built from
  78 source, available from L<http://gmplib.org/>.
  79
  80 =item 2 Configure
  81
  82 C<isl> uses the standard C<autoconf> C<configure> script.
  83 To run it, just type
  84
  85         ./configure
  86
  87 optionally followed by some configure options.
  88 A complete list of options can be obtained by running
  89
  90         ./configure --help
  91
  92 Below we discuss some of the more common options.
  93
  94 C<isl> can optionally use C<piplib>, but no
  95 C<piplib> functionality is currently used by default.
  96 The C<--with-piplib> option can
  97 be used to specify which C<piplib>
  98 library to use, either an installed version (C<system>),
  99 an externally built version (C<build>), a bundled version (C<bundled>)
 100 or no version (C<no>).  The option C<build> is mostly useful
 101 in C<configure> scripts of larger projects that bundle both C<isl>
 102 and C<piplib>.
 103
 104 =over
 105
 106 =item C<--prefix>
 107
 108 Installation prefix for C<isl>
 109
 110 =item C<--with-gmp-prefix>
 111
 112 Installation prefix for C<GMP> (architecture-independent files).
 113
 114 =item C<--with-gmp-exec-prefix>
 115
 116 Installation prefix for C<GMP> (architecture-dependent files).
 117
 118 =item C<--with-piplib>
 119
 120 Which copy of C<piplib> to use, either C<no> (default), C<system>, C<build>
 121 or C<bundled>.  Note that C<bundled> only works if you have obtained
 122 C<isl> and its submodules from the git repository.
 123
 124 =item C<--with-piplib-prefix>
 125
 126 Installation prefix for C<system> C<piplib> (architecture-independent files).
 127
 128 =item C<--with-piplib-exec-prefix>
 129
 130 Installation prefix for C<system> C<piplib> (architecture-dependent files).
 131
 132 =item C<--with-piplib-builddir>
 133
 134 Location where C<build> C<piplib> was built.
 135
 136 =back
 137
 138 =item 3 Compile
 139
 140         make
 141
 142 =item 4 Install (optional)
 143
 144         make install
 145
 146 =back
 147
 148 =head1 Library
 149
 150 =head2 Initialization
 151
 152 All manipulations of integer sets and relations occur within
 153 the context of an C<isl_ctx>.
 154 A given C<isl_ctx> can only be used within a single thread.
 155 All arguments of a function are required to have been allocated
 156 within the same context.
 157 There are currently no functions available for moving an object
 158 from one C<isl_ctx> to another C<isl_ctx>.  This means that
 159 there is currently no way of safely moving an object from one
 160 thread to another, unless the whole C<isl_ctx> is moved.
 161
 162 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
 163 freed using C<isl_ctx_free>.
 164 All objects allocated within an C<isl_ctx> should be freed
 165 before the C<isl_ctx> itself is freed.
 166
 167         isl_ctx *isl_ctx_alloc();
 168         void isl_ctx_free(isl_ctx *ctx);
 169
 170 =head2 Integers
 171
 172 All operations on integers, mainly the coefficients
 173 of the constraints describing the sets and relations,
 174 are performed in exact integer arithmetic using C<GMP>.
 175 However, to allow future versions of C<isl> to optionally
 176 support fixed integer arithmetic, all calls to C<GMP>
 177 are wrapped inside C<isl> specific macros.
 178 The basic type is C<isl_int> and the following operations
 179 are available on this type.
 180 The meanings of these operations are essentially the same
 181 as their C<GMP> C<mpz_> counterparts.
 182 As always with C<GMP> types, C<isl_int>s need to be
 183 initialized with C<isl_int_init> before they can be used
 184 and they need to be released with C<isl_int_clear>
 185 after the last use.
 186
 187 =over
 188
 189 =item isl_int_init(i)
 190
 191 =item isl_int_clear(i)
 192
 193 =item isl_int_set(r,i)
 194
 195 =item isl_int_set_si(r,i)
 196
 197 =item isl_int_abs(r,i)
 198
 199 =item isl_int_neg(r,i)
 200
 201 =item isl_int_swap(i,j)
 202
 203 =item isl_int_swap_or_set(i,j)
 204
 205 =item isl_int_add_ui(r,i,j)
 206
 207 =item isl_int_sub_ui(r,i,j)
 208
 209 =item isl_int_add(r,i,j)
 210
 211 =item isl_int_sub(r,i,j)
 212
 213 =item isl_int_mul(r,i,j)
 214
 215 =item isl_int_mul_ui(r,i,j)
 216
 217 =item isl_int_addmul(r,i,j)
 218
 219 =item isl_int_submul(r,i,j)
 220
 221 =item isl_int_gcd(r,i,j)
 222
 223 =item isl_int_lcm(r,i,j)
 224
 225 =item isl_int_divexact(r,i,j)
 226
 227 =item isl_int_cdiv_q(r,i,j)
 228
 229 =item isl_int_fdiv_q(r,i,j)
 230
 231 =item isl_int_fdiv_r(r,i,j)
 232
 233 =item isl_int_fdiv_q_ui(r,i,j)
 234
 235 =item isl_int_read(r,s)
 236
 237 =item isl_int_print(out,i,width)
 238
 239 =item isl_int_sgn(i)
 240
 241 =item isl_int_cmp(i,j)
 242
 243 =item isl_int_cmp_si(i,si)
 244
 245 =item isl_int_eq(i,j)
 246
 247 =item isl_int_ne(i,j)
 248
 249 =item isl_int_lt(i,j)
 250
 251 =item isl_int_le(i,j)
 252
 253 =item isl_int_gt(i,j)
 254
 255 =item isl_int_ge(i,j)
 256
 257 =item isl_int_abs_eq(i,j)
 258
 259 =item isl_int_abs_ne(i,j)
 260
 261 =item isl_int_abs_lt(i,j)
 262
 263 =item isl_int_abs_gt(i,j)
 264
 265 =item isl_int_abs_ge(i,j)
 266
 267 =item isl_int_is_zero(i)
 268
 269 =item isl_int_is_one(i)
 270
 271 =item isl_int_is_negone(i)
 272
 273 =item isl_int_is_pos(i)
 274
 275 =item isl_int_is_neg(i)
 276
 277 =item isl_int_is_nonpos(i)
 278
 279 =item isl_int_is_nonneg(i)
 280
 281 =item isl_int_is_divisible_by(i,j)
 282
 283 =back
 284
 285 =head2 Sets and Relations
 286
 287 C<isl> uses four types of objects for representing sets and relations,
 288 C<isl_basic_set>, C<isl_basic_map>, C<isl_set> and C<isl_map>.
 289 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
 290 can be described as a conjunction of affine constraints, while
 291 C<isl_set> and C<isl_map> represent unions of
 292 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
 293 The difference between sets and relations (maps) is that sets have
 294 one set of variables, while relations have two sets of variables,
 295 input variables and output variables.
 296
 297 =head2 Memory Management
 298
 299 Since a high-level operation on sets and/or relations usually involves
 300 several substeps and since the user is usually not interested in
 301 the intermediate results, most functions that return a new object
 302 will also release all the objects passed as arguments.
 303 If the user still wants to use one or more of these arguments
 304 after the function call, she should pass along a copy of the
 305 object rather than the object itself.
 306 The user is then responsible for make sure that the original
 307 object gets used somewhere else or is explicitly freed.
 308
 309 The arguments and return values of all documents functions are
 310 annotated to make clear which arguments are released and which
 311 arguments are preserved.  In particular, the following annotations
 312 are used
 313
 314 =over
 315
 316 =item C<__isl_give>
 317
 318 C<__isl_give> means that a new object is returned.
 319 The user should make sure that the returned pointer is
 320 used exactly once as a value for an C<__isl_take> argument.
 321 In between, it can be used as a value for as many
 322 C<__isl_keep> arguments as the user likes.
 323 There is one exception, and that is the case where the
 324 pointer returned is C<NULL>.  Is this case, the user
 325 is free to use it as an C<__isl_take> argument or not.
 326
 327 =item C<__isl_take>
 328
 329 C<__isl_take> means that the object the argument points to
 330 is taken over by the function and may no longer be used
 331 by the user as an argument to any other function.
 332 The pointer value must be one returned by a function
 333 returning an C<__isl_give> pointer.
 334 If the user passes in a C<NULL> value, then this will
 335 be treated as an error in the sense that the function will
 336 not perform its usual operation.  However, it will still
 337 make sure that all the the other C<__isl_take> arguments
 338 are released.
 339
 340 =item C<__isl_keep>
 341
 342 C<__isl_keep> means that the function will only use the object
 343 temporarily.  After the function has finished, the user
 344 can still use it as an argument to other functions.
 345 A C<NULL> value will be treated in the same way as
 346 a C<NULL> value for an C<__isl_take> argument.
 347
 348 =back
 349
 350 =head2 Dimension Specifications
 351
 352 Whenever a new set or relation is created from scratch,
 353 its dimension needs to be specified using an C<isl_dim>.
 354
 355         #include <isl_dim.h>
 356         __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
 357                 unsigned nparam, unsigned n_in, unsigned n_out);
 358         __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
 359                 unsigned nparam, unsigned dim);
 360         __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
 361         void isl_dim_free(__isl_take isl_dim *dim);
 362         unsigned isl_dim_size(__isl_keep isl_dim *dim,
 363                 enum isl_dim_type type);
 364
 365 The dimension specification used for creating a set
 366 needs to be created using C<isl_dim_set_alloc>, while
 367 that for creating a relation
 368 needs to be created using C<isl_dim_alloc>.
 369 C<isl_dim_size> can be used
 370 to find out the number of dimensions of each type in
 371 a dimension specification, where type may be
 372 C<isl_dim_param>, C<isl_dim_in> (only for relations),
 373 C<isl_dim_out> (only for relations), C<isl_dim_set>
 374 (only for sets) or C<isl_dim_all>.
 375
 376 =head2 Input and Output
 377
 378 C<isl> supports its own input/output format, which is similar
 379 to the C<Omega> format, but also supports the C<PolyLib> format
 380 in some cases.
 381
 382 =head3 C<isl> format
 383
 384 The C<isl> format is similar to that of C<Omega>, but has a different
 385 syntax for describing the parameters and allows for the definition
 386 of an existentially quantified variable as the integer division
 387 of an affine expression.
 388 For example, the set of integers C<i> between C<0> and C<n>
 389 such that C<i % 10 <= 6> can be described as
 390
 391         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
 392                                 i - 10 a <= 6) }
 393
 394 A set or relation can have several disjuncts, separated
 395 by the keyword C<or>.  Each disjunct is either a conjunction
 396 of constraints or a projection (C<exists>) of a conjunction
 397 of constraints.  The constraints are separated by the keyword
 398 C<and>.
 399
 400 =head3 C<PolyLib> format
 401
 402 If the represented set is a union, then the first line
 403 contains a single number representing the number of disjuncts.
 404 Otherwise, a line containing the number C<1> is optional.
 405
 406 Each disjunct is represented by a matrix of constraints.
 407 The first line contains two numbers representing
 408 the number of rows and columns,
 409 where the number of rows is equal to the number of constraints
 410 and the number of columns is equal to two plus the number of variables.
 411 The following lines contain the actual rows of the constraint matrix.
 412 In each row, the first column indicates whether the constraint
 413 is an equality (C<0>) or inequality (C<1>).  The final column
 414 corresponds to the constant term.
 415
 416 If the set is parametric, then the coefficients of the parameters
 417 appear in the last columns before the constant column.
 418 The coefficients of any existentially quantified variables appear
 419 between those of the set variables and those of the parameters.
 420
 421 =head3 Input
 422
 423         #include <isl_set.h>
 424         __isl_give isl_basic_set *isl_basic_set_read_from_file(
 425                 isl_ctx *ctx, FILE *input, int nparam);
 426         __isl_give isl_basic_set *isl_basic_set_read_from_str(
 427                 isl_ctx *ctx, const char *str, int nparam);
 428         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
 429                 FILE *input, int nparam);
 430         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
 431                 const char *str, int nparam);
 432
 433         #include <isl_map.h>
 434         __isl_give isl_basic_map *isl_basic_map_read_from_file(
 435                 isl_ctx *ctx, FILE *input, int nparam);
 436         __isl_give isl_basic_map *isl_basic_map_read_from_str(
 437                 isl_ctx *ctx, const char *str, int nparam);
 438         __isl_give isl_map *isl_map_read_from_file(
 439                 struct isl_ctx *ctx, FILE *input, int nparam);
 440         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
 441                 const char *str, int nparam);
 442
 443 The input format is autodetected and may be either the C<PolyLib> format
 444 or the C<isl> format.
 445 C<nparam> specifies how many of the final columns in
 446 the C<PolyLib> format correspond to parameters.
 447 If input is given in the C<isl> format, then the number
 448 of parameters needs to be equal to C<nparam>.
 449 If C<nparam> is negative, then any number of parameters
 450 is accepted in the C<isl> format and zero parameters
 451 are assumed in the C<PolyLib> format.
 452
 453 =head3 Output
 454
 455         #include <isl_set.h>
 456         void isl_basic_set_print(__isl_keep isl_basic_set *bset,
 457                 FILE *out, int indent,
 458                 const char *prefix, const char *suffix,
 459                 unsigned output_format);
 460         void isl_set_print(__isl_keep struct isl_set *set,
 461                 FILE *out, int indent, unsigned output_format);
 462
 463         #include <isl_map.h>
 464         void isl_basic_map_print(__isl_keep isl_basic_map *bmap,
 465                 FILE *out, int indent,
 466                 const char *prefix, const char *suffix,
 467                 unsigned output_format);
 468         void isl_map_print(__isl_keep struct isl_map *map,
 469                 FILE *out, int indent, unsigned output_format);
 470
 471 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>
 472 or C<ISL_FORMAT_POLYLIB>.
 473 Each line in the output is indented by C<indent> spaces,
 474 prefixed by C<prefix> and suffixed by C<suffix>.
 475 In the C<PolyLib> format output,
 476 the coefficients of the existentially quantified variables
 477 appear between those of the set variables and those
 478 of the parameters.
 479
 480 =head2 Creating New Sets and Relations
 481
 482 C<isl> has functions for creating some standard sets and relations.
 483
 484 =over
 485
 486 =item * Empty sets and relations
 487
 488         __isl_give isl_basic_set *isl_basic_set_empty(
 489                 __isl_take isl_dim *dim);
 490         __isl_give isl_basic_map *isl_basic_map_empty(
 491                 __isl_take isl_dim *dim);
 492         __isl_give isl_set *isl_set_empty(
 493                 __isl_take isl_dim *dim);
 494         __isl_give isl_map *isl_map_empty(
 495                 __isl_take isl_dim *dim);
 496
 497 =item * Universe sets and relations
 498
 499         __isl_give isl_basic_set *isl_basic_set_universe(
 500                 __isl_take isl_dim *dim);
 501         __isl_give isl_basic_map *isl_basic_map_universe(
 502                 __isl_take isl_dim *dim);
 503         __isl_give isl_set *isl_set_universe(
 504                 __isl_take isl_dim *dim);
 505         __isl_give isl_map *isl_map_universe(
 506                 __isl_take isl_dim *dim);
 507
 508 =item * Identity relations
 509
 510         __isl_give isl_basic_map *isl_basic_map_identity(
 511                 __isl_take isl_dim *set_dim);
 512         __isl_give isl_map *isl_map_identity(
 513                 __isl_take isl_dim *set_dim);
 514
 515 These functions take a dimension specification for a B<set>
 516 and return an identity relation between two such sets.
 517
 518 =item * Lexicographic order
 519
 520         __isl_give isl_map *isl_map_lex_lt(
 521                 __isl_take isl_dim *set_dim);
 522         __isl_give isl_map *isl_map_lex_le(
 523                 __isl_take isl_dim *set_dim);
 524         __isl_give isl_map *isl_map_lex_gt(
 525                 __isl_take isl_dim *set_dim);
 526         __isl_give isl_map *isl_map_lex_ge(
 527                 __isl_take isl_dim *set_dim);
 528
 529 These functions take a dimension specification for a B<set>
 530 and return relations that express that the elements in the domain
 531 are lexicographically less
 532 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
 533 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
 534 than the elements in the range.
 535
 536 =back
 537
 538 A basic set or relation can be converted to a set or relation
 539 using the following functions.
 540
 541         __isl_give isl_set *isl_set_from_basic_set(
 542                 __isl_take isl_basic_set *bset);
 543         __isl_give isl_map *isl_map_from_basic_map(
 544                 __isl_take isl_basic_map *bmap);
 545
 546 Sets and relations can be copied and freed again using the following
 547 functions.
 548
 549         __isl_give isl_basic_set *isl_basic_set_copy(
 550                 __isl_keep isl_basic_set *bset);
 551         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
 552         __isl_give isl_basic_map *isl_basic_map_copy(
 553                 __isl_keep isl_basic_map *bmap);
 554         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
 555         void isl_basic_set_free(__isl_take isl_basic_set *bset);
 556         void isl_set_free(__isl_take isl_set *set);
 557         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
 558         void isl_map_free(__isl_take isl_map *map);
 559
 560 Other sets and relations can be constructed by starting
 561 from a universe set or relation, adding equality and/or
 562 inequality constraints and then projecting out the
 563 existentially quantified variables, if any.
 564 Constraints can be constructed, manipulated and
 565 added to basic sets and relations using the following functions.
 566
 567         #include <isl_constraint.h>
 568         __isl_give isl_constraint *isl_equality_alloc(
 569                 __isl_take isl_dim *dim);
 570         __isl_give isl_constraint *isl_inequality_alloc(
 571                 __isl_take isl_dim *dim);
 572         void isl_constraint_set_constant(
 573                 __isl_keep isl_constraint *constraint, isl_int v);
 574         void isl_constraint_set_coefficient(
 575                 __isl_keep isl_constraint *constraint,
 576                 enum isl_dim_type type, int pos, isl_int v);
 577         __isl_give isl_basic_map *isl_basic_map_add_constraint(
 578                 __isl_take isl_basic_map *bmap,
 579                 __isl_take isl_constraint *constraint);
 580         __isl_give isl_basic_set *isl_basic_set_add_constraint(
 581                 __isl_take isl_basic_set *bset,
 582                 __isl_take isl_constraint *constraint);
 583
 584 For example, to create a set containing the even integers
 585 between 10 and 42, you would use the following code.
 586
 587         isl_int v;
 588         struct isl_dim *dim;
 589         struct isl_constraint *c;
 590         struct isl_basic_set *bset;
 591
 592         isl_int_init(v);
 593         dim = isl_dim_set_alloc(ctx, 0, 2);
 594         bset = isl_basic_set_universe(isl_dim_copy(dim));
 595
 596         c = isl_equality_alloc(isl_dim_copy(dim));
 597         isl_int_set_si(v, -1);
 598         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 599         isl_int_set_si(v, 2);
 600         isl_constraint_set_coefficient(c, isl_dim_set, 1, v);
 601         bset = isl_basic_set_add_constraint(bset, c);
 602
 603         c = isl_inequality_alloc(isl_dim_copy(dim));
 604         isl_int_set_si(v, -10);
 605         isl_constraint_set_constant(c, v);
 606         isl_int_set_si(v, 1);
 607         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 608         bset = isl_basic_set_add_constraint(bset, c);
 609
 610         c = isl_inequality_alloc(dim);
 611         isl_int_set_si(v, 42);
 612         isl_constraint_set_constant(c, v);
 613         isl_int_set_si(v, -1);
 614         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 615         bset = isl_basic_set_add_constraint(bset, c);
 616
 617         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
 618
 619         isl_int_clear(v);
 620
 621 Or, alternatively,
 622
 623         struct isl_basic_set *bset;
 624         bset = isl_basic_set_read_from_str(ctx,
 625                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}", -1);
 626
 627 =head2 Inspecting Sets and Relations
 628
 629 Usually, the user should not have to care about the actual constraints
 630 of the sets and maps, but should instead apply the abstract operations
 631 explained in the following sections.
 632 Occasionally, however, it may be required to inspect the individual
 633 coefficients of the constraints.  This section explains how to do so.
 634 In these cases, it may also be useful to have C<isl> compute
 635 an explicit representation of the existentially quantified variables.
 636
 637         __isl_give isl_set *isl_set_compute_divs(
 638                 __isl_take isl_set *set);
 639         __isl_give isl_map *isl_map_compute_divs(
 640                 __isl_take isl_map *map);
 641
 642 This explicit representation defines the existentially quantified
 643 variables as integer divisions of the other variables, possibly
 644 including earlier existentially quantified variables.
 645 An explicitly represented existentially quantified variable therefore
 646 has a unique value when the values of the other variables are known.
 647
 648 To iterate over all the basic sets or maps in a set or map, use
 649
 650         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
 651                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
 652                 void *user);
 653         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
 654                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
 655                 void *user);
 656
 657 The callback function C<fn> should return 0 if successful and
 658 -1 if an error occurs.  In the latter case, or if any other error
 659 occurs, the above functions will return -1.
 660
 661 To iterate over the constraints of a basic set or map, use
 662
 663         #include <isl_constraint.h>
 664
 665         int isl_basic_map_foreach_constraint(
 666                 __isl_keep isl_basic_map *bmap,
 667                 int (*fn)(__isl_take isl_constraint *c, void *user),
 668                 void *user);
 669         void isl_constraint_free(struct isl_constraint *c);
 670
 671 Again, the callback function C<fn> should return 0 if successful and
 672 -1 if an error occurs.  In the latter case, or if any other error
 673 occurs, the above functions will return -1.
 674
 675 The coefficients of the constraints can be inspected using
 676 the following functions.
 677
 678         void isl_constraint_get_constant(
 679                 __isl_keep isl_constraint *constraint, isl_int *v);
 680         void isl_constraint_get_coefficient(
 681                 __isl_keep isl_constraint *constraint,
 682                 enum isl_dim_type type, int pos, isl_int *v);
 683
 684 The explicit representations of the existentially quantified
 685 variables can be inspected using the following functions.
 686 Note that the user is only allowed to use these functions
 687 if the inspected set or map is the result of a call
 688 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
 689
 690         __isl_give isl_div *isl_constraint_div(
 691                 __isl_keep isl_constraint *constraint, int pos);
 692         void isl_div_get_constant(__isl_keep isl_div *div,
 693                 isl_int *v);
 694         void isl_div_get_denominator(__isl_keep isl_div *div,
 695                 isl_int *v);
 696         void isl_div_get_coefficient(__isl_keep isl_div *div,
 697                 enum isl_dim_type type, int pos, isl_int *v);
 698
 699 =head2 Properties
 700
 701 =head3 Unary Properties
 702
 703 =over
 704
 705 =item Emptiness
 706
 707 The following functions test whether the given set or relation
 708 contains any integer points.  The ``fast'' variants do not perform
 709 any computations, but simply check if the given set or relation
 710 is already known to be empty.
 711
 712         int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
 713         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
 714         int isl_set_is_empty(__isl_keep isl_set *set);
 715         int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
 716         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
 717         int isl_map_fast_is_empty(__isl_keep isl_map *map);
 718         int isl_map_is_empty(__isl_keep isl_map *map);
 719
 720 =item * Universality
 721
 722         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
 723         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
 724
 725 =back
 726
 727 =head3 Binary Properties
 728
 729 =over
 730
 731 =item * Equality
 732
 733         int isl_set_fast_is_equal(__isl_keep isl_set *set1,
 734                 __isl_keep isl_set *set2);
 735         int isl_set_is_equal(__isl_keep isl_set *set1,
 736                 __isl_keep isl_set *set2);
 737         int isl_map_is_equal(__isl_keep isl_map *map1,
 738                 __isl_keep isl_map *map2);
 739         int isl_map_fast_is_equal(__isl_keep isl_map *map1,
 740                 __isl_keep isl_map *map2);
 741         int isl_basic_map_is_equal(
 742                 __isl_keep isl_basic_map *bmap1,
 743                 __isl_keep isl_basic_map *bmap2);
 744
 745 =item * Disjointness
 746
 747         int isl_set_fast_is_disjoint(__isl_keep isl_set *set1,
 748                 __isl_keep isl_set *set2);
 749
 750 =item * Subset
 751
 752         int isl_set_is_subset(__isl_keep isl_set *set1,
 753                 __isl_keep isl_set *set2);
 754         int isl_set_is_strict_subset(
 755                 __isl_keep isl_set *set1,
 756                 __isl_keep isl_set *set2);
 757         int isl_basic_map_is_subset(
 758                 __isl_keep isl_basic_map *bmap1,
 759                 __isl_keep isl_basic_map *bmap2);
 760         int isl_basic_map_is_strict_subset(
 761                 __isl_keep isl_basic_map *bmap1,
 762                 __isl_keep isl_basic_map *bmap2);
 763         int isl_map_is_subset(
 764                 __isl_keep isl_map *map1,
 765                 __isl_keep isl_map *map2);
 766         int isl_map_is_strict_subset(
 767                 __isl_keep isl_map *map1,
 768                 __isl_keep isl_map *map2);
 769
 770 =back
 771
 772 =head2 Unary Operations
 773
 774 =over
 775
 776 =item * Projection
 777
 778         __isl_give isl_basic_set *isl_basic_set_project_out(
 779                 __isl_take isl_basic_set *bset,
 780                 enum isl_dim_type type, unsigned first, unsigned n);
 781         __isl_give isl_basic_map *isl_basic_map_project_out(
 782                 __isl_take isl_basic_map *bmap,
 783                 enum isl_dim_type type, unsigned first, unsigned n);
 784         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
 785                 enum isl_dim_type type, unsigned first, unsigned n);
 786         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
 787                 enum isl_dim_type type, unsigned first, unsigned n);
 788         __isl_give isl_basic_set *isl_basic_map_domain(
 789                 __isl_take isl_basic_map *bmap);
 790         __isl_give isl_basic_set *isl_basic_map_range(
 791                 __isl_take isl_basic_map *bmap);
 792         __isl_give isl_set *isl_map_domain(
 793                 __isl_take isl_map *bmap);
 794         __isl_give isl_set *isl_map_range(
 795                 __isl_take isl_map *map);
 796
 797 =item * Coalescing
 798
 799 Simplify the representation of a set or relation by trying
 800 to combine pairs of basic sets or relations into a single
 801 basic set or relation.
 802
 803         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
 804         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
 805
 806 =item * Convex hull
 807
 808         __isl_give isl_basic_set *isl_set_convex_hull(
 809                 __isl_take isl_set *set);
 810         __isl_give isl_basic_map *isl_map_convex_hull(
 811                 __isl_take isl_map *map);
 812
 813 If the input set or relation has any existentially quantified
 814 variables, then the result of these operations is currently undefined.
 815
 816 =item * Affine hull
 817
 818         __isl_give isl_basic_set *isl_basic_set_affine_hull(
 819                 __isl_take isl_basic_set *bset);
 820         __isl_give isl_basic_set *isl_set_affine_hull(
 821                 __isl_take isl_set *set);
 822         __isl_give isl_basic_map *isl_basic_map_affine_hull(
 823                 __isl_take isl_basic_map *bmap);
 824         __isl_give isl_basic_map *isl_map_affine_hull(
 825                 __isl_take isl_map *map);
 826
 827 =item * Power
 828
 829         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
 830                 unsigned param, int *exact);
 831
 832 Compute a parametric representation for all positive powers I<k> of C<map>.
 833 The power I<k> is equated to the parameter at position C<param>.
 834 The result may be an overapproximation.  If the result is exact,
 835 then C<*exact> is set to C<1>.
 836 The current implementation only produces exact results for particular
 837 cases of piecewise translations (i.e., piecewise uniform dependences).
 838
 839 =item * Transitive closure
 840
 841         __isl_give isl_map *isl_map_transitive_closure(
 842                 __isl_take isl_map *map, int *exact);
 843
 844 Compute the transitive closure of C<map>.
 845 The result may be an overapproximation.  If the result is known to be exact,
 846 then C<*exact> is set to C<1>.
 847 The current implementation only produces exact results for particular
 848 cases of piecewise translations (i.e., piecewise uniform dependences).
 849
 850 =back
 851
 852 =head2 Binary Operations
 853
 854 The two arguments of a binary operation not only need to live
 855 in the same C<isl_ctx>, they currently also need to have
 856 the same (number of) parameters.
 857
 858 =head3 Basic Operations
 859
 860 =over
 861
 862 =item * Intersection
 863
 864         __isl_give isl_basic_set *isl_basic_set_intersect(
 865                 __isl_take isl_basic_set *bset1,
 866                 __isl_take isl_basic_set *bset2);
 867         __isl_give isl_set *isl_set_intersect(
 868                 __isl_take isl_set *set1,
 869                 __isl_take isl_set *set2);
 870         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
 871                 __isl_take isl_basic_map *bmap,
 872                 __isl_take isl_basic_set *bset);
 873         __isl_give isl_basic_map *isl_basic_map_intersect_range(
 874                 __isl_take isl_basic_map *bmap,
 875                 __isl_take isl_basic_set *bset);
 876         __isl_give isl_basic_map *isl_basic_map_intersect(
 877                 __isl_take isl_basic_map *bmap1,
 878                 __isl_take isl_basic_map *bmap2);
 879         __isl_give isl_map *isl_map_intersect_domain(
 880                 __isl_take isl_map *map,
 881                 __isl_take isl_set *set);
 882         __isl_give isl_map *isl_map_intersect_range(
 883                 __isl_take isl_map *map,
 884                 __isl_take isl_set *set);
 885         __isl_give isl_map *isl_map_intersect(
 886                 __isl_take isl_map *map1,
 887                 __isl_take isl_map *map2);
 888
 889 =item * Union
 890
 891         __isl_give isl_set *isl_basic_set_union(
 892                 __isl_take isl_basic_set *bset1,
 893                 __isl_take isl_basic_set *bset2);
 894         __isl_give isl_map *isl_basic_map_union(
 895                 __isl_take isl_basic_map *bmap1,
 896                 __isl_take isl_basic_map *bmap2);
 897         __isl_give isl_set *isl_set_union(
 898                 __isl_take isl_set *set1,
 899                 __isl_take isl_set *set2);
 900         __isl_give isl_map *isl_map_union(
 901                 __isl_take isl_map *map1,
 902                 __isl_take isl_map *map2);
 903
 904 =item * Set difference
 905
 906         __isl_give isl_set *isl_set_subtract(
 907                 __isl_take isl_set *set1,
 908                 __isl_take isl_set *set2);
 909         __isl_give isl_map *isl_map_subtract(
 910                 __isl_take isl_map *map1,
 911                 __isl_take isl_map *map2);
 912
 913 =item * Application
 914
 915         __isl_give isl_basic_set *isl_basic_set_apply(
 916                 __isl_take isl_basic_set *bset,
 917                 __isl_take isl_basic_map *bmap);
 918         __isl_give isl_set *isl_set_apply(
 919                 __isl_take isl_set *set,
 920                 __isl_take isl_map *map);
 921         __isl_give isl_basic_map *isl_basic_map_apply_domain(
 922                 __isl_take isl_basic_map *bmap1,
 923                 __isl_take isl_basic_map *bmap2);
 924         __isl_give isl_basic_map *isl_basic_map_apply_range(
 925                 __isl_take isl_basic_map *bmap1,
 926                 __isl_take isl_basic_map *bmap2);
 927         __isl_give isl_map *isl_map_apply_domain(
 928                 __isl_take isl_map *map1,
 929                 __isl_take isl_map *map2);
 930         __isl_give isl_map *isl_map_apply_range(
 931                 __isl_take isl_map *map1,
 932                 __isl_take isl_map *map2);
 933
 934 =back
 935
 936 =head3 Lexicographic Optimization
 937
 938 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
 939 the following functions
 940 compute a set that contains the lexicographic minimum or maximum
 941 of the elements in C<set> (or C<bset>) for those values of the parameters
 942 that satisfy C<dom>.
 943 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
 944 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
 945 has no elements.
 946 In other words, the union of the parameter values
 947 for which the result is non-empty and of C<*empty>
 948 is equal to C<dom>.
 949
 950         __isl_give isl_set *isl_basic_set_partial_lexmin(
 951                 __isl_take isl_basic_set *bset,
 952                 __isl_take isl_basic_set *dom,
 953                 __isl_give isl_set **empty);
 954         __isl_give isl_set *isl_basic_set_partial_lexmax(
 955                 __isl_take isl_basic_set *bset,
 956                 __isl_take isl_basic_set *dom,
 957                 __isl_give isl_set **empty);
 958         __isl_give isl_set *isl_set_partial_lexmin(
 959                 __isl_take isl_set *set, __isl_take isl_set *dom,
 960                 __isl_give isl_set **empty);
 961         __isl_give isl_set *isl_set_partial_lexmax(
 962                 __isl_take isl_set *set, __isl_take isl_set *dom,
 963                 __isl_give isl_set **empty);
 964
 965 Given a (basic) set C<set> (or C<bset>), the following functions simply
 966 return a set containing the lexicographic minimum or maximum
 967 of the elements in C<set> (or C<bset>).
 968
 969         __isl_give isl_set *isl_basic_set_lexmin(
 970                 __isl_take isl_basic_set *bset);
 971         __isl_give isl_set *isl_basic_set_lexmax(
 972                 __isl_take isl_basic_set *bset);
 973         __isl_give isl_set *isl_set_lexmin(
 974                 __isl_take isl_set *set);
 975         __isl_give isl_set *isl_set_lexmax(
 976                 __isl_take isl_set *set);
 977
 978 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
 979 the following functions
 980 compute a relation that maps each element of C<dom>
 981 to the single lexicographic minimum or maximum
 982 of the elements that are associated to that same
 983 element in C<map> (or C<bmap>).
 984 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
 985 that contains the elements in C<dom> that do not map
 986 to any elements in C<map> (or C<bmap>).
 987 In other words, the union of the domain of the result and of C<*empty>
 988 is equal to C<dom>.
 989
 990         __isl_give isl_map *isl_basic_map_partial_lexmax(
 991                 __isl_take isl_basic_map *bmap,
 992                 __isl_take isl_basic_set *dom,
 993                 __isl_give isl_set **empty);
 994         __isl_give isl_map *isl_basic_map_partial_lexmin(
 995                 __isl_take isl_basic_map *bmap,
 996                 __isl_take isl_basic_set *dom,
 997                 __isl_give isl_set **empty);
 998         __isl_give isl_map *isl_map_partial_lexmax(
 999                 __isl_take isl_map *map, __isl_take isl_set *dom,
1000                 __isl_give isl_set **empty);
1001         __isl_give isl_map *isl_map_partial_lexmin(
1002                 __isl_take isl_map *map, __isl_take isl_set *dom,
1003                 __isl_give isl_set **empty);
1004
1005 Given a (basic) map C<map> (or C<bmap>), the following functions simply
1006 return a map mapping each element in the domain of
1007 C<map> (or C<bmap>) to the lexicographic minimum or maximum
1008 of all elements associated to that element.
1009
1010         __isl_give isl_map *isl_basic_map_lexmin(
1011                 __isl_take isl_basic_map *bmap);
1012         __isl_give isl_map *isl_basic_map_lexmax(
1013                 __isl_take isl_basic_map *bmap);
1014         __isl_give isl_map *isl_map_lexmin(
1015                 __isl_take isl_map *map);
1016         __isl_give isl_map *isl_map_lexmax(
1017                 __isl_take isl_map *map);
1018
1019 =head2 Dependence Analysis
1020
1021 C<isl> contains specialized functionality for performing
1022 array dataflow analysis.  That is, given a I<sink> access relation
1023 and a collection of possible I<source> access relations,
1024 C<isl> can compute relations that describe
1025 for each iteration of the sink access, which iteration
1026 of which of the source access relations was the last
1027 to access the same data element before the given iteration
1028 of the sink access.
1029 To compute standard flow dependences, the sink should be
1030 a read, while the sources should be writes.
1031
1032         #include <isl_flow.h>
1033
1034         __isl_give isl_access_info *isl_access_info_alloc(
1035                 __isl_take isl_map *sink,
1036                 void *sink_user, isl_access_level_before fn,
1037                 int max_source);
1038         __isl_give isl_access_info *isl_access_info_add_source(
1039                 __isl_take isl_access_info *acc,
1040                 __isl_take isl_map *source, void *source_user);
1041
1042         __isl_give isl_flow *isl_access_info_compute_flow(
1043                 __isl_take isl_access_info *acc);
1044
1045         int isl_flow_foreach(__isl_keep isl_flow *deps,
1046                 int (*fn)(__isl_take isl_map *dep, void *dep_user,
1047                           void *user),
1048                 void *user);
1049         __isl_give isl_set *isl_flow_get_no_source(
1050                 __isl_keep isl_flow *deps);
1051         void isl_flow_free(__isl_take isl_flow *deps);
1052
1053 The function C<isl_access_info_compute_flow> performs the actual
1054 dependence analysis.  The other functions are used to construct
1055 the input for this function or to read off the output.
1056
1057 The input is collected in an C<isl_access_info>, which can
1058 be created through a call to C<isl_access_info_alloc>.
1059 The arguments to this functions are the sink access relation
1060 C<sink>, a token C<sink_user> used to identify the sink
1061 access to the user, a callback function for specifying the
1062 relative order of source and sink accesses, and the number
1063 of source access relations that will be added.
1064 The callback function has type C<int (*)(void *first, void *second)>.
1065 The function is called with two user supplied tokens identifying
1066 either a source or the sink and it should return the shared nesting
1067 level and the relative order of the two accesses.
1068 In particular, let I<n> be the number of loops shared by
1069 the two accesses.  If C<first> precedes C<second> textually,
1070 then the function should return I<2 * n + 1>; otherwise,
1071 it should return I<2 * n>.
1072 The sources can be added to the C<isl_access_info> by performing
1073 (at most) C<max_source> calls to C<isl_access_info_add_source>.
1074 The C<source_user> token is again used to identify
1075 the source access.  The range of the source access relation
1076 C<source> should have the same dimension as the range
1077 of the sink access relation.
1078
1079 The result of the dependence analysis is collected in an
1080 C<isl_flow>.  There may be elements in the domain of
1081 the sink access for which no preceding source access could be
1082 find.  The set of these elements can be obtained through
1083 a call to C<isl_flow_get_no_source>.
1084 In the case of standard flow dependence analysis,
1085 this set corresponds to the reads from uninitialized
1086 array elements.
1087 The actual flow dependences can be extracted using
1088 C<isl_flow_foreach>.  This function will call the user-specified
1089 callback function C<fn> for each B<non-empty> dependence between
1090 a source and the sink.  The callback function is called
1091 with three arguments, the actual flow dependence relation
1092 mapping source iterations to sink iterations, a token
1093 identifying the source and an additional C<void *> with value
1094 equal to the third argument of the C<isl_flow_foreach> call.
1095
1096 After finishing with an C<isl_flow>, the user should call
1097 C<isl_flow_free> to free all associated memory.
1098
1099 =head1 Applications
1100
1101 Although C<isl> is mainly meant to be used as a library,
1102 it also contains some basic applications that use some
1103 of the functionality of C<isl>.
1104 The input may specified either in the L<isl format>
1105 or the L<PolyLib format>.
1106
1107 =head2 C<isl_polyhedron_sample>
1108
1109 C<isl_polyhedron_sample> takes a polyhedron as input and prints
1110 an integer element of the polyhedron, if there is any.
1111 The first column in the output is the denominator and is always
1112 equal to 1.  If the polyhedron contains no integer points,
1113 then a vector of length zero is printed.
1114
1115 =head2 C<isl_pip>
1116
1117 C<isl_pip> takes the same input as the C<example> program
1118 from the C<piplib> distribution, i.e., a set of constraints
1119 on the parameters, a line contains only -1 and finally a set
1120 of constraints on a parametric polyhedron.
1121 The coefficients of the parameters appear in the last columns
1122 (but before the final constant column).
1123 The output is the lexicographic minimum of the parametric polyhedron.
1124 As C<isl> currently does not have its own output format, the output
1125 is just a dump of the internal state.
1126
1127 =head2 C<isl_polyhedron_minimize>
1128
1129 C<isl_polyhedron_minimize> computes the minimum of some linear
1130 or affine objective function over the integer points in a polyhedron.
1131 If an affine objective function
1132 is given, then the constant should appear in the last column.
1133
1134 =head2 C<isl_polytope_scan>
1135
1136 Given a polytope, C<isl_polytope_scan> prints
1137 all integer points in the polytope.
1138
1139 =head1 C<isl-polylib>
1140
1141 The C<isl-polylib> library provides the following functions for converting
1142 between C<isl> objects and C<PolyLib> objects.
1143 The library is distributed separately for licensing reasons.
1144
1145         #include <isl_set_polylib.h>
1146         __isl_give isl_basic_set *isl_basic_set_new_from_polylib(
1147                 Polyhedron *P, __isl_take isl_dim *dim);
1148         Polyhedron *isl_basic_set_to_polylib(
1149                 __isl_keep isl_basic_set *bset);
1150         __isl_give isl_set *isl_set_new_from_polylib(Polyhedron *D,
1151                 __isl_take isl_dim *dim);
1152         Polyhedron *isl_set_to_polylib(__isl_keep isl_set *set);
1153
1154         #include <isl_map_polylib.h>
1155         __isl_give isl_basic_map *isl_basic_map_new_from_polylib(
1156                 Polyhedron *P, __isl_take isl_dim *dim);
1157         __isl_give isl_map *isl_map_new_from_polylib(Polyhedron *D,
1158                 __isl_take isl_dim *dim);
1159         Polyhedron *isl_basic_map_to_polylib(
1160                 __isl_keep isl_basic_map *bmap);
1161         Polyhedron *isl_map_to_polylib(__isl_keep isl_map *map);