Module: ppl/ppl Branch: master Commit: ad78ee45b1a55b0be516c2b0f00af68dc76cabf9 URL: http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=ad78ee45b1a55... Author: Enea Zaffanella <zaffanella@cs.unipr.it> Date: Sat Mar 31 10:06:55 2012 +0200 Improved documentation formatting using Doxygen command \tparam. --- src/linearize.hh | 38 ++++++++++++++++++++++---------------- 1 files changed, 22 insertions(+), 16 deletions(-) diff --git a/src/linearize.hh b/src/linearize.hh index 9e8de89..6bd75d8 100644 --- a/src/linearize.hh +++ b/src/linearize.hh @@ -643,29 +643,35 @@ cast_linearize(const Cast_Operator<Target>& cast_expr, return !result.overflows(); } -/*! \brief - Linearizes a floating point expression. - - \relates Concrete_Expression +//! Linearizes a floating point expression. +/*! \relates Concrete_Expression Makes \p result become a linear form that correctly approximates the value of \p expr in the given composite abstract store. - \par Template type parameters - - - The class template parameter \p Target specifies the implementation - of Concrete_Expression to be used. - - The class template parameter \p FP_Interval_Type represents the type - of the intervals used in the abstract domain. The interval bounds - should have a floating point type. + \tparam Target + A type template parameter specifying the instantiation of + Concrete_Expression to be used. - \param expr The concrete expression to linearize. - \param oracle The FP_Oracle to be queried. - \param lf_store The linear form abstract store. - \param result Becomes the linearized expression. + \tparam FP_Interval_Type + A type template parameter for the intervals used in the abstract domain. + The interval bounds should have a floating point type. - \return <CODE>true</CODE> if the linearization succeeded, + \return + <CODE>true</CODE> if the linearization succeeded, <CODE>false</CODE> otherwise. + \param expr + The concrete expression to linearize. + + \param oracle + The FP_Oracle to be queried. + + \param lf_store + The linear form abstract store. + + \param result + Becomes the linearized expression. + Formally, if \p expr represents the expression \f$e\f$ and \p lf_store represents the linear form abstract store \f$\rho^{\#}_l\f$, then \p result will become \f$\linexprenv{e}{\rho^{\#}}{\rho^{\#}_l}\f$