include/piplib/piplib.h

   1 /******************************************************************************
   2  *                     PIP : Parametric Integer Programming                   *
   3  ******************************************************************************
   4  *                                 piplib.h                                   *
   5  ******************************************************************************
   6  *                                                                            *
   7  * Copyright Paul Feautrier, 1988-2005                                        *
   8  *                                                                            *
   9  * This is free software; you can redistribute it and/or modify it under the  *
  10  * terms of the GNU General Public License as published by the Free Software  *
  11  * Foundation; either version 2 of the License, or (at your option) any later *
  12  * version.                                                                   *
  13  *                                                                            *
  14  * This software is distributed in the hope that it will be useful, but       *
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *
  16  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License   *
  17  * for more details.                                                          *
  18  *                                                                            *
  19  * You should have received a copy of the GNU General Public License along    *
  20  * with software; if not, write to the Free Software Foundation, Inc.,        *
  21  * 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA                     *
  22  *                                                                            *
  23  * Written by Cedric Bastoul                                                  *
  24  *                                                                            *
  25  ******************************************************************************/
  26
  27 /* Premiere version du 18 septembre 2002. */
  28
  29 #if !defined(LINEAR_VALUE_IS_LONGLONG) && !defined(LINEAR_VALUE_IS_INT)
  30 #if !defined(LINEAR_VALUE_IS_MP)
  31 # error Please define LINEAR_VALUE_IS_* or #include polylib32.h or polylib64.h
  32 #endif
  33 #endif
  34
  35 #if defined(LINEAR_VALUE_IS_LONGLONG)
  36
  37 # define Entier   long long
  38 # define FORMAT   "%lld"
  39 # define VAL_UN   1LL
  40 # define VAL_ZERO 0LL
  41
  42 #define VALUE_TO_INT(val) ((int)(val))
  43
  44 #elif defined(LINEAR_VALUE_IS_INT)
  45
  46 # define Entier   long int
  47 # define FORMAT   "%ld"
  48 # define VAL_UN   1L
  49 # define VAL_ZERO 0L
  50
  51 #define VALUE_TO_INT(val) ((int)(val))
  52
  53 #elif defined(LINEAR_VALUE_IS_MP)
  54
  55 # include <gmp.h>
  56 # define Entier   mpz_t
  57 # define FORMAT   "%d"
  58 # define GMP_INPUT_FORMAT   "%lZd"
  59
  60 #define VALUE_TO_INT(val) ((int)mpz_get_si(val))
  61
  62 #endif
  63
  64 #if defined(LINEAR_VALUE_IS_MP)
  65
  66 #define value_addto(ref,val1,val2)      (mpz_add((ref),(val1),(val2)))
  67 #define value_assign(v1,v2)             (mpz_set((v1),(v2)))
  68 #define value_clear(val)                (mpz_clear((val)))
  69 #define value_divexact(d,v1,v2)         (mpz_divexact((d),(v1),(v2)))
  70 #define value_gcd(g,v1,v2)              (mpz_gcd((g),(v1),(v2)))
  71 #define value_init(val)                 (mpz_init((val)))
  72 #define value_init_set(v1,v2)           (mpz_init_set((v1),(v2)))
  73 #define value_oppose(ref,val)           (mpz_neg((ref),(val)))
  74 #define value_set_si(val,i)             (mpz_set_si((val),(i)))
  75 #define value_subtract(ref,val1,val2)   (mpz_sub((ref),(val1),(val2)))
  76 #define value_eq(v1,v2)                 (mpz_cmp((v1),(v2)) == 0)
  77 #define value_ne(v1,v2)                 (mpz_cmp((v1),(v2)) != 0)
  78 #define value_notzero_p(val)            (mpz_sgn(val) != 0)
  79
  80 #else
  81
  82 #define value_addto(ref,val1,val2)      ((ref) = (val1)+(val2))
  83 #define value_assign(v1,v2)             ((v1) = (v2))
  84 #define value_clear(val)                ((val) = 0)
  85 #define value_divexact(d,v1,v2)         ((d) = (v1) / (v2))
  86 #define value_gcd(g,v1,v2)              ((g) = pgcd((v1),(v2)))
  87 #define value_init(val)                 ((val) = 0)
  88 #define value_init_set(v1,v2)           ((v1) = (v2))
  89 #define value_oppose(ref,val)           ((ref) = -(val))
  90 #define value_set_si(val,i)             ((val) = (Entier)(i))
  91 #define value_subtract(ref,val1,val2)   ((ref) = (val1)-(val2))
  92 #define value_eq(v1,v2)                 ((v1) == (v2))
  93 #define value_ne(v1,v2)                 ((v1) != (v2))
  94 #define value_notzero_p(val)            ((val) != 0)
  95
  96 #endif
  97
  98
  99 #ifndef PIPLIB_H
 100 #define PIPLIB_H
 101 #if defined(__cplusplus)
 102 extern "C"
 103   {
 104 #endif
 105
 106
 107 /* Structure PipMatrix :
 108  * Structure de matrice au format PolyLib. Le premier element d'une ligne
 109  * indique quand il vaut 1 que la ligne decrit une inequation de la forme
 110  * p(x)>=0 et quand il vaut 0, que la ligne decrit une egalite de la forme
 111  * p(x)=0. Le dernier element de chaque ligne correspond au coefficient
 112  * constant.
 113  */
 114 struct pipmatrix
 115 { unsigned NbRows, NbColumns ;
 116   Entier **p ;
 117   Entier *p_Init ;
 118   int p_Init_size;              /* Only for PolyLib compatibility under MP
 119                                  * version: PolyLib makes sometimes
 120                                  * overestimates on the size of the matrices,
 121                                  * in order to go faster. Thus
 122                                  * NbRows*NbColumns is not the number of
 123                                  * allocated elements. With MP version, we
 124                                  * have to think to mpz_clear() all the
 125                                  * initialized elements before freing, then
 126                                  * we need to know the number of allocated
 127                                  * elements: p_Init_size.
 128                                  */
 129 } ;
 130 typedef struct pipmatrix PipMatrix ;
 131
 132
 133 /* Structure PipVector :
 134  * Cette structure contient un Vector de 'nb_elements' la ieme composante de
 135  * ce vecteur vaut the_vector[i]/the_deno[i].
 136  */
 137 struct pipvector
 138 { int nb_elements ;             /* Nombre d'elements du vecteur. */
 139   Entier * the_vector ;         /* Numerateurs du vecteur. */
 140   Entier * the_deno ;           /* Denominateurs du vecteur. */
 141 } ;
 142 typedef struct pipvector PipVector ;
 143
 144
 145 /* Structure PipNewparm :
 146  * Liste chainee de Newparm, les informations d'un newparm etant son rang, un
 147  * vecteur de coefficients et un denominateur. Le newparm est egal a la division
 148  * du vecteur par le denominateur.
 149  */
 150 struct pipnewparm
 151 { int rank ;                    /* Rang du 'newparm'. */
 152   PipVector * vector ;          /* Le vector decrivant le newparm. */
 153   Entier deno ;                 /* Denominateur du 'newparm'. */
 154   struct pipnewparm * next ;    /* Pointeur vers le newparm suivant. */
 155 } ;
 156 typedef struct pipnewparm PipNewparm ;
 157
 158
 159 /* Structure PipList :
 160  * Liste chainee de Vector.
 161  */
 162 struct piplist
 163 { PipVector * vector ;          /* Le vector contenant la partie de solution. */
 164   struct piplist * next ;       /* Pointeur vers l'element suivant. */
 165 } ;
 166 typedef struct piplist PipList ;
 167
 168
 169 /* Structure pipquast :
 170  * Arbre binaire. Conformement a la grammaire de sortie (voir mode d'emploi), un
 171  * noeud de l'arbre des solutions debute par une liste de 'newparm'. Il continue
 172  * ensuite soit par une 'list' (alors condition vaut null), soit par un 'if'
 173  * (alors le champ condition contient la condition).
 174  */
 175 struct pipquast
 176 { PipNewparm * newparm ;        /* Les 'newparm'. */
 177   PipList * list ;              /* La 'list' si pas de 'if'. */
 178   PipVector * condition ;       /* La condition si 'if'. */
 179   struct pipquast * next_then ; /* Noeud si condition et si verifiee. */
 180   struct pipquast * next_else ; /* Noeud si condition et si non verifiee. */
 181   struct pipquast * father ;    /* Pointeur vers le quast pere. */
 182 } ;
 183 typedef struct pipquast PipQuast ;
 184
 185
 186 /* Structure pipoptions:
 187  * This structure contains each option that can be set to change the PIP
 188  * behaviour.
 189  */
 190 struct pipoptions
 191 { int Nq ;                      /* 1 if an integer solution is needed,
 192                                  * 0 otherwise.
 193                                  */
 194   int Verbose ;                 /* -1 -> absolute silence,
 195                                  *  0 -> relative silence,
 196                                  *  1 -> information on cuts when an integer
 197                                  *       solution is needed,
 198                                  *  2 -> information sur les pivots et les
 199                                  *       déterminants,
 200                                  *  3 -> information on arrays,
 201                                  * Each option include the preceding.
 202                                  */
 203   int Simplify ;                /* Set to 1 to eliminate some trivial
 204                                  * solutions, 0 otherwise.
 205                                  */
 206   int Deepest_cut ;             /* Set to 1 to include deepest cut
 207                                  * algorithm.
 208                                  */
 209   int Maximize;                 /* Set to 1 if maximum is needed. */
 210   int Urs_parms;                /* -1 -> all parameters may be negative
 211                                  *  0 -> all parameters are non-negative
 212                                  */
 213   int Urs_unknowns;             /* -1 -> all unknowns may be negative
 214                                  *  0 -> all unknowns are non-negative
 215                                  */
 216 } ;
 217 typedef struct pipoptions PipOptions ;
 218
 219
 220 /* Prototypes des fonctions d'affichages des structures de la PipLib. */
 221 void pip_matrix_print(FILE *, PipMatrix *) ;
 222 void pip_vector_print(FILE *, PipVector *) ;
 223 void pip_newparm_print(FILE * foo, PipNewparm *, int indent) ;
 224 void pip_list_print(FILE * foo, PipList *, int indent) ;
 225 void pip_quast_print(FILE *, PipQuast *, int) ;
 226
 227
 228 /* Prototypes des fonctions de liberation memoire des structures de la PipLib.*/
 229 void pip_matrix_free(PipMatrix *) ;
 230 void pip_vector_free(PipVector *) ;
 231 void pip_newparm_free(PipNewparm *) ;
 232 void pip_list_free(PipList *) ;
 233 void pip_quast_free(PipQuast *) ;
 234 void pip_options_free(PipOptions *) ;
 235
 236
 237 /* Prototypes des fonctions d'acquisition de matrices de contraintes et
 238  * options.
 239  */
 240 PipMatrix * pip_matrix_alloc(unsigned, unsigned) ;
 241 PipMatrix * pip_matrix_read(FILE *) ;
 242 PipOptions * pip_options_init(void) ;
 243
 244
 245 /* initialization of pip library */
 246 void pip_init();
 247 void pip_close();
 248
 249
 250 /* Prototype de la fonction de resolution :
 251  * pip_solve resoud le probleme qu'on lui passe en parametre, suivant les
 252  * options elles aussi en parametre. Elle renvoie la solution sous forme
 253  * d'un arbre de PipQuast. Parametres :
 254  * - probleme :
 255  * 1 PipMatrix  : systeme des inequations definissant le domaine des inconnues,
 256  * 2 PipMatrix  : systeme des inequations satisfaites par les parametres,
 257  * 3 int        : column rank of the bignum, or negative value if there
 258  *                is no big parameter.
 259  * 4 PipOptions : options for PIP.
 260  */
 261 PipQuast * pip_solve(PipMatrix *, PipMatrix *, int, PipOptions *) ;
 262
 263 #define SOL_SHIFT               (1 << 0)    /* Shift solution over -bigparam */
 264 #define SOL_NEGATE              (1 << 1)    /* Negate solution */
 265 #define SOL_REMOVE              (1 << 2)    /* Remove big parameter */
 266 #define SOL_MAX                 (SOL_SHIFT | SOL_NEGATE)
 267                                             /* Maximum was computed */
 268 PipQuast *sol_quast_edit(int *i, PipQuast *father, int Bg, int Urs_p, int flags);
 269
 270 #if defined(__cplusplus)
 271   }
 272 #endif
 273 #endif /* define PIPLIB_H */