doc support

C/arith0.c

@@ -18,8 +18,72 @@
 static char     SccsId[] = "%W% %G%";
 #endif
 
-/*
- * This file implements arithmetic operations 
+/**
+   @file arith0.c
+
+   @defgroup arithmetic_operators Arithmetic Functions
+   @ingroup arithmetic
+
+  YAP implements several arithmetic functions.  Arithmetic expressions
+  in YAP may use the following operators:
+
+   - <b>pi [ISO]</b><p> @anchor pi_0
+
+     An approximation to the value of <em>pi</em>, that is, the ratio of a circle's circumference to its diameter.
+
+   - <b>e</b><p>    @anchor e_0
+
+     Euler's number, the base of the natural logarithms.
+
+   - <b>epsilon</b><p>  @anchor epsilon_0
+
+     The difference between the float `1.0` and the next largest floating point number.
+
+   - <b>inf</b><p>  @anchor inf_0
+
+     Infinity according to the IEEE Floating-Point standard. Note that evaluating this term will generate a domain error in the `iso` language mode.
+
+     Note also that YAP supports `+inf` and  `-inf`
+
+   - <b>nan (not a number)</b><p>  @anchor nan_0
+
+     Not-a-number according to the IEEE Floating-Point standard. Note that evaluating this term will generate a domain error in the `iso` language mode.
+
+   - <b>random</b><p>  @anchor random_0
+
+     A "random" floating point number between 0 and 1.
+
+   - <b>cputime</b><p>  @anchor cputime_0
+
+     CPU time since YAP was invoked, in seconds.
+
+   - <b>heapused</b><p>  @anchor heapused_0
+
+     Heap (data-base) space used, in bytes.
+
+   - <b>local</b><p>  @anchor local_0
+
+     Local stack in use, in bytes
+
+   - <b>$b</b><p>  @anchor b_0
+
+     current choicepoint
+
+   - <b>$env</b><p>  @anchor env_0
+
+     Environment
+
+   - <b>$tr</b><p>  @anchor tr_0
+
+     Trail in use
+
+   - <b>$free_stack</b><p>  @anchor free_stack_0
+     
+     Amount of free stack space, that is, free space between global and local stacks.
+
+   - <b>global</b><p>  @anchor global_0
+
+     Global stack in use, in bytes.
  *
  */
 
@@ -89,7 +153,7 @@ eval0(Int fi) {
     }
   case op_nan:
     {
-#ifdef _MSC_VER /* Microsoft's Visual C++ Compiler */
+#ifdef _MSC_VER /* Microsoft's Visual C++ Compi<ler */
       Yap_Error(TYPE_ERROR_EVALUABLE, TermNil, "evaluating infinity");
       P = (yamop *)FAILCODE;
       RERROR();
@@ -112,40 +176,62 @@ eval0(Int fi) {
       RFLOAT((Float)Yap_cputime()/1000.0);
     }
   case op_heapused:
+    /// - heapused
+    ///   Heap (data-base) space used, in bytes.
+    ///
     RINT(HeapUsed);
   case op_localsp:
+    /// - local
+    ///   Local stack in use, in bytes
+    ///
 #if YAPOR_SBA
     RINT((Int)ASP);
 #else
     RINT(LCL0 - ASP);
 #endif
   case op_b:
+    /// - $b
+    ///   current choicepoint
+    ///
 #if YAPOR_SBA
     RINT((Int)B);
 #else
     RINT(LCL0 - (CELL *)B);
 #endif
   case op_env:
+    /// - $env
+    ///   Environment
+    ///
 #if YAPOR_SBA
     RINT((Int)YENV);
 #else
     RINT(LCL0 - YENV);
 #endif
   case op_tr:
+    /// - $tr
+    ///   Trail in use
+    ///
 #if YAPOR_SBA
     RINT(TR);
 #else
     RINT(((CELL *)TR)-LCL0);
 #endif
   case op_stackfree:
+    /// - $free_stack
+    ///   
+    /// Not-a-number according to the IEEE Floating-Point standard. Note that evaluating this term will generate a domain error in the `iso` language mode.
     RINT(Unsigned(ASP) - Unsigned(HR));
   case op_globalsp:
+    /// - global
+    ///   Global stack in use, in bytes.
+    ///
 #if YAPOR_SBA
     RINT((Int)HR);
 #else
     RINT(HR - H0);
 #endif
   }
+  /// end of switch
   RERROR();
 }
 
@@ -210,3 +296,4 @@ Yap_ReInitConstExps(void)
   return TRUE;
 }
 
+/// @}