[PPL-devel] [GIT] ppl/ppl(floating_point): Update documentation

Fabio Biselli fabio.biselli at studenti.unipr.it
Mon Sep 7 18:27:31 CEST 2009


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

Author: Fabio Biselli <fabio.biselli at studenti.unipr.it>
Date:   Mon Sep  7 20:24:53 2009 +0200

Update documentation

---

 src/Division_Floating_Point_Expression.defs.hh |    4 +---
 src/Floating_Point_Expression.defs.hh          |    4 ++--
 src/Variable_Floating_Point_Expression.defs.hh |    3 ++-
 3 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/src/Division_Floating_Point_Expression.defs.hh b/src/Division_Floating_Point_Expression.defs.hh
index a2a3d68..2a7738a 100644
--- a/src/Division_Floating_Point_Expression.defs.hh
+++ b/src/Division_Floating_Point_Expression.defs.hh
@@ -121,10 +121,8 @@ public:
      \param store The abstract store.
      \param result The linear form that will be modified.
 
-
      \exception Parma_Polyhedra_Library::Linearization_Failed
-     Thrown if \f$0 \in\f$
-      \p *this.second_operand.
+     Thrown if \f$0 \f$ is into second operand range.
   */
   void linearize(const FP_Interval_Abstract_Store& int_store,
                  const FP_Linear_Form_Abstract_Store& lf_store,
diff --git a/src/Floating_Point_Expression.defs.hh b/src/Floating_Point_Expression.defs.hh
index 845667a..68618a6 100644
--- a/src/Floating_Point_Expression.defs.hh
+++ b/src/Floating_Point_Expression.defs.hh
@@ -51,8 +51,8 @@ struct IEEE754_Double {
 //! A floating point expression on a given format
 /*! \ingroup PPL_CXX_Interface
   This class offers a generic implemenation of a
-  <EM>floating point expression</EM> of format \f$f\f$, this includes
-  constants, variables of format \f$f\f$, binary and unary
+  <EM>floating point expression</EM> of format \f$$\mathbf{f}$\f$, this 
+  includes constants, variables of format \f$$\mathbf{f}$\f$, binary and unary
   arithmetic operators.
 
   \par Template type parameters
diff --git a/src/Variable_Floating_Point_Expression.defs.hh b/src/Variable_Floating_Point_Expression.defs.hh
index e614df4..cb1c300 100644
--- a/src/Variable_Floating_Point_Expression.defs.hh
+++ b/src/Variable_Floating_Point_Expression.defs.hh
@@ -106,9 +106,10 @@ public:
 
   //@} // Constructors and Destructor
 
+  //! Linearization of a variable.
   /*! \brief
      Modifies a linear form \p result in the abstract store \p store
-     corresponding to <CODE>this</CODE> variable with coefficent \f[1,1]\f.
+     corresponding to <CODE>this</CODE> variable with coefficent \f$[1,1]\f$.
 
      \param store The abstract store.
      \param result The linear form that will be modified.




More information about the PPL-devel mailing list