[PPL-devel] [GIT] ppl/ppl(master): Fixed a couple of comments for BD and octagonal shapes.

[Enea Zaffanella]

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

Author: Enea Zaffanella <zaffanella at cs.unipr.it>
Date:   Mon May  4 08:07:36 2009 +0200

Fixed a couple of comments for BD and octagonal shapes.
When adding constraints/congruences, an exception is thrown if they cannot
be accurately represented.

---

 src/BD_Shape.defs.hh        |   17 ++++++++---------
 src/Octagonal_Shape.defs.hh |   14 ++++++++------
 2 files changed, 16 insertions(+), 15 deletions(-)

diff --git a/src/BD_Shape.defs.hh b/src/BD_Shape.defs.hh
index 165f0eb..d65ecfe 100644
--- a/src/BD_Shape.defs.hh
+++ b/src/BD_Shape.defs.hh
@@ -467,10 +467,7 @@ public:
     The BDS inherits the space dimension of \p cs.
 
     \param cs
-    A system of constraints: constraints that are not
-    \ref Bounded_Difference_Shapes "bounded differences"
-    are ignored (even though they may have contributed
-    to the space dimension).
+    A system of BD constraints.
 
     \exception std::invalid_argument
     Thrown if \p cs contains a constraint which is not optimally supported
@@ -483,7 +480,11 @@ public:
     The BDS inherits the space dimension of \p cgs
 
     \param cgs
-    A system of congruences: some elements may be safely ignored.
+    A system of congruences.
+
+    \exception std::invalid_argument
+    Thrown if \p cgs contains congruences which are not optimally
+    supported by the BD shape domain.
   */
   explicit BD_Shape(const Congruence_System& cgs);
 
@@ -839,8 +840,7 @@ public:
     defining \p *this.
 
     \param c
-    The constraint to be added. If it is not a bounded difference, it
-    will be simply ignored.
+    The constraint to be added.
 
     \exception std::invalid_argument
     Thrown if \p *this and constraint \p c are dimension-incompatible,
@@ -865,8 +865,7 @@ public:
     defining \p *this.
 
     \param  cs
-    The constraints that will be added. Constraints that are not bounded
-    differences will be simply ignored.
+    The constraints that will be added.
 
     \exception std::invalid_argument
     Thrown if \p *this and \p cs are dimension-incompatible,
diff --git a/src/Octagonal_Shape.defs.hh b/src/Octagonal_Shape.defs.hh
index 83456e9..8bdd491 100644
--- a/src/Octagonal_Shape.defs.hh
+++ b/src/Octagonal_Shape.defs.hh
@@ -477,13 +477,11 @@ public:
     The OS inherits the space dimension of \p cs.
 
     \param cs
-    A system of constraints: constraints that are not
-    \ref Octagonal_Shapes "octagonal constraints"
-    are ignored (even though they may have contributed
-    to the space dimension).
+    A system of octagonal constraints.
 
     \exception std::invalid_argument
-    Thrown if the system of constraints \p cs contains strict inequalities.
+    Thrown if \p cs contains a constraint which is not optimally supported
+    by the Octagonal shape domain.
   */
   explicit Octagonal_Shape(const Constraint_System& cs);
 
@@ -492,7 +490,11 @@ public:
     The OS inherits the space dimension of \p cgs
 
     \param cgs
-    A system of congruences: some elements may be safely ignored.
+    A system of congruences.
+
+    \exception std::invalid_argument
+    Thrown if \p cgs contains a congruence which is not optimally supported
+    by the Octagonal shape domain.
   */
   explicit Octagonal_Shape(const Congruence_System& cgs);