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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
<html>
<head>
<title>seq-utils - clojure-contrib v1.1 API documentation</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">
<span class="toc-header"><span id="project-name">clojure-contrib</span> <span id="version">v1.1</span> API</span><br />
<ul>
<li><a class="wiki_link" href="index.html">Overview</a></li>
<li><a class="wiki_link" href="api-index.html">API Index</a></li>
</ul>
<span class="toc-header">Namespaces</span>
<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 class="BranchTOC">
<span class="toc-header">Other Versions</span>
<ul id="left-sidebar-branch-list">
<li><a href="../index.html" class="wiki_link">v1.2 (beta 1)</a></li><li><a href="../branch-master/index.html" class="wiki_link">next (in development)</a></li>
</ul>
</div>
<a href="http://clojure.org" class="wiki_link">Clojure Home</a>
</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.seq-utils/fill-queue">fill-queue</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/find-first">find-first</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/flatten">flatten</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/frequencies">frequencies</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/group-by">group-by</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/includes?">includes?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/indexed">indexed</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/partition-all">partition-all</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/partition-by">partition-by</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/positions">positions</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/rand-elt">rand-elt</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/rec-cat">rec-cat</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/rec-seq">rec-seq</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/reductions">reductions</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/rotations">rotations</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/separate">separate</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/seq-on">seq-on</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.seq-utils/shuffle">shuffle</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">seq-utils</span>
- <span id="header-project">clojure-contrib</span> <span id="header-version">v1.1</span> (<span id="header-status">stable</span>)
</h1>
<span id="author-line">by <span id="author-name">Stuart Sierra (and others)</span><br /></span>
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.seq-utils</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Sequence utilities for Clojure</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/fill-queue">fill-queue</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (fill-queue filler-func & optseq)
</pre>
<pre id="var-docstr">filler-func will be called in another thread with a single arg
'fill'. filler-func may call fill repeatedly with one arg each
time which will be pushed onto a queue, blocking if needed until
this is possible. fill-queue will return a lazy seq of the values
filler-func has pushed onto the queue, blocking if needed until each
next element becomes available. filler-func's return value is ignored.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L179" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/find-first">find-first</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-first pred coll)
</pre>
<pre id="var-docstr">Returns the first item of coll for which (pred item) returns logical true.
Consumes sequences up to the first match, will consume the entire sequence
and return nil if no match is found.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L170" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/flatten">flatten</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (flatten x)
</pre>
<pre id="var-docstr">Takes any nested combination of sequential things (lists, vectors,
etc.) and returns their contents as a single, flat sequence.
(flatten nil) returns nil.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L34" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/frequencies">frequencies</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (frequencies coll)
</pre>
<pre id="var-docstr">Returns a map from distinct items in coll to the number of times
they appear.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L89" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/group-by">group-by</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (group-by f coll)
</pre>
<pre id="var-docstr">Returns a sorted map of the elements of coll keyed by the result of
f on each element. The value at each key will be a vector of the
corresponding elements, in the order they appeared in coll.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L65" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/includes?">includes?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (includes? coll x)
</pre>
<pre id="var-docstr">Returns true if coll contains something equal (with =) to x,
in linear time.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L48" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/indexed">indexed</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (indexed s)
</pre>
<pre id="var-docstr">Returns a lazy sequence of [index, item] pairs, where items come
from 's' and indexes count up from zero.
(indexed '(a b c d)) => ([0 a] [1 b] [2 c] [3 d])</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L55" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/partition-all">partition-all</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (partition-all n coll)
(partition-all n step coll)
</pre>
<pre id="var-docstr">Returns a lazy sequence of lists like clojure.core/partition, but may
include lists with fewer than n items at the end.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L135" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/partition-by">partition-by</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (partition-by f coll)
</pre>
<pre id="var-docstr">Applies f to each value in coll, splitting it each time f returns
a new value. Returns a lazy seq of lazy seqs.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L78" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/positions">positions</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (positions pred coll)
</pre>
<pre id="var-docstr">Returns a lazy sequence containing the positions at which pred
is true for items in coll.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L214" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/rand-elt">rand-elt</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (rand-elt s)
</pre>
<pre id="var-docstr">Return a random element of this seq</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L152" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/rec-cat">rec-cat</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (rec-cat binding-name & exprs)
</pre>
<pre id="var-docstr">Similar to lazy-cat but binds the resulting sequence to the supplied
binding-name, allowing for recursive expressions.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L106" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/rec-seq">rec-seq</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (rec-seq binding-name & body)
</pre>
<pre id="var-docstr">Similar to lazy-seq but binds the resulting seq to the supplied
binding-name, allowing for recursive expressions.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L99" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/reductions">reductions</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (reductions f coll)
(reductions f init coll)
</pre>
<pre id="var-docstr">Returns a lazy seq of the intermediate values of the reduction (as
per reduce) of coll by f, starting with init.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L115" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/rotations">rotations</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (rotations x)
</pre>
<pre id="var-docstr">Returns a lazy seq of all rotations of a seq</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L125" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/separate">separate</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (separate f s)
</pre>
<pre id="var-docstr">Returns a vector:
[ (filter f s), (filter (complement f) s) ]</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L42" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/seq-on">seq-on</h2>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">Usage: (seq-on s)
</pre>
<pre id="var-docstr">Returns a seq on the object s. Works like the built-in seq but as
a multimethod that can have implementations for new classes and types.</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L159" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.seq-utils/shuffle">shuffle</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (shuffle coll)
</pre>
<pre id="var-docstr">Return a random permutation of coll</pre>
<a href="http://github.com/clojure/clojure-contrib/blob/1640c0433e35cf9a60e1483424c0a2a8ca56b730/src/clojure/contrib/seq_utils.clj#L145" id="var-source">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2010 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>
|
