Changeset 370 for trunk/lib/statistics/Histogram.h

Timestamp:

Aug 5, 2005, 3:26:10 PM (17 years ago)

Author:

Peter

Message:

improved docs

File:

• trunk/lib/statistics/Histogram.h (modified) (2 diffs)

trunk/lib/statistics/Histogram.h

@@ -96 +96 @@
 
     ///
-    /// @return The value of the histogram corresponding to bin \a
-    /// bin.
+    /// @return The value in the middle of bin \a k.
     ///
-    /// @note No check is done that \a bin is within the size of the
+    /// @note No check is done that \a k is within the size of the
     /// histogram.
     ///
-    inline double observation_value(const size_t bin) const
-      { return xmin_+spacing()*(bin+0.5); }
+    inline double observation_value(const size_t k) const
+      { return xmin_+spacing()*(k+0.5); }
 
     ///
@@ -131 +130 @@
 
     ///
-    /// @return The count of bin \a bin.in the histogram.
-    inline double operator[](size_t bin) const { return histogram_[bin]; } 
+    /// @return The count of bin \a k.in the histogram.
+    inline double operator[](size_t k) const { return histogram_[k]; } 
 
     ///