Skip to content
Browse files

Add comment on mmeasurement overhead to README

  • Loading branch information...
1 parent e90bb7e commit 82eb56df3cd384774996c50a3424488d8b90cbed @hugoduncan committed Feb 13, 2014
Showing with 15 additions and 0 deletions.
  1. +15 −0 README.md
View
15 README.md
@@ -70,6 +70,21 @@ generation and reporting.
Note that results are returned to the user to prevent JIT from recognising that
the results are not used.
+## Measurement Overhead Estimation
+
+Criterium will automatically estimate a time for it's measurement
+overhead. The estimate is normally made once per session, and is
+available in the `criterium.core/extimated-overhead-cache` var.
+
+If the estimation is made while their is a lot of other processing
+going on, then benchmarking quick functions may report small negative
+times. You can force a recalculation of the overhead by calling
+`criterium.core/estimated-overhead!`.
+
+If you want consistency across JVM processes, it might be prudent to
+explicitly set `criterium.core/estimated-overhead!` to a constant
+value.
+
## References
[API Documentation](http://hugoduncan.github.com/criterium/0.4/api/)

0 comments on commit 82eb56d

Please sign in to comment.
Something went wrong with that request. Please try again.