@ciao-lang/ts-ciao-interface

Version:

Simple Ciao interface for node.

28 lines • 9.06 kB

HTML

<!DOCTYPE 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_extra (library) — 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_utils.html">←</a><a class="lpdoc-navbutton" href="profiler_auto_conf.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_extra (library)</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_extra (library)</h1><a class="lpdoc-idx-anchor" href="ciaodbg_ref_mansearch.html#profiler_extra"></a> Implementation of some predicates related with the profiler, but that don't requires the activation of the profiling option in the engine.<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_extra)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#measure/2"><tt>measure/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#measure/3"><tt>measure/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#measure_nf/3"><tt>measure_nf/3</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#measure_0/3"><tt>measure_0/3</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#get_option/1"><tt>get_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#time_option/2"><tt>time_option/2</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="measure/2" href="ciaodbg_ref_mansearch.html#measure/2">measure/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>measure(Goal,Value)</tt> </span><p>Same as measure/3, but uses ticks to measure the time.</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="6" 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> <li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="7" href="ciaodbg_ref_mansearch.html#num/1"><tt>num/1</tt></a>)</span><span><span class="lpdoc-var">Value</span> is a number. </span> </ul> <em>Meta-predicate</em> with arguments: <tt>measure(goal,?)</tt>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="measure/3" href="ciaodbg_ref_mansearch.html#measure/3">measure/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>measure(Option,Goal,Value)</tt> </span><p>Unifies <span class="lpdoc-var">Value</span> with the time spent in evaluate <span class="lpdoc-var">Goal</span>, using the type of time <span class="lpdoc-var">Option</span>.</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#atom/1"><tt>atom/1</tt></a>)</span><span><span class="lpdoc-var">Option</span> is currently instantiated to an atom. </span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="9" 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> <li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="10" href="ciaodbg_ref_mansearch.html#num/1"><tt>num/1</tt></a>)</span><span><span class="lpdoc-var">Value</span> is a number. </span> </ul> <em>Meta-predicate</em> with arguments: <tt>measure(?,goal,?)</tt>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="measure_nf/3" href="ciaodbg_ref_mansearch.html#measure_nf/3">measure_nf/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. <em>Meta-predicate</em> with arguments: <tt>measure_nf(?,goal,?)</tt>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="measure_0/3" href="ciaodbg_ref_mansearch.html#measure_0/3">measure_0/3</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. <em>Meta-predicate</em> with arguments: <tt>measure_0(?,goal,?)</tt>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="get_option/1" href="ciaodbg_ref_mansearch.html#get_option/1">get_option/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate. The predicate is of type <em>data</em>.<br/></div></div><p> <div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="time_option/2" href="ciaodbg_ref_mansearch.html#time_option/2">time_option/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</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>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="11" href="ciaodbg_ref_mansearch.html#datafacts_rt"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="ciaodbg_ref_mansearch.html#hrtime"><tt>hrtime</tt></a>. <li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="13" href="ciaodbg_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="ciaodbg_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="ciaodbg_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="ciaodbg_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="ciaodbg_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="ciaodbg_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="ciaodbg_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="ciaodbg_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="ciaodbg_ref_mansearch.html#basic_props"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="ciaodbg_ref_mansearch.html#hiord_rt"><tt>hiord_rt</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="ciaodbg_ref_mansearch.html#runtime_control"><tt>runtime_control</tt></a>. <li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="24" href="ciaodbg_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="ciaodbg_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="ciaodbg_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="ciaodbg_ref_mansearch.html#assertions"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="ciaodbg_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="ciaodbg_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>