[PPL-devel] [GIT] ppl/ppl(master): Described the input formats.

[Roberto Bagnara]

Module: ppl/ppl
Branch: master
Commit: 84cdf71053ad8257bca1e8bd90bd2d22c145e75d
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=84cdf71053ad8257bca1e8bd90bd2d22c145e75d

Author: Roberto Bagnara <bagnara at cs.unipr.it>
Date:   Thu Feb 18 11:23:44 2010 +0100

Described the input formats.

---

 demos/ppl_pips/ppl_pips.1              |   55 +++++++++++++++++++++++++++++++-
 demos/ppl_pips/ppl_pips_extra_man_text |   53 ++++++++++++++++++++++++++++++
 2 files changed, 107 insertions(+), 1 deletions(-)

diff --git a/demos/ppl_pips/ppl_pips.1 b/demos/ppl_pips/ppl_pips.1
index 3c492da..58b6fee 100644
--- a/demos/ppl_pips/ppl_pips.1
+++ b/demos/ppl_pips/ppl_pips.1
@@ -63,6 +63,54 @@ is available at \fBhttp://www.cs.unipr.it/ppl/\fR .
 .SH NOTES
 The options \fB\-CSECS\fR (\fB\-\-max\-cpu\fR=\fISECS\fR) and
 \fB\-t\fR (\fB\-\-timings\fR) are not available on some platforms.
+.sp
+The PolyLib format is as follows:
+.TP
+-
+The first row describes the context matrix (i.e., constraints on the
+parameters).  The first value is the number of rows (which can be zero)
+and the second value is the number of columns. The number of parameters
+is the number of columns minus 2.
+.TP
+-
+Starting from the second row, there are the rows of the context matrix,
+if any.  Each row, which represents a constraint of the form
+.B "c1*p1 + ... + cn*pn + c0 =/>= 0",
+contains:
+the value 0 if the constraint is an equality, 1 if it is an inequality;
+the coefficients of the parameters
+.B "c1, ..., cn";
+the constant term
+.B "c0".
+For example, the inequality constraint on two parameters
+.B "p1 + 2*p2 - 1 >= 0"
+is encoded by the row
+.B "1 1 2 -1".
+.TP
+-
+The following row contains the parameter number for the so-called
+.IR "big parameter".
+If no big parameter is used, the value is -1.
+.TP
+-
+The following rows encode the problem inequality matrix..
+As for the context matrix, the first two values are the dimensions of the
+matrix. The number of variables is the number of columns in the matrix
+minus the number of parameters minus 2.
+Each row, which represents a constraint of the form
+.B "d1*v1 + ... + dm*vm + c1*p1 + ... + cn*pn + c0 =/>= 0",
+contains:
+the value 0 if the constraint is an equality, 1 if it is an inequality;
+the coefficients of the variables
+.B "d1, ..., dm";
+the coefficients of the parameters
+.B "c1, ..., cn";
+the constant term
+.B "c0".
+.sp
+The PipLib format is described in Section 2.2 of
+.IR "PIP/PipLib: A Solver for Parametric Integer Programming Problems"
+(see below).
 .SH AUTHOR
 See the file \fBCREDITS\fR in the source distribution or use the command
 \fBppl\-config \-\-credits\fR for a list of contributors.
@@ -80,4 +128,9 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .sp
 Paul Feautrier.
 .IR "Parametric Integer Programming".
-RAIRO Recherche Opérationnelle, 22(3):243-268, 1988. 
+RAIRO Recherche Operationnelle, 22(3):243-268, 1988.
+.sp
+Paul Feautrier, Jean-Francois Collard, and Cedric Bastoul.
+.IR "PIP/PipLib: A Solver for Parametric Integer Programming Problems",
+5.0 edition, July 2007.
+Distributed with PIP/PipLib 1.4.0.
diff --git a/demos/ppl_pips/ppl_pips_extra_man_text b/demos/ppl_pips/ppl_pips_extra_man_text
index bf71097..c12a617 100644
--- a/demos/ppl_pips/ppl_pips_extra_man_text
+++ b/demos/ppl_pips/ppl_pips_extra_man_text
@@ -18,6 +18,54 @@ is available at \fBhttp://www.cs.unipr.it/ppl/\fR .
 [NOTES]
 The options \fB\-CSECS\fR (\fB\-\-max\-cpu\fR=\fISECS\fR) and
 \fB\-t\fR (\fB\-\-timings\fR) are not available on some platforms.
+.sp
+The PolyLib format is as follows:
+.TP
+-
+The first row describes the context matrix (i.e., constraints on the
+parameters).  The first value is the number of rows (which can be zero)
+and the second value is the number of columns. The number of parameters
+is the number of columns minus 2.
+.TP
+-
+Starting from the second row, there are the rows of the context matrix,
+if any.  Each row, which represents a constraint of the form
+.B "c1*p1 + ... + cn*pn + c0 =/>= 0",
+contains:
+the value 0 if the constraint is an equality, 1 if it is an inequality;
+the coefficients of the parameters
+.B "c1, ..., cn";
+the constant term
+.B "c0".
+For example, the inequality constraint on two parameters
+.B "p1 + 2*p2 - 1 >= 0"
+is encoded by the row
+.B "1 1 2 -1".
+.TP
+-
+The following row contains the parameter number for the so-called
+.IR "big parameter".
+If no big parameter is used, the value is -1.
+.TP
+-
+The following rows encode the problem inequality matrix.
+As for the context matrix, the first two values are the dimensions of the
+matrix. The number of variables is the number of columns in the matrix
+minus the number of parameters minus 2.
+Each row, which represents a constraint of the form
+.B "d1*v1 + ... + dm*vm + c1*p1 + ... + cn*pn + c0 =/>= 0",
+contains:
+the value 0 if the constraint is an equality, 1 if it is an inequality;
+the coefficients of the variables
+.B "d1, ..., dm";
+the coefficients of the parameters
+.B "c1, ..., cn";
+the constant term
+.B "c0".
+.sp
+The PipLib format is described in Section 2.2 of
+.IR "PIP/PipLib: A Solver for Parametric Integer Programming Problems"
+(see below).
 
 [SEE ALSO]
 .BR ppl-config(1)
@@ -25,3 +73,8 @@ The options \fB\-CSECS\fR (\fB\-\-max\-cpu\fR=\fISECS\fR) and
 Paul Feautrier.
 .IR "Parametric Integer Programming".
 RAIRO Recherche Operationnelle, 22(3):243-268, 1988.
+.sp
+Paul Feautrier, Jean-Francois Collard, and Cedric Bastoul.
+.IR "PIP/PipLib: A Solver for Parametric Integer Programming Problems",
+5.0 edition, July 2007.
+Distributed with PIP/PipLib 1.4.0.