This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
<!DOCTYPE html>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>PerfStats (infer.InferModules.PerfStats)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc %%VERSION%%"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">InferModules</a>» PerfStats</nav><h1>Module <code>InferModules.PerfStats</code></h1></header><aside><p>Performance Statistics gathering and reporting</p></aside><dl><dtclass="spec type"id="type-perf_stats"><ahref="#type-perf_stats"class="anchor"></a><code><spanclass="keyword">type</span> perf_stats</code></dt><dtclass="spec type"id="type-stats_kind"><ahref="#type-stats_kind"class="anchor"></a><code><spanclass="keyword">type</span> stats_kind</code><code> = </code><tableclass="variant"><trid="type-stats_kind.Time"class="anchored"><tdclass="def constructor"><ahref="#type-stats_kind.Time"class="anchor"></a><code>| </code><code><spanclass="constructor">Time</span><spanclass="keyword">of</span> Mtime_clock.counter * <ahref="../../../InferStdlib/InferStdlib/index.html#module-IStd">InferStdlib.IStd</a>.Unix.process_times</code></td></tr><trid="type-stats_kind.Memory"class="anchored"><tdclass="def constructor"><ahref="#type-stats_kind.Memory"class="anchor"></a><code>| </code><code><spanclass="constructor">Memory</span></code></td></tr><trid="type-stats_kind.TimeAndMemory"class="anchored"><tdclass="def constructor"><ahref="#type-stats_kind.TimeAndMemory"class="anchor"></a><code>| </code><code><spanclass="constructor">TimeAndMemory</span></code></td></tr></table></dt><dtclass="spec type"id="type-stats_type"><ahref="#type-stats_type"class="anchor"></a><code><spanclass="keyword">type</span> stats_type</code><code> = </code><tableclass="variant"><trid="type-stats_type.ClangLinters"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.ClangLinters"class="anchor"></a><code>| </code><code><spanclass="constructor">ClangLinters</span><spanclass="keyword">of</span><ahref="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><trid="type-stats_type.ClangFrontend"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.ClangFrontend"class="anchor"></a><code>| </code><code><spanclass="constructor">ClangFrontend</span><spanclass="keyword">of</span><ahref="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><trid="type-stats_type.ClangFrontendLinters"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.ClangFrontendLinters"class="anchor"></a><code>| </code><code><spanclass="constructor">ClangFrontendLinters</span><spanclass="keyword">of</span><ahref="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><trid="type-stats_type.JavaFrontend"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.JavaFrontend"class="anchor"></a><code>| </code><code><spanclass="constructor">JavaFrontend</span><spanclass="keyword">of</span><ahref="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><trid="type-stats_type.TotalFrontend"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.TotalFrontend"class="anchor"></a><code>| </code><code><spanclass="constructor">TotalFrontend</span></code></td></tr><trid="type-stats_type.Backend"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.Backend"class="anchor"></a><code>| </code><code><spanclass="constructor">Backend</span><spanclass="keyword">of</span><ahref="../../../InferBase/InferBase/SourceFile/index.html#type-t">InferBase.SourceFile.t</a></code></td></tr><trid="type-stats_type.TotalBackend"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.TotalBackend"class="anchor"></a><code>| </code><code><spanclass="constructor">TotalBackend</span></code></td></tr><trid="type-stats_type.Reporting"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.Reporting"class="anchor"></a><code>| </code><code><spanclass="constructor">Reporting</span></code></td></tr><trid="type-stats_type.Driver"class="anchored"><tdclass="def constructor"><ahref="#type-stats_type.Driver"class="anchor"></a><code>| </code><code><spanclass="constructor">Driver</span></code></td></tr></table></dt></dl><dl><dtclass="spec value"id="val-from_json"><ahref="#val-from_json"class="anchor"></a><code><spanclass="keyword">val</span> from_json : Yojson.Basic.t <span>-></span><ahref="index.html#type-perf_stats">perf_stats</a></code></dt><dtclass="spec value"id="val-aggregate"><ahref="#val-aggregate"class="anchor"></a><code><spanclass="keyword">val</span> aggregate : <span><ahref="index.html#type-perf_stats">perf_stats</a> list</span><span>-></span> Yojson.Basic.t</code></dt><dtclass="spec value"id="val-register_report"><ahref="#val-register_report"class="anchor"></a><code><spanclass="keyword">val</span> register_report : <ahref="index.html#type-stats_kind">stats_kind</a><span>-></span><ahref="index.html#type-stats_type">stats_type</a><span>-></span> unit</code></dt><dd><p>Register performance reporting function</p></dd></dl><dl><dtclass="spec value"id="val-get_reporter"><ahref="#val-get_reporter"class="anchor"></a><code><spanclass="keyword">val</span> get_reporter : <ahref="index.html#type-stats_type">stats_type</a><span>-></span> unit <span>-></span> unit</code></dt><dd><p>Get reporting function that can be called at any time to create a performance report</p></dd></dl><dl><dtclass="spec value"id="val-register_report_at_exit"><ahref="#val-register_report_at_exit"class="anchor"></a><code><spanclass="keyword">val</span> register_report_at_exit : <ahref="index.html#type-stats_type">stats_type</a><span>-></span> unit</code></dt><dd><p>Create performance report when the current process terminates</p></dd></dl></div></body></html>
