infer_clone/website/static/odoc/next/infer/IBase/SymOp/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>SymOp (infer.IBase.SymOp)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">IBase</a> &#x00BB; SymOp</nav><h1>Module <code>IBase.SymOp</code></h1></header><aside><p>Symbolic Operations and Failures: the units in which analysis work is measured</p></aside><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Internal state of the module</p></dd></dl><dl><dt class="spec value" id="val-check_wallclock_alarm"><a href="#val-check_wallclock_alarm" class="anchor"></a><code><span class="keyword">val</span> check_wallclock_alarm : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>if the wallclock alarm has expired, raise a timeout exception</p></dd></dl><dl><dt class="spec value" id="val-get_remaining_wallclock_time"><a href="#val-get_remaining_wallclock_time" class="anchor"></a><code><span class="keyword">val</span> get_remaining_wallclock_time : unit <span>&#45;&gt;</span> float</code></dt><dd><p>Return the time remaining before the wallclock alarm expires</p></dd></dl><dl><dt class="spec value" id="val-get_timeout_seconds"><a href="#val-get_timeout_seconds" class="anchor"></a><code><span class="keyword">val</span> get_timeout_seconds : unit <span>&#45;&gt;</span> <span>float option</span></code></dt><dd><p>Timeout in seconds for each function</p></dd></dl><dl><dt class="spec value" id="val-get_total"><a href="#val-get_total" class="anchor"></a><code><span class="keyword">val</span> get_total : unit <span>&#45;&gt;</span> int</code></dt><dd><p>Return the total number of symop's since the beginning</p></dd></dl><dl><dt class="spec value" id="val-pay"><a href="#val-pay" class="anchor"></a><code><span class="keyword">val</span> pay : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>Count one symop</p></dd></dl><dl><dt class="spec value" id="val-reset_total"><a href="#val-reset_total" class="anchor"></a><code><span class="keyword">val</span> reset_total : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>Reset the total number of symop's</p></dd></dl><dl><dt class="spec value" id="val-restore_state"><a href="#val-restore_state" class="anchor"></a><code><span class="keyword">val</span> restore_state : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p>Restore the old state.</p></dd></dl><dl><dt class="spec value" id="val-save_state"><a href="#val-save_state" class="anchor"></a><code><span class="keyword">val</span> save_state : <span>keep_symop_total:bool</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>Return the old state, and revert the current state to the initial one. If keep_symop_total is true, share the total counter.</p></dd></dl><dl><dt class="spec value" id="val-set_alarm"><a href="#val-set_alarm" class="anchor"></a><code><span class="keyword">val</span> set_alarm : unit <span>&#45;&gt;</span> unit</code></dt><dd><p>Reset the counter and activate the alarm</p></dd></dl><dl><dt class="spec value" id="val-set_wallclock_alarm"><a href="#val-set_wallclock_alarm" class="anchor"></a><code><span class="keyword">val</span> set_wallclock_alarm : float <span>&#45;&gt;</span> unit</code></dt><dd><p>Set the wallclock alarm checked at every pay()</p></dd></dl><dl><dt class="spec value" id="val-set_wallclock_timeout_handler"><a href="#val-set_wallclock_timeout_handler" class="anchor"></a><code><span class="keyword">val</span> set_wallclock_timeout_handler : <span>(unit <span>&#45;&gt;</span> unit)</span> <span>&#45;&gt;</span> unit</code></dt><dd><p>set the handler for the wallclock timeout</p></dd></dl><dl><dt class="spec value" id="val-unset_alarm"
[website] docs for current master Summary: Run `make doc-publish` and adjust links in website/docs/04-internal-API.md to point to odoc/next/infer/infer.html as the starting point of the docs has changed (was: odoc/index.html but now this also contains dead links to sledge and ppx_trace... also infer.mld is a me-written exposé of the various libraries and index.mld is an auto-generated list of all the modules now). Reviewed By: ngorogiannis Differential Revision: D21552864 fbshipit-source-id: c3977f645 5 years ago				`<!DOCTYPE html>`
make new-website-version Summary: Update documentation and add a version for v1.0.0. Reviewed By: martintrojer Differential Revision: D24191031 fbshipit-source-id: 0a57c693e 4 years ago				<html xmlns="http://www.w3.org/1999/xhtml"><head><title>SymOp (infer.IBase.SymOp)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> » <a href="../index.html">IBase</a> » SymOp</nav><h1>Module <code>IBase.SymOp</code></h1></header><aside><p>Symbolic Operations and Failures: the units in which analysis work is measured</p></aside><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Internal state of the module</p></dd></dl><dl><dt class="spec value" id="val-check_wallclock_alarm"><a href="#val-check_wallclock_alarm" class="anchor"></a><code><span class="keyword">val</span> check_wallclock_alarm : unit <span>-></span> unit</code></dt><dd><p>if the wallclock alarm has expired, raise a timeout exception</p></dd></dl><dl><dt class="spec value" id="val-get_remaining_wallclock_time"><a href="#val-get_remaining_wallclock_time" class="anchor"></a><code><span class="keyword">val</span> get_remaining_wallclock_time : unit <span>-></span> float</code></dt><dd><p>Return the time remaining before the wallclock alarm expires</p></dd></dl><dl><dt class="spec value" id="val-get_timeout_seconds"><a href="#val-get_timeout_seconds" class="anchor"></a><code><span class="keyword">val</span> get_timeout_seconds : unit <span>-></span> <span>float option</span></code></dt><dd><p>Timeout in seconds for each function</p></dd></dl><dl><dt class="spec value" id="val-get_total"><a href="#val-get_total" class="anchor"></a><code><span class="keyword">val</span> get_total : unit <span>-></span> int</code></dt><dd><p>Return the total number of symop's since the beginning</p></dd></dl><dl><dt class="spec value" id="val-pay"><a href="#val-pay" class="anchor"></a><code><span class="keyword">val</span> pay : unit <span>-></span> unit</code></dt><dd><p>Count one symop</p></dd></dl><dl><dt class="spec value" id="val-reset_total"><a href="#val-reset_total" class="anchor"></a><code><span class="keyword">val</span> reset_total : unit <span>-></span> unit</code></dt><dd><p>Reset the total number of symop's</p></dd></dl><dl><dt class="spec value" id="val-restore_state"><a href="#val-restore_state" class="anchor"></a><code><span class="keyword">val</span> restore_state : <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dd><p>Restore the old state.</p></dd></dl><dl><dt class="spec value" id="val-save_state"><a href="#val-save_state" class="anchor"></a><code><span class="keyword">val</span> save_state : <span>keep_symop_total:bool</span> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Return the old state, and revert the current state to the initial one. If keep_symop_total is true, share the total counter.</p></dd></dl><dl><dt class="spec value" id="val-set_alarm"><a href="#val-set_alarm" class="anchor"></a><code><span class="keyword">val</span> set_alarm : unit <span>-></span> unit</code></dt><dd><p>Reset the counter and activate the alarm</p></dd></dl><dl><dt class="spec value" id="val-set_wallclock_alarm"><a href="#val-set_wallclock_alarm" class="anchor"></a><code><span class="keyword">val</span> set_wallclock_alarm : float <span>-></span> unit</code></dt><dd><p>Set the wallclock alarm checked at every pay()</p></dd></dl><dl><dt class="spec value" id="val-set_wallclock_timeout_handler"><a href="#val-set_wallclock_timeout_handler" class="anchor"></a><code><span class="keyword">val</span> set_wallclock_timeout_handler : <span>(unit <span>-></span> unit)</span> <span>-></span> unit</code></dt><dd><p>set the handler for the wallclock timeout</p></dd></dl><dl><dt class="spec value" id="val-unset_alarm"