@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
36 lines (35 loc) • 12.2 kB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Fixpoint tracer — The CiaoPP Program Processor v1.5</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="DebugFixp.html">↑</a><a class="lpdoc-navbutton" href="DebugFixp.html">←</a><a class="lpdoc-navbutton" href="view_fixp.html">→</a><a class="lpdoc-navbutton" href="ciaopp_ref_mansearch.html">🔍</a></span><span><a href="ciaopp_ref_manfulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciaopp_ref_man.html">The CiaoPP Program Processor</a> »<br/> </li><li><a href="part_internals.html">PART IV - CiaoPP Internals</a> »<br/> </li><li><a href="DebugFixp.html">Debugging the fixpoint operations</a> »<br/> </li><li><a href=""><strong>Fixpoint tracer</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Fixpoint tracer</h1><a class="lpdoc-idx-anchor" href="ciaopp_ref_mansearch.html#trace_fixp"></a>
<div class="lpdoc-alert"><strong>Stability: [</strong><strong>devel</strong><strong>] </strong>Currently the subject of active
development and/or research. Functionality may be limited and API
and/or functionality may change without warning or deprecation period. Not recommended yet for use in production.</div><p><br/>
This module traces the operations of fixpoints by explicitely calling <a class="lpdoc-idx-anchor" id="0" href="#fixpoint_trace/7"><tt>fixpoint_trace/7</tt></a> during computation.<p>To deactivate tracing (it can slowdown the analysis), package <tt>ciaopp(plai/notrace)</tt> has to be imported in the used fixpoint.<br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(ciaopp(plai/trace_fixp)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="1" href="#fixpoint_trace/7"><tt>fixpoint_trace/7</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="analyze_driver.html#trace_fixp/1"><tt>trace_fixp/1</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#memotable_trace/3"><tt>memotable_trace/3</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#show_spypoint_op_count/0"><tt>show_spypoint_op_count/0</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#show_updated_memotable/3"><tt>show_updated_memotable/3</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#trace_init/0"><tt>trace_init/0</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#trace_end/0"><tt>trace_end/0</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#trace_reset/0"><tt>trace_reset/0</tt></a>.
<li><em>Regular Types:</em><br/><a class="lpdoc-idx-anchor" id="9" href="#trace_option/1"><tt>trace_option/1</tt></a>.
</ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fixpoint_trace/7" href="ciaopp_ref_mansearch.html#fixpoint_trace/7">fixpoint_trace/7</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="trace_fixp/1" href="ciaopp_ref_mansearch.html#trace_fixp/1">trace_fixp/1</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>trace_fixp(X)</tt>
</span><p>Toggle a trace of the fixpoint computation during analysis. The (X=op_count) option counts steps of fixpoint operations, show certain relevant spy points during analysis (X=trace), and/or display the analysis graph which is being constructed (X=view). The information added up can be seen at end of analysis with <tt>show_fixpoint_op_count.</tt><p><span class="lpdoc-usage-header">Usage 1:</span><span class="lpdoc-usage-decl"><tt>trace_fixp(X)</tt>
</span><p>Mode for setting the current flag to a single value.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="11" href="#trace_option/1"><tt>trace_option/1</tt></a>)</span><span><a class="lpdoc-idx-anchor" id="10" href="ciaopp_ref_mansearch.html#trace_option(X)"><tt>trace_option(X)</tt></a>
</span>
<li><em>The following properties should hold globally:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="12" href="basic_props.html#not_further_inst/2"><tt>not_further_inst/2</tt></a>)</span><span><span class="lpdoc-var">X</span> is not further instantiated.
</span>
</ul><p><span class="lpdoc-usage-header">Usage 2:</span><span class="lpdoc-usage-decl"><tt>trace_fixp(X)</tt>
</span><p>Mode for setting the current flag to several values.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#list/2"><tt>list/2</tt></a>)</span><span><span class="lpdoc-var">X</span> is a list of <span class="lpdoc-var">trace_option</span>s.
</span>
<li><em>The following properties should hold globally:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#not_further_inst/2"><tt>not_further_inst/2</tt></a>)</span><span><span class="lpdoc-var">X</span> is not further instantiated.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="memotable_trace/3" href="ciaopp_ref_mansearch.html#memotable_trace/3">memotable_trace/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="show_spypoint_op_count/0" href="ciaopp_ref_mansearch.html#show_spypoint_op_count/0">show_spypoint_op_count/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="show_updated_memotable/3" href="ciaopp_ref_mansearch.html#show_updated_memotable/3">show_updated_memotable/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="trace_init/0" href="ciaopp_ref_mansearch.html#trace_init/0">trace_init/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="trace_end/0" href="ciaopp_ref_mansearch.html#trace_end/0">trace_end/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="trace_reset/0" href="ciaopp_ref_mansearch.html#trace_reset/0">trace_reset/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">REGTYPE</span><a class="lpdoc-idx-anchor" id="trace_option/1" href="ciaopp_ref_mansearch.html#trace_option/1">trace_option/1</a></div><div class="lpdoc-deftext">A regular type, defined as follows:<pre class="lpdoc-codeblock">trace_option(no).
trace_option(op_count).
trace_option(trace).
trace_option(view).
</pre> </div></div><p>
</div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>Application modules:</em><br/><a class="lpdoc-idx-anchor" id="15" href="ciaopp_ref_mansearch.html#analysis_stats"><tt>analysis_stats</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="view_fixp.html"><tt>view_fixp</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="preprocess_flags.html"><tt>preprocess_flags</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="fixpo_plai.html"><tt>fixpo_plai</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="plai_db.html"><tt>plai_db</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="20" href="ciaopp_ref_mansearch.html#datafacts_rt"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="ciaopp_ref_mansearch.html#aggregates"><tt>aggregates</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="ciaopp_ref_mansearch.html#format"><tt>format</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="ciaopp_ref_mansearch.html#write"><tt>write</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="ciaopp_ref_mansearch.html#p_unit_db"><tt>p_unit_db</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="ciaopp_ref_mansearch.html#pathnames"><tt>pathnames</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="ciaopp_ref_mansearch.html#terms"><tt>terms</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="ciaopp_ref_mansearch.html#terms_vars"><tt>terms_vars</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="28" href="ciaopp_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="ciaopp_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="ciaopp_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="ciaopp_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="ciaopp_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="ciaopp_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="ciaopp_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="ciaopp_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="basic_props.html"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="ciaopp_ref_mansearch.html#messages_basic"><tt>messages_basic</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="ciaopp_ref_mansearch.html#stream_basic"><tt>stream_basic</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="ciaopp_ref_mansearch.html#io_basic"><tt>io_basic</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="40" href="ciaopp_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="ciaopp_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="ciaopp_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="ciaopp_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="ciaopp_ref_mansearch.html#datafacts"><tt>datafacts</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>