README

   1 barvinok is a library for counting the number of integer points
   2 in parametric and non-parametric polytopes as well as projections
   3 of such sets.
   4 For parametric polytopes the count is represented by either
   5 an explicit function or a generating function.
   6 The first comes in the shape of a piece-wise step-polynomial.
   7 This is a generalization of both Ehrhart quasi-polynomials
   8 and vector partition functions.
   9 The second is a generalization of an Ehrhart series.
  10
  11 This library shares some functionality with LattE
  12 (http://www.math.ucdavis.edu/~latte/)
  13 and uses PolyLib (included), PIP (included) and NTL (http://shoup.net/ntl/).
  14 If you have cloned the git repository, you need to run
  15         git submodule init
  16         git submodule update
  17         sh autogen.sh
  18 to get the submodules and create the configure scripts.
  19
  20 Additionally, the following packages can optionally be used
  21 - Omega (http://www.cs.umd.edu/projects/omega/ or
  22     http://www.liacs.nl/~sverdool/gitweb.cgi?p=omega.git;a=summary)
  23 - GLPK (http://www.gnu.org/software/glpk/)
  24 - GiNaC (http://www.ginac.de/) (needed for the bernstein library)
  25
  26 NTL needs to have been compiled with GMP support.
  27 That is, you have to specify
  28     NTL_GMP_LIP=on
  29
  30 Suppose you want to put everything in /opt,
  31 Then you configure/compile NTL using
  32
  33 ./configure --prefix=/opt
  34 make
  35 make install
  36
  37 For NTL,
  38
  39 cd src
  40 ./configure NTL_GMP_LIP=on PREFIX=/opt GMP_PREFIX=/path/to/gmp
  41 make
  42 make install
  43
  44 For Omega,
  45
  46 vi -c '/DESTDIR=/|s/=.*$/=\/opt/|wq' Makefile.config
  47 make libomega.a libcode_gen.a
  48 make install
  49
  50 Configure this library using
  51
  52 ./configure --prefix=/opt --with-libgmp=/path/to/gmp  --with-ntl=/opt
  53
  54 If you want shared libraries, then configure with the
  55 --enable-shared-barvinok option.
  56 Note that this doesn't work on some systems because we link in libntl, which
  57 is only available as a static library.
  58 Also note that if you have previously installed a shared library of an older
  59 version of barvinok, and you do not install one for this version, then the
  60 linker may pick up the old shared library rather than the new static library.
  61
  62 Then
  63
  64 make
  65 make check
  66 make install
  67
  68 If you want to put any one of these packages in the default location
  69 (typically /usr/local), then the prefix argument can be omitted.
  70 For more information on other arguments,
  71
  72 ./configure --help
  73
  74 The input format of barvinok_enumerate is the same as that
  75 of testehrhart from the PolyLib distribution.
  76 See the PolyLib manual, barvinok_enumerate.c or the
  77 examples in tests/ehrhart/ .
  78
  79 Note that the fractional representation is subject to change.
  80
  81 The library supports three specialization algorithms.
  82 The first performs a direct specialization using a random vector.
  83 The second performs a "depth-first" incremental specialization.
  84 The third performs a "breadth-first" incremental specialization.
  85
  86 The first is usually the fastest, but can fail if the random
  87 vector happens to be chosen incorrectly.
  88 The incremental algorithms should never fail, but can be slower,
  89 in some cases by quite a bit.  The breadth-first version should
  90 be faster than the depth-first version, especially on polytopes
  91 of moderate dimension with a lot of "structure", but can require
  92 more memory.
  93
  94 Sven Verdoolaege <skimo@kotnet.org>