[Boost-commit] svn:boost r53405 - in trunk: boost/accumulators/statistics libs/accumulators/doc

Subject: [Boost-commit] svn:boost r53405 - in trunk: boost/accumulators/statistics libs/accumulators/doc
From: eric_at_[hidden]
Date: 2009-05-29 14:21:13

Author: eric_niebler
Date: 2009-05-29 14:21:13 EDT (Fri, 29 May 2009)
New Revision: 53405
URL: http://svn.boost.org/trac/boost/changeset/53405

Log:
document precondition on result extraction for density accumulator
Text files modified: 
   trunk/boost/accumulators/statistics/density.hpp |     3 +++                                     
   trunk/libs/accumulators/doc/accumulators.qbk    |     5 +++++                                   
   2 files changed, 8 insertions(+), 0 deletions(-)

Modified: trunk/boost/accumulators/statistics/density.hpp
==============================================================================
--- trunk/boost/accumulators/statistics/density.hpp	(original)
+++ trunk/boost/accumulators/statistics/density.hpp	2009-05-29 14:21:13 EDT (Fri, 29 May 2009)
@@ -157,6 +157,9 @@
             }
         }
 
+        /**
+            @pre The number of samples must meet or exceed the cache size
+        */
         template<typename Args>
         result_type result(Args const &args) const
         {

Modified: trunk/libs/accumulators/doc/accumulators.qbk
==============================================================================
--- trunk/libs/accumulators/doc/accumulators.qbk	(original)
+++ trunk/libs/accumulators/doc/accumulators.qbk	2009-05-29 14:21:13 EDT (Fri, 29 May 2009)
@@ -1141,6 +1141,11 @@
 
     #include <_DENSITY_HPP_>
 
+[*Note]
+
+Results from the `density` accumulator can only be extracted after the number of
+samples meets or exceeds the cache size.
+
 [/ TODO add example ]
 
 [*See also]