@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
60 lines • 18.1 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>Profiler utilities — Run-time Checking, Testing, and Profiling for Ciao</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 class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="profiler_doc.html">↑</a><a class="lpdoc-navbutton" href="profiler_doc.html">←</a><a class="lpdoc-navbutton" href="profiler_extra.html">→</a><a class="lpdoc-navbutton" href="ciaodbg_ref_mansearch.html">🔍</a></span><span><a href="ciaodbg_ref_manfulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciaodbg_ref_man.html">Run-time Checking, Testing, and Profiling for Ciao</a> »<br/> </li><li><a href="profiler_doc.html">Profiler</a> »<br/> </li><li><a href=""><strong>Profiler utilities</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>Profiler utilities</h1><a class="lpdoc-idx-anchor" href="ciaodbg_ref_mansearch.html#profiler_utils"></a>
This module provides predicates to interact with the profiler for particular calls.<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(library(profilercc/profiler_utils)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#profile/1"><tt>profile/1</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#profile_call/1"><tt>profile_call/1</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#profile_reset/0"><tt>profile_reset/0</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#profile_info/1"><tt>profile_info/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#activate_trace/0"><tt>activate_trace/0</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#deactivate_trace/0"><tt>deactivate_trace/0</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#activate_hooks/0"><tt>activate_hooks/0</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#deactivate_hooks/0"><tt>deactivate_hooks/0</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="profile/1" href="ciaodbg_ref_mansearch.html#profile/1">profile/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>profile(Goal)</tt>
</span><p>Evaluates <span class="lpdoc-var">Goal</span>, collect profile information related with the evaluation and dump the information.</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="8" href="ciaodbg_ref_mansearch.html#cgoal/1"><tt>cgoal/1</tt></a>)</span><span><span class="lpdoc-var">Goal</span> is a term which represents a goal, i.e., an atom or a structure.
</span>
</ul>
<em>Meta-predicate</em> with arguments: <tt>profile(goal)</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="profile_call/1" href="ciaodbg_ref_mansearch.html#profile_call/1">profile_call/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
<em>Meta-predicate</em> with arguments: <tt>profile_call(goal)</tt>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="profile_reset/0" href="ciaodbg_ref_mansearch.html#profile_reset/0">profile_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">PREDICATE</span><a class="lpdoc-idx-anchor" id="profile_info/1" href="ciaodbg_ref_mansearch.html#profile_info/1">profile_info/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="9" href="ciaodbg_ref_mansearch.html#profile_info_type/1"><tt>profile_info_type/1</tt></a>)</span><span>Term containing the information collected by the profiler
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="activate_trace/0" href="ciaodbg_ref_mansearch.html#activate_trace/0">activate_trace/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="deactivate_trace/0" href="ciaodbg_ref_mansearch.html#deactivate_trace/0">deactivate_trace/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="activate_hooks/0" href="ciaodbg_ref_mansearch.html#activate_hooks/0">activate_hooks/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="deactivate_hooks/0" href="ciaodbg_ref_mansearch.html#deactivate_hooks/0">deactivate_hooks/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">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center_ncnf/4" href="ciaodbg_ref_mansearch.html#cost_center_ncnf/4">cost_center_ncnf/4</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="10" href="ciaodbg_ref_mansearch.html#profiler_cc"><tt>profiler_cc</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center_nf/4" href="ciaodbg_ref_mansearch.html#cost_center_nf/4">cost_center_nf/4</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="11" href="ciaodbg_ref_mansearch.html#profiler_cc"><tt>profiler_cc</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center_nc/4" href="ciaodbg_ref_mansearch.html#cost_center_nc/4">cost_center_nc/4</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="12" href="ciaodbg_ref_mansearch.html#profiler_cc"><tt>profiler_cc</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center/4" href="ciaodbg_ref_mansearch.html#cost_center/4">cost_center/4</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="13" href="ciaodbg_ref_mansearch.html#profiler_cc"><tt>profiler_cc</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center/2" href="ciaodbg_ref_mansearch.html#cost_center/2">cost_center/2</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="14" href="ciaodbg_ref_mansearch.html#profiler_cc"><tt>profiler_cc</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="total_time/1" href="ciaodbg_ref_mansearch.html#total_time/1">total_time/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="15" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="have_overhead/2" href="ciaodbg_ref_mansearch.html#have_overhead/2">have_overhead/2</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="16" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="dump_node_table_cc/0" href="ciaodbg_ref_mansearch.html#dump_node_table_cc/0">dump_node_table_cc/0</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="17" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="do_profile_reset/0" href="ciaodbg_ref_mansearch.html#do_profile_reset/0">do_profile_reset/0</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="18" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="set_hooks_active/1" href="ciaodbg_ref_mansearch.html#set_hooks_active/1">set_hooks_active/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="19" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="get_hooks_active/1" href="ciaodbg_ref_mansearch.html#get_hooks_active/1">get_hooks_active/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="20" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="set_trace_active/1" href="ciaodbg_ref_mansearch.html#set_trace_active/1">set_trace_active/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="21" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="get_trace_active/1" href="ciaodbg_ref_mansearch.html#get_trace_active/1">get_trace_active/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="22" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="get_trace_active/1" href="ciaodbg_ref_mansearch.html#get_trace_active/1">get_trace_active/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="23" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="using_timestamp/1" href="ciaodbg_ref_mansearch.html#using_timestamp/1">using_timestamp/1</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="24" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="profile_dump/0" href="ciaodbg_ref_mansearch.html#profile_dump/0">profile_dump/0</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="25" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center_global_value/2" href="ciaodbg_ref_mansearch.html#cost_center_global_value/2">cost_center_global_value/2</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="26" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center_edge_value/4" href="ciaodbg_ref_mansearch.html#cost_center_edge_value/4">cost_center_edge_value/4</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="27" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">(UNDOC_REEXPORT)</span><a class="lpdoc-idx-anchor" id="cost_center_node_value/3" href="ciaodbg_ref_mansearch.html#cost_center_node_value/3">cost_center_node_value/3</a></div><div class="lpdoc-deftext">
Imported from <a class="lpdoc-idx-anchor" id="28" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a> (see the corresponding documentation for details).<br/></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="29" href="ciaodbg_ref_mansearch.html#profiler_rt"><tt>profiler_rt</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="ciaodbg_ref_mansearch.html#profiler_type"><tt>profiler_type</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="ciaodbg_ref_mansearch.html#profiler_cc"><tt>profiler_cc</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="ciaodbg_ref_mansearch.html#profiler_utils_native"><tt>profiler_utils_native</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="ciaodbg_ref_mansearch.html#profiler_utils_base"><tt>profiler_utils_base</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="34" href="ciaodbg_ref_mansearch.html#native_props"><tt>native_props</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="ciaodbg_ref_mansearch.html#read"><tt>read</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="ciaodbg_ref_mansearch.html#stream_utils"><tt>stream_utils</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="ciaodbg_ref_mansearch.html#system"><tt>system</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="38" href="ciaodbg_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="ciaodbg_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="ciaodbg_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="ciaodbg_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="ciaodbg_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="ciaodbg_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="ciaodbg_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="ciaodbg_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="ciaodbg_ref_mansearch.html#basic_props"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="ciaodbg_ref_mansearch.html#io_basic"><tt>io_basic</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="ciaodbg_ref_mansearch.html#hiord_rt"><tt>hiord_rt</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="49" href="ciaodbg_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="ciaodbg_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="ciaodbg_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="52" href="ciaodbg_ref_mansearch.html#assertions"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="53" href="ciaodbg_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="54" href="ciaodbg_ref_mansearch.html#nativeprops"><tt>nativeprops</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>