Skip to content

Commit

Permalink
updated man + pldoc
Browse files Browse the repository at this point in the history
  • Loading branch information
friguzzi committed Dec 9, 2023
1 parent 000b02a commit ef94c3a
Show file tree
Hide file tree
Showing 15 changed files with 2,154 additions and 0 deletions.
62 changes: 62 additions & 0 deletions docs/pldoc/cplint_util.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!DOCTYPE html>
<html>
<head>
<title>cplint_util.pl -- cplint_util</title>

<link rel="stylesheet" type="text/css" href="pldoc.css">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">

</head>
<body>


<h1 class="file"><span style="float:right"></span>cplint_util.pl -- cplint_util</h1>

<p>
Utility module for cplint</p>

<dl class="tags">
<dt class="keyword-author">author</dt><dd class="keyword-author">- Fabrizio Riguzzi</dd>
<dt class="keyword-copyright">copyright</dt><dd class="keyword-copyright">- Fabrizio Riguzzi</dd>
<dt class="keyword-license">license</dt><dd class="keyword-license">- Artistic License 2.0 <a href="https://opensource.org/licenses/Artistic-2.0">https://opensource.org/licenses/Artistic-2.0</a></dd>
</dl>

<dl>
<dt class="pubdef"><span style="float:right">&nbsp;</span><a name="bar/2"><b class="pred">bar</b><var class="arglist">(+Probability:float, -Chart:dict)</var></a> is <b class="det">det</b></dt><dd class="defbody">The predicate returns a dict for rendering with c3 as a bar chart with
a bar for the probability and a bar for one minus the probability.</dd>
</dl>

<h2 class="undoc">Undocumented predicates</h2>

<p>
The following predicates are exported, but not or incorrectly documented.</p>

<dl class="undoc">
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="density2d/3"><b class="pred">density2d</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="bin/5"><b class="pred">bin</b><var class="arglist">(Arg1, Arg2, Arg3, Arg4, Arg5)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="argbar/2"><b class="pred">argbar</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="densities/4"><b class="pred">densities</b><var class="arglist">(Arg1, Arg2, Arg3, Arg4)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="agg_val/3"><b class="pred">agg_val</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="variance/2"><b class="pred">variance</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="beta/2"><b class="pred">beta</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="to_pair/2"><b class="pred">to_pair</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="density/2"><b class="pred">density</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="histogram/2"><b class="pred">histogram</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="swi_builtin/1"><b class="pred">swi_builtin</b><var class="arglist">(Arg1)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="variance/3"><b class="pred">variance</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="key_pair/2"><b class="pred">key_pair</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="density/3"><b class="pred">density</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="histogram/3"><b class="pred">histogram</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="bar/3"><b class="pred">bar</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="std_dev/2"><b class="pred">std_dev</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="to_atom/2"><b class="pred">to_atom</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="value_pair/2"><b class="pred">value_pair</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="density2d/2"><b class="pred">density2d</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="densities/3"><b class="pred">densities</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="bar1/2"><b class="pred">bar1</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="std_dev/3"><b class="pred">std_dev</b><var class="arglist">(Arg1, Arg2, Arg3)</var></a></dt>
<dt class="undoc"><span style="float:right">&nbsp;</span><a name="average/2"><b class="pred">average</b><var class="arglist">(Arg1, Arg2)</var></a></dt>
</dl>

</body>
</html>
Binary file added docs/pldoc/h1-bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pldoc/h2-bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/pldoc/highlight.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!DOCTYPE html>
<html>
<head>
<title>cplint</title>

<link rel="stylesheet" type="text/css" href="pldoc.css">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">

</head>
<body>


<h1 class="file"><span style="float:right"></span>highlight.pl -- SWI-Prolog IDE and SWISH highlighting</h1>

<p>
This module defines highlight support for both the offline tools,
notably PceEmacs and the graphical debugger, and the online
<a href="http://cplint.eu">cplint-on-SWISH</a>.</p>
</body>
</html>
35 changes: 35 additions & 0 deletions docs/pldoc/kbest.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html>
<head>
<title>kbest.pl -- kbest</title>

<link rel="stylesheet" type="text/css" href="pldoc.css">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">

</head>
<body>


<h1 class="file"><span style="float:right"></span>kbest.pl -- kbest</h1>

<p>
This module performs reasoning over Logic Programs with Annotated
Disjunctions and CP-Logic programs.
It reads probabilistic program and computes the probability of queries
using kbest inference.</p>

<dl class="tags">
<dt class="keyword-author">author</dt><dd class="keyword-author">- Stefano Bragaglia and Fabrizio Riguzzi</dd>
<dt class="keyword-copyright">copyright</dt><dd class="keyword-copyright">- Stefano Bragaglia and Fabrizio Riguzzi</dd>
<dt class="keyword-license">license</dt><dd class="keyword-license">- Artistic License 2.0 <a href="https://opensource.org/licenses/Artistic-2.0">https://opensource.org/licenses/Artistic-2.0</a></dd>
</dl>

<dl>
<dt class="pubdef"><span style="float:right">&nbsp;</span><a name="kbest/4"><b class="pred">kbest</b><var class="arglist">(:Quer:conjunction_of_literals, +K:int, -Probability:float, -Exps:list)</var></a> is <b class="det">nondet</b></dt><dd class="defbody">The predicate computes the <var>K</var> most probable explanations of the conjunction of literals Query.
It returns the explanations in <var>Exps</var> together with their <var>Probability</var></dd>
<dt class="pubdef"><span style="float:right">&nbsp;</span><a name="kbest/3"><b class="pred">kbest</b><var class="arglist">(:Quer:conjunction_of_literals, +K:int, -Exps:list)</var></a> is <b class="det">nondet</b></dt><dd class="defbody">The predicate computes the <var>K</var> most probable explanations of the conjunction of literals Query.
It returns the explanations in <var>Exps</var></dd>
</dl>

</body>
</html>
Loading

0 comments on commit ef94c3a

Please sign in to comment.