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
 181 =over
 182
 183 =item isl_int_init(i)
 184
 185 =item isl_int_clear(i)
 186
 187 =item isl_int_set(r,i)
 188
 189 =item isl_int_set_si(r,i)
 190
 191 =item isl_int_abs(r,i)
 192
 193 =item isl_int_neg(r,i)
 194
 195 =item isl_int_swap(i,j)
 196
 197 =item isl_int_swap_or_set(i,j)
 198
 199 =item isl_int_add_ui(r,i,j)
 200
 201 =item isl_int_sub_ui(r,i,j)
 202
 203 =item isl_int_add(r,i,j)
 204
 205 =item isl_int_sub(r,i,j)
 206
 207 =item isl_int_mul(r,i,j)
 208
 209 =item isl_int_mul_ui(r,i,j)
 210
 211 =item isl_int_addmul(r,i,j)
 212
 213 =item isl_int_submul(r,i,j)
 214
 215 =item isl_int_gcd(r,i,j)
 216
 217 =item isl_int_lcm(r,i,j)
 218
 219 =item isl_int_divexact(r,i,j)
 220
 221 =item isl_int_cdiv_q(r,i,j)
 222
 223 =item isl_int_fdiv_q(r,i,j)
 224
 225 =item isl_int_fdiv_r(r,i,j)
 226
 227 =item isl_int_fdiv_q_ui(r,i,j)
 228
 229 =item isl_int_read(r,s)
 230
 231 =item isl_int_print(out,i,width)
 232
 233 =item isl_int_sgn(i)
 234
 235 =item isl_int_cmp(i,j)
 236
 237 =item isl_int_cmp_si(i,si)
 238
 239 =item isl_int_eq(i,j)
 240
 241 =item isl_int_ne(i,j)
 242
 243 =item isl_int_lt(i,j)
 244
 245 =item isl_int_le(i,j)
 246
 247 =item isl_int_gt(i,j)
 248
 249 =item isl_int_ge(i,j)
 250
 251 =item isl_int_abs_eq(i,j)
 252
 253 =item isl_int_abs_ne(i,j)
 254
 255 =item isl_int_abs_lt(i,j)
 256
 257 =item isl_int_abs_gt(i,j)
 258
 259 =item isl_int_abs_ge(i,j)
 260
 261 =item isl_int_is_zero(i)
 262
 263 =item isl_int_is_one(i)
 264
 265 =item isl_int_is_negone(i)
 266
 267 =item isl_int_is_pos(i)
 268
 269 =item isl_int_is_neg(i)
 270
 271 =item isl_int_is_nonpos(i)
 272
 273 =item isl_int_is_nonneg(i)
 274
 275 =item isl_int_is_divisible_by(i,j)
 276
 277 =back
 278
 279 =head2 Sets and Relations
 280
 281 C<isl> uses four types of objects for representing sets and relations,
 282 C<isl_basic_set>, C<isl_basic_map>, C<isl_set> and C<isl_map>.
 283 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
 284 can be described as a conjunction of affine constraints, while
 285 C<isl_set> and C<isl_map> represent unions of
 286 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
 287 The difference between sets and relations (maps) is that sets have
 288 one set of variables, while relations have two sets of variables,
 289 input variables and output variables.
 290
 291 =head2 Memory Management
 292
 293 Since a high-level operation on sets and/or relations usually involves
 294 several substeps and since the user is usually not interested in
 295 the intermediate results, most functions that return a new object
 296 will also release all the objects passed as arguments.
 297 If the user still wants to use one or more of these arguments
 298 after the function call, she should pass along a copy of the
 299 object rather than the object itself.
 300 The user is then responsible for make sure that the original
 301 object gets used somewhere else or is explicitly freed.
 302
 303 The arguments and return values of all documents functions are
 304 annotated to make clear which arguments are released and which
 305 arguments are preserved.  In particular, the following annotations
 306 are used
 307
 308 =over
 309
 310 =item C<__isl_give>
 311
 312 C<__isl_give> means that a new object is returned.
 313 The user should make sure that the returned pointer is
 314 used exactly once as a value for an C<__isl_take> argument.
 315 In between, it can be used as a value for as many
 316 C<__isl_keep> arguments as the user likes.
 317 There is one exception, and that is the case where the
 318 pointer returned is C<NULL>.  Is this case, the user
 319 is free to use it as an C<__isl_take> argument or not.
 320
 321 =item C<__isl_take>
 322
 323 C<__isl_take> means that the object the argument points to
 324 is taken over by the function and may no longer be used
 325 by the user as an argument to any other function.
 326 The pointer value must be one returned by a function
 327 returning an C<__isl_give> pointer.
 328 If the user passes in a C<NULL> value, then this will
 329 be treated as an error in the sense that the function will
 330 not perform its usual operation.  However, it will still
 331 make sure that all the the other C<__isl_take> arguments
 332 are released.
 333
 334 =item C<__isl_keep>
 335
 336 C<__isl_keep> means that the function will only use the object
 337 temporarily.  After the function has finished, the user
 338 can still use it as an argument to other functions.
 339 A C<NULL> value will be treated in the same way as
 340 a C<NULL> value for an C<__isl_take> argument.
 341
 342 =back
 343
 344 =head2 Dimension Specifications
 345
 346 Whenever a new set or relation is created from scratch,
 347 its dimension needs to be specified using an C<isl_dim>.
 348
 349         #include <isl_dim.h>
 350         __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
 351                 unsigned nparam, unsigned n_in, unsigned n_out);
 352         __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
 353                 unsigned nparam, unsigned dim);
 354         __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
 355         void isl_dim_free(__isl_take isl_dim *dim);
 356         unsigned isl_dim_size(__isl_keep isl_dim *dim,
 357                 enum isl_dim_type type);
 358
 359 The dimension specification used for creating a set
 360 needs to be created using C<isl_dim_set_alloc>, while
 361 that for creating a relation
 362 needs to be created using C<isl_dim_alloc>.
 363 C<isl_dim_size> can be used
 364 to find out the number of dimensions of each type in
 365 a dimension specification, where type may be
 366 C<isl_dim_param>, C<isl_dim_in> (only for relations),
 367 C<isl_dim_out> (only for relations), C<isl_dim_set>
 368 (only for sets) or C<isl_dim_all>.
 369
 370 =head2 Input and Output
 371
 372 Proper input and output functions are still in development.
 373 However, some functions are provided to read and write
 374 to foreign file formats.
 375
 376 =head3 Input
 377
 378         #include <isl_set.h>
 379         __isl_give isl_basic_set *isl_basic_set_read_from_file(
 380                 isl_ctx *ctx, FILE *input, int nparam);
 381         __isl_give isl_basic_set *isl_basic_set_read_from_str(
 382                 isl_ctx *ctx, const char *str, int nparam);
 383         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
 384                 FILE *input, int nparam);
 385         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
 386                 const char *str, int nparam);
 387
 388         #include <isl_map.h>
 389         __isl_give isl_basic_map *isl_basic_map_read_from_file(
 390                 isl_ctx *ctx, FILE *input, int nparam);
 391         __isl_give isl_basic_map *isl_basic_map_read_from_str(
 392                 isl_ctx *ctx, const char *str, int nparam);
 393         __isl_give isl_map *isl_map_read_from_file(
 394                 struct isl_ctx *ctx, FILE *input, int nparam);
 395         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
 396                 const char *str, int nparam);
 397
 398 The input may be either in C<PolyLib> format or in the
 399 C<isl> format, which is similar to the C<Omega> format.
 400 C<nparam> specifies how many of the final columns in
 401 the C<PolyLib> format correspond to parameters.
 402 If input is given in the C<isl> format, then the number
 403 of parameters needs to be equal to C<nparam>.
 404 If C<nparam> is negative, then any number of parameters
 405 is accepted in the C<isl> format and zero parameters
 406 are assumed in the C<PolyLib> format.
 407
 408 =head3 Output
 409
 410         #include <isl_set.h>
 411         void isl_basic_set_print(__isl_keep isl_basic_set *bset,
 412                 FILE *out, int indent,
 413                 const char *prefix, const char *suffix,
 414                 unsigned output_format);
 415         void isl_set_print(__isl_keep struct isl_set *set,
 416                 FILE *out, int indent, unsigned output_format);
 417
 418         #include <isl_map.h>
 419         void isl_basic_map_print(__isl_keep isl_basic_map *bmap,
 420                 FILE *out, int indent,
 421                 const char *prefix, const char *suffix,
 422                 unsigned output_format);
 423         void isl_map_print(__isl_keep struct isl_map *map,
 424                 FILE *out, int indent, unsigned output_format);
 425
 426 C<output_format> may be either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_POLYLIB>.
 427 Each line in the output is indented by C<indent> spaces,
 428 prefixed by C<prefix> and suffixed by C<suffix>.
 429 In the C<PolyLib> format output,
 430 the coefficients of the existentially quantified variables
 431 appear between those of the set variables and those
 432 of the parameters.
 433
 434 =head3 Dumping the internal state
 435
 436 For lack of proper output functions, the following functions
 437 can be used to dump the internal state of a set or relation.
 438 The user should not depend on the output format of these functions.
 439
 440         void isl_basic_set_dump(__isl_keep isl_basic_set *bset,
 441                 FILE *out, int indent);
 442         void isl_basic_map_dump(__isl_keep isl_basic_map *bmap,
 443                 FILE *out, int indent);
 444         void isl_set_dump(__isl_keep isl_set *set,
 445                 FILE *out, int indent);
 446         void isl_map_dump(__isl_keep isl_map *map,
 447                 FILE *out, int indent);
 448
 449 =head2 Creating New Sets and Relations
 450
 451 C<isl> has functions for creating some standard sets and relations.
 452
 453 =over
 454
 455 =item * Empty sets and relations
 456
 457         __isl_give isl_basic_set *isl_basic_set_empty(
 458                 __isl_take isl_dim *dim);
 459         __isl_give isl_basic_map *isl_basic_map_empty(
 460                 __isl_take isl_dim *dim);
 461         __isl_give isl_set *isl_set_empty(
 462                 __isl_take isl_dim *dim);
 463         __isl_give isl_map *isl_map_empty(
 464                 __isl_take isl_dim *dim);
 465
 466 =item * Universe sets and relations
 467
 468         __isl_give isl_basic_set *isl_basic_set_universe(
 469                 __isl_take isl_dim *dim);
 470         __isl_give isl_basic_map *isl_basic_map_universe(
 471                 __isl_take isl_dim *dim);
 472         __isl_give isl_set *isl_set_universe(
 473                 __isl_take isl_dim *dim);
 474         __isl_give isl_map *isl_map_universe(
 475                 __isl_take isl_dim *dim);
 476
 477 =item * Identity relations
 478
 479         __isl_give isl_basic_map *isl_basic_map_identity(
 480                 __isl_take isl_dim *set_dim);
 481         __isl_give isl_map *isl_map_identity(
 482                 __isl_take isl_dim *set_dim);
 483
 484 These functions take a dimension specification for a B<set>
 485 and return an identity relation between two such sets.
 486
 487 =item * Lexicographic order
 488
 489         __isl_give isl_map *isl_map_lex_lt(
 490                 __isl_take isl_dim *set_dim);
 491         __isl_give isl_map *isl_map_lex_le(
 492                 __isl_take isl_dim *set_dim);
 493         __isl_give isl_map *isl_map_lex_gt(
 494                 __isl_take isl_dim *set_dim);
 495         __isl_give isl_map *isl_map_lex_ge(
 496                 __isl_take isl_dim *set_dim);
 497
 498 These functions take a dimension specification for a B<set>
 499 and return relations that express that the elements in the domain
 500 are lexicograhically less
 501 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
 502 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
 503 than the elements in the range.
 504
 505 =back
 506
 507 A basic set or relation can be converted to a set or relation
 508 using the following functions.
 509
 510         __isl_give isl_set *isl_set_from_basic_set(
 511                 __isl_take isl_basic_set *bset);
 512         __isl_give isl_map *isl_map_from_basic_map(
 513                 __isl_take isl_basic_map *bmap);
 514
 515 Sets and relations can be copied and freed again using the following
 516 functions.
 517
 518         __isl_give isl_basic_set *isl_basic_set_copy(
 519                 __isl_keep isl_basic_set *bset);
 520         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
 521         __isl_give isl_basic_map *isl_basic_map_copy(
 522                 __isl_keep isl_basic_map *bmap);
 523         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
 524         void isl_basic_set_free(__isl_take isl_basic_set *bset);
 525         void isl_set_free(__isl_take isl_set *set);
 526         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
 527         void isl_map_free(__isl_take isl_map *map);
 528
 529 Other sets and relations can be constructed by starting
 530 from a universe set or relation, adding equality and/or
 531 inequality constraints and then projecting out the
 532 existentially quantified variables, if any.
 533 Constraints can be constructed, manipulated and
 534 added to basic sets and relations using the following functions.
 535
 536         #include <isl_constraint.h>
 537         __isl_give isl_constraint *isl_equality_alloc(
 538                 __isl_take isl_dim *dim);
 539         __isl_give isl_constraint *isl_inequality_alloc(
 540                 __isl_take isl_dim *dim);
 541         void isl_constraint_set_constant(
 542                 __isl_keep isl_constraint *constraint, isl_int v);
 543         void isl_constraint_set_coefficient(
 544                 __isl_keep isl_constraint *constraint,
 545                 enum isl_dim_type type, int pos, isl_int v);
 546         __isl_give isl_basic_map *isl_basic_map_add_constraint(
 547                 __isl_take isl_basic_map *bmap,
 548                 __isl_take isl_constraint *constraint);
 549         __isl_give isl_basic_set *isl_basic_set_add_constraint(
 550                 __isl_take isl_basic_set *bset,
 551                 __isl_take isl_constraint *constraint);
 552
 553 For example, to create a set containing the even integers
 554 between 10 and 42, you would use the following code.
 555
 556         isl_int v;
 557         struct isl_dim *dim;
 558         struct isl_constraint *c;
 559         struct isl_basic_set *bset;
 560
 561         isl_int_init(v);
 562         dim = isl_dim_set_alloc(ctx, 0, 2);
 563         bset = isl_basic_set_universe(isl_dim_copy(dim));
 564
 565         c = isl_equality_alloc(isl_dim_copy(dim));
 566         isl_int_set_si(v, -1);
 567         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 568         isl_int_set_si(v, 2);
 569         isl_constraint_set_coefficient(c, isl_dim_set, 1, v);
 570         bset = isl_basic_set_add_constraint(bset, c);
 571
 572         c = isl_inequality_alloc(isl_dim_copy(dim));
 573         isl_int_set_si(v, -10);
 574         isl_constraint_set_constant(c, v);
 575         isl_int_set_si(v, 1);
 576         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 577         bset = isl_basic_set_add_constraint(bset, c);
 578
 579         c = isl_inequality_alloc(dim);
 580         isl_int_set_si(v, 42);
 581         isl_constraint_set_constant(c, v);
 582         isl_int_set_si(v, -1);
 583         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 584         bset = isl_basic_set_add_constraint(bset, c);
 585
 586         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
 587
 588         isl_int_clear(v);
 589
 590 =head2 Properties
 591
 592 =head3 Unary Properties
 593
 594 =over
 595
 596 =item Emptiness
 597
 598 The following functions test whether the given set or relation
 599 contains any integer points.  The ``fast'' variants do not perform
 600 any computations, but simply check if the given set or relation
 601 is already known to be empty.
 602
 603         int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
 604         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
 605         int isl_set_is_empty(__isl_keep isl_set *set);
 606         int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
 607         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
 608         int isl_map_fast_is_empty(__isl_keep isl_map *map);
 609         int isl_map_is_empty(__isl_keep isl_map *map);
 610
 611 =item * Universality
 612
 613         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
 614         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
 615
 616 =back
 617
 618 =head3 Binary Properties
 619
 620 =over
 621
 622 =item * Equality
 623
 624         int isl_set_fast_is_equal(__isl_keep isl_set *set1,
 625                 __isl_keep isl_set *set2);
 626         int isl_set_is_equal(__isl_keep isl_set *set1,
 627                 __isl_keep isl_set *set2);
 628         int isl_map_is_equal(__isl_keep isl_map *map1,
 629                 __isl_keep isl_map *map2);
 630         int isl_map_fast_is_equal(__isl_keep isl_map *map1,
 631                 __isl_keep isl_map *map2);
 632         int isl_basic_map_is_equal(
 633                 __isl_keep isl_basic_map *bmap1,
 634                 __isl_keep isl_basic_map *bmap2);
 635
 636 =item * Disjointness
 637
 638         int isl_set_fast_is_disjoint(__isl_keep isl_set *set1,
 639                 __isl_keep isl_set *set2);
 640
 641 =item * Subset
 642
 643         int isl_set_is_subset(__isl_keep isl_set *set1,
 644                 __isl_keep isl_set *set2);
 645         int isl_set_is_strict_subset(
 646                 __isl_keep isl_set *set1,
 647                 __isl_keep isl_set *set2);
 648         int isl_basic_map_is_subset(
 649                 __isl_keep isl_basic_map *bmap1,
 650                 __isl_keep isl_basic_map *bmap2);
 651         int isl_basic_map_is_strict_subset(
 652                 __isl_keep isl_basic_map *bmap1,
 653                 __isl_keep isl_basic_map *bmap2);
 654         int isl_map_is_subset(
 655                 __isl_keep isl_map *map1,
 656                 __isl_keep isl_map *map2);
 657         int isl_map_is_strict_subset(
 658                 __isl_keep isl_map *map1,
 659                 __isl_keep isl_map *map2);
 660
 661 =back
 662
 663 =head2 Unary Operations
 664
 665 =over
 666
 667 =item * Projection
 668
 669         __isl_give isl_basic_set *isl_basic_set_project_out(
 670                 __isl_take isl_basic_set *bset,
 671                 enum isl_dim_type type, unsigned first, unsigned n);
 672         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
 673                 enum isl_dim_type type, unsigned first, unsigned n);
 674         __isl_give isl_basic_set *isl_basic_map_domain(
 675                 __isl_take isl_basic_map *bmap);
 676         __isl_give isl_basic_set *isl_basic_map_range(
 677                 __isl_take isl_basic_map *bmap);
 678         __isl_give isl_set *isl_map_domain(
 679                 __isl_take isl_map *bmap);
 680         __isl_give isl_set *isl_map_range(
 681                 __isl_take isl_map *map);
 682
 683 C<isl_basic_set_project_out> currently only supports projecting
 684 out the final C<isl_dim_set> dimensions.
 685
 686 =item * Coalescing
 687
 688 Simplify the representation of a set or relation by trying
 689 to combine pairs of basic sets or relations into a single
 690 basic set or relation.
 691
 692         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
 693         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
 694
 695 =item * Convex hull
 696
 697         __isl_give isl_basic_set *isl_set_convex_hull(
 698                 __isl_take isl_set *set);
 699         __isl_give isl_basic_map *isl_map_convex_hull(
 700                 __isl_take isl_map *map);
 701
 702 If the input set or relation has any existentially quantified
 703 variables, then the result of these operations is currently undefined.
 704
 705 =item * Affine hull
 706
 707         __isl_give isl_basic_set *isl_basic_set_affine_hull(
 708                 __isl_take isl_basic_set *bset);
 709         __isl_give isl_basic_set *isl_set_affine_hull(
 710                 __isl_take isl_set *set);
 711         __isl_give isl_basic_map *isl_basic_map_affine_hull(
 712                 __isl_take isl_basic_map *bmap);
 713         __isl_give isl_basic_map *isl_map_affine_hull(
 714                 __isl_take isl_map *map);
 715
 716 =back
 717
 718 =head2 Binary Operations
 719
 720 The two arguments of a binary operation not only need to live
 721 in the same C<isl_ctx>, they currently also need to have
 722 the same (number of) parameters.
 723
 724 =head3 Basic Operations
 725
 726 =over
 727
 728 =item * Intersection
 729
 730         __isl_give isl_basic_set *isl_basic_set_intersect(
 731                 __isl_take isl_basic_set *bset1,
 732                 __isl_take isl_basic_set *bset2);
 733         __isl_give isl_set *isl_set_intersect(
 734                 __isl_take isl_set *set1,
 735                 __isl_take isl_set *set2);
 736         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
 737                 __isl_take isl_basic_map *bmap,
 738                 __isl_take isl_basic_set *bset);
 739         __isl_give isl_basic_map *isl_basic_map_intersect_range(
 740                 __isl_take isl_basic_map *bmap,
 741                 __isl_take isl_basic_set *bset);
 742         __isl_give isl_basic_map *isl_basic_map_intersect(
 743                 __isl_take isl_basic_map *bmap1,
 744                 __isl_take isl_basic_map *bmap2);
 745         __isl_give isl_map *isl_map_intersect_domain(
 746                 __isl_take isl_map *map,
 747                 __isl_take isl_set *set);
 748         __isl_give isl_map *isl_map_intersect_range(
 749                 __isl_take isl_map *map,
 750                 __isl_take isl_set *set);
 751         __isl_give isl_map *isl_map_intersect(
 752                 __isl_take isl_map *map1,
 753                 __isl_take isl_map *map2);
 754
 755 =item * Union
 756
 757         __isl_give isl_set *isl_basic_set_union(
 758                 __isl_take isl_basic_set *bset1,
 759                 __isl_take isl_basic_set *bset2);
 760         __isl_give isl_map *isl_basic_map_union(
 761                 __isl_take isl_basic_map *bmap1,
 762                 __isl_take isl_basic_map *bmap2);
 763         __isl_give isl_set *isl_set_union(
 764                 __isl_take isl_set *set1,
 765                 __isl_take isl_set *set2);
 766         __isl_give isl_map *isl_map_union(
 767                 __isl_take isl_map *map1,
 768                 __isl_take isl_map *map2);
 769
 770 =item * Set difference
 771
 772         __isl_give isl_set *isl_set_subtract(
 773                 __isl_take isl_set *set1,
 774                 __isl_take isl_set *set2);
 775         __isl_give isl_map *isl_map_subtract(
 776                 __isl_take isl_map *map1,
 777                 __isl_take isl_map *map2);
 778
 779 =item * Application
 780
 781         __isl_give isl_basic_set *isl_basic_set_apply(
 782                 __isl_take isl_basic_set *bset,
 783                 __isl_take isl_basic_map *bmap);
 784         __isl_give isl_set *isl_set_apply(
 785                 __isl_take isl_set *set,
 786                 __isl_take isl_map *map);
 787         __isl_give isl_basic_map *isl_basic_map_apply_domain(
 788                 __isl_take isl_basic_map *bmap1,
 789                 __isl_take isl_basic_map *bmap2);
 790         __isl_give isl_basic_map *isl_basic_map_apply_range(
 791                 __isl_take isl_basic_map *bmap1,
 792                 __isl_take isl_basic_map *bmap2);
 793         __isl_give isl_map *isl_map_apply_domain(
 794                 __isl_take isl_map *map1,
 795                 __isl_take isl_map *map2);
 796         __isl_give isl_map *isl_map_apply_range(
 797                 __isl_take isl_map *map1,
 798                 __isl_take isl_map *map2);
 799
 800 =back
 801
 802 =head3 Lexicographic Optimization
 803
 804 Given a basic set C<bset> and a zero-dimensional domain C<dom>,
 805 the following functions
 806 compute a set that contains the lexicographic minimum or maximum
 807 of the elements in C<bset> for those values of the parameters
 808 that satisfy C<dom>.
 809 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
 810 that contains the parameter values in C<dom> for which C<bset>
 811 has no elements.
 812 In other words, the union of the parameter values
 813 for which the result is non-empty and of C<*empty>
 814 is equal to C<dom>.
 815
 816         __isl_give isl_set *isl_basic_set_partial_lexmin(
 817                 __isl_take isl_basic_set *bset,
 818                 __isl_take isl_basic_set *dom,
 819                 __isl_give isl_set **empty);
 820         __isl_give isl_set *isl_basic_set_partial_lexmax(
 821                 __isl_take isl_basic_set *bset,
 822                 __isl_take isl_basic_set *dom,
 823                 __isl_give isl_set **empty);
 824
 825 Given a basic set C<bset>, the following functions simply
 826 return a set containing the lexicographic minimum or maximum
 827 of the elements in C<bset>.
 828
 829         __isl_give isl_set *isl_basic_set_lexmin(
 830                 __isl_take isl_basic_set *bset);
 831         __isl_give isl_set *isl_basic_set_lexmax(
 832                 __isl_take isl_basic_set *bset);
 833
 834 Given a basic relation C<bmap> and a domain C<dom>,
 835 the following functions
 836 compute a relation that maps each element of C<dom>
 837 to the single lexicographic minimum or maximum
 838 of the elements that are associated to that same
 839 element in C<bmap>.
 840 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
 841 that contains the elements in C<dom> that do not map
 842 to any elements in C<bmap>.
 843 In other words, the union of the domain of the result and of C<*empty>
 844 is equal to C<dom>.
 845
 846         __isl_give isl_map *isl_basic_map_partial_lexmax(
 847                 __isl_take isl_basic_map *bmap,
 848                 __isl_take isl_basic_set *dom,
 849                 __isl_give isl_set **empty);
 850         __isl_give isl_map *isl_basic_map_partial_lexmin(
 851                 __isl_take isl_basic_map *bmap,
 852                 __isl_take isl_basic_set *dom,
 853                 __isl_give isl_set **empty);
 854
 855 Given a basic map C<bmap>, the following functions simply
 856 return a map mapping each element in the domain of
 857 C<bmap> to the lexicographic minimum or maximum
 858 of all elements associated to that element.
 859
 860         __isl_give isl_map *isl_basic_map_lexmin(
 861                 __isl_take isl_basic_map *bmap);
 862         __isl_give isl_map *isl_basic_map_lexmax(
 863                 __isl_take isl_basic_map *bmap);
 864
 865 =head1 Applications
 866
 867 Although C<isl> is mainly meant to be used as a library,
 868 it also contains some basic applications that use some
 869 of the functionality of C<isl>.
 870 Since C<isl> does not have its own input format yet, these
 871 applications currently take input in C<PolyLib> style.
 872 That is, a line with the number of rows and columns,
 873 where the number of rows is equal to the number of constraints
 874 and the number of columns is equal to two plus the number of variables,
 875 followed by the actual rows.
 876 In each row, the first column indicates whether the constraint
 877 is an equality (C<0>) or inequality (C<1>).  The final column
 878 corresponds to the constant term.
 879
 880 =head2 C<isl_polyhedron_sample>
 881
 882 C<isl_polyhedron_sample>
 883 takes a polyhedron in C<PolyLib> format as input and prints
 884 an integer element of the polyhedron, if there is any.
 885 The first column in the output is the denominator and is always
 886 equal to 1.  If the polyhedron contains no integer points,
 887 then a vector of length zero is printed.
 888
 889 =head2 C<isl_pip>
 890
 891 C<isl_pip> takes the same input as the C<example> program
 892 from the C<piplib> distribution, i.e., a set of constraints
 893 on the parameters in C<PolyLib> format,
 894 a line contains only -1 and finally a set
 895 of constraints on a parametric polyhedron, again in C<PolyLib> format.
 896 The coefficients of the parameters appear in the last columns
 897 (but before the final constant column).
 898 The output is the lexicographic minimum of the parametric polyhedron.
 899 As C<isl> currently does not have its own output format, the output
 900 is just a dump of the internal state.
 901
 902 =head2 C<isl_polyhedron_minimize>
 903
 904 C<isl_polyhedron_minimize> computes the minimum of some linear
 905 or affine objective function over the integer points in a polyhedron.
 906 The input is in C<PolyLib> format.  If an affine objective function
 907 is given, then the constant should appear in the last column.
 908
 909 =head2 C<isl_polytope_scan>
 910
 911 Given a polytope in C<PolyLib> format, C<isl_polytope_scan> prints
 912 all integer points in the polytope.
 913
 914 =head1 C<isl-polylib>
 915
 916 The C<isl-polylib> library provides the following functions for converting
 917 between C<isl> objects and C<PolyLib> objects.
 918 The library is distributed separately for licensing reasons.
 919
 920         #include <isl_set_polylib.h>
 921         __isl_give isl_basic_set *isl_basic_set_new_from_polylib(
 922                 Polyhedron *P, __isl_take isl_dim *dim);
 923         Polyhedron *isl_basic_set_to_polylib(
 924                 __isl_keep isl_basic_set *bset);
 925         __isl_give isl_set *isl_set_new_from_polylib(Polyhedron *D,
 926                 __isl_take isl_dim *dim);
 927         Polyhedron *isl_set_to_polylib(__isl_keep isl_set *set);
 928
 929         #include <isl_map_polylib.h>
 930         __isl_give isl_basic_map *isl_basic_map_new_from_polylib(
 931                 Polyhedron *P, __isl_take isl_dim *dim);
 932         __isl_give isl_map *isl_map_new_from_polylib(Polyhedron *D,
 933                 __isl_take isl_dim *dim);
 934         Polyhedron *isl_basic_map_to_polylib(
 935                 __isl_keep isl_basic_map *bmap);
 936         Polyhedron *isl_map_to_polylib(__isl_keep isl_map *map);