-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathpackage-summary.html
300 lines (300 loc) · 11.3 KB
/
package-summary.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Mon Dec 15 00:48:04 EST 2014 -->
<title>fj.data</title>
<meta name="date" content="2014-12-15">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="fj.data";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../fj/control/parallel/package-summary.html">Prev Package</a></li>
<li><a href="../../fj/data/fingertrees/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?fj/data/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package fj.data</h1>
<div class="docSummary">
<div class="block">Common algebraic data types.</div>
</div>
<p>See: <a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/$.html" title="class in fj.data">$</a><A,B></td>
<td class="colLast">
<div class="block">The constant arrow, for attaching a new name to an existing type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Array.html" title="class in fj.data">Array</a><A></td>
<td class="colLast">
<div class="block">Provides an interface to arrays.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Conversions.html" title="class in fj.data">Conversions</a></td>
<td class="colLast">
<div class="block">Functions that convert between data structure types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Either.html" title="class in fj.data">Either</a><A,B></td>
<td class="colLast">
<div class="block">The <code>Either</code> type represents a value of one of two possible types (a disjoint union).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Enumerator.html" title="class in fj.data">Enumerator</a><A></td>
<td class="colLast">
<div class="block">Abstracts over a type that may have a successor and/or predecessor value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/HashMap.html" title="class in fj.data">HashMap</a><K,V></td>
<td class="colLast">
<div class="block">A mutable hash map providing O(1) lookup.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/HashSet.html" title="class in fj.data">HashSet</a><A></td>
<td class="colLast">
<div class="block">A mutable hash set that guarantees uniqueness of its elements providing O(1) lookup.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/IO.html" title="class in fj.data">IO</a><A></td>
<td class="colLast">
<div class="block">IO monad for processing files, with main methods <code>#enumFileLines(File, Option, IterV)</code>,
<code>#enumFileChars(File, Option, IterV)</code> and <code>#enumFileCharChunks(File, Option, IterV)</code>
(the latter one is the fastest as char chunks read from the file are directly passed to the iteratee
without indirection in between).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/IterableW.html" title="class in fj.data">IterableW</a><A></td>
<td class="colLast">
<div class="block">A wrapper for Iterable that equips it with some useful functions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Iteratee.html" title="class in fj.data">Iteratee</a></td>
<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Iteratee.Input.html" title="class in fj.data">Iteratee.Input</a><E></td>
<td class="colLast">
<div class="block">The input to an iteratee.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Iteratee.IterV.html" title="class in fj.data">Iteratee.IterV</a><E,A></td>
<td class="colLast">
<div class="block">A pure iteratee computation which is either done or needs more input</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Java.html" title="class in fj.data">Java</a></td>
<td class="colLast">
<div class="block">Functions that convert between types from the core Java API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/LazyString.html" title="class in fj.data">LazyString</a></td>
<td class="colLast">
<div class="block">A lazy (non-evaluated) immutable character string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/List.html" title="class in fj.data">List</a><A></td>
<td class="colLast">
<div class="block">Provides an in-memory, immutable, singly linked list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/List.Buffer.html" title="class in fj.data">List.Buffer</a><A></td>
<td class="colLast">
<div class="block">A mutable, singly linked list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Natural.html" title="class in fj.data">Natural</a></td>
<td class="colLast">
<div class="block">Represents a natural number (zero, one, two, etc.)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/NonEmptyList.html" title="class in fj.data">NonEmptyList</a><A></td>
<td class="colLast">
<div class="block">Provides an in-memory, immutable, singly linked list with total <code>head</code> and <code>tail</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Option.html" title="class in fj.data">Option</a><A></td>
<td class="colLast">
<div class="block">An optional value that may be none (no value) or some (a value).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Seq.html" title="class in fj.data">Seq</a><A></td>
<td class="colLast">
<div class="block">Provides an immutable finite sequence, implemented as a finger tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Set.html" title="class in fj.data">Set</a><A></td>
<td class="colLast">
<div class="block">Provides an in-memory, immutable set, implemented as a red/black tree.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Stream.html" title="class in fj.data">Stream</a><A></td>
<td class="colLast">
<div class="block">A lazy (not yet evaluated), immutable, singly linked list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/Tree.html" title="class in fj.data">Tree</a><A></td>
<td class="colLast">
<div class="block">Provides a lazy, immutable, non-empty, multi-way tree (a rose tree).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/TreeMap.html" title="class in fj.data">TreeMap</a><K,V></td>
<td class="colLast">
<div class="block">An immutable, in-memory map, backed by a red-black tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../fj/data/TreeZipper.html" title="class in fj.data">TreeZipper</a><A></td>
<td class="colLast">
<div class="block">Provides a zipper structure for rose trees, which is a Tree supplied with a location within that tree.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Validation.html" title="class in fj.data">Validation</a><E,T></td>
<td class="colLast">
<div class="block">Isomorphic to <a href="../../fj/data/Either.html" title="class in fj.data"><code>Either</code></a> but has renamed functions and represents failure on the left and success on the right.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../fj/data/Zipper.html" title="class in fj.data">Zipper</a><A></td>
<td class="colLast">
<div class="block">Provides a pointed stream, which is a non-empty zipper-like stream structure that tracks an index (focus)
position in a stream.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package fj.data Description">Package fj.data Description</h2>
<div class="block">Common algebraic data types.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../fj/control/parallel/package-summary.html">Prev Package</a></li>
<li><a href="../../fj/data/fingertrees/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?fj/data/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>