Changeset 327:63c138adc477 in lemon-0.x for src/work/marci

Timestamp:

04/15/04 08:49:49 (21 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@445

Message:

Documentation.

File:

• src/work/marci/time_measure.h (modified) (8 diffs)

src/work/marci/time_measure.h

@@ -18 +18 @@
 //   }
 
+  /// Class to store (cpu)time instances.
+
+  /// This class stores five time values.
+  /// - a real time
+  /// - a user cpu time
+  /// - a system cpu time
+  /// - a user cpu time of children
+  /// - a system cpu time of children
+  ///
+  /// TimeStamp's can be added to or substracted from each other and
+  /// they can be push to a stream.
+
   class TimeStamp
   {
@@ -28 +40 @@
     const tms &getTms() const {return ts;}
     double getRealTime() const {return real_time;}
+    ///Read the current time values of the process.
     void stamp()
     {
@@ -35 +48 @@
     }
   
+    /// Constructor initializing with zero.
     TimeStamp()
     { ts.tms_utime=ts.tms_stime=ts.tms_cutime=ts.tms_cstime=0; real_time=0;}
-  
+    ///Constructor initializing with the current time values of the process.
     TimeStamp(void *) { stamp();}
   
@@ -69 +83 @@
     }
 
+    ///The time ellapsed since the last call of stamp()
     TimeStamp ellapsed() const
     {
@@ -95 +110 @@
   };
 
+  ///Class measuring the cpu time and real time usage of the process.
   class Timer
   {
@@ -102 +118 @@
   
   public: 
+    ///Constructor. It starts with zero time counters.
     Timer() {_reset();}
 
+    ///Computes the ellapsed time.
+
+    ///This conversion computes the ellapsed time
+    ///since the construction of \c t or since
+    ///the last \c t.reset().
     operator TimeStamp ()
     {
@@ -111 +133 @@
     }
 
+    ///Resets the time counters.
     TimeStamp reset()
     {
@@ -119 +142 @@
   };
 
+  ///Prints the time counters.
   inline std::ostream& operator<<(std::ostream& os,const TimeStamp &t)
   {