Changeset 2598 in Sophya for trunk/SophyaLib/SysTools/rpneval.cc

Timestamp:

Aug 11, 2004, 3:10:25 PM (21 years ago)

Author:

ansari

Message:

Documentation (ajoutee ou completee) pour les classes du module SysTools - Reza 11 Aout 2004

File:

• trunk/SophyaLib/SysTools/rpneval.cc (modified) (3 diffs)

trunk/SophyaLib/SysTools/rpneval.cc

@@ -10 +10 @@
 
 /*!
-  \class SOPHYA::RPNExpressionEvaluator
+  \class RPNExpressionEvaluator
   \ingroup SysTools
   Arithmetic expression (double precision float) evaluator 
   in Reverse Polish Notation (RPN). This is an HP calculator 
   like syntax. Space are used for separating the string 
-  expression into tokens. 
+  expression into tokens. \n
+  The string parsed by RPNExpressionEvaluator should be 
+  formed by a set of space separated words. Each word may be
+  a numerical constant or operation or function. 
+  All numeriacl constants are pushed to stack top. 
+  The stack is limited only
+  by the available memory. The three numbers on the stack top
+  are referred to as <tt> x y x </tt>. \n
+  Available operations: 
+  - op= + - * / % : replace (x,y) by x.op.y 
+  - e pi : M_PI , M_E numerical constants
+  - f= sin cos tan asin acos atan : replace x by f(x)
+  - f= chs sqrt sq : (x<-f(x)) change-sign , square root and square (x<-x^2) operations 
+  - f= log log10 exp : replace x by f(x) 
+  - f= fabs floor ceiling : replace x by f(x) 
+  - f= deg2rad rad2deg : replace x by f(x) 
+  - f= rand01 randpm1 gaurand : pushes a random number on the stack top ([0 1] [-1 1] Gaussian)
+  - print x<>y pop push : stack operations
+  - sum product : Replace the complete stack by the sum / product of the numbers in the stack
+  - mean sigma : Replace the complete stack by the mean / sigma of the numbers in the stack
+
+  \sa CExpressionEvaluator Commander
+
+  The following output is produced by the sample code below:
+  \code
+  #include "rpneval.h"
+  ...
+  RPNExpressionEvaluator rpn1("4 2 print + 3 * ");
+  cout << "RPN1: 4 2 + 3 * -> rpn1.Value() = " << rpn1.Value() << endl;  
+  RPNExpressionEvaluator rpn2("1 2 3 4 5 sum");
+  cout << "RPN2: 1 2 3 4 5 sum -> rpn2.Value() = " << rpn2.Value() << endl;
+  \endcode
+
+  Output:
+  \verbatim
+  RPNExpressionEvaluator::PrintStack() Size()= 2
+      0:  2   (x) 
+      1:  4   (y) 
+  RPN1: 4 2 + 3 * -> rpn1.Value() = 18
+  RPN2: 1 2 3 4 5 sum -> rpn2.Value() = 15  
+  \endverbatim
 */
 
+/*!
+  \brief Parses the string \b sex into words and perform the specified operations on the stack.
+
+  Can throw  RPNExprException 
+*/
 RPNExpressionEvaluator::RPNExpressionEvaluator(string const & sex)
 {
@@ -33 +78 @@
 }
 
+/*! 
+  \brief Perform the operations specified by \b on the stack, starting from element \b exe[off].  
+
+  Can throw  RPNExprException 
+*/
 RPNExpressionEvaluator::RPNExpressionEvaluator(vector<string> & exe, int off)
 {
@@ -52 +102 @@
 /* Operations sur le stack RPN */
 /* --Methode-- */
+//! Return the stack top (x) 
 double RPNExpressionEvaluator::Evaluate() const
 {