@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
17 lines (16 loc) • 7.32 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>Testing statistics — 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="unittest.html">↑</a><a class="lpdoc-navbutton" href="unittestdecls_doc.html">←</a><a class="lpdoc-navbutton" href="unittest_examples.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="unittest.html">Unit testing</a> »<br/> </li><li><a href=""><strong>Testing statistics</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>Testing statistics</h1><a class="lpdoc-idx-anchor" href="ciaodbg_ref_mansearch.html#unittest_statistics"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Alvaro Sevilla San Mateo" href="ciaodbg_ref_mansearch.html#Alvaro Sevilla San Mateo">Alvaro Sevilla San Mateo</a>.<p>
<strong>Stability: [</strong><strong>beta</strong><strong>] </strong>Most of the functionality is there but it is still missing some testing and/or verification.<p><br/>
This module implements predicates for generating statistical summaries for the testing processes.<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(unittest/unittest_statistics)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#get_statistical_summary/2"><tt>get_statistical_summary/2</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#print_statistical_summary/1"><tt>print_statistical_summary/1</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#statistical_summary/1"><tt>statistical_summary/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="get_statistical_summary/2" href="ciaodbg_ref_mansearch.html#get_statistical_summary/2">get_statistical_summary/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>get_statistical_summary(IdxTestSummaries,Stats)</tt>
</span><p>Narrow the information of the tests and generate the statistical information structure needed to perform the statistical summary. <span class="lpdoc-var">IdxTestSummaries</span> contains a list of terms with the results of tests. </p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="print_statistical_summary/1" href="ciaodbg_ref_mansearch.html#print_statistical_summary/1">print_statistical_summary/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>print_statistical_summary(Stats)</tt>
</span><p>Prints the statistical summary of the test, previously computed and given as input <span class="lpdoc-var">Stats</span>. </p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="statistical_summary/1" href="ciaodbg_ref_mansearch.html#statistical_summary/1">statistical_summary/1</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>statistical_summary(IdxTestSummaries)</tt>
</span><p>Makes the statistic summary with the results of the tests. <span class="lpdoc-var">IdxTestSummaries</span> contains a list of terms with the results of the tests.</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="3" href="ciaodbg_ref_mansearch.html#list/1"><tt>list/1</tt></a>)</span><span><span class="lpdoc-var">IdxTestSummaries</span> is a list.
</span>
</ul></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="4" href="ciaodbg_ref_mansearch.html#lists"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="ciaodbg_ref_mansearch.html#llists"><tt>llists</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="ciaodbg_ref_mansearch.html#format"><tt>format</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="7" href="ciaodbg_ref_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="ciaodbg_ref_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="ciaodbg_ref_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="ciaodbg_ref_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="ciaodbg_ref_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="ciaodbg_ref_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="ciaodbg_ref_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="ciaodbg_ref_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="ciaodbg_ref_mansearch.html#basic_props"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="ciaodbg_ref_mansearch.html#messages_basic"><tt>messages_basic</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="17" href="ciaodbg_ref_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="ciaodbg_ref_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="ciaodbg_ref_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="ciaodbg_ref_mansearch.html#assertions"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="ciaodbg_ref_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>