[PPL-devel] [GIT] ppl/ppl(floating_point): Fixed Documentation.

[Fabio Biselli]

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

Author: Fabio Biselli <fabio.biselli at studenti.unipr.it>
Date:   Fri Apr  9 10:25:46 2010 +0200

Fixed Documentation.

---

 src/Cast_Floating_Point_Expression.defs.hh         |    2 +-
 src/Constant_Floating_Point_Expression.defs.hh     |    2 +-
 src/Difference_Floating_Point_Expression.defs.hh   |    2 +-
 src/Division_Floating_Point_Expression.defs.hh     |    2 +-
 src/Floating_Point_Expression.defs.hh              |    8 ++++----
 ...ultiplication_Floating_Point_Expression.defs.hh |    2 +-
 src/Sum_Floating_Point_Expression.defs.hh          |    2 +-
 src/Variable_Floating_Point_Expression.defs.hh     |    2 +-
 8 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/Cast_Floating_Point_Expression.defs.hh b/src/Cast_Floating_Point_Expression.defs.hh
index 5dacccc..c02f3a7 100644
--- a/src/Cast_Floating_Point_Expression.defs.hh
+++ b/src/Cast_Floating_Point_Expression.defs.hh
@@ -105,7 +105,7 @@ public:
   FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename
diff --git a/src/Constant_Floating_Point_Expression.defs.hh b/src/Constant_Floating_Point_Expression.defs.hh
index 5036e75..190f86d 100644
--- a/src/Constant_Floating_Point_Expression.defs.hh
+++ b/src/Constant_Floating_Point_Expression.defs.hh
@@ -77,7 +77,7 @@ public:
   FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename
diff --git a/src/Difference_Floating_Point_Expression.defs.hh b/src/Difference_Floating_Point_Expression.defs.hh
index 1d1ab02..5fb74c6 100644
--- a/src/Difference_Floating_Point_Expression.defs.hh
+++ b/src/Difference_Floating_Point_Expression.defs.hh
@@ -118,7 +118,7 @@ public:
   ::FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename
diff --git a/src/Division_Floating_Point_Expression.defs.hh b/src/Division_Floating_Point_Expression.defs.hh
index ea4ebae..56f64f6 100644
--- a/src/Division_Floating_Point_Expression.defs.hh
+++ b/src/Division_Floating_Point_Expression.defs.hh
@@ -134,7 +134,7 @@ public:
   ::FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename
diff --git a/src/Floating_Point_Expression.defs.hh b/src/Floating_Point_Expression.defs.hh
index 5a25e9f..3f608d8 100644
--- a/src/Floating_Point_Expression.defs.hh
+++ b/src/Floating_Point_Expression.defs.hh
@@ -130,8 +130,8 @@ public:
     Verifies if a given linear form overflows.
     \param lf The linear form to verify.
     \return
-    Returns <CODE>true</CODE> if all coefficients in \p lf are bounded,
-    <CODE>false</CODE> otherwise.
+    Returns <CODE>false</CODE> if all coefficients in \p lf are bounded,
+    <CODE>true</CODE> otherwise.
   */
   static bool overflows(const FP_Linear_Form& lf);
 
@@ -146,7 +146,7 @@ public:
 
     This method makes <CODE>result</CODE> become a linear form
     obtained by evaluating the function \f$\varepsilon_{\mathbf{f}}(l)\f$
-    on the linear form \p lf. This function is defined as:
+    on the linear form \p lf. This function is defined
     such as:
     \f[
     \varepsilon_{\mathbf{f}}\left([a;b]+\sum_{v \in \cV}[a_{v};b_{v}]v\right)
@@ -192,7 +192,7 @@ private:
     Static helper method that is used to compute the value of the public
     static field <CODE>absolute_error</CODE>.
 
-    \return the interval \f$[-\omega; \omega]\f$ corresponding to the value
+    \return The interval \f$[-\omega; \omega]\f$ corresponding to the value
     of <CODE>absolute_error</CODE>
   */
   static FP_Interval_Type compute_absolute_error();
diff --git a/src/Multiplication_Floating_Point_Expression.defs.hh b/src/Multiplication_Floating_Point_Expression.defs.hh
index e2d994a..9630bed 100644
--- a/src/Multiplication_Floating_Point_Expression.defs.hh
+++ b/src/Multiplication_Floating_Point_Expression.defs.hh
@@ -148,7 +148,7 @@ public:
   ::FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename
diff --git a/src/Sum_Floating_Point_Expression.defs.hh b/src/Sum_Floating_Point_Expression.defs.hh
index f9bb6a7..4cd1009 100644
--- a/src/Sum_Floating_Point_Expression.defs.hh
+++ b/src/Sum_Floating_Point_Expression.defs.hh
@@ -111,7 +111,7 @@ public:
   ::FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename
diff --git a/src/Variable_Floating_Point_Expression.defs.hh b/src/Variable_Floating_Point_Expression.defs.hh
index 8c7eac7..1d0025b 100644
--- a/src/Variable_Floating_Point_Expression.defs.hh
+++ b/src/Variable_Floating_Point_Expression.defs.hh
@@ -80,7 +80,7 @@ public:
   FP_Linear_Form FP_Linear_Form;
 
   /*! \brief
-     Alias for the std::map<dimension_type, FP_Interval_Type> from
+     Alias for the Box<FP_Interval_Type> from
      Floating_Point_Expression.
   */
   typedef typename