[PPL-devel] [GIT] ppl/ppl(master): Added documentation for the OCaml wrap_assign function.

[Patricia Hill]

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

Author: Patricia Hill <p.m.hill at leeds.ac.uk>
Date:   Tue Mar 23 20:01:55 2010 +0000

Added documentation for the OCaml wrap_assign function.

---

 interfaces/OCaml/OCaml_interface.dox |   26 ++++++++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)

diff --git a/interfaces/OCaml/OCaml_interface.dox b/interfaces/OCaml/OCaml_interface.dox
index 96c64b1..2bc0ac9 100644
--- a/interfaces/OCaml/OCaml_interface.dox
+++ b/interfaces/OCaml/OCaml_interface.dox
@@ -975,6 +975,32 @@ This is the inverse transformation to that for <CODE>ppl_affine_image</CODE>.
    Mapping the Dimensions of the Vector Space}
    of the main PPL user manual.
 
+<H2><CODE> ppl_Polyhedron_wrap_assign handle
+                                      list_of_vars
+                                      width
+                                      representation
+                                      overflow
+                                      constraint_system
+                                      complexity_threshold
+                                      wrap_indicator
+</CODE></H2>
+
+    Transforms the polyhedron referenced by <CODE>handle</CODE> by
+    wrapping the dimensions given by <CODE>list_of_vars</CODE> while
+    respecting the specified <CODE>width</CODE>,
+    <CODE>representation</CODE> and <CODE>overflow</CODE> behavior of
+    all these variables. The parameter <CODE>constraint_system</CODE>
+    represents the conditional or looping construct guard with respect
+    to which wrapping is performed.  The non-negative integer
+    <CODE>complexity_threshold</CODE> and Boolean
+    <CODE>wrap_indicator</CODE> allow control of the
+    complexity/precision ratio; higher values for
+    <CODE>complexity_threshold</CODE> will lead to possibly greater
+    precision while a true value for <CODE>wrap_indicator</CODE>
+    indicates that the space dimensions should be wrapped
+    individually.  See Section \extref{Wrapping_Operator, Wrapping
+    Operator} for a more detailed description of this operator.
+
 <H2><CODE>
   ppl_Polyhedron_ascii_dump handle
 </CODE></H2>