Skip to content

Commit 82eb56d

Browse files
committed
Add comment on mmeasurement overhead to README
1 parent e90bb7e commit 82eb56d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,21 @@ generation and reporting.
7070
Note that results are returned to the user to prevent JIT from recognising that
7171
the results are not used.
7272

73+
## Measurement Overhead Estimation
74+
75+
Criterium will automatically estimate a time for it's measurement
76+
overhead. The estimate is normally made once per session, and is
77+
available in the `criterium.core/extimated-overhead-cache` var.
78+
79+
If the estimation is made while their is a lot of other processing
80+
going on, then benchmarking quick functions may report small negative
81+
times. You can force a recalculation of the overhead by calling
82+
`criterium.core/estimated-overhead!`.
83+
84+
If you want consistency across JVM processes, it might be prudent to
85+
explicitly set `criterium.core/estimated-overhead!` to a constant
86+
value.
87+
7388
## References
7489

7590
[API Documentation](http://hugoduncan.github.com/criterium/0.4/api/)

0 commit comments

Comments
 (0)