[PPL-devel] [GIT] ppl/ppl(floating_point): Added and fixed documentation for Var_FP_Expression.

[Roberto Amadini]

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

Author: Roberto Amadini <r.amadini at virgilio.it>
Date:   Thu Feb 18 00:06:40 2010 +0100

Added and fixed documentation for Var_FP_Expression.

---

 src/Variable_Floating_Point_Expression.defs.hh |   18 ++++++++++++++----
 1 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/src/Variable_Floating_Point_Expression.defs.hh b/src/Variable_Floating_Point_Expression.defs.hh
index 1a44d09..70334fa 100644
--- a/src/Variable_Floating_Point_Expression.defs.hh
+++ b/src/Variable_Floating_Point_Expression.defs.hh
@@ -59,7 +59,7 @@ namespace Parma_Polyhedra_Library {
   \par Linearization of floating-point variable expressions
 
   Given a variable expression \f$v\f$ and a composite
-  abstract store \f$\left \llbracket \rho^{\#}, \rho^{\#}_l \right 
+  abstract store \f$\left \llbracket \rho^{\#}, \rho^{\#}_l \right
   \rrbracket\f$, we construct the interval
   linear form \f$\linexprenv{v}{\rho^{\#}}{\rho^{\#}_l}\f$ as
   \f$\rho^{\#}_l(v)\f$ if it is defined; otherwise we construct it as
@@ -95,7 +95,7 @@ public:
   Floating_Point_Expression<FP_Interval_Type, FP_Format>::
   FP_Linear_Form_Abstract_Store FP_Linear_Form_Abstract_Store;
 
-  /* \brief
+  /*! \brief
      Alias for the FP_Interval_Type::boundary_type from
      Floating_Point_Expression.
   */
@@ -123,7 +123,7 @@ public:
   //@} // Constructors and Destructor
 
   /*! \brief
-    Linearizes the expression in a given astract store.
+    Linearizes the expression in a given abstract store.
 
     Makes \p result become the linearization of \p *this in the given
     composite abstract store.
@@ -143,9 +143,19 @@ public:
                  const FP_Linear_Form_Abstract_Store& lf_store,
                  FP_Linear_Form& result) const;
 
+  /*! \brief
+    Assigns a linear form to the variable with the same index of
+    \p *this in a given linear form abstract store.
+
+    \param lf The linear form assigned to the variable.
+    \param lf_store The linear form abstract store.
 
-  void linear_form_assign(const FP_Linear_Form&,
+    Note that once \p lf is assigned to a variable, all the other entries
+    of \p lf_store which contain that variable are discarded.
+  */
+  void linear_form_assign(const FP_Linear_Form& lf,
                                 FP_Linear_Form_Abstract_Store& lf_store) const;
+
   //! Swaps \p *this with \p y.
   void swap(Variable_Floating_Point_Expression& y);