Permalink
Browse files

Update doc for 0.4.3

  • Loading branch information...
1 parent e5ed91c commit 2e872366e9cfd22ec6120b3d53105e1407b3db72 @hugoduncan committed Jan 22, 2014
@@ -8,7 +8,7 @@
<body>
<header>
<div id="header">
- <h1 class="project-title">Criterium 0.4.0 API documentation</h1>
+ <h1 class="project-title">Criterium 0.4.3 API documentation</h1>
</div>
</header>
<navigation>
@@ -21,7 +21,7 @@ <h1 class="project-title">Criterium 0.4.0 API documentation</h1>
<div id="vars" class="sidebar">
<h3>Public Vars</h3>
<ul class="ns-var-links">
- <li class="ns-var-link"><a href="criterium.core.html#var-*final-gc-problem-threshold*">*final-gc-problem-threshold*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*max-gc-attempts*">*max-gc-attempts*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*sample-count*">*sample-count*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*target-execution-time*">*target-execution-time*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*warmup-jit-period*">*warmup-jit-period*</a></li><li class="ns-var-link"><a href="criterium.core.html#var--%3EJvmClassLoaderState">-&gt;JvmClassLoaderState</a></li><li class="ns-var-link"><a href="criterium.core.html#var--%3EJvmCompilationState">-&gt;JvmCompilationState</a></li><li class="ns-var-link"><a href="criterium.core.html#var--%3EOutlierCount">-&gt;OutlierCount</a></li><li class="ns-var-link"><a href="criterium.core.html#var--%3EUnsynchronized">-&gt;Unsynchronized</a></li><li class="ns-var-link"><a href="criterium.core.html#var-MutablePlace">MutablePlace</a></li><li class="ns-var-link"><a href="criterium.core.html#var-StateChanged">StateChanged</a></li><li class="ns-var-link"><a href="criterium.core.html#var-bench">bench</a></li><li class="ns-var-link"><a href="criterium.core.html#var-benchmark">benchmark</a></li><li class="ns-var-link"><a href="criterium.core.html#var-benchmark*">benchmark*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-bootstrap">bootstrap</a></li><li class="ns-var-link"><a href="criterium.core.html#var-bootstrap-bca">bootstrap-bca</a></li><li class="ns-var-link"><a href="criterium.core.html#var-estimatated-overhead%21">estimatated-overhead!</a></li><li class="ns-var-link"><a href="criterium.core.html#var-estimate-execution-count">estimate-execution-count</a></li><li class="ns-var-link"><a href="criterium.core.html#var-estimate-overhead">estimate-overhead</a></li><li class="ns-var-link"><a href="criterium.core.html#var-execute-expr">execute-expr</a></li><li class="ns-var-link"><a href="criterium.core.html#var-execute-expr-core-timed-part">execute-expr-core-timed-part</a></li><li class="ns-var-link"><a href="criterium.core.html#var-extract-report-options">extract-report-options</a></li><li class="ns-var-link"><a href="criterium.core.html#var-final-gc">final-gc</a></li><li class="ns-var-link"><a href="criterium.core.html#var-force-gc">force-gc</a></li><li class="ns-var-link"><a href="criterium.core.html#var-get-place">get-place</a></li><li class="ns-var-link"><a href="criterium.core.html#var-heap-used">heap-used</a></li><li class="ns-var-link"><a href="criterium.core.html#var-jvm-compilation-state">jvm-compilation-state</a></li><li class="ns-var-link"><a href="criterium.core.html#var-jvm-jit-name">jvm-jit-name</a></li><li class="ns-var-link"><a href="criterium.core.html#var-map-%3EJvmClassLoaderState">map-&gt;JvmClassLoaderState</a></li><li class="ns-var-link"><a href="criterium.core.html#var-map-%3EJvmCompilationState">map-&gt;JvmCompilationState</a></li><li class="ns-var-link"><a href="criterium.core.html#var-map-%3EOutlierCount">map-&gt;OutlierCount</a></li><li class="ns-var-link"><a href="criterium.core.html#var-memory">memory</a></li><li class="ns-var-link"><a href="criterium.core.html#var-os-details">os-details</a></li><li class="ns-var-link"><a href="criterium.core.html#var-outlier-effect">outlier-effect</a></li><li class="ns-var-link"><a href="criterium.core.html#var-outlier-significance">outlier-significance</a></li><li class="ns-var-link"><a href="criterium.core.html#var-outliers">outliers</a></li><li class="ns-var-link"><a href="criterium.core.html#var-quick-bench">quick-bench</a></li><li class="ns-var-link"><a href="criterium.core.html#var-quick-benchmark">quick-benchmark</a></li><li class="ns-var-link"><a href="criterium.core.html#var-quick-benchmark*">quick-benchmark*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-report">report</a></li><li class="ns-var-link"><a href="criterium.core.html#var-run-benchmark">run-benchmark</a></li><li class="ns-var-link"><a href="criterium.core.html#var-run-benchmarks-round-robin">run-benchmarks-round-robin</a></li><li class="ns-var-link"><a href="criterium.core.html#var-runtime-details">runtime-details</a></li><li class="ns-var-link"><a href="criterium.core.html#var-scale-time">scale-time</a></li><li class="ns-var-link"><a href="criterium.core.html#var-set-place">set-place</a></li><li class="ns-var-link"><a href="criterium.core.html#var-state-changed%3F">state-changed?</a></li><li class="ns-var-link"><a href="criterium.core.html#var-state-delta">state-delta</a></li><li class="ns-var-link"><a href="criterium.core.html#var-system-properties">system-properties</a></li><li class="ns-var-link"><a href="criterium.core.html#var-time-body">time-body</a></li><li class="ns-var-link"><a href="criterium.core.html#var-time-body-with-jvm-state">time-body-with-jvm-state</a></li><li class="ns-var-link"><a href="criterium.core.html#var-timestamp">timestamp</a></li><li class="ns-var-link"><a href="criterium.core.html#var-timestamp-2">timestamp-2</a></li><li class="ns-var-link"><a href="criterium.core.html#var-warmup-for-jit">warmup-for-jit</a></li><li class="ns-var-link"><a href="criterium.core.html#var-with-progress-reporting">with-progress-reporting</a></li>
+ <li class="ns-var-link"><a href="criterium.core.html#var-*final-gc-problem-threshold*">*final-gc-problem-threshold*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*max-gc-attempts*">*max-gc-attempts*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*sample-count*">*sample-count*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*target-execution-time*">*target-execution-time*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-*warmup-jit-period*">*warmup-jit-period*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-MutablePlace">MutablePlace</a></li><li class="ns-var-link"><a href="criterium.core.html#var-StateChanged">StateChanged</a></li><li class="ns-var-link"><a href="criterium.core.html#var-bench">bench</a></li><li class="ns-var-link"><a href="criterium.core.html#var-benchmark">benchmark</a></li><li class="ns-var-link"><a href="criterium.core.html#var-benchmark*">benchmark*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-bootstrap">bootstrap</a></li><li class="ns-var-link"><a href="criterium.core.html#var-bootstrap-bca">bootstrap-bca</a></li><li class="ns-var-link"><a href="criterium.core.html#var-estimatated-overhead%21">estimatated-overhead!</a></li><li class="ns-var-link"><a href="criterium.core.html#var-estimate-execution-count">estimate-execution-count</a></li><li class="ns-var-link"><a href="criterium.core.html#var-estimate-overhead">estimate-overhead</a></li><li class="ns-var-link"><a href="criterium.core.html#var-execute-expr">execute-expr</a></li><li class="ns-var-link"><a href="criterium.core.html#var-execute-expr-core-timed-part">execute-expr-core-timed-part</a></li><li class="ns-var-link"><a href="criterium.core.html#var-extract-report-options">extract-report-options</a></li><li class="ns-var-link"><a href="criterium.core.html#var-final-gc">final-gc</a></li><li class="ns-var-link"><a href="criterium.core.html#var-force-gc">force-gc</a></li><li class="ns-var-link"><a href="criterium.core.html#var-get-place">get-place</a></li><li class="ns-var-link"><a href="criterium.core.html#var-heap-used">heap-used</a></li><li class="ns-var-link"><a href="criterium.core.html#var-jvm-compilation-state">jvm-compilation-state</a></li><li class="ns-var-link"><a href="criterium.core.html#var-jvm-jit-name">jvm-jit-name</a></li><li class="ns-var-link"><a href="criterium.core.html#var-memory">memory</a></li><li class="ns-var-link"><a href="criterium.core.html#var-os-details">os-details</a></li><li class="ns-var-link"><a href="criterium.core.html#var-outlier-effect">outlier-effect</a></li><li class="ns-var-link"><a href="criterium.core.html#var-outlier-significance">outlier-significance</a></li><li class="ns-var-link"><a href="criterium.core.html#var-outliers">outliers</a></li><li class="ns-var-link"><a href="criterium.core.html#var-quick-bench">quick-bench</a></li><li class="ns-var-link"><a href="criterium.core.html#var-quick-benchmark">quick-benchmark</a></li><li class="ns-var-link"><a href="criterium.core.html#var-quick-benchmark*">quick-benchmark*</a></li><li class="ns-var-link"><a href="criterium.core.html#var-report">report</a></li><li class="ns-var-link"><a href="criterium.core.html#var-run-benchmark">run-benchmark</a></li><li class="ns-var-link"><a href="criterium.core.html#var-run-benchmarks-round-robin">run-benchmarks-round-robin</a></li><li class="ns-var-link"><a href="criterium.core.html#var-runtime-details">runtime-details</a></li><li class="ns-var-link"><a href="criterium.core.html#var-scale-time">scale-time</a></li><li class="ns-var-link"><a href="criterium.core.html#var-set-place">set-place</a></li><li class="ns-var-link"><a href="criterium.core.html#var-state-changed%3F">state-changed?</a></li><li class="ns-var-link"><a href="criterium.core.html#var-state-delta">state-delta</a></li><li class="ns-var-link"><a href="criterium.core.html#var-system-properties">system-properties</a></li><li class="ns-var-link"><a href="criterium.core.html#var-time-body">time-body</a></li><li class="ns-var-link"><a href="criterium.core.html#var-time-body-with-jvm-state">time-body-with-jvm-state</a></li><li class="ns-var-link"><a href="criterium.core.html#var-timestamp">timestamp</a></li><li class="ns-var-link"><a href="criterium.core.html#var-timestamp-2">timestamp-2</a></li><li class="ns-var-link"><a href="criterium.core.html#var-warmup-for-jit">warmup-for-jit</a></li><li class="ns-var-link"><a href="criterium.core.html#var-warn-on-suspicious-jvm-options">warn-on-suspicious-jvm-options</a></li><li class="ns-var-link"><a href="criterium.core.html#var-with-progress-reporting">with-progress-reporting</a></li>
</ul>
</div>
</navigation>
@@ -95,34 +95,6 @@ <h3 id="var-*warmup-jit-period*">*warmup-jit-period*</h3>
its work.</p>
</div>
</div><div class="public">
- <h3 id="var--%3EJvmClassLoaderState">-&gt;JvmClassLoaderState</h3>
- <div class="usage">[loaded-count unloaded-count]</div>
-
-
- <div class="doc"><p>Positional factory function for class criterium.core.JvmClassLoaderState.</p>
-</div>
- </div><div class="public">
- <h3 id="var--%3EJvmCompilationState">-&gt;JvmCompilationState</h3>
- <div class="usage">[compilation-time]</div>
-
-
- <div class="doc"><p>Positional factory function for class criterium.core.JvmCompilationState.</p>
-</div>
- </div><div class="public">
- <h3 id="var--%3EOutlierCount">-&gt;OutlierCount</h3>
- <div class="usage">[low-severe low-mild high-mild high-severe]</div>
-
-
- <div class="doc"><p>Positional factory function for class criterium.core.OutlierCount.</p>
-</div>
- </div><div class="public">
- <h3 id="var--%3EUnsynchronized">-&gt;Unsynchronized</h3>
- <div class="usage">[v]</div>
-
-
- <div class="doc"><p>Positional factory function for class criterium.core.Unsynchronized.</p>
-</div>
- </div><div class="public">
<h3 id="var-MutablePlace">MutablePlace</h3>
@@ -157,7 +129,7 @@ <h3 id="var-benchmark">benchmark</h3>
</div>
</div><div class="public">
<h3 id="var-benchmark*">benchmark*</h3>
- <div class="usage">[f {:keys [samples warmup-jit-period target-execution-time gc-before-sample overhead], :as options}]</div>
+ <div class="usage">[f {:keys [samples warmup-jit-period target-execution-time gc-before-sample overhead supress-jvm-option-warnings], :as options}]</div>
<div class="doc"><p>Benchmark a function. This tries its best to eliminate sources of error.
@@ -292,27 +264,6 @@ <h3 id="var-jvm-jit-name">jvm-jit-name</h3>
<div class="doc"><p>Returns the name of the JIT compiler.</p>
</div>
</div><div class="public">
- <h3 id="var-map-%3EJvmClassLoaderState">map-&gt;JvmClassLoaderState</h3>
- <div class="usage">[m__5665__auto__]</div>
-
-
- <div class="doc"><p>Factory function for class criterium.core.JvmClassLoaderState, taking a map of keywords to field values.</p>
-</div>
- </div><div class="public">
- <h3 id="var-map-%3EJvmCompilationState">map-&gt;JvmCompilationState</h3>
- <div class="usage">[m__5665__auto__]</div>
-
-
- <div class="doc"><p>Factory function for class criterium.core.JvmCompilationState, taking a map of keywords to field values.</p>
-</div>
- </div><div class="public">
- <h3 id="var-map-%3EOutlierCount">map-&gt;OutlierCount</h3>
- <div class="usage">[m__5665__auto__]</div>
-
-
- <div class="doc"><p>Factory function for class criterium.core.OutlierCount, taking a map of keywords to field values.</p>
-</div>
- </div><div class="public">
<h3 id="var-memory">memory</h3>
<div class="usage">[]</div>
@@ -496,6 +447,13 @@ <h3 id="var-warmup-for-jit">warmup-for-jit</h3>
<div class="doc"><p>Run expression for the given amount of time to enable JIT compilation.</p>
</div>
</div><div class="public">
+ <h3 id="var-warn-on-suspicious-jvm-options">warn-on-suspicious-jvm-options</h3>
+ <div class="usage">[]</div>
+
+
+ <div class="doc"><p>Warn if the JIT options are suspicious looking.</p>
+</div>
+ </div><div class="public">
<h3 id="var-with-progress-reporting">with-progress-reporting</h3>
<div class="usage">[expr]</div>
@@ -8,7 +8,7 @@
<body>
<header>
<div id="header">
- <h1 class="project-title">Criterium 0.4.0 API documentation</h1>
+ <h1 class="project-title">Criterium 0.4.3 API documentation</h1>
</div>
</header>
<navigation>
@@ -8,7 +8,7 @@
<body>
<header>
<div id="header">
- <h1 class="project-title">Criterium 0.4.0 API documentation</h1>
+ <h1 class="project-title">Criterium 0.4.3 API documentation</h1>
</div>
</header>
<navigation>
@@ -8,7 +8,7 @@
<body>
<header>
<div id="header">
- <h1 class="project-title">Criterium 0.4.0 API documentation</h1>
+ <h1 class="project-title">Criterium 0.4.3 API documentation</h1>
</div>
</header>
<navigation>
Oops, something went wrong.

0 comments on commit 2e87236

Please sign in to comment.