blob: 31a6aa5294bc8cf80750cd4195b0e5d546ebab92 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<html>
<head>
<title>probabilities.finite-distributions API reference (clojure-contrib)</title>
<link href="../static/favicon.png" rel="icon" />
<link href="../static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="../static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="../static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="../static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="../static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<div class="BranchTOC">
<a class="wiki_link" href="#">Branches</a>
<ul id="left-sidebar-branch-list">
<li><a href="../index.html" class="wiki_link">master</a></li><li><a href="../branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li>
</ul>
</div>
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/certainly">certainly</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/choose">choose</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/cond-dist-m">cond-dist-m</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/cond-prob">cond-prob</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/dist-m">dist-m</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/join-with">join-with</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/make-distribution">make-distribution</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/normalize">normalize</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/prob">prob</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/uniform">uniform</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.probabilities.finite-distributions/zipf">zipf</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">probabilities.finite-distributions</span>
<span id="branch-name">(1.1.x branch)</span></h1>
<span id="author-line">by <span id="author-name">Konrad Hinsen</span><br /></span>
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.probabilities.finite-distributions</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Finite probability distributions
This library defines a monad for combining finite probability
distributions.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/certainly">certainly</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (certainly v)
</pre>
<pre id="var-docstr">Returns a distribution in which the single value v has probability 1.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L146" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/choose">choose</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (choose & choices)
</pre>
<pre id="var-docstr">Construct a distribution from an explicit list of probabilities
and values. They are given in the form of a vector of probability-value
pairs. In the last pair, the probability can be given by the keyword
:else, which stands for 1 minus the total of the other probabilities.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L92" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/cond-dist-m">cond-dist-m</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Variant of the dist monad that can handle undefined values.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L46" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/cond-prob">cond-prob</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (cond-prob pred dist)
</pre>
<pre id="var-docstr">Returns the conditional probability for the values in dist that satisfy
the predicate pred.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L160" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/dist-m">dist-m</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Monad describing computations on fuzzy quantities, represented by a finite
probability distribution for the possible values. A distribution is
represented by a map from values to probabilities.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L28" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/join-with">join-with</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (join-with f dist1 dist2)
</pre>
<pre id="var-docstr">Returns the distribution of (f x y) with x from dist1 and y from dist2.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L151" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/make-distribution">make-distribution</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (make-distribution coll f)
</pre>
<pre id="var-docstr">Returns the distribution in which each element x of the collection
has a probability proportional to (f x)</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L134" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/normalize">normalize</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (normalize weights)
</pre>
<pre id="var-docstr">Convert a weight map (e.g. a map of counter values) to a distribution
by multiplying with a normalization factor. If the map has a key
:total, its value is assumed to be the sum over all the other values and
it is used for normalization. Otherwise, the sum is calculated
explicitly. The :total key is removed from the resulting distribution.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L70" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/prob">prob</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (prob pred dist)
</pre>
<pre id="var-docstr">Return the probability that the predicate pred is satisfied in the
distribution dist, i.e. the sum of the probabilities of the values
that satisfy pred.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L197" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/uniform">uniform</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (uniform coll)
</pre>
<pre id="var-docstr">Return a distribution in which each of the elements of coll
has the same probability.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L84" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.probabilities.finite-distributions/zipf">zipf</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (zipf s n)
</pre>
<pre id="var-docstr">Returns the Zipf distribution in which the numbers k=1..n have
probabilities proportional to 1/k^s.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/3f893e28ecc0fc2335355aea2cc9324ed5781c81/src/clojure/contrib/probabilities/finite_distributions.clj#L140" id="var-source">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>
|
