Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 304 lines (269 sloc) 19.317 kb
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
1 <html>
2 <head>
f9f9c92 @tomfaulhaber Autodoc commit for 1.2.x/25d33167, master/e7930c85, 1.1.x/d132c5f1
tomfaulhaber authored
3 <title>stream-utils - clojure-contrib v1.2 API documentation</title>
18738ad @tomfaulhaber Updated documentation for commit 835bfe2a02c70c150f2354f8ef9e866f3e2f…
tomfaulhaber authored
4 <link href="static/favicon.png" rel="icon" />
5 <link href="static/favicon.png" rel="shortcut icon" />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
6 <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
7 <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
8 <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
9 <style>.menuWrapper{height: 36px;}</style>
10 <!--[if lte IE 6]>
11 <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
12 <![endif]-->
13 </head>
14 <!--
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
15 This document was auto-generated from the source by the clojure autodoc system.
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
16 To report errors or ask questions about the overall documentation structure, formatting,
17 etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
18 For errors in the documentation of a particular namespace, contact the author of that
19 namespace.
20 -->
21 <body>
22 <div id="AllContentContainer">
23 <div id="Header">
18738ad @tomfaulhaber Updated documentation for commit 835bfe2a02c70c150f2354f8ef9e866f3e2f…
tomfaulhaber authored
24 <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
5e5f1d4 @tomfaulhaber Manual (forced) documentation build for commit f24f6412a1cee701528585…
tomfaulhaber authored
25 <h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
26 </div>
3bd8e49 @tomfaulhaber Manual (forced) documentation build for commit be33acd87f190d9ec2ad75…
tomfaulhaber authored
27 <div id="leftcolumn"><div style="text-align: center;"></div>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
28 <div class="menu">
29 <div class="WikiCustomNav WikiElement wiki">
f9f9c92 @tomfaulhaber Autodoc commit for 1.2.x/25d33167, master/e7930c85, 1.1.x/d132c5f1
tomfaulhaber authored
30 <span class="toc-header"><span id="project-name">clojure-contrib</span> <span id="version">v1.2</span> API</span><br />
31 <ul>
32 <li><a class="wiki_link" href="index.html">Overview</a></li>
33 <li><a class="wiki_link" href="api-index.html">API Index</a></li>
34 </ul>
35 <span class="toc-header">Namespaces</span>
36 <ul id="left-sidebar-list">
37 <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="io-api.html" class="wiki_link">io</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-api.html" class="wiki_link">json</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="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</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-api.html" class="wiki_link">seq</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-api.html" class="wiki_link">shell</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="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</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>
38 </ul>
78b132e @tomfaulhaber Document the latest branches, et al., in clojure-contrib. Supporting …
tomfaulhaber authored
39 <div class="BranchTOC">
f9f9c92 @tomfaulhaber Autodoc commit for 1.2.x/25d33167, master/e7930c85, 1.1.x/d132c5f1
tomfaulhaber authored
40 <span class="toc-header">Other Versions</span>
78b132e @tomfaulhaber Document the latest branches, et al., in clojure-contrib. Supporting …
tomfaulhaber authored
41 <ul id="left-sidebar-branch-list">
c396345 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/39c38227, 1.1.x/d132c5f1
tomfaulhaber authored
42 <li><a href="branch-master/index.html" class="wiki_link">v1.3 (in development)</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">v1.1 (stable)</a></li>
78b132e @tomfaulhaber Document the latest branches, et al., in clojure-contrib. Supporting …
tomfaulhaber authored
43 </ul>
44 </div>
f9f9c92 @tomfaulhaber Autodoc commit for 1.2.x/25d33167, master/e7930c85, 1.1.x/d132c5f1
tomfaulhaber authored
45 <a href="http://clojure.org" class="wiki_link">Clojure Home</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
46 </div>
47 </div>
3bd8e49 @tomfaulhaber Manual (forced) documentation build for commit be33acd87f190d9ec2ad75…
tomfaulhaber authored
48 </div>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
49 <div id="rightcolumn">
50 <div id="Content">
51 <div class="contentBox"><div class="innerContentBox">
814795d @tomfaulhaber Updated documentation for commit cb1432c492ce086f1c7145287eb5d14ccf9b…
tomfaulhaber authored
52 <div id="content_view" class="wiki wikiPage">
3bd8e49 @tomfaulhaber Manual (forced) documentation build for commit be33acd87f190d9ec2ad75…
tomfaulhaber authored
53 <div id="right-sidebar"><div id="toc">
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
54 <h1 class="nopad">Table of Contents</h1>
55 <div style="margin-left: 1em;" class="toc-section">
56 <a href="#toc0">Overview</a>
57 <div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
58 <a href="#clojure.contrib.stream-utils/defst">defst</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
59 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
60 <a href="#clojure.contrib.stream-utils/defstream">defstream</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
61 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
62 <a href="#clojure.contrib.stream-utils/pick">pick</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
63 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
64 <a href="#clojure.contrib.stream-utils/pick-all">pick-all</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
65 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
66 <a href="#clojure.contrib.stream-utils/stream-drop">stream-drop</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
67 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
68 <a href="#clojure.contrib.stream-utils/stream-filter">stream-filter</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
69 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
70 <a href="#clojure.contrib.stream-utils/stream-flatten">stream-flatten</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
71 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
72 <a href="#clojure.contrib.stream-utils/stream-m">stream-m</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
73 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
74 <a href="#clojure.contrib.stream-utils/stream-map">stream-map</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
75 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
76 <a href="#clojure.contrib.stream-utils/stream-next">stream-next</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
77 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
78 <a href="#clojure.contrib.stream-utils/stream-seq">stream-seq</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
79 </div><div style="margin-left: 1em;" class="toc-entry">
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
80 <a href="#clojure.contrib.stream-utils/stream-type">stream-type</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
81 </div>
82 <br />
83 </div>
84 </div>
3bd8e49 @tomfaulhaber Manual (forced) documentation build for commit be33acd87f190d9ec2ad75…
tomfaulhaber authored
85 </div>
78b132e @tomfaulhaber Document the latest branches, et al., in clojure-contrib. Supporting …
tomfaulhaber authored
86 <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">stream-utils</span>
d71a52d @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/b0f2e778, 1.1.x/d132c5f1
tomfaulhaber authored
87 - <span id="header-project">clojure-contrib</span> <span id="header-version">v1.2</span> (<span id="header-status">stable</span>)
f9f9c92 @tomfaulhaber Autodoc commit for 1.2.x/25d33167, master/e7930c85, 1.1.x/d132c5f1
tomfaulhaber authored
88 </h1>
29b74eb @tomfaulhaber Autodoc commit for master/18c87137, 1.1.x/d132c5f1
tomfaulhaber authored
89 <span id="author-line">by <span id="author-name">Konrad Hinsen</span><br /></span>
d210bb2 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/37fba7ef, 1.1.x/d132c5f1
tomfaulhaber authored
90 <br />Full namespace name: <span id="long-name">clojure.contrib.stream-utils</span>
91 <p></p>
92 <h2>Overview</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
93 <pre id="namespace-docstr">Functions for setting up computational pipelines via data streams.
94
95 NOTE: This library is experimental. It may change significantly
96 with future release.
97
98 This library defines:
99 - an abstract stream type, whose interface consists of the
100 multimethod stream-next
101 - a macro for implementing streams
102 - implementations of stream for
103 1) Clojure sequences, and vectors
104 2) nil, representing an empty stream
105 - tools for writing stream transformers, including the
106 monad stream-m
107 - various utility functions for working with streams
108
109 Streams are building blocks in the construction of computational
110 pipelines. A stream is represented by its current state plus
111 a function that takes a stream state and obtains the next item
112 in the stream as well as the new stream state. The state is
113 implemented as a Java class or a Clojure type (as defined by the
114 function clojure.core/type), and the function is provided as an
115 implementation of the multimethod stream-next for this class or type.
116
117 While setting up pipelines using this mechanism is somewhat more
118 cumbersome than using Clojure's lazy seq mechanisms, there are a
119 few advantages:
120 - The state of a stream can be stored in any Clojure data structure,
121 and the stream can be re-generated from it any number of times.
122 Any number of states can be stored this way.
123 - The elements of the stream are never cached, so keeping a reference
124 to a stream state does not incur an uncontrollable memory penalty.
125
126 Note that the stream mechanism is thread-safe as long as the
127 concrete stream implementations do not use any mutable state.
128
129 Stream transformers take any number of input streams and produce one
130 output stream. They are typically written using the stream-m
131 monad. In the definition of a stream transformer, (pick s) returns
132 the next value of stream argument s, whereas pick-all returns the
133 next value of all stream arguments in the form of a vector.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
134
135
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
136 <br />
137 <h2>Public Variables and Functions</h2>
138 <div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
139 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
140 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
141 <h2 id="clojure.contrib.stream-utils/defst">defst</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
142 <span id="var-type">macro</span><br />
143 <pre id="var-usage">Usage: (defst name args streams &amp; body)
144 </pre>
145 <pre id="var-docstr">Define the stream transformer name by body.
146 The non-stream arguments args and the stream arguments streams
147 are given separately, with args being possibly empty.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
148
149
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
150 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L183" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
151 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
152 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
153 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
154 <h2 id="clojure.contrib.stream-utils/defstream">defstream</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
155 <span id="var-type">macro</span><br />
156 <pre id="var-usage">Usage: (defstream type-tag args &amp; body)
157 </pre>
158 <pre id="var-docstr">Define object of the given type as a stream whose implementation
159 of stream-next is defined by args and body. This macro adds
160 a type-specific method for stream-next and derives type
161 from stream-type.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
162
163
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
164 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L73" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
165 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
166 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
167 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
168 <h2 id="clojure.contrib.stream-utils/pick">pick</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
169 <span id="var-type">function</span><br />
170 <pre id="var-usage">Usage: (pick n)
171 </pre>
172 <pre id="var-docstr">Return the next value of stream argument n inside a stream
173 transformer. When used inside of defst, the name of the stream
174 argument can be used instead of its index n.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
175
176
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
177 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L149" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
178 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
179 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
180 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
181 <h2 id="clojure.contrib.stream-utils/pick-all">pick-all</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
182 <span id="var-type">function</span><br />
183 <pre id="var-usage">Usage: (pick-all streams)
184 </pre>
185 <pre id="var-docstr">Return a vector containing the next value of each stream argument
186 inside a stream transformer.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
187
188
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
189 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L160" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
190 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
191 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
192 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
193 <h2 id="clojure.contrib.stream-utils/stream-drop">stream-drop</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
194 <span id="var-type">function</span><br />
195 <pre id="var-usage">Usage: (stream-drop n stream)
196 </pre>
197 <pre id="var-docstr">Return a stream containing all but the first n elements of stream.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
198
199
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
200 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L201" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
201 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
202 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
203 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
204 <h2 id="clojure.contrib.stream-utils/stream-filter">stream-filter</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
205 <span id="var-type">multimethod</span><br />
206 <pre id="var-usage">Usage: (stream-filter p stream)
207 </pre>
208 <pre id="var-docstr">Return a new stream that contrains the elements of stream
209 that satisfy the predicate p.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
210
211
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
212 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L243" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
213 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
214 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
215 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
216 <h2 id="clojure.contrib.stream-utils/stream-flatten">stream-flatten</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
217 <span id="var-type">function</span><br />
218 <pre id="var-usage">Usage: (stream-flatten s)
219 </pre>
220 <pre id="var-docstr">Converts a stream of sequences into a stream of the elements of the
221 sequences. Flattening is not recursive, only one level of nesting
222 will be removed.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
223
224
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
225 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L271" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
226 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
227 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
228 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
229 <h2 id="clojure.contrib.stream-utils/stream-m">stream-m</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
230 <span id="var-type">var</span><br />
231 <pre id="var-usage"></pre>
232 <pre id="var-docstr">Monad describing stream computations. The monadic values can be
233 of any type handled by stream-next.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
234
235
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
236 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L135" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
237 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
238 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
239 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
240 <h2 id="clojure.contrib.stream-utils/stream-map">stream-map</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
241 <span id="var-type">multimethod</span><br />
242 <pre id="var-usage">Usage: (stream-map f stream)
243 </pre>
244 <pre id="var-docstr">Return a new stream by mapping the function f on the given stream.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
245
246
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
247 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L219" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
248 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
249 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
250 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
251 <h2 id="clojure.contrib.stream-utils/stream-next">stream-next</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
252 <span id="var-type">multimethod</span><br />
253 <pre id="var-usage">Usage: (stream-next stream-state)
254 </pre>
255 <pre id="var-docstr">Returns a vector [next-value new-state] where next-value is the next
256 item in the data stream defined by stream-state and new-state
257 is the new state of the stream. At the end of the stream,
258 next-value and new-state are nil.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
259
260
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
261 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L91" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
262 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
263 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
264 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
265 <h2 id="clojure.contrib.stream-utils/stream-seq">stream-seq</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
266 <span id="var-type">function</span><br />
267 <pre id="var-usage">Usage: (stream-seq s)
268 </pre>
269 <pre id="var-docstr">Return a lazy seq on the stream. Also accessible via
78b132e @tomfaulhaber Document the latest branches, et al., in clojure-contrib. Supporting …
tomfaulhaber authored
270 clojure.contrib.seq/seq-on and
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
271 clojure.contrib.generic.collection/seq for streams.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
272
273
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
274 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L113" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
275 </div><div id="var-entry">
3ce4065 @tomfaulhaber Updated documentation for commit 44e4c23000a7cdee5395006dadc2eb1b58bc…
tomfaulhaber authored
276 <br />
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
277 <hr />
384311a @tomfaulhaber Manual (forced) documentation build for commit b902ebe3c80ec86d4f80f8…
tomfaulhaber authored
278 <h2 id="clojure.contrib.stream-utils/stream-type">stream-type</h2>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
279 <span id="var-type">var</span><br />
280 <pre id="var-usage"></pre>
281 <pre id="var-docstr">The root type for the stream hierarchy. For each stream type,
282 add a derivation from this type.</pre>
4a3f270 @tomfaulhaber Manual autodoc update (mostly whitespace diffs caused by new tags, no…
tomfaulhaber authored
283
284
dc17990 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/1068a72b, 1.1.x/d132c5f1
tomfaulhaber authored
285 <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/stream_utils.clj#L69" id="var-source">Source</a>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
286 </div>
287
288
3bd8e49 @tomfaulhaber Manual (forced) documentation build for commit be33acd87f190d9ec2ad75…
tomfaulhaber authored
289 </div>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
290 </div>
291 </div>
292 </div>
293 </div>
294 <div id="foot">
b1a0810 @tomfaulhaber Autodoc commit for 1.2.x/e4ea06c9, master/b0f2e778, 1.1.x/d132c5f1
tomfaulhaber authored
295 <div style="text-align: center;" id="copyright">Copyright 2007-2010 by Rich Hickey and the various contributors</div>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
296 </div>
297 </div>
18738ad @tomfaulhaber Updated documentation for commit 835bfe2a02c70c150f2354f8ef9e866f3e2f…
tomfaulhaber authored
298 <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
299 Clojure auto-documentation system by Tom Faulhaber.</div>
e9a3aad @tomfaulhaber Added the first (provisional) stab at real content
tomfaulhaber authored
300 </div>
301 <!-- /AllContentContainer -->
302 </body>
303
304 </html>
Something went wrong with that request. Please try again.